aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface FarmsStakingPoolObject

    The normalized SDK view of a staking pool, also called a vault on chain.

    The pool defines the stake coin, minimum and maximum lock durations, the fixed-point multiplier range, and the reward schedules used for positions.

    interface FarmsStakingPoolObject {
        emissionEndTimestamp: number;
        isUnlocked: boolean;
        lockEnforcement: FarmsLockEnforcement;
        maxLockDurationMs: number;
        maxLockMultiplier: bigint;
        minLockDurationMs: number;
        minStakeAmount: bigint;
        objectId: string;
        objectType: string;
        rewardCoins: FarmsStakingPoolRewardCoin[];
        stakeCoinType: string;
        stakedAmount: bigint;
        stakedAmountWithMultiplier: bigint;
        version: FarmsVersion;
    }

    Hierarchy (View Summary)

    • Object
      • FarmsStakingPoolObject
    Index
    emissionEndTimestamp: number

    The timestamp in milliseconds after which the pool stops emitting rewards.

    isUnlocked: boolean

    Whether the pool is forcibly open for position actions, even before lock expiry.

    lockEnforcement: FarmsLockEnforcement

    The policy that controls principal withdrawal before a position's lock expires.

    maxLockDurationMs: number

    The longest lock duration used when calculating a position's multiplier, in milliseconds.

    maxLockMultiplier: bigint

    The largest lock multiplier, using 18-decimal fixed-point scaling.

    minLockDurationMs: number

    The shortest accepted lock duration, in milliseconds.

    minStakeAmount: bigint

    The minimum principal required for a position, in stake-coin base units.

    objectId: string

    The on-chain object ID.

    objectType: string

    The Move type of the object.

    Reward coin schedules and balances configured for this pool.

    stakeCoinType: string

    The fully qualified Move type of the coin that users stake.

    stakedAmount: bigint

    The total staked principal, in the stake coin's base units.

    stakedAmountWithMultiplier: bigint

    The total reward-weighted stake, in base units scaled by each position's multiplier.

    version: FarmsVersion

    The farm contract version represented by this object.