Class Farms

constructor

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

  Creates a Farms instance for farm API reads and transaction builders.

  Parameters

  • Optionalconfig: CallerConfig

    Optional network, API-host, and access-token configuration.

  • Optionalapi: AftermathApi

    Optional provider used by transaction builders. Reads do not require it.

  Returns Farms

Optional Readonlyapi

Static Readonlyconstants

getAllStakingPools

• getAllStakingPools(abortSignal?: AbortSignal): Promise<FarmsStakingPool[]>

  Fetches all existing staking pools registered within the indexer or farm API.

  Parameters

  • OptionalabortSignal: AbortSignal

    Optional signal that cancels the API request.

  Returns Promise<FarmsStakingPool[]>

  An array of FarmsStakingPool objects.

  Example

  const allPools = await farms.getAllStakingPools();
  console.log(allPools.map(pool => pool.stakingPool));
  Copy

getCreateStakingPoolTransactionV1

• getCreateStakingPoolTransactionV1(
      inputs: ApiFarmsCreateStakingPoolBodyV1,
  ): Promise<Transaction>

  Deprecated: Use getCreateStakingPoolTransactionV2() instead.

  Builds a transaction to create a new staking pool (farming vault) on version 1 of the farm system.

  Parameters

  • inputs: ApiFarmsCreateStakingPoolBodyV1

    Pool durations in milliseconds, fixed-point multiplier, minimum stake, coin type, and creator address.

  Returns Promise<Transaction>

  A transaction object (or bytes) that can be signed and submitted.

  Deprecated

  Please use getCreateStakingPoolTransactionV2.

getCreateStakingPoolTransactionV2

• getCreateStakingPoolTransactionV2(
      inputs: ApiFarmsCreateStakingPoolBody,
  ): Promise<Transaction>

  Builds a transaction to create a new staking pool (farming vault) on version 2 of the farm system.

  Parameters

  • inputs: ApiFarmsCreateStakingPoolBody

    Pool durations in milliseconds, fixed-point multiplier, minimum stake, coin type, and creator address.

  Returns Promise<Transaction>

  A transaction object (or bytes) that can be signed and submitted.

  Throws

  An error if no AftermathApi instance was provided.

  Example

  const tx = await farms.getCreateStakingPoolTransactionV2({
    minLockDurationMs: 604800000, // 1 week
    maxLockDurationMs: 31536000000, // 1 year
    maxLockMultiplier: BigInt("2000000000000000000"), // 2.0x in 18-decimal fixed point
    minStakeAmount: BigInt("1000000"),
    stakeCoinType: "0x<coin_type>",
    walletAddress: "0x<admin_address>"
  });
  // sign and submit the transaction
  Copy

getFarmSummaries

• getFarmSummaries(
      inputs?: ApiFarmsSummaryBody,
      abortSignal?: AbortSignal,
  ): Promise<FarmSummary[]>

  Fetches TVL and reward TVL for multiple farms in a single batch response. When farmIds is omitted, the API returns summaries for all farms.

  Parameters

  • Optionalinputs: ApiFarmsSummaryBody

    Optionally provide the farm IDs to include.

  • OptionalabortSignal: AbortSignal

    An optional signal for cancelling the request.

  Returns Promise<FarmSummary[]>

  TVL and reward TVL metrics for each requested farm.

getInteractionEvents

• getInteractionEvents(
      inputs: ApiIndexerEventsBody & { walletAddress: string },
  ): Promise<IndexerEventsWithCursor<FarmUserEvent>>

  Fetches user-specific farm interaction events (e.g., staked, unlocked, withdrew) with optional pagination.

  Parameters

  • inputs: ApiIndexerEventsBody & { walletAddress: string }

    Includes the user's walletAddress, along with cursor and limit for pagination.

  Returns Promise<IndexerEventsWithCursor<FarmUserEvent>>

  A paginated set of events of type FarmUserEvent.

  Example

  const userEvents = await farms.getInteractionEvents({
    walletAddress: "0x<user_address>",
    cursor: 0,
    limit: 10
  });
  console.log(userEvents);
  Copy

getOwnedStakedPositions

• getOwnedStakedPositions(
      inputs: ApiFarmsOwnedStakedPositionsBody,
  ): Promise<FarmsStakedPosition[]>

  Fetches all staked positions owned by a given user.

  Parameters

  • inputs: ApiFarmsOwnedStakedPositionsBody

    An object containing the user's walletAddress.

  Returns Promise<FarmsStakedPosition[]>

  An array of FarmsStakedPosition objects representing each of the user's staked positions.

  Example

  const positions = await farms.getOwnedStakedPositions({
    walletAddress: "0x<user_address>"
  });
  console.log(positions);
  Copy

getOwnedStakingPoolOneTimeAdminCaps

• getOwnedStakingPoolOneTimeAdminCaps(
      inputs: ApiFarmsOwnedStakingPoolOneTimeAdminCapsBody,
  ): Promise<StakingPoolOneTimeAdminCapObject[]>

  Fetches all StakingPoolOneTimeAdminCapObjects that a given address owns. These caps grant one-time admin privileges, typically for initializing reward coins.

  Parameters

  • inputs: ApiFarmsOwnedStakingPoolOneTimeAdminCapsBody

    An object containing the admin's walletAddress.

  Returns Promise<StakingPoolOneTimeAdminCapObject[]>

  An array of StakingPoolOneTimeAdminCapObjects.

  Example

  const adminCaps = await farms.getOwnedStakingPoolOneTimeAdminCaps({
    walletAddress: "0x<user_address>"
  });
  console.log(adminCaps);
  Copy

getOwnedStakingPoolOwnerCaps

• getOwnedStakingPoolOwnerCaps(
      inputs: ApiFarmsOwnedStakingPoolOwnerCapsBody,
  ): Promise<StakingPoolOwnerCapObject[]>

  Fetches all StakingPoolOwnerCapObjects that a given address owns. These caps grant the owner the ability to modify staking pool parameters.

  Parameters

  • inputs: ApiFarmsOwnedStakingPoolOwnerCapsBody

    An object containing the owner's walletAddress.

  Returns Promise<StakingPoolOwnerCapObject[]>

  An array of StakingPoolOwnerCapObjects.

  Example

  const ownerCaps = await farms.getOwnedStakingPoolOwnerCaps({
    walletAddress: "0x<user_address>"
  });
  console.log(ownerCaps);
  Copy

getRewardsTVL

• getRewardsTVL(
      inputs?: { farmIds?: string[] },
      abortSignal?: AbortSignal,
  ): Promise<number>

  Retrieves the total value locked (TVL) of reward coins across specified farm IDs or all farms if none are specified.

  Parameters

  • Optionalinputs: { farmIds?: string[] }

    An optional object containing an array of farmIds. If not provided, returns global reward TVL.

  • OptionalabortSignal: AbortSignal

    Optional signal that cancels the API request.

  Returns Promise<number>

  A promise that resolves to the reward TVL as a number in the API's reporting currency.

  Example

  const rewardsTvl = await farms.getRewardsTVL();
  console.log("All farms' rewards TVL:", rewardsTvl);
  
  const singleFarmRewardsTvl = await farms.getRewardsTVL({ farmIds: ["0x<farm_id>"] });
  console.log("Single farm's rewards TVL:", singleFarmRewardsTvl);
  Copy

getStakingPool

• getStakingPool(
      inputs: { objectId: string },
      abortSignal?: AbortSignal,
  ): Promise<FarmsStakingPool>

  Fetches a single staking pool by its objectId from the farm API/indexer.

  Parameters

  • inputs: { objectId: string }

    An object containing the objectId of the staking pool.

  • OptionalabortSignal: AbortSignal

    Optional signal that cancels the API request.

  Returns Promise<FarmsStakingPool>

  A FarmsStakingPool object representing the staking pool.

  Example

  const pool = await farms.getStakingPool({ objectId: "0x<pool_id>" });
  console.log(pool.stakingPool);
  Copy

getStakingPools

• getStakingPools(
      inputs: { objectIds: string[] },
      abortSignal?: AbortSignal,
  ): Promise<FarmsStakingPool[]>

  Fetches multiple staking pools by their objectIds.

  Parameters

  • inputs: { objectIds: string[] }

    An object containing an array of objectIds.

  • OptionalabortSignal: AbortSignal

    Optional signal that cancels the API request.

  Returns Promise<FarmsStakingPool[]>

  An array of FarmsStakingPool instances corresponding to each objectId.

  Example

  const pools = await farms.getStakingPools({
    objectIds: ["0x<id1>", "0x<id2>"]
  });
  console.log(pools[0].stakingPool, pools[1].stakingPool);
  Copy

getTVL

• getTVL(
      inputs?: { farmIds?: string[] },
      abortSignal?: AbortSignal,
  ): Promise<number>

  Retrieves the total value locked (TVL) in the specified farm IDs or in all farms if none are specified.

  Parameters

  • Optionalinputs: { farmIds?: string[] }

    An optional object containing an array of farmIds to filter TVL by. If not provided, returns global TVL.

  • OptionalabortSignal: AbortSignal

    Optional signal that cancels the API request.

  Returns Promise<number>

  A promise that resolves to the TVL as a number in the API's reporting currency.

  Example

  const tvl = await farms.getTVL();
  console.log("All farms' TVL:", tvl);
  
  const tvlForSpecificFarm = await farms.getTVL({ farmIds: ["0x<farm_id>"] });
  console.log("Specific farm's TVL:", tvlForSpecificFarm);
  Copy