@paystreamer/sdk
    Preparing search index...

    Interface BuildProcessRoutedPaymentTxParams

    interface BuildProcessRoutedPaymentTxParams {
        accountId: string;
        clockId: string;
        fundingCoinType: string;
        maxSpend: bigint;
        packageId: string;
        performSwap: (
            fundingCoin: any,
        ) => { fundingChange: any; platformCoin: any };
        platformCoinType: string;
        platformId: string;
        platformInitVersion: number;
        registryId: string;
        schedulerId: string;
        schedulerInitVersion: number;
        tx: Transaction;
    }
    Index
    accountId clockId fundingCoinType maxSpend packageId performSwap platformCoinType platformId platformInitVersion registryId schedulerId schedulerInitVersion tx
    accountId: string
    clockId: string
    fundingCoinType: string

    The coin type the account actually holds.

    maxSpend: bigint

    Upper bound on how much of the account's FundingCoin the swap may spend — also the amount policy limiters are evaluated against.

    packageId: string
    performSwap: (fundingCoin: any) => { fundingChange: any; platformCoin: any }

    Called with the Coin<FundingCoin> withdrawn from the account (a transaction argument, not a value) — perform your swap against it (e.g. deepbook.swapExactQuantity) and return the resulting Coin<PlatformCoin> plus any unspent Coin<FundingCoin> change. Composed into the same tx, between withdraw_for_route and process_routed_payment — this is the only place a swap can go, since the funding coin doesn't exist until withdraw_for_route runs.

    platformCoinType: string

    The coin type the platform settles in.

    platformId: string
    platformInitVersion: number
    registryId: string
    schedulerId: string
    schedulerInitVersion: number
    tx: Transaction

    Settings
    Member Visibility

    On This Page
    Properties