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

    Type Alias ApiPerpetualsCancelOrdersBody

    ApiPerpetualsCancelOrdersBody: {
        marketIdsToData: Record<
            PerpetualsMarketId,
            {
                clientOrderIds?: PerpetualsClientOrderId[];
                collateralChange: number;
                orderIds: PerpetualsOrderId[];
            },
        >;
        shouldAbortOnMissingId?: boolean;
        sponsor?: PerpetualsSponsorConfig;
        txKind?: SerializedTransaction;
        walletAddress: SuiAddress;
    } & (
        | { accountCapId?: ObjectId; accountId: PerpetualsAccountId }
        | { vaultId: ObjectId }
    )

    API request body for canceling one or more orders for an account or vault, per market.

    Type Declaration

    • marketIdsToData: Record<
          PerpetualsMarketId,
          {
              clientOrderIds?: PerpetualsClientOrderId[];
              collateralChange: number;
              orderIds: PerpetualsOrderId[];
          },
      >

      Per-market map of order IDs or preview results.

    • OptionalshouldAbortOnMissingId?: boolean

      If true, abort the transaction when any given order ID is not found on-chain. If false (default), missing IDs are tolerated.

    • Optionalsponsor?: PerpetualsSponsorConfig

      Optional transaction sponsorship configuration.

    • OptionaltxKind?: SerializedTransaction

      Serialized transaction kind sent to the service.

    • walletAddress: SuiAddress

      Wallet address used to identify the signer or owner.