Class FarmsApi

Low-level farm API for reading farm-owned objects and composing Move transaction commands for V1 and V2 staking pools.

Command methods such as stakeTxV2 append one Move command to a
caller-owned Transaction. Methods beginning with build or fetchBuild
assemble a complete transaction. The fetchBuild methods may read owned coins through AftermathApi before they append commands. None of these methods submits a transaction to the network.

Move abort descriptions are exposed through moveErrors. On-chain validation still applies when the completed transaction executes.

Implements

MoveErrorsInterface

Index

Constructors

constructor

Properties

addresses buildGrantOneTimeAdminCapTxV1 buildGrantOneTimeAdminCapTxV2 buildLockTxV1 buildLockTxV2 buildRenewLockTxV1 buildRenewLockTxV2 buildSetStakingPoolMaxLockDurationMsTxV2 buildSetStakingPoolMinLockDurationMsTxV2 buildSetStakingPoolMinStakeAmountTxV1 buildSetStakingPoolMinStakeAmountTxV2 buildUnlockTxV1 buildUnlockTxV2 buildUpdatePositionTx2 buildUpdatePositionTxV1 eventTypes moveErrors objectTypes

Methods

Constructors

constructor

new FarmsApi(api: AftermathApi): FarmsApi
Creates a low-level farm API from an initialized provider.
Parameters
- api: AftermathApi
  Provider containing the farm package and object addresses.
Returns FarmsApi

Throws
Error if the provider has no farm address configuration.
- Defined in packages/farms/api/farmsApi.ts:200

Properties

`Readonly`addresses

addresses: FarmsAddresses

Package and shared-object addresses used by the farm contracts.

buildGrantOneTimeAdminCapTxV1

buildGrantOneTimeAdminCapTxV1: (
    inputs: { walletAddress: string } & Omit<
        {
            ownerCapId: string
            | TransactionArgument;
            recipientAddress: string;
            rewardCoinType: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              ownerCapId: string
              | TransactionArgument;
              recipientAddress: string;
              rewardCoinType: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            ownerCapId: string
            | TransactionArgument;
            recipientAddress: string;
            rewardCoinType: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

Deprecated

use buildGrantOneTimeAdminCapTxV2 instead Builds a transaction for granting a one-time admin capability for a staking pool

buildGrantOneTimeAdminCapTxV2

buildGrantOneTimeAdminCapTxV2: (
    inputs: { walletAddress: string } & Omit<
        {
            ownerCapId: string
            | TransactionArgument;
            recipientAddress: string;
            rewardCoinType: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Builds a transaction for granting a one-time admin capability for a staking pool

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              ownerCapId: string
              | TransactionArgument;
              recipientAddress: string;
              rewardCoinType: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            ownerCapId: string
            | TransactionArgument;
            recipientAddress: string;
            rewardCoinType: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

buildLockTxV1

buildLockTxV1: (
    inputs: { walletAddress: string } & Omit<
        {
            lockDurationMs: number;
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              lockDurationMs: number;
              stakeCoinType: string;
              stakedPositionId: string;
              stakingPoolId: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            lockDurationMs: number;
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

Deprecated

use buildLockTxV2 instead Builds a transaction for locking a staked position

buildLockTxV2

buildLockTxV2: (
    inputs: { walletAddress: string } & Omit<
        {
            lockDurationMs: number;
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Builds a transaction for locking a staked position

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              lockDurationMs: number;
              stakeCoinType: string;
              stakedPositionId: string;
              stakingPoolId: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            lockDurationMs: number;
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

buildRenewLockTxV1

buildRenewLockTxV1: (
    inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              stakeCoinType: string;
              stakedPositionId: string;
              stakingPoolId: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

Deprecated

use buildRenewLockTxV2 instead Builds a transaction for renewing the lock on a staked position

buildRenewLockTxV2

buildRenewLockTxV2: (
    inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Builds a transaction for renewing the lock on a staked position

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              stakeCoinType: string;
              stakedPositionId: string;
              stakingPoolId: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

buildSetStakingPoolMaxLockDurationMsTxV2

buildSetStakingPoolMaxLockDurationMsTxV2: (
    inputs: { walletAddress: string } & Omit<
        {
            lockDurationMs: bigint;
            ownerCapId: string;
            stakeCoinType: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Builds a V2 transaction that updates the pool's maximum lock duration in milliseconds.

buildSetStakingPoolMinLockDurationMsTxV2

buildSetStakingPoolMinLockDurationMsTxV2: (
    inputs: { walletAddress: string } & Omit<
        {
            lockDurationMs: bigint;
            ownerCapId: string;
            stakeCoinType: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Builds a V2 transaction that updates the pool's minimum lock duration in milliseconds.

buildSetStakingPoolMinStakeAmountTxV1

buildSetStakingPoolMinStakeAmountTxV1: (
    inputs: { walletAddress: string } & Omit<
        {
            minStakeAmount: bigint;
            ownerCapId: string;
            stakeCoinType: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              minStakeAmount: bigint;
              ownerCapId: string;
              stakeCoinType: string;
              stakingPoolId: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            minStakeAmount: bigint;
            ownerCapId: string;
            stakeCoinType: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

Deprecated

use buildSetStakingPoolMinStakeAmountTxV2 instead Builds a transaction for setting the minimum stake amount for a staking pool

buildSetStakingPoolMinStakeAmountTxV2

buildSetStakingPoolMinStakeAmountTxV2: (
    inputs: { walletAddress: string } & Omit<
        {
            minStakeAmount: bigint;
            ownerCapId: string;
            stakeCoinType: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Builds a transaction for setting the minimum stake amount for a staking pool

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              minStakeAmount: bigint;
              ownerCapId: string;
              stakeCoinType: string;
              stakingPoolId: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            minStakeAmount: bigint;
            ownerCapId: string;
            stakeCoinType: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

buildUnlockTxV1

buildUnlockTxV1: (
    inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              stakeCoinType: string;
              stakedPositionId: string;
              stakingPoolId: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

Deprecated

use buildUnlockTxV2 instead Builds a transaction for unlocking a staked position

buildUnlockTxV2

buildUnlockTxV2: (
    inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Builds a transaction for unlocking a staked position

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              stakeCoinType: string;
              stakedPositionId: string;
              stakingPoolId: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

buildUpdatePositionTx2

buildUpdatePositionTx2: (
    inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Builds a transaction for updating a staked position

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              stakeCoinType: string;
              stakedPositionId: string;
              stakingPoolId: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

buildUpdatePositionTxV1

buildUpdatePositionTxV1: (
    inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >,
) => Transaction = ...

Type Declaration

- (
      inputs: { walletAddress: string } & Omit<
          {
              stakeCoinType: string;
              stakedPositionId: string;
              stakingPoolId: string;
              tx: Transaction;
          },
          "tx",
      >,
  ): Transaction
- Parameters
  - inputs: { walletAddress: string } & Omit<
        {
            stakeCoinType: string;
            stakedPositionId: string;
            stakingPoolId: string;
            tx: Transaction;
        },
        "tx",
    >
  Returns Transaction
  Complete transaction ready for signing and execution

Deprecated

use buildUpdatePositionTxV2 instead Builds a transaction for updating a staked position

`Readonly`eventTypes

eventTypes: {
    addedRewardV1: string;
    addedRewardV2: string;
    createdVaultV1: string;
    createdVaultV2: string;
    depositedPrincipalV1: string;
    depositedPrincipalV2: string;
    harvestedRewardsV1: string;
    harvestedRewardsV2: string;
    increasedEmissionsV1: string;
    initializedRewardV1: string;
    initializedRewardV2: string;
    lockedV1: string;
    lockedV2: string;
    stakedRelaxedV1: string;
    stakedV1: string;
    stakedV2: string;
    unlockedV1: string;
    unlockedV2: string;
    updatedEmissionsV2: string;
    withdrewPrincipalV1: string;
    withdrewPrincipalV2: string;
}

Fully qualified event types used by the farm event queries.

Type Declaration

addedRewardV1: string

V1 reward-added event type.
addedRewardV2: string

V2 reward-added event type.
createdVaultV1: string

V1 pool-created event type.
createdVaultV2: string

V2 pool-created event type.
depositedPrincipalV1: string

V1 principal-deposit event type.
depositedPrincipalV2: string

V2 principal-deposit event type.
harvestedRewardsV1: string

V1 reward-harvest event type.
harvestedRewardsV2: string

V2 reward-harvest event type.
increasedEmissionsV1: string

V1 emission-increase event type.
initializedRewardV1: string

V1 reward-initialized event type.
initializedRewardV2: string

V2 reward-initialized event type.
lockedV1: string

V1 lock event type.
lockedV2: string

V2 lock event type.
stakedRelaxedV1: string

V1 relaxed-stake event type.
stakedV1: string

V1 strict-stake event type.
stakedV2: string

V2 strict-stake event type.
unlockedV1: string

V1 unlock event type.
unlockedV2: string

V2 unlock event type.
updatedEmissionsV2: string

V2 emission-update event type.
withdrewPrincipalV1: string

V1 principal-withdrawal event type.
withdrewPrincipalV2: string

V2 principal-withdrawal event type.

`Readonly`moveErrors

moveErrors: MoveErrors

Move abort messages keyed by package, module, and numeric error code.

`Readonly`objectTypes

objectTypes: {
    stakedPositionV1: string;
    stakedPositionV2: string;
    stakingPoolOneTimeAdminCapV1: string;
    stakingPoolOneTimeAdminCapV2: string;
    stakingPoolOwnerCapV1: string;
    stakingPoolOwnerCapV2: string;
}

Fully qualified object types used for V1 and V2 ownership reads.

Type Declaration

stakedPositionV1: string

V1 staked-position object type.
stakedPositionV2: string

V2 staked-position object type.
stakingPoolOneTimeAdminCapV1: string

V1 one-time-admin-cap object type.
stakingPoolOneTimeAdminCapV2: string

V2 one-time-admin-cap object type.
stakingPoolOwnerCapV1: string

V1 owner-cap object type.
stakingPoolOwnerCapV2: string

V2 owner-cap object type, including its authority type arguments.

Methods

beginHarvestTxV1

beginHarvestTxV1(
    inputs: {
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: { stakeCoinType: string; stakingPoolId: string; tx: Transaction }
  Begin harvest parameters including transaction, pool ID, and coin type
Returns TransactionResult
Transaction object argument for the harvest metadata

Deprecated
use beginHarvestTxV2 instead Creates a transaction to begin the reward harvesting process (original version)
- Defined in packages/farms/api/farmsApi.ts:975

beginHarvestTxV2

beginHarvestTxV2(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to begin the reward harvesting process
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Begin harvest parameters including transaction, position ID, pool ID, and coin type
Returns TransactionResult
Transaction object argument for the harvest cap
- Defined in packages/farms/api/farmsApi.ts:1000

buildCreateStakingPoolTxV1

buildCreateStakingPoolTxV1(inputs: ApiFarmsCreateStakingPoolBodyV1): Transaction
Parameters
- inputs: ApiFarmsCreateStakingPoolBodyV1
  Pool creation parameters including wallet address, lock enforcements, durations, multiplier, stake amount, and coin type
Returns Transaction
Complete transaction ready for signing and execution

Deprecated
use buildCreateStakingPoolTxV2 instead Builds a complete transaction for creating a new staking pool
- Defined in packages/farms/api/farmsApi.ts:2326

buildCreateStakingPoolTxV2

buildCreateStakingPoolTxV2(inputs: ApiFarmsCreateStakingPoolBody): Transaction
Builds a complete transaction for creating a new staking pool
Parameters
- inputs: ApiFarmsCreateStakingPoolBody
  Pool creation parameters including wallet address, lock enforcements, durations, multiplier, stake amount, and coin type
Returns Transaction
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:2358

buildHarvestRewardsTxV1

buildHarvestRewardsTxV1(
inputs: ApiHarvestFarmsRewardsBody & { tx?: Transaction },
): Transaction
Parameters
- inputs: ApiHarvestFarmsRewardsBody & { tx?: Transaction }
  Harvest parameters including wallet address, position IDs, pool ID, reward coin types, and optional claim as AfSui flag
Returns Transaction
Complete transaction ready for signing and execution

Deprecated
use buildHarvestRewardsTxV2 instead Builds a complete transaction for harvesting rewards from staked positions
- Defined in packages/farms/api/farmsApi.ts:2181

buildHarvestRewardsTxV2

buildHarvestRewardsTxV2(
inputs: ApiHarvestFarmsRewardsBody & { tx?: Transaction },
): Transaction
Builds a complete transaction for harvesting rewards from staked positions
Parameters
- inputs: ApiHarvestFarmsRewardsBody & { tx?: Transaction }
  Harvest parameters including wallet address, position IDs, pool ID, reward coin types, and optional claim as AfSui flag
Returns Transaction
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:2249

buildIncreaseStakingPoolRewardsEmissionsTxV1

buildIncreaseStakingPoolRewardsEmissionsTxV1(
inputs: ApiFarmsIncreaseStakingPoolRewardsEmissionsBody,
): Transaction
Parameters
- inputs: ApiFarmsIncreaseStakingPoolRewardsEmissionsBody
  Increase emissions parameters including wallet address, owner cap ID, pool ID, rewards array with emission parameters and coin types, and stake coin type
Returns Transaction
Complete transaction ready for signing and execution

Deprecated
use buildIncreaseStakingPoolRewardsEmissionsTxV2 instead Builds a complete transaction for increasing the emission rate of rewards for a staking pool
- Defined in packages/farms/api/farmsApi.ts:2511

buildIncreaseStakingPoolRewardsEmissionsTxV2

buildIncreaseStakingPoolRewardsEmissionsTxV2(
inputs: ApiFarmsIncreaseStakingPoolRewardsEmissionsBody,
): Transaction
Builds a complete transaction for increasing the emission rate of rewards for a staking pool
Parameters
- inputs: ApiFarmsIncreaseStakingPoolRewardsEmissionsBody
  Increase emissions parameters including wallet address, owner cap ID, pool ID, rewards array with emission parameters and coin types, and stake coin type
Returns Transaction
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:2535

buildRemoveStakingPoolRewardTxV1

buildRemoveStakingPoolRewardTxV1(
    inputs: {
        ownerCapId: string;
        rewards: { rewardAmount: bigint; rewardCoinType: string }[];
        stakeCoinType: string;
        stakingPoolId: string;
        walletAddress: string;
    },
): Transaction
Builds a transaction for removing undistributed reward coins from a staking pool (V1). Requires the pool OwnerCap. The removal is specific to a rewardCoinType.
Parameters
- inputs: {
      ownerCapId: string;
      rewards: { rewardAmount: bigint; rewardCoinType: string }[];
      stakeCoinType: string;
      stakingPoolId: string;
      walletAddress: string;
  }
Returns Transaction
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:2591

buildRemoveStakingPoolRewardTxV2

buildRemoveStakingPoolRewardTxV2(
    inputs: {
        ownerCapId: string;
        rewards: { rewardAmount: bigint; rewardCoinType: string }[];
        stakeCoinType: string;
        stakingPoolId: string;
        walletAddress: string;
    },
): Transaction
Builds a transaction for removing undistributed reward coins from a staking pool (V2). Requires the pool OwnerCap and includes the on-chain version object.
Parameters
- inputs: {
      ownerCapId: string;
      rewards: { rewardAmount: bigint; rewardCoinType: string }[];
      stakeCoinType: string;
      stakingPoolId: string;
      walletAddress: string;
  }
Returns Transaction
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:2623

buildUnstakeTxV1

buildUnstakeTxV1(inputs: ApiFarmsUnstakeBody): Transaction
Parameters
- inputs: ApiFarmsUnstakeBody
  Unstake parameters including wallet address, position ID, pool ID, reward coin types, and coin type
Returns Transaction
Complete transaction ready for signing and execution

Deprecated
use buildUnstakeTxV2 instead Builds a complete transaction for unstaking (withdrawing and destroying a position)
- Defined in packages/farms/api/farmsApi.ts:2031

buildUnstakeTxV2

buildUnstakeTxV2(inputs: ApiFarmsUnstakeBody): Transaction
Builds a complete transaction for unstaking (withdrawing and destroying a position)
Parameters
- inputs: ApiFarmsUnstakeBody
  Unstake parameters including wallet address, position ID, pool ID, reward coin types, and coin type
Returns Transaction
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:2070

buildWithdrawPrincipalTxV1

buildWithdrawPrincipalTxV1(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        walletAddress: string;
        withdrawAmount: bigint;
    },
): Transaction
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      walletAddress: string;
      withdrawAmount: bigint;
  }
  Withdraw parameters including wallet address, position ID, pool ID, withdraw amount, and coin type
Returns Transaction
Complete transaction ready for signing and execution

Deprecated
use buildWithdrawPrincipalTxV2 instead Builds a complete transaction for withdrawing principal from a staked position
- Defined in packages/farms/api/farmsApi.ts:1978

buildWithdrawPrincipalTxV2

buildWithdrawPrincipalTxV2(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        walletAddress: string;
        withdrawAmount: bigint;
    },
): Transaction
Builds a complete transaction for withdrawing principal from a staked position
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      walletAddress: string;
      withdrawAmount: bigint;
  }
  Withdraw parameters including wallet address, position ID, pool ID, withdraw amount, and coin type
Returns Transaction
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:2004

depositPrincipalTxV1

depositPrincipalTxV1(
    inputs: {
        stakeCoinId: string | TransactionArgument;
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      stakeCoinId: string | TransactionArgument;
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Deposit parameters including transaction, position ID, pool ID, coin ID, and coin type
Returns TransactionResult
Transaction command to deposit principal

Deprecated
use depositPrincipalTxV2 instead Creates a transaction to deposit additional principal to a staked position (original version)
- Defined in packages/farms/api/farmsApi.ts:552

depositPrincipalTxV2

depositPrincipalTxV2(
    inputs: {
        stakeCoinId: string | TransactionArgument;
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to deposit additional principal to a staked position
Parameters
- inputs: {
      stakeCoinId: string | TransactionArgument;
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Deposit parameters including transaction, position ID, pool ID, coin ID, and coin type
Returns TransactionResult
Transaction command to deposit principal
- Defined in packages/farms/api/farmsApi.ts:582

destroyStakedPositionTxV1

destroyStakedPositionTxV1(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Destroy parameters including transaction, position ID, pool ID, and coin type
Returns TransactionResult
Transaction command to destroy the position

Deprecated
use destroyStakedPositionTxV2 instead Creates a transaction to destroy a staked position (original version)
- Defined in packages/farms/api/farmsApi.ts:676

destroyStakedPositionTxV2

destroyStakedPositionTxV2(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to destroy a staked position
Parameters
- inputs: { stakeCoinType: string; stakedPositionId: string; tx: Transaction }
  Destroy parameters including transaction, position ID, and coin type
Returns TransactionResult
Transaction command to destroy the position
- Defined in packages/farms/api/farmsApi.ts:704

endHarvestTxV1

endHarvestTxV1(
    inputs: {
        harvestedRewardsEventMetadataId: string | TransactionArgument;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
  harvestedRewardsEventMetadataId: string | TransactionArgument;
  tx: Transaction;
  }
  End harvest parameters including transaction and harvest metadata
Returns TransactionResult
Transaction command to end the harvest

Deprecated
use endHarvestTxV2 instead Creates a transaction to end the reward harvesting process (original version)
- Defined in packages/farms/api/farmsApi.ts:1097

endHarvestTxV2

endHarvestTxV2(
    inputs: {
        harvestRewardsCap: string | TransactionArgument;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to end the reward harvesting process
Parameters
- inputs: { harvestRewardsCap: string | TransactionArgument; tx: Transaction }
  End harvest parameters including transaction and harvest cap
Returns TransactionResult
Transaction command to end the harvest
- Defined in packages/farms/api/farmsApi.ts:1123

fetchBuildDepositPrincipalTxV1

fetchBuildDepositPrincipalTxV1(
inputs: ApiFarmsDepositPrincipalBody,
): Promise<Transaction>
Parameters
- inputs: ApiFarmsDepositPrincipalBody
  Deposit parameters including wallet address, position ID, pool ID, deposit amount, and coin type
Returns Promise<Transaction>
Complete transaction ready for signing and execution

Deprecated
use fetchBuildDepositPrincipalTxV2 instead Builds a complete transaction for depositing additional principal to a staked position
- Defined in packages/farms/api/farmsApi.ts:1917

fetchBuildDepositPrincipalTxV2

fetchBuildDepositPrincipalTxV2(
inputs: ApiFarmsDepositPrincipalBody,
): Promise<Transaction>
Builds a complete transaction for depositing additional principal to a staked position
Parameters
- inputs: ApiFarmsDepositPrincipalBody
  Deposit parameters including wallet address, position ID, pool ID, deposit amount, and coin type
Returns Promise<Transaction>
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:1947

fetchBuildInitializeStakingPoolRewardTxV1

fetchBuildInitializeStakingPoolRewardTxV1(
inputs: ApiFarmsInitializeStakingPoolRewardBody,
): Promise<Transaction>
Parameters
- inputs: ApiFarmsInitializeStakingPoolRewardBody
  Initialize rewards parameters including wallet address, owner cap ID, pool ID, reward amount, emission parameters, stake coin type, and reward coin type
Returns Promise<Transaction>
Complete transaction ready for signing and execution

Deprecated
use fetchBuildInitializeStakingPoolRewardTxV2 instead Builds a complete transaction for initializing rewards for a staking pool
- Defined in packages/farms/api/farmsApi.ts:2391

fetchBuildInitializeStakingPoolRewardTxV2

fetchBuildInitializeStakingPoolRewardTxV2(
inputs: ApiFarmsInitializeStakingPoolRewardBody,
): Promise<Transaction>
Builds a complete transaction for initializing rewards for a staking pool
Parameters
- inputs: ApiFarmsInitializeStakingPoolRewardBody
  Initialize rewards parameters including wallet address, owner cap ID, pool ID, reward amount, emission parameters, stake coin type, and reward coin type
Returns Promise<Transaction>
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:2417

fetchBuildStakeTxV1

fetchBuildStakeTxV1(inputs: ApiFarmsStakeBodyV1): Promise<Transaction>
Parameters
- inputs: ApiFarmsStakeBodyV1
  Staking parameters including wallet address, lock enforcement, stake amount, pool ID, lock duration, and coin type
Returns Promise<Transaction>
Complete transaction ready for signing and execution

Deprecated
use fetchBuildStakeTxV2 instead Builds a complete transaction for staking coins
- Defined in packages/farms/api/farmsApi.ts:1857

fetchBuildStakeTxV2

fetchBuildStakeTxV2(inputs: ApiFarmsStakeBody): Promise<Transaction>
Builds a complete transaction for staking coins
Parameters
- inputs: ApiFarmsStakeBody
  Staking parameters including wallet address, lock enforcement, stake amount, pool ID, lock duration, and coin type
Returns Promise<Transaction>
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:1886

fetchBuildTopUpStakingPoolRewardsTxV1

fetchBuildTopUpStakingPoolRewardsTxV1(
inputs: ApiFarmsTopUpStakingPoolRewardsBody,
): Promise<Transaction>
Parameters
- inputs: ApiFarmsTopUpStakingPoolRewardsBody
  Top up rewards parameters including wallet address, owner cap ID, pool ID, rewards array with amounts and coin types, and stake coin type
Returns Promise<Transaction>
Complete transaction ready for signing and execution

Deprecated
use fetchBuildTopUpStakingPoolRewardsTxV2 instead Builds a complete transaction for adding more rewards to a staking pool
- Defined in packages/farms/api/farmsApi.ts:2444

fetchBuildTopUpStakingPoolRewardsTxV2

fetchBuildTopUpStakingPoolRewardsTxV2(
inputs: ApiFarmsTopUpStakingPoolRewardsBody,
): Promise<Transaction>
Builds a complete transaction for adding more rewards to a staking pool
Parameters
- inputs: ApiFarmsTopUpStakingPoolRewardsBody
  Top up rewards parameters including wallet address, owner cap ID, pool ID, rewards array with amounts and coin types, and stake coin type
Returns Promise<Transaction>
Complete transaction ready for signing and execution
- Defined in packages/farms/api/farmsApi.ts:2477

fetchOwnedPartialStakedPositions

fetchOwnedPartialStakedPositions(
inputs: { walletAddress: string },
): Promise<PartialFarmsStakedPositionObject[]>
Parameters
- inputs: { walletAddress: string }
  Object containing wallet address
Returns Promise<PartialFarmsStakedPositionObject[]>
Array of PartialFarmsStakedPositionObject

Deprecated
Use getOwnedStakedPositions method in Farms class instead. Fetches partial staked positions owned by a specific wallet address
- Defined in packages/farms/api/farmsApi.ts:452

fetchOwnedStakingPoolOneTimeAdminCaps

fetchOwnedStakingPoolOneTimeAdminCaps(
inputs: ApiFarmsOwnedStakingPoolOwnerCapsBody,
): Promise<StakingPoolOneTimeAdminCapObject[]>
Parameters
- inputs: ApiFarmsOwnedStakingPoolOwnerCapsBody
  Object containing wallet address
Returns Promise<StakingPoolOneTimeAdminCapObject[]>
Array of StakingPoolOneTimeAdminCapObject

Deprecated
Use the new API method in Farms class instead. Fetches the one-time admin caps for staking pools owned by a specific wallet address
- Defined in packages/farms/api/farmsApi.ts:420

fetchOwnedStakingPoolOwnerCaps

fetchOwnedStakingPoolOwnerCaps(
inputs: ApiFarmsOwnedStakingPoolOwnerCapsBody,
): Promise<StakingPoolOwnerCapObject[]>
Parameters
- inputs: ApiFarmsOwnedStakingPoolOwnerCapsBody
  Object containing wallet address
Returns Promise<StakingPoolOwnerCapObject[]>
Array of StakingPoolOwnerCapObject

Deprecated
Use the new API method in Farms class instead. Fetches the owner caps for staking pools owned by a specific wallet address
- Defined in packages/farms/api/farmsApi.ts:392

grantOneTimeAdminCapTxV1

grantOneTimeAdminCapTxV1(
    inputs: {
        ownerCapId: string | TransactionArgument;
        recipientAddress: string;
        rewardCoinType: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      ownerCapId: string | TransactionArgument;
      recipientAddress: string;
      rewardCoinType: string;
      tx: Transaction;
  }
  Grant parameters including transaction, owner cap ID, recipient address, and reward coin type
Returns TransactionResult
Transaction command to grant the one-time admin cap

Deprecated
use grantOneTimeAdminCapTxV2 instead Creates a transaction to grant a one-time admin capability for a staking pool (original version)
- Defined in packages/farms/api/farmsApi.ts:1310

grantOneTimeAdminCapTxV2

grantOneTimeAdminCapTxV2(
    inputs: {
        ownerCapId: string | TransactionArgument;
        recipientAddress: string;
        rewardCoinType: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to grant a one-time admin capability for a staking pool
Parameters
- inputs: {
      ownerCapId: string | TransactionArgument;
      recipientAddress: string;
      rewardCoinType: string;
      tx: Transaction;
  }
  Grant parameters including transaction, owner cap ID, recipient address, and reward coin type
Returns TransactionResult
Transaction command to grant the one-time admin cap
- Defined in packages/farms/api/farmsApi.ts:1337

harvestRewardsTxV1

harvestRewardsTxV1(
    inputs: {
        harvestedRewardsEventMetadataId: string | TransactionArgument;
        rewardCoinType: string;
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      harvestedRewardsEventMetadataId: string | TransactionArgument;
      rewardCoinType: string;
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Harvest parameters including transaction, position ID, pool ID, harvest metadata, stake coin type, and reward coin type
Returns TransactionResult
Transaction object argument for the harvested rewards

Deprecated
use harvestRewardsTxV2 instead Creates a transaction to harvest rewards from a staked position (original version)
- Defined in packages/farms/api/farmsApi.ts:1029

harvestRewardsTxV2

harvestRewardsTxV2(
    inputs: {
        harvestRewardsCap: string | TransactionArgument;
        rewardCoinType: string;
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to harvest rewards from a staked position
Parameters
- inputs: {
      harvestRewardsCap: string | TransactionArgument;
      rewardCoinType: string;
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Harvest parameters including transaction, harvest cap, position ID, pool ID, stake coin type, and reward coin type
Returns TransactionResult
Transaction object argument for the harvested rewards
- Defined in packages/farms/api/farmsApi.ts:1062

increaseStakingPoolRewardEmissionsTxV1

increaseStakingPoolRewardEmissionsTxV1(
    inputs: {
        emissionRate: bigint;
        emissionScheduleMs: number;
        ownerCapId: string;
        rewardCoinType: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      emissionRate: bigint;
      emissionScheduleMs: number;
      ownerCapId: string;
      rewardCoinType: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Increase emissions parameters including transaction, owner cap ID, pool ID, emission parameters, stake coin type, and reward coin type
Returns TransactionResult
Transaction command to update emissions

Deprecated
use increaseStakingPoolRewardEmissionsTxV2 instead Creates a transaction to increase the emission rate for a staking pool reward (original version)
- Defined in packages/farms/api/farmsApi.ts:1532

increaseStakingPoolRewardEmissionsTxV2

increaseStakingPoolRewardEmissionsTxV2(
    inputs: {
        emissionRate: bigint;
        emissionScheduleMs: number;
        ownerCapId: string;
        rewardCoinType: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to increase the emission rate for a staking pool reward
Parameters
- inputs: {
      emissionRate: bigint;
      emissionScheduleMs: number;
      ownerCapId: string;
      rewardCoinType: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Increase emissions parameters including transaction, owner cap ID, pool ID, emission parameters, stake coin type, and reward coin type
Returns TransactionResult
Transaction command to update emissions
- Defined in packages/farms/api/farmsApi.ts:1565

initializeStakingPoolRewardTxV1

initializeStakingPoolRewardTxV1(
    inputs: {
        emissionDelayTimestampMs: number;
        emissionRate: bigint;
        emissionScheduleMs: number;
        rewardCoinId: string | TransactionArgument;
        rewardCoinType: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    } & FarmOwnerOrOneTimeAdminCap,
): TransactionResult
Parameters
- inputs: {
      emissionDelayTimestampMs: number;
      emissionRate: bigint;
      emissionScheduleMs: number;
      rewardCoinId: string | TransactionArgument;
      rewardCoinType: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  } & FarmOwnerOrOneTimeAdminCap
  Initialize reward parameters including transaction, pool ID, reward coin ID, emission parameters, stake coin type, and reward coin type
Returns TransactionResult
Transaction command to initialize the reward

Deprecated
use initializeStakingPoolRewardTxV2 instead Creates a transaction to initialize rewards for a staking pool (original version)
- Defined in packages/farms/api/farmsApi.ts:1370

initializeStakingPoolRewardTxV2

initializeStakingPoolRewardTxV2(
    inputs: {
        emissionDelayTimestampMs: number;
        emissionRate: bigint;
        emissionScheduleMs: number;
        rewardCoinId: string | TransactionArgument;
        rewardCoinType: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    } & FarmOwnerOrOneTimeAdminCap,
): TransactionResult
Creates a transaction to initialize rewards for a staking pool
Parameters
- inputs: {
      emissionDelayTimestampMs: number;
      emissionRate: bigint;
      emissionScheduleMs: number;
      rewardCoinId: string | TransactionArgument;
      rewardCoinType: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  } & FarmOwnerOrOneTimeAdminCap
  Initialize reward parameters including transaction, pool ID, reward coin ID, emission parameters, stake coin type, and reward coin type
Returns TransactionResult
Transaction command to initialize the reward
- Defined in packages/farms/api/farmsApi.ts:1414

isVaultUnlockedTxV1

isVaultUnlockedTxV1(
    inputs: {
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to check if a staking pool is unlocked
Parameters
- inputs: { stakeCoinType: string; stakingPoolId: string; tx: Transaction }
  Check parameters including transaction, pool ID, and coin type
Returns TransactionResult
Transaction object argument for the boolean result
- Defined in packages/farms/api/farmsApi.ts:1800

lockTxV1

lockTxV1(
    inputs: {
        lockDurationMs: number;
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      lockDurationMs: number;
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Lock parameters including transaction, position ID, pool ID, lock duration, and coin type
Returns TransactionResult
Transaction command to lock the position

Deprecated
use lockTxV2 instead Creates a transaction to lock a staked position for a specific duration (original version)
- Defined in packages/farms/api/farmsApi.ts:793

lockTxV2

lockTxV2(
    inputs: {
        lockDurationMs: number;
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to lock a staked position for a specific duration
Parameters
- inputs: {
      lockDurationMs: number;
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Lock parameters including transaction, position ID, pool ID, lock duration, and coin type
Returns TransactionResult
Transaction command to lock the position
- Defined in packages/farms/api/farmsApi.ts:823

newStakingPoolTxV1

newStakingPoolTxV1(
    inputs: {
        lockEnforcement: FarmsLockEnforcement;
        maxLockDurationMs: number;
        maxLockMultiplier: bigint;
        minLockDurationMs: number;
        minStakeAmount: bigint;
        stakeCoinType: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      lockEnforcement: FarmsLockEnforcement;
      maxLockDurationMs: number;
      maxLockMultiplier: bigint;
      minLockDurationMs: number;
      minStakeAmount: bigint;
      stakeCoinType: string;
      tx: Transaction;
  }
  Pool creation parameters including transaction, lock enforcement, durations, multiplier, stake amount, and coin type
Returns TransactionResult
Transaction objects for the vault and owner cap

Deprecated
use newStakingPoolTxV2 instead Creates a transaction for the deprecated version of staking pool creation
- Defined in packages/farms/api/farmsApi.ts:1155

newStakingPoolTxV2

newStakingPoolTxV2(
    inputs: {
        lockEnforcements: FarmsLockEnforcement[];
        maxLockDurationMs: number;
        maxLockMultiplier: bigint;
        minLockDurationMs: number;
        minStakeAmount: bigint;
        stakeCoinType: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction for the current version of staking pool creation
Parameters
- inputs: {
      lockEnforcements: FarmsLockEnforcement[];
      maxLockDurationMs: number;
      maxLockMultiplier: bigint;
      minLockDurationMs: number;
      minStakeAmount: bigint;
      stakeCoinType: string;
      tx: Transaction;
  }
  Pool creation parameters including transaction, lock enforcements array, durations, multiplier, stake amount, and coin type
Returns TransactionResult
Transaction objects for the vault and authority cap
- Defined in packages/farms/api/farmsApi.ts:1188

remainingRewardsTxV1

remainingRewardsTxV1(
    inputs: {
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to get the remaining rewards for a staking pool
Parameters
- inputs: { stakeCoinType: string; stakingPoolId: string; tx: Transaction }
  Remaining rewards parameters including transaction, pool ID, and coin type
Returns TransactionResult
Transaction object argument for the vector of remaining rewards
- Defined in packages/farms/api/farmsApi.ts:1824

removeStakingPoolRewardTxV1

removeStakingPoolRewardTxV1(
    inputs: {
        ownerCapId: string;
        rewardAmount: bigint;
        rewardCoinType: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a Move call (V1) to remove undistributed reward coins from a staking pool. Only callable by the pool owner (validated via ownerCapId). This does not claw back rewards already accrued/claimed by stakers—only reduces the remaining reward balance for the specified rewardCoinType.
Parameters
- inputs: {
      ownerCapId: string;
      rewardAmount: bigint;
      rewardCoinType: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Transaction assembly parameters
  - ownerCapId: string
    
    OwnerCap object ID authorizing the removal
  - rewardAmount: bigint
    
    Amount to remove (base units, encoded as u64)
  - rewardCoinType: string
    
    Reward coin type to be removed
  - stakeCoinType: string
    
    Stake coin type argument for the vault module
  - stakingPoolId: string
    
    The staking pool (vault) object ID
  - tx: Transaction
    
    Transaction instance to append the command to
Returns TransactionResult
The transaction command added to tx
- Defined in packages/farms/api/farmsApi.ts:1726

removeStakingPoolRewardTxV2

removeStakingPoolRewardTxV2(
    inputs: {
        ownerCapId: string;
        rewardAmount: bigint;
        rewardCoinType: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a Move call (V2) to remove undistributed reward coins from a staking pool. Only callable by the pool owner (validated via ownerCapId). Includes the protocol version object as required by V2 modules.
Parameters
- inputs: {
      ownerCapId: string;
      rewardAmount: bigint;
      rewardCoinType: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Transaction assembly parameters
  - ownerCapId: string
    
    OwnerCap object ID authorizing the removal
  - rewardAmount: bigint
    
    Amount to remove (base units, encoded as u64)
  - rewardCoinType: string
    
    Reward coin type to be removed
  - stakeCoinType: string
    
    Stake coin type argument for the vault module
  - stakingPoolId: string
    
    The staking pool (vault) object ID
  - tx: Transaction
    
    Transaction instance to append the command to
Returns TransactionResult
The transaction command added to tx
- Defined in packages/farms/api/farmsApi.ts:1765

renewLockTxV1

renewLockTxV1(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Renew lock parameters including transaction, position ID, pool ID, and coin type
Returns TransactionResult
Transaction command to renew the lock

Deprecated
use renewLockTxV2 instead Creates a transaction to renew the lock on a staked position (original version)
- Defined in packages/farms/api/farmsApi.ts:855

renewLockTxV2

renewLockTxV2(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to renew the lock on a staked position
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Renew lock parameters including transaction, position ID, pool ID, and coin type
Returns TransactionResult
Transaction command to renew the lock
- Defined in packages/farms/api/farmsApi.ts:883

setStakingPoolMaxLockDurationMsTxV2

setStakingPoolMaxLockDurationMsTxV2(
    inputs: {
        lockDurationMs: bigint;
        ownerCapId: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction command to set the maximum lock duration (ms) for a staking pool. Owner-cap only; V2 vault module.
Parameters
- inputs: {
      lockDurationMs: bigint;
      ownerCapId: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  }
Returns TransactionResult
- Defined in packages/farms/api/farmsApi.ts:1687

setStakingPoolMinLockDurationMsTxV2

setStakingPoolMinLockDurationMsTxV2(
    inputs: {
        lockDurationMs: bigint;
        ownerCapId: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction command to set the minimum lock duration (ms) for a staking pool. Owner-cap only; V2 vault module. Mirrors setStakingPoolMinStakeAmountTxV2.
Parameters
- inputs: {
      lockDurationMs: bigint;
      ownerCapId: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  }
Returns TransactionResult
- Defined in packages/farms/api/farmsApi.ts:1659

setStakingPoolMinStakeAmountTxV1

setStakingPoolMinStakeAmountTxV1(
    inputs: {
        minStakeAmount: bigint;
        ownerCapId: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      minStakeAmount: bigint;
      ownerCapId: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Min stake amount parameters including transaction, owner cap ID, pool ID, minimum amount, and stake coin type
Returns TransactionResult
Transaction command to set the minimum stake amount

Deprecated
use setStakingPoolMinStakeAmountTxV2 instead Creates a transaction to set the minimum stake amount for a staking pool (original version)
- Defined in packages/farms/api/farmsApi.ts:1600

setStakingPoolMinStakeAmountTxV2

setStakingPoolMinStakeAmountTxV2(
    inputs: {
        minStakeAmount: bigint;
        ownerCapId: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to set the minimum stake amount for a staking pool
Parameters
- inputs: {
      minStakeAmount: bigint;
      ownerCapId: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Min stake amount parameters including transaction, owner cap ID, pool ID, minimum amount, and stake coin type
Returns TransactionResult
Transaction command to set the minimum stake amount
- Defined in packages/farms/api/farmsApi.ts:1629

shareStakingPoolTxV1

shareStakingPoolTxV1(
    inputs: {
        stakeCoinType: string;
        stakingPoolId: string | TransactionArgument;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      stakeCoinType: string;
      stakingPoolId: string | TransactionArgument;
      tx: Transaction;
  }
  Share pool parameters including transaction, pool ID, and coin type
Returns TransactionResult
Transaction command to share the pool

Deprecated
use shareStakingPoolTxV2 instead Creates a transaction to share a staking pool, making it public
- Defined in packages/farms/api/farmsApi.ts:1228

shareStakingPoolTxV2

shareStakingPoolTxV2(
    inputs: {
        stakeCoinType: string;
        stakingPoolId: string | TransactionArgument;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to share a staking pool, making it public
Parameters
- inputs: {
      stakeCoinType: string;
      stakingPoolId: string | TransactionArgument;
      tx: Transaction;
  }
  Share pool parameters including transaction, pool ID, and coin type
Returns TransactionResult
Transaction command to share the pool
- Defined in packages/farms/api/farmsApi.ts:1255

stakeTxV1

stakeTxV1(
    inputs: {
        lockDurationMs: number;
        stakeCoinId: string | TransactionArgument;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      lockDurationMs: number;
      stakeCoinId: string | TransactionArgument;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Staking parameters including transaction, pool ID, coin ID, lock duration, and coin type
Returns TransactionResult
Transaction object argument for StakedPosition

Deprecated
use stakeTxV2 instead Creates a transaction to stake coins in a staking pool (original version)
- Defined in packages/farms/api/farmsApi.ts:488

stakeTxV2

stakeTxV2(
    inputs: {
        lockDurationMs: number;
        lockEnforcement: FarmsLockEnforcement;
        stakeCoinId: string | TransactionArgument;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to stake coins in a staking pool
Parameters
- inputs: {
      lockDurationMs: number;
      lockEnforcement: FarmsLockEnforcement;
      stakeCoinId: string | TransactionArgument;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Staking parameters including transaction, pool ID, coin ID, lock duration, lock enforcement, and coin type
Returns TransactionResult
Transaction object argument for StakedPosition
- Defined in packages/farms/api/farmsApi.ts:518

topUpStakingPoolRewardTxV1

topUpStakingPoolRewardTxV1(
    inputs: {
        rewardCoinId: string | TransactionArgument;
        rewardCoinType: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    } & FarmOwnerOrOneTimeAdminCap,
): TransactionResult
Parameters
- inputs: {
      rewardCoinId: string | TransactionArgument;
      rewardCoinType: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  } & FarmOwnerOrOneTimeAdminCap
  Top up parameters including transaction, pool ID, reward coin ID, stake coin type, and reward coin type
Returns TransactionResult
Transaction command to add rewards

Deprecated
use topUpStakingPoolRewardTxV2 instead Creates a transaction to add more rewards to a staking pool (original version)
- Defined in packages/farms/api/farmsApi.ts:1460

topUpStakingPoolRewardTxV2

topUpStakingPoolRewardTxV2(
    inputs: {
        rewardCoinId: string | TransactionArgument;
        rewardCoinType: string;
        stakeCoinType: string;
        stakingPoolId: string;
        tx: Transaction;
    } & FarmOwnerOrOneTimeAdminCap,
): TransactionResult
Creates a transaction to add more rewards to a staking pool
Parameters
- inputs: {
      rewardCoinId: string | TransactionArgument;
      rewardCoinType: string;
      stakeCoinType: string;
      stakingPoolId: string;
      tx: Transaction;
  } & FarmOwnerOrOneTimeAdminCap
  Top up parameters including transaction, pool ID, reward coin ID, stake coin type, and reward coin type
Returns TransactionResult
Transaction command to add rewards
- Defined in packages/farms/api/farmsApi.ts:1495

transferOwnerCapTxV1

transferOwnerCapTxV1(
    inputs: {
        ownerCapId: string | TransactionArgument;
        recipientAddress: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      ownerCapId: string | TransactionArgument;
      recipientAddress: string;
      tx: Transaction;
  }
  Transfer parameters including transaction, owner cap ID, and recipient address
Returns TransactionResult
Transaction command to transfer the owner cap

Deprecated
use transferOwnerCapTxV2 instead Creates a transaction to transfer ownership of a staking pool
- Defined in packages/farms/api/farmsApi.ts:1283

unlockTxV1

unlockTxV1(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Unlock parameters including transaction, position ID, pool ID, and coin type
Returns TransactionResult
Transaction command to unlock the position

Deprecated
use unlockTxV2 instead Creates a transaction to unlock a staked position (original version)
- Defined in packages/farms/api/farmsApi.ts:913

unlockTxV2

unlockTxV2(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to unlock a staked position
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Unlock parameters including transaction, position ID, pool ID, and coin type
Returns TransactionResult
Transaction command to unlock the position
- Defined in packages/farms/api/farmsApi.ts:941

updatePositionTxV1

updatePositionTxV1(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Update parameters including transaction, position ID, pool ID, and coin type
Returns TransactionResult
Transaction command to update the position

Deprecated
use updatePositionTxV2 instead Creates a transaction to update a staked position, recalculating rewards (original version)
- Defined in packages/farms/api/farmsApi.ts:731

updatePositionTxV2

updatePositionTxV2(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
    },
): TransactionResult
Creates a transaction to update a staked position, recalculating rewards
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
  }
  Update parameters including transaction, position ID, pool ID, and coin type
Returns TransactionResult
Transaction command to update the position
- Defined in packages/farms/api/farmsApi.ts:759

withdrawPrincipalTxV1

withdrawPrincipalTxV1(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
        withdrawAmount: bigint;
    },
): TransactionResult
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
      withdrawAmount: bigint;
  }
  Withdrawal parameters including transaction, position ID, pool ID, amount, and coin type
Returns TransactionResult
Transaction object argument for the withdrawn Coin

Deprecated
use withdrawPrincipalTxV2 instead Creates a transaction to withdraw principal from a staked position (original version)
- Defined in packages/farms/api/farmsApi.ts:614

withdrawPrincipalTxV2

withdrawPrincipalTxV2(
    inputs: {
        stakeCoinType: string;
        stakedPositionId: string;
        stakingPoolId: string;
        tx: Transaction;
        withdrawAmount: bigint;
    },
): TransactionResult
Creates a transaction to withdraw principal from a staked position
Parameters
- inputs: {
      stakeCoinType: string;
      stakedPositionId: string;
      stakingPoolId: string;
      tx: Transaction;
      withdrawAmount: bigint;
  }
  Withdrawal parameters including transaction, position ID, pool ID, amount, and coin type
Returns TransactionResult
Transaction object argument for the withdrawn Coin
- Defined in packages/farms/api/farmsApi.ts:644

Class FarmsApi

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FarmsApi

Throws

Properties

Readonlyaddresses

buildGrantOneTimeAdminCapTxV1

Type Declaration

Parameters

Returns Transaction

Deprecated

buildGrantOneTimeAdminCapTxV2

Type Declaration

Parameters

Returns Transaction

buildLockTxV1

Type Declaration

Parameters

Returns Transaction

Deprecated

buildLockTxV2

Type Declaration

Parameters

Returns Transaction

buildRenewLockTxV1

Type Declaration

Parameters

Returns Transaction

Deprecated

buildRenewLockTxV2

Type Declaration

Parameters

Returns Transaction

buildSetStakingPoolMaxLockDurationMsTxV2

buildSetStakingPoolMinLockDurationMsTxV2

buildSetStakingPoolMinStakeAmountTxV1

Type Declaration

Parameters

Returns Transaction

Deprecated

buildSetStakingPoolMinStakeAmountTxV2

Type Declaration

Parameters

Returns Transaction

buildUnlockTxV1

Type Declaration

Parameters

Returns Transaction

Deprecated

buildUnlockTxV2

Type Declaration

Parameters

Returns Transaction

buildUpdatePositionTx2

Type Declaration

Parameters

Returns Transaction

buildUpdatePositionTxV1

Type Declaration

Parameters

Returns Transaction

Deprecated

ReadonlyeventTypes

Type Declaration

addedRewardV1: string

addedRewardV2: string

createdVaultV1: string

createdVaultV2: string

depositedPrincipalV1: string

depositedPrincipalV2: string

harvestedRewardsV1: string

harvestedRewardsV2: string

increasedEmissionsV1: string

`Readonly`addresses

`Readonly`eventTypes

`Readonly`moveErrors

`Readonly`objectTypes