aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface ApiPerpetualsBuilderCodesClaimIntegratorVaultFeesTxBody

    Request payload for creating a transaction to claim accumulated integrator fees from a vault.

    Integrators earn fees on taker volume generated by orders they submit on behalf of users. These fees accumulate in a global vault per integrator and can be claimed at any time.

    interface ApiPerpetualsBuilderCodesClaimIntegratorVaultFeesTxBody {
        integratorId: number;
        recipientAddress?: string;
        txKind?: string;
    }
    Index
    integratorId: number

    Numeric integrator id (as assigned by the registry).

    Only the integrator who earned the fees can claim them. Integrator vaults are global across markets, so no clearing-house id is required.

    recipientAddress?: string

    Optional recipient address for the claimed fees.

    When provided, the transaction will include on-chain transfers of all claimed coins to this address. When omitted, the claimed coins are exposed as transaction arguments that can be used in subsequent commands.

    txKind?: string

    Optional existing transaction kind (base64-encoded) to extend.

    If provided, the fee claim will be added to this transaction.