Class LimitOrders

constructor

• new LimitOrders(config?: CallerConfig): LimitOrders

  Creates a new LimitOrders instance for interacting with limit order functionality on Aftermath.

  Parameters

  • Optionalconfig: CallerConfig

    Optional configuration, including network, API host, access token, and API path.

  Returns LimitOrders

Static Readonlyconstants

cancelLimitOrder

• cancelLimitOrder(
      inputs: ApiLimitOrdersCancelOrderTransactionBody,
  ): Promise<boolean>

  Sends a signed request to cancel one or more limit orders.

  Sign the exact string returned by UserData.createTermsAndConditionsMessage() as a personal message over its UTF-8 bytes. Send those signed bytes and the signature in inputs. The order IDs are sent in orderObjectIds; the deprecated per-action message from cancelLimitOrdersMessageToSign is not the current credential.

  Parameters

  • inputs: ApiLimitOrdersCancelOrderTransactionBody

    Wallet address, signed terms-message bytes, signature, and the order object IDs to cancel.

  Returns Promise<boolean>

  The backend cancellation result. false is a valid response.

  Throws

  AftermathTransportError when the API request or response fails.

  Example

  const success = await limitOrders.cancelLimitOrder({
    walletAddress: "0x<address>",
    bytes: "0x<signed_bytes>",
    signature: "0x<signature>",
  });
  Copy

cancelLimitOrdersMessageToSign

• cancelLimitOrdersMessageToSign(
      inputs: { orderIds: string[] },
  ): { action: string; order_object_ids: string[] }

  Builds the legacy per-action message for canceling limit orders.

  This method performs no network I/O. The current cancellation endpoint authenticates with the canonical terms message instead. Put the order IDs in cancelLimitOrder's orderObjectIds field.

  Parameters

  • inputs: { orderIds: string[] }

    Object with orderIds, an array of order object IDs to cancel.

  Returns { action: string; order_object_ids: string[] }

  { action: "CANCEL_LIMIT_ORDERS", order_object_ids: inputs.orderIds }.

  Deprecated

  af-fe no longer accepts this per-action message. Sign UserData.createTermsAndConditionsMessage and pass orderObjectIds in the cancelLimitOrder body instead.

getActiveLimitOrders

• getActiveLimitOrders(
      inputs: ApiLimitOrdersActiveOrdersOwnedBody,
  ): Promise<LimitOrderObject[]>

  Fetches the user's active limit orders from the Aftermath API.

  The bytes and signature fields authenticate the request. They are the signed terms-message credential, not a transaction or a limit-order cancellation payload.

  Parameters

  • inputs: ApiLimitOrdersActiveOrdersOwnedBody

    Contains the walletAddress, as well as bytes and signature if needed for auth.

  Returns Promise<LimitOrderObject[]>

  A promise resolving to an array of LimitOrderObject, representing the active orders.

  Throws

  AftermathTransportError when the API request or response fails.

  Example

  const activeOrders = await limitOrders.getActiveLimitOrders({
    walletAddress: "0x<address>",
    bytes: "0x<signed_bytes>",
    signature: "0x<signature>"
  });
  Copy

getCreateLimitOrderTx

• getCreateLimitOrderTx(
      inputs: ApiLimitOrdersCreateOrderTransactionBody,
  ): Promise<Transaction>

  Requests a limit-order creation transaction from the Aftermath API. The returned Transaction is not signed or executed.

  Parameters

  • inputs: ApiLimitOrdersCreateOrderTransactionBody

    Limit-order details. Coin amounts are in the smallest units of their coin, and expiryDurationMs is in milliseconds.

  Returns Promise<Transaction>

  A parsed Transaction with the wallet address set as its sender.

  Throws

  AftermathTransportError when the API request, response decoding, or transaction parsing fails.

  Example

  const tx = await limitOrders.getCreateLimitOrderTx({
    walletAddress: "0x<address>",
    allocateCoinType: "0x<coin>",
    allocateCoinAmount: BigInt(1000),
    buyCoinType: "0x<other_coin>",
    expiryDurationMs: 3600000, // 1 hour
    outputToInputExchangeRate: 0.5,
  });
  // sign and execute the transaction
  Copy

getMinOrderSizeUsd

• getMinOrderSizeUsd(): Promise<number | undefined>

  Fetches the minimum allowable limit-order size in USD.

  Returns Promise<number | undefined>

  A promise resolving to a number (USD value) or undefined if not configured.

  Throws

  AftermathTransportError when the API request or response fails.

  Example

  const minSize = await limitOrders.getMinOrderSizeUsd();
  console.log("Minimum order size in USD:", minSize);
  Copy

getPastLimitOrders

• getPastLimitOrders(
      inputs: { walletAddress: string },
  ): Promise<LimitOrderObject[]>

  Fetches the user's past limit orders from the Aftermath API, including completed, canceled, expired, and failed orders.

  Parameters

  • inputs: { walletAddress: string }

    An object containing the walletAddress.

  Returns Promise<LimitOrderObject[]>

  A promise resolving to an array of LimitOrderObject representing past orders.

  Throws

  AftermathTransportError when the API request or response fails.

  Example

  const pastOrders = await limitOrders.getPastLimitOrders({
    walletAddress: "0x<address>",
  });
  Copy