Coda by Ian Macalinao
    Preparing search index...

    Interface FarmState

    interface FarmState {
        delegateAuthority: Address;
        delegatedRpsAdmin: Address;
        depositCapAmount: bigint;
        depositWarmupPeriod: number;
        discriminator: ReadonlyUint8Array;
        farmAdmin: Address;
        farmVault: Address;
        farmVaultsAuthority: Address;
        farmVaultsAuthorityBump: bigint;
        globalConfig: Address;
        isFarmDelegated: number;
        isFarmFrozen: number;
        lockingDuration: bigint;
        lockingEarlyWithdrawalPenaltyBps: bigint;
        lockingMode: bigint;
        lockingStartTimestamp: bigint;
        numRewardTokens: bigint;
        numUsers: bigint;
        padding: bigint[];
        padding0: number[];
        pendingFarmAdmin: Address;
        rewardInfos: RewardInfo[];
        scopeOracleMaxAge: bigint;
        scopeOraclePriceId: bigint;
        scopePrices: Address;
        slashedAmountCumulative: bigint;
        slashedAmountCurrent: bigint;
        slashedAmountSpillAddress: Address;
        strategyId: Address;
        timeUnit: number;
        token: FarmsTokenInfo;
        totalActiveStakeScaled: bigint;
        totalPendingAmount: bigint;
        totalPendingStakeScaled: bigint;
        totalStakedAmount: bigint;
        vaultId: Address;
        withdrawalCooldownPeriod: number;
        withdrawAuthority: Address;
    }
    Index

    Properties

    delegateAuthority delegatedRpsAdmin depositCapAmount depositWarmupPeriod discriminator farmAdmin farmVault farmVaultsAuthority farmVaultsAuthorityBump globalConfig isFarmDelegated isFarmFrozen lockingDuration lockingEarlyWithdrawalPenaltyBps lockingMode lockingStartTimestamp numRewardTokens numUsers padding padding0 pendingFarmAdmin rewardInfos scopeOracleMaxAge scopeOraclePriceId scopePrices slashedAmountCumulative slashedAmountCurrent slashedAmountSpillAddress strategyId timeUnit token totalActiveStakeScaled totalPendingAmount totalPendingStakeScaled totalStakedAmount vaultId withdrawalCooldownPeriod withdrawAuthority

    Properties

    delegateAuthority: Address

    Only used for delegate farms Set to default() otherwise

    delegatedRpsAdmin: Address
    depositCapAmount: bigint
    depositWarmupPeriod: number

    Delay between a user deposit and the moment it is considered as staked 0 if unused

    discriminator: ReadonlyUint8Array
    farmAdmin: Address
    farmVault: Address
    farmVaultsAuthority: Address
    farmVaultsAuthorityBump: bigint
    globalConfig: Address
    isFarmDelegated: number

    Indicates if the farm is a delegate farm If true, the farm is a delegate farm and the delegate_authority is set*

    isFarmFrozen: number

    Automatically set to true in case of a full authority withdrawal If true, the farm is frozen and no more deposits are allowed

    lockingDuration: bigint
    lockingEarlyWithdrawalPenaltyBps: bigint
    lockingMode: bigint

    Locking stake

    lockingStartTimestamp: bigint
    numRewardTokens: bigint
    numUsers: bigint

    Data used to calculate the rewards of the user

    padding: bigint[]
    padding0: number[]
    pendingFarmAdmin: Address
    rewardInfos: RewardInfo[]
    scopeOracleMaxAge: bigint
    scopeOraclePriceId: bigint
    scopePrices: Address
    slashedAmountCumulative: bigint
    slashedAmountCurrent: bigint

    Slashed amounts from early withdrawal

    slashedAmountSpillAddress: Address
    strategyId: Address
    timeUnit: number

    Raw representation of a TimeUnit Seconds = 0, Slots = 1

    token: FarmsTokenInfo
    totalActiveStakeScaled: bigint

    Total active stake of tokens in the farm (scaled from Decimal representation).

    totalPendingAmount: bigint

    Total pending amount of tokens in the farm

    totalPendingStakeScaled: bigint

    Total pending stake of tokens in the farm (scaled from Decimal representation). (can be used by withdraw_authority but don't get rewards or fees)

    totalStakedAmount: bigint

    The number of token in the farm_vault staked (getting rewards and fees) Set such as farm_vault.amount = total_staked_amount + total_pending_amount

    vaultId: Address
    withdrawalCooldownPeriod: number

    Delay between a user unstake and the ability to withdraw his deposit.

    withdrawAuthority: Address

    Withdraw authority for the farm, allowed to lock deposited funds and withdraw them Set to default() if unused (only the depositors can withdraw their funds)

    Settings

    Member Visibility

    On This Page

    Properties