Coda by Ian Macalinao
    Preparing search index...

    Interface StakePoolArgs

    interface StakePoolArgs {
        epochFee: FeeArgs;
        lastEpochPoolTokenSupply: number | bigint;
        lastEpochTotalLamports: number | bigint;
        lastUpdateEpoch: number | bigint;
        lockup: LockupArgs;
        manager: Address;
        managerFeeAccount: Address;
        nextEpochFee: FutureEpochArgs;
        nextSolWithdrawalFee: FutureEpochArgs;
        nextStakeWithdrawalFee: FutureEpochArgs;
        poolMint: Address;
        poolTokenSupply: number | bigint;
        preferredDepositValidatorVoteAddress: OptionOrNullable<Address>;
        preferredWithdrawValidatorVoteAddress: OptionOrNullable<Address>;
        reserveStake: Address;
        solDepositAuthority: OptionOrNullable<Address>;
        solDepositFee: FeeArgs;
        solReferralFee: number;
        solWithdrawalFee: FeeArgs;
        solWithdrawAuthority: OptionOrNullable<Address>;
        stakeDepositAuthority: Address;
        stakeDepositFee: FeeArgs;
        staker: Address;
        stakeReferralFee: number;
        stakeWithdrawalFee: FeeArgs;
        stakeWithdrawBumpSeed: number;
        tokenProgramId: Address;
        totalLamports: number | bigint;
        validatorList: Address;
    }
    Index

    Properties

    epochFee lastEpochPoolTokenSupply lastEpochTotalLamports lastUpdateEpoch lockup manager managerFeeAccount nextEpochFee nextSolWithdrawalFee nextStakeWithdrawalFee poolMint poolTokenSupply preferredDepositValidatorVoteAddress preferredWithdrawValidatorVoteAddress reserveStake solDepositAuthority solDepositFee solReferralFee solWithdrawalFee solWithdrawAuthority stakeDepositAuthority stakeDepositFee staker stakeReferralFee stakeWithdrawalFee stakeWithdrawBumpSeed tokenProgramId totalLamports validatorList

    Properties

    epochFee: FeeArgs

    Fee taken as a proportion of rewards each epoch

    lastEpochPoolTokenSupply: number | bigint

    Last epoch's total pool tokens, used only for APR estimation

    lastEpochTotalLamports: number | bigint

    Last epoch's total lamports, used only for APR estimation

    lastUpdateEpoch: number | bigint

    Last epoch the total_lamports field was updated

    lockup: LockupArgs

    Lockup that all stakes in the pool must have

    manager: Address

    Manager authority, allows for updating the staker, manager, and fee account

    managerFeeAccount: Address

    Manager fee account

    nextEpochFee: FutureEpochArgs

    Fee for next epoch

    nextSolWithdrawalFee: FutureEpochArgs

    Future SOL withdrawal fee, to be set for the following epoch

    nextStakeWithdrawalFee: FutureEpochArgs

    Future stake withdrawal fee, to be set for the following epoch

    poolMint: Address

    Pool Mint

    poolTokenSupply: number | bigint

    Total supply of pool tokens (should always match the supply in the Pool Mint)

    preferredDepositValidatorVoteAddress: OptionOrNullable<Address>

    Preferred deposit validator vote account pubkey

    preferredWithdrawValidatorVoteAddress: OptionOrNullable<Address>

    Preferred withdraw validator vote account pubkey

    reserveStake: Address

    Reserve stake account, holds deactivated stake

    solDepositAuthority: OptionOrNullable<Address>

    Toggles whether the DepositSol instruction requires a signature from this sol_deposit_authority

    solDepositFee: FeeArgs

    Fee assessed on SOL deposits

    solReferralFee: number

    Fees paid out to referrers on referred SOL deposits. Expressed as a percentage (0 - 100) of SOL deposit fees. i.e. sol_deposit_fee% of SOL deposited is collected as deposit fees for every deposit and sol_referral_fee% of the collected SOL deposit fees is paid out to the referrer

    solWithdrawalFee: FeeArgs

    Fee assessed on SOL withdrawals

    solWithdrawAuthority: OptionOrNullable<Address>

    Toggles whether the WithdrawSol instruction requires a signature from the deposit_authority

    stakeDepositAuthority: Address

    Stake deposit authority If a depositor pubkey is specified on initialization, then deposits must be signed by this authority. If no deposit authority is specified, then the stake pool will default to the result of: Pubkey::find_program_address( &[&stake_pool_address.as_ref(), b"deposit"], program_id, )

    stakeDepositFee: FeeArgs

    Fee assessed on stake deposits

    staker: Address

    Staker authority, allows for adding and removing validators, and managing stake distribution

    stakeReferralFee: number

    Fees paid out to referrers on referred stake deposits. Expressed as a percentage (0 - 100) of deposit fees. i.e. stake_deposit_fee% of stake deposited is collected as deposit fees for every deposit and stake_referral_fee% of the collected stake deposit fees is paid out to the referrer

    stakeWithdrawalFee: FeeArgs

    Fee assessed on withdrawals

    stakeWithdrawBumpSeed: number

    Stake withdrawal authority bump seed for create_program_address(&[state::StakePool account, "withdrawal"])

    tokenProgramId: Address

    Pool token program id

    totalLamports: number | bigint

    Total stake under management. Note that if last_update_epoch does not match the current epoch then this field may not be accurate

    validatorList: Address

    Validator stake list storage account

    Settings

    Member Visibility

    On This Page

    Properties