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

    Interface FarmsStakedPositionObject

    The normalized SDK view of a user's staked position.

    A position keeps its principal, the reward-weighted amount derived from its lock multiplier, its lock window, and per-reward-coin accounting fields.

    interface FarmsStakedPositionObject {
        lastHarvestRewardsTimestamp: number;
        lockDurationMs: number;
        lockMultiplier: bigint;
        lockStartTimestamp: number;
        objectId: string;
        objectType: string;
        rewardCoins: FarmsStakedPositionRewardCoin[];
        stakeCoinType: string;
        stakedAmount: bigint;
        stakedAmountWithMultiplier: bigint;
        stakingPoolObjectId: string;
        version: FarmsVersion;
    }

    Hierarchy (View Summary)

    • Object
      • FarmsStakedPositionObject
    Index
    lastHarvestRewardsTimestamp: number

    The last reward-accounting or harvest timestamp, in milliseconds.

    lockDurationMs: number

    The lock duration, in milliseconds.

    lockMultiplier: bigint

    The position's lock multiplier using 18-decimal fixed-point scaling.

    lockStartTimestamp: number

    The lock start timestamp, in milliseconds.

    objectId: string

    The on-chain object ID.

    objectType: string

    The Move type of the object.

    Reward accounting records for the pool's reward coin types.

    stakeCoinType: string

    The fully qualified Move type of the staked coin.

    stakedAmount: bigint

    The position's principal, in stake-coin base units.

    stakedAmountWithMultiplier: bigint

    The position's reward-weighted stake, in fixed-point-scaled base units.

    stakingPoolObjectId: string

    The object ID of the staking pool that owns this position.

    version: FarmsVersion

    The farm contract version represented by this position.