Class Rewards

constructor

• new Rewards(config?: CallerConfig, api?: AftermathApi): Rewards

  Creates a rewards HTTP client.

  Parameters

  • Optionalconfig: CallerConfig

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

  • Optionalapi: AftermathApi

    Optional low-level provider used to serialize a caller-supplied transaction before requesting a claim transaction.

  Returns Rewards

Optional Readonlyapi

getClaimable

• getClaimable(
      inputs: ApiRewardsGetClaimableBody,
  ): Promise<ApiRewardsGetClaimableResponse>

  Fetches the wallet's currently claimable rewards.

  Parameters

  • inputs: ApiRewardsGetClaimableBody

    Wallet address to query.

  Returns Promise<ApiRewardsGetClaimableResponse>

  Claimable amounts grouped by coin type. Amounts are bigint values in each coin's smallest units.

  Throws

  AftermathTransportError when the API request or response fails.

getClaimTransaction

• getClaimTransaction(
      inputs: {
          coinTypes?: string[];
          recipientAddress?: string;
          tx?: Transaction;
          walletAddress: string;
      },
  ): Promise<
      Omit<ApiRewardsClaimRequestTxResponse, "txKind"> & { tx: Transaction },
  >

  Requests a reward-claim transaction and restores it as a Sui Transaction.

  If tx is supplied, this method serializes only its TransactionKind via AftermathApi.Transactions().fetchBase64TxKindFromTx and sends that txKind to the API. If tx is omitted, the request can still succeed with a backend-generated transaction. When the response includes a sponsorSignature, the returned bytes are parsed as a full transaction; otherwise they are parsed as a transaction kind. The returned transaction is not signed or executed by this method.

  Parameters

  • inputs: {
        coinTypes?: string[];
        recipientAddress?: string;
        tx?: Transaction;
        walletAddress: string;
    }

    Wallet address, optional coin filters, recipient, and an optional transaction to extend.

  Returns Promise<Omit<ApiRewardsClaimRequestTxResponse, "txKind"> & { tx: Transaction }>

  The parsed claim transaction and any backend sponsor signature.

  Throws

  AftermathTransportError when the API request or response fails.

  Throws

  Error when a supplied transaction cannot be serialized or the response cannot be restored as a Sui transaction.

getExpectedRewards

• getExpectedRewards(
      inputs: ApiRewardsExpectedRewardsBody,
  ): Promise<ApiRewardsExpectedRewardsResponse>

  Preview a single account's expected rewards for an epoch, broken down by domain (trading, referral, AFLP, integrator) plus totals. Backed by the newer rewards/expected-rewards endpoint. Provide exactly one of address or accountId; omit epoch for the current epoch.

  This method performs an HTTP request. Account IDs are decimal strings so that values larger than JavaScript's safe integer range remain exact.

  Parameters

  • inputs: ApiRewardsExpectedRewardsBody

    Account selector, epoch, and optional calculation overrides.

  Returns Promise<ApiRewardsExpectedRewardsResponse>

  The selected epoch, total reward values, and domain breakdown.

  Throws

  AftermathTransportError when the API request or response fails.

getHistory

• getHistory(
      inputs: ApiRewardsGetHistoryBody,
  ): Promise<ApiRewardsGetHistoryResponse>

  Fetches one page of the wallet's reward history.

  Pass cursor from the previous response to request the next page. The API documents a default page size of 20 and a maximum of 100 entries. Amounts in each history entry are returned as bigint values in the coin's smallest units.

  Parameters

  • inputs: ApiRewardsGetHistoryBody

    Wallet authentication data and optional domain and page parameters.

  Returns Promise<ApiRewardsGetHistoryResponse>

  History entries and pagination metadata.

  Throws

  AftermathTransportError when the API request or response fails.

getPoints

• getPoints(inputs: ApiRewardsGetPointsBody): Promise<ApiRewardsGetPointsResponse>

  Fetches the wallet's total reward points.

  The request uses the signed authentication fields in inputs. The method performs HTTP I/O and returns the decoded response.

  Parameters

  • inputs: ApiRewardsGetPointsBody

    Wallet address, signed message bytes, and signature.

  Returns Promise<ApiRewardsGetPointsResponse>

  The total points across all reward epochs and domains.

  Throws

  AftermathTransportError when the API request or response fails.