159 lines
5.0 KiB
Rust
159 lines
5.0 KiB
Rust
use {
|
|
borsh::BorshDeserialize,
|
|
solana_sdk::{pubkey::Pubkey, stake::state::Lockup},
|
|
};
|
|
|
|
#[derive(Clone, Debug, PartialEq, BorshDeserialize)]
|
|
pub enum AccountType {
|
|
/// If the account has not been initialized, the enum will be 0
|
|
Uninitialized,
|
|
/// Stake pool
|
|
StakePool,
|
|
/// Validator stake list
|
|
ValidatorList,
|
|
}
|
|
|
|
#[repr(C)]
|
|
#[derive(Clone, Debug, PartialEq, BorshDeserialize)]
|
|
pub struct StakePool {
|
|
/// Account type, must be StakePool currently
|
|
pub account_type: AccountType,
|
|
|
|
/// Manager authority, allows for updating the staker, manager, and fee
|
|
/// account
|
|
pub manager: Pubkey,
|
|
|
|
/// Staker authority, allows for adding and removing validators, and
|
|
/// managing stake distribution
|
|
pub staker: Pubkey,
|
|
|
|
/// 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,
|
|
/// )`
|
|
pub stake_deposit_authority: Pubkey,
|
|
|
|
/// Stake withdrawal authority bump seed
|
|
/// for `create_program_address(&[state::StakePool account, "withdrawal"])`
|
|
pub stake_withdraw_bump_seed: u8,
|
|
|
|
/// Validator stake list storage account
|
|
pub validator_list: Pubkey,
|
|
|
|
/// Reserve stake account, holds deactivated stake
|
|
pub reserve_stake: Pubkey,
|
|
|
|
/// Pool Mint
|
|
pub pool_mint: Pubkey,
|
|
|
|
/// Manager fee account
|
|
pub manager_fee_account: Pubkey,
|
|
|
|
/// Pool token program id
|
|
pub token_program_id: Pubkey,
|
|
|
|
/// Total stake under management.
|
|
/// Note that if `last_update_epoch` does not match the current epoch then
|
|
/// this field may not be accurate
|
|
pub total_lamports: u64,
|
|
|
|
/// Total supply of pool tokens (should always match the supply in the Pool
|
|
/// Mint)
|
|
pub pool_token_supply: u64,
|
|
|
|
/// Last epoch the `total_lamports` field was updated
|
|
pub last_update_epoch: u64,
|
|
|
|
/// Lockup that all stakes in the pool must have
|
|
pub lockup: Lockup,
|
|
|
|
/// Fee taken as a proportion of rewards each epoch
|
|
pub epoch_fee: Fee,
|
|
|
|
/// Fee for next epoch
|
|
pub next_epoch_fee: FutureEpoch<Fee>,
|
|
|
|
/// Preferred deposit validator vote account pubkey
|
|
pub preferred_deposit_validator_vote_address: Option<Pubkey>,
|
|
|
|
/// Preferred withdraw validator vote account pubkey
|
|
pub preferred_withdraw_validator_vote_address: Option<Pubkey>,
|
|
|
|
/// Fee assessed on stake deposits
|
|
pub stake_deposit_fee: Fee,
|
|
|
|
/// Fee assessed on withdrawals
|
|
pub stake_withdrawal_fee: Fee,
|
|
|
|
/// Future stake withdrawal fee, to be set for the following epoch
|
|
pub next_stake_withdrawal_fee: FutureEpoch<Fee>,
|
|
|
|
/// 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
|
|
pub stake_referral_fee: u8,
|
|
|
|
/// Toggles whether the `DepositSol` instruction requires a signature from
|
|
/// this `sol_deposit_authority`
|
|
pub sol_deposit_authority: Option<Pubkey>,
|
|
|
|
/// Fee assessed on SOL deposits
|
|
pub sol_deposit_fee: Fee,
|
|
|
|
/// 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
|
|
pub sol_referral_fee: u8,
|
|
|
|
/// Toggles whether the `WithdrawSol` instruction requires a signature from
|
|
/// the `deposit_authority`
|
|
pub sol_withdraw_authority: Option<Pubkey>,
|
|
|
|
/// Fee assessed on SOL withdrawals
|
|
pub sol_withdrawal_fee: Fee,
|
|
|
|
/// Future SOL withdrawal fee, to be set for the following epoch
|
|
pub next_sol_withdrawal_fee: FutureEpoch<Fee>,
|
|
|
|
/// Last epoch's total pool tokens, used only for APR estimation
|
|
pub last_epoch_pool_token_supply: u64,
|
|
|
|
/// Last epoch's total lamports, used only for APR estimation
|
|
pub last_epoch_total_lamports: u64,
|
|
}
|
|
|
|
/// Fee rate as a ratio, minted on `UpdateStakePoolBalance` as a proportion of
|
|
/// the rewards
|
|
/// If either the numerator or the denominator is 0, the fee is considered to be
|
|
/// 0
|
|
#[repr(C)]
|
|
#[derive(Clone, Copy, Debug, PartialEq, BorshDeserialize)]
|
|
pub struct Fee {
|
|
/// denominator of the fee ratio
|
|
pub denominator: u64,
|
|
/// numerator of the fee ratio
|
|
pub numerator: u64,
|
|
}
|
|
|
|
/// Wrapper type that "counts down" epochs, which is Borsh-compatible with the
|
|
/// native `Option`
|
|
#[repr(C)]
|
|
#[derive(Clone, Copy, Debug, PartialEq, BorshDeserialize)]
|
|
pub enum FutureEpoch<T> {
|
|
/// Nothing is set
|
|
None,
|
|
/// Value is ready after the next epoch boundary
|
|
One(T),
|
|
/// Value is ready after two epoch boundaries
|
|
Two(T),
|
|
}
|