Skip to content

EVENTS.md

Latest commit

 

History

History
174 lines (138 loc) · 3.92 KB

EVENTS.md

File metadata and controls

174 lines (138 loc) · 3.92 KB
Raw

Linkora Social Contract - Event Schema

This document defines the canonical event schema for the Linkora Social contract. Indexers and clients should use this as the source of truth for decoding and filtering events.

Versioning Strategy

All events follow a consistent topic structure: (ContractName, EventName, Version)

  • ContractName: Linkora (Symbol)
  • EventName: Descriptive name (Symbol)
  • Version: v1, v2, etc. (Symbol)

When a schema change is required, the version symbol will be incremented. Indexers should filter for the versions they support.

Canonical Events

ProfileSet

Emitted when a user creates or updates their profile.

  • Topic 0: Linkora
  • Topic 1: profile
  • Topic 2: v1
  • Data Payload: ProfileSetEvent
    • user: Address
    • username: String

Follow

Emitted when a user follows another user.

  • Topic 0: Linkora
  • Topic 1: follow
  • Topic 2: v1
  • Data Payload: FollowEvent
    • follower: Address
    • followee: Address

Unfollow

Emitted when a user unfollows another user.

  • Topic 0: Linkora
  • Topic 1: unfollow
  • Topic 2: v1
  • Data Payload: UnfollowEvent
    • follower: Address
    • followee: Address

Block

Emitted when a user blocks another user.

  • Topic 0: Linkora
  • Topic 1: block
  • Topic 2: v1
  • Data Payload: BlockEvent
    • blocker: Address
    • blocked: Address

Unblock

Emitted when a user unblocks another user.

  • Topic 0: Linkora
  • Topic 1: unblock
  • Topic 2: v1
  • Data Payload: UnblockEvent
    • blocker: Address
    • blocked: Address

PostCreated

Emitted when a new post is successfully created.

  • Topic 0: Linkora
  • Topic 1: post
  • Topic 2: v1
  • Data Payload: PostCreatedEvent
    • id: u64
    • author: Address

Tip

Emitted when a post author is tipped.

  • Topic 0: Linkora
  • Topic 1: tip
  • Topic 2: v1
  • Data Payload: TipEvent
    • tipper: Address
    • post_id: u64
    • amount: i128 (Gross amount)
    • fee: i128 (Amount sent to protocol treasury)

Like

Emitted when a user likes a post.

  • Topic 0: Linkora
  • Topic 1: like
  • Topic 2: v1
  • Data Payload: LikePostEvent
    • user: Address
    • post_id: u64

ContractUpgraded

Emitted when the contract WASM is upgraded.

  • Topic 0: Linkora
  • Topic 1: upgraded
  • Topic 2: v1
  • Data Payload: ContractUpgraded
    • new_wasm_hash: BytesN<32>

PostDeleted

Emitted when a post is deleted by its author.

  • Topic 0: Linkora
  • Topic 1: post_del
  • Topic 2: v1
  • Data Payload: PostDeleted
    • post_id: u64
    • author: Address

PoolDeposit

Emitted when tokens are deposited into a community pool.

  • Topic 0: Linkora
  • Topic 1: deposit
  • Topic 2: v1
  • Data Payload: PoolDepositEvent
    • depositor: Address
    • pool_id: Symbol
    • amount: i128

PoolWithdraw

Emitted when tokens are withdrawn from a community pool.

  • Topic 0: Linkora
  • Topic 1: withdraw
  • Topic 2: v1
  • Data Payload: PoolWithdrawEvent
    • recipient: Address
    • pool_id: Symbol
    • amount: i128

Querying and Decoding

Using Stellar CLI

To fetch events from a specific contract on Testnet:

stellar events --id <CONTRACT_ID> --network testnet --start-ledger <LEDGER_NUM>

To filter for only tip events:

stellar events --id <CONTRACT_ID> --network testnet --topic "Linkora, tip, v1"

Using JS SDK

const events = await server.getEvents({
  filters: [
    {
      type: "contract",
      contractIds: [CONTRACT_ID],
      topics: [
        [
          xdr.ScVal.scvSymbol("Linkora").toXDR("base64"),
          xdr.ScVal.scvSymbol("tip").toXDR("base64"),
          xdr.ScVal.scvSymbol("v1").toXDR("base64"),
        ]
      ]
    }
  ],
  startLedger: 123456,
});