StakePool class

Stake Pool

Inheritance

Constructors

StakePool.new({required AccountType accountType, required String manager, required String staker, required String stakeDepositAuthority, required u8 stakeWithdrawBumpSeed, required String validatorList, required String reserveStake, required String poolMint, required String managerFeeAccount, required String tokenProgramId, required u64 totalLamports, required u64 poolTokenSupply, required u64 lastUpdateEpoch, required Lockup lockup, required Fee epochFee, required Fee? nextEpochFee, required String? preferredDepositValidatorVoteAddress, required String? preferredWithdrawValidatorVoteAddress, required Fee stakeDepositFee, required Fee stakeWithdrawalFee, required Fee? nextStakeWithdrawalFee, required u8 stakeReferralFee, required String? solDepositAuthority, required Fee solDepositFee, required u8 solReferralFee, required String? solWithdrawAuthority, required Fee solWithdrawalFee, required Fee? nextSolWithdrawalFee, required u64 lastEpochPoolTokenSupply, required u64 lastEpochTotalLamports})
const
StakePool.fromAccountInfo(AccountInfo info)
factory
StakePool.fromJson(Map<String, dynamic> json)
factory

Properties

accountType AccountType
Account type, must be StakePool currently
final
borshSchema BorshSchema
Maps this class' properties to codecs.
no setteroverride
epochFee Fee
Fee taken as a proportion of rewards each epoch
final
hashCode int
The hash code for this object.
no setterinherited
lastEpochPoolTokenSupply u64
Last epoch's total pool tokens, used only for APR estimation
final
lastEpochTotalLamports u64
Last epoch's total lamports, used only for APR estimation
final
lastUpdateEpoch u64
Last epoch the totalLamports field was updated
final
lockup Lockup
Lockup that all stakes in the pool must have
final
manager String
Manager authority, allows for updating the staker, manager, and fee account
final
managerFeeAccount String
Manager fee account
final
nextEpochFee Fee?
Fee for next epoch
final
nextSolWithdrawalFee Fee?
Future SOL withdrawal fee, to be set for the following epoch
final
nextStakeWithdrawalFee Fee?
Future stake withdrawal fee, to be set for the following epoch
final
poolMint String
Pool Mint
final
poolTokenSupply u64
Total supply of pool tokens (should always match the supply in the Pool Mint)
final
preferredDepositValidatorVoteAddress String?
Preferred deposit validator vote account pubkey
final
preferredWithdrawValidatorVoteAddress String?
Preferred withdraw validator vote account pubkey
final
reserveStake String
Reserve stake account, holds deactivated stake
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
solDepositAuthority String?
Toggles whether the DepositSol instruction requires a signature from this solDepositAuthority
final
solDepositFee Fee
Fee assessed on SOL deposits
final
solReferralFee u8
Fees paid out to referrers on referred SOL deposits. Expressed as a percentage (0 - 100) of SOL deposit fees. i.e. solDepositFee% of SOL deposited is collected as deposit fees for every deposit and solReferralFee% of the collected SOL deposit fees is paid out to the referrer
final
solWithdrawalFee Fee
Fee assessed on SOL withdrawals
final
solWithdrawAuthority String?
Toggles whether the WithdrawSol instruction requires a signature from the deposit_authority
final
stakeDepositAuthority String
Stake deposit authority
final
stakeDepositFee Fee
Fee assessed on stake deposits
final
staker String
Staker authority, allows for adding and removing validators, and managing stake distribution
final
stakeReferralFee u8
Fees paid out to referrers on referred stake deposits. Expressed as a percentage (0 - 100) of deposit fees. i.e. stakeDepositFee% of stake deposited is collected as deposit fees for every deposit and stakeReferralFee% of the collected stake deposit fees is paid out to the referrer
final
stakeWithdrawalFee Fee
Fee assessed on withdrawals
final
stakeWithdrawBumpSeed u8
Stake withdrawal authority bump seed for create_program_address(&[state::StakePool account, "withdrawal"])
final
tokenProgramId String
Pool token program id
final
totalLamports u64
Total stake under management. Note that if lastUpdateEpoch does not match the current epoch then this field may not be accurate
final
validatorList String
Validator stake list storage account
final

Methods

borshSize() int
Returns the serialized byte length of this instance.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toBorsh() Iterable<int>
Serializes this instance into a buffer.
inherited
toJson() Map<String, dynamic>
Serialises this class into a JSON object.
override
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

codec BorshStructCodec
no setter