soroswap-utils/src/types/events-common.ts

Utilities for interacting with Soroswap, the decentralized exchange (DEX) on Soroban, which is the smart contracts platform of the Stellar network.

type FactoryEventType = "fees" | "fee_to" | "init" | "new_pair" | "setter";

type PairEventType = "deposit" | "skim" | "swap" | "sync" | "withdraw";

type RouterEventType = "add" | "init" | "remove" | "swap";

type TokenAdminEventType = "clawback" | "mint" | "set_admin" | "set_authorized";

type TokenEventType = "approve" | "burn" | "transfer";

type ExtendedTokenEventType = TokenEventType | TokenAdminEventType;

type EventType =
    | FactoryEventType
    | PairEventType
    | RouterEventType
    | TokenAdminEventType
    | TokenEventType;

type ContractType = "SoroswapFactory" | "SoroswapPair" | "SoroswapRouter" | "SorobanToken";

interface BaseRawEvent {
    readonly ledger: number;
    readonly timestamp: number;
    readonly topic1: string;
    readonly topic2: string;
    readonly topic3: string;
    readonly topic4: string;
}

interface BaseEvent {
    readonly contractType: ContractType;
    readonly eventType: EventType;
    readonly ledger: number;
    readonly timestamp: number;
}

export type {
    BaseEvent,
    BaseRawEvent,
    ContractType,
    EventType,
    ExtendedTokenEventType,
    FactoryEventType,
    PairEventType,
    RouterEventType,
    TokenAdminEventType,
    TokenEventType,
};