Class Dca

constructor

• new Dca(config?: CallerConfig): Dca

  Creates a new instance of the Dca class, responsible for managing DCA orders (querying, creating, closing).

  Parameters

  • Optionalconfig: CallerConfig

    Optional caller configuration, such as network, API host, access token, and API path.

  Returns Dca

Static Readonlyconstants

closeDcaOrder

• closeDcaOrder(inputs: ApiDcaTransactionForCloseOrderBody): Promise<boolean>

  Sends a signed request to cancel one or more DCA 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 closeDcaOrdersMessageToSign is not the current credential.

  Parameters

  • inputs: ApiDcaTransactionForCloseOrderBody

    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 dca.closeDcaOrder({
    walletAddress: "0x...",
    bytes: "0x<signed_bytes>",
    signature: "0x<signature>",
  });
  Copy

closeDcaOrdersMessageToSign

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

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

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

  Parameters

  • inputs: { orderIds: string[] }

    An object containing orderIds, an array of order object IDs to cancel.

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

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

  Deprecated

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

createUserAccountMessageToSign

• createUserAccountMessageToSign(): { action: string }

  Deprecated. Generates a message object used in older flows to create a DCA user account. Use the userData package for user key storage or account creation.

  Returns { action: string }

  { action: "CREATE_DCA_ACCOUNT" }. No network request is made.

  Deprecated

  Please use method from userData package instead.

createUserPublicKey

• createUserPublicKey(inputs: ApiDcaCreateUserBody): Promise<boolean>

  Deprecated. Creates the user's public key in the older DCA system. Please use createUserPublicKey from the userData package instead.

  Parameters

  • inputs: ApiDcaCreateUserBody

    User address, signed message bytes, and the corresponding signature.

  Returns Promise<boolean>

  true if the public key was stored. false is also a valid backend response.

  Deprecated

  Use userData package method instead

  Throws

  AftermathTransportError when the API request or response fails.

getActiveDcaOrders

• getActiveDcaOrders(inputs: { walletAddress: string }): Promise<DcaOrderObject[]>

  Retrieves the currently active DCA orders for a specific user.

  Parameters

  • inputs: { walletAddress: string }

    An object containing the user's walletAddress.

  Returns Promise<DcaOrderObject[]>

  A promise that resolves to an array of DcaOrderObject for the active orders.

  Throws

  AftermathTransportError when the API request or response fails.

  Example

  const activeOrders = await dca.getActiveDcaOrders({ walletAddress: "0x..." });
  console.log(activeOrders); // Array of active DCA orders
  Copy

getAllDcaOrders

• getAllDcaOrders(inputs: ApiDCAsOwnedBody): Promise<DcaOrdersObject>

  Deprecated. Fetches both active and past DCA orders for a given user in one response. Use getActiveDcaOrders and getPastDcaOrders for a more explicit approach.

  Parameters

  • inputs: ApiDCAsOwnedBody

    Object containing the user's walletAddress.

  Returns Promise<DcaOrdersObject>

  A DcaOrdersObject grouping active and past orders.

  Throws

  AftermathTransportError when the API request or response fails.

  Deprecated

  Please use getActiveDcaOrders & getPastDcaOrders instead.

  Example

  // Old usage:
  const allOrders = await dca.getAllDcaOrders({ walletAddress: "0x..." });
  console.log(allOrders.active, allOrders.past);
  Copy

getCreateDcaOrderTx

• getCreateDcaOrderTx(
      inputs: ApiDcaTransactionForCreateOrderBody,
  ): Promise<Transaction>

  Requests a transaction block from the Aftermath API to create a new DCA order. The returned Transaction is not signed or executed.

  Parameters

  • inputs: ApiDcaTransactionForCreateOrderBody

    The DCA order parameters. Coin amounts are in the smallest units of their coin, and time values ending in Ms are 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 createOrderTx = await dca.getCreateDcaOrderTx({
    walletAddress: "0x<user>",
    allocateCoinType: "0x2::sui::SUI",
    allocateCoinAmount: BigInt(1_000_000_000),
    buyCoinType: "0x<coin>",
    frequencyMs: 3600000, // Every hour
    tradesAmount: 5,
    // ...other fields...
  });
  // sign & send the transaction
  Copy

getPastDcaOrders

• getPastDcaOrders(inputs: { walletAddress: string }): Promise<DcaOrderObject[]>

  Retrieves the past (completed or canceled) DCA orders for a specific user.

  Parameters

  • inputs: { walletAddress: string }

    An object containing the user's walletAddress.

  Returns Promise<DcaOrderObject[]>

  A promise that resolves to an array of DcaOrderObject for the past orders.

  Throws

  AftermathTransportError when the API request or response fails.

  Example

  const pastOrders = await dca.getPastDcaOrders({ walletAddress: "0x..." });
  console.log(pastOrders); // Array of past DCA orders
  Copy

getUserPublicKey

• getUserPublicKey(inputs: { walletAddress: string }): Promise<string | undefined>

  Deprecated. Fetches the user's public key from the older DCA system. Please use getUserPublicKey from the userData package instead.

  Parameters

  • inputs: { walletAddress: string }

    Contains the user's walletAddress.

  Returns Promise<string | undefined>

  The stored public key, or undefined when the API returns no key.

  Deprecated

  Use userData package method instead

  Throws

  AftermathTransportError when the API request or response fails.