Struct quarry_mine::Miner

pub struct Miner {
    pub quarry: Pubkey,
    pub authority: Pubkey,
    pub bump: u8,
    pub token_vault_key: Pubkey,
    pub rewards_earned: u64,
    pub rewards_per_token_paid: u128,
    pub balance: u64,
    pub index: u64,
}

An account that has staked tokens into a Quarry.

Fields

quarry: Pubkey

Key of the Quarry this Miner works on.

authority: Pubkey

Authority who manages this Miner. All withdrawals of tokens must accrue to TokenAccounts owned by this account.

bump: u8

Bump.

token_vault_key: Pubkey

TokenAccount to hold the Miner’s staked LP tokens.

rewards_earned: u64

Stores the amount of tokens that the Miner may claim. Whenever the Miner claims tokens, this is reset to 0.

rewards_per_token_paid: u128

A checkpoint of the Quarry’s reward tokens paid per staked token.

When the Miner is initialized, this number starts at 0. On the first quarry_mine::stake_tokens, the Quarry#update_rewards_and_miner method is called, which updates this checkpoint to the current quarry value.

On a quarry_mine::claim_rewards, the difference in checkpoints is used to calculate the amount of tokens owed.

balance: u64

Number of tokens the Miner holds.

index: u64

Index of the Miner.

Implementations

impl Miner

pub const LEN: usize = 137usize

Trait Implementations

impl AccountDeserialize for Miner

fn try_deserialize(buf: &mut &[u8]) -> Result<Self>

Deserializes previously initialized account data. Should fail for all uninitialized accounts, where the bytes are zeroed. Implementations should be unique to a particular account type so that one can never successfully deserialize the data of one account type into another. For example, if the SPL token program were to implement this trait, it should be impossible to deserialize a Mint account into a token Account.

fn try_deserialize_unchecked(buf: &mut &[u8]) -> Result<Self>

Deserializes account data without checking the account discriminator. This should only be used on account initialization, when the bytes of the account are zeroed.

impl AccountSerialize for Miner

fn try_serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Serializes the account data into writer.

impl BorshDeserialize for Miner where
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize,
    u8: BorshDeserialize,
    Pubkey: BorshDeserialize,
    u64: BorshDeserialize,
    u128: BorshDeserialize,
    u64: BorshDeserialize,
    u64: BorshDeserialize, 

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

impl BorshSerialize for Miner where
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize,
    u8: BorshSerialize,
    Pubkey: BorshSerialize,
    u64: BorshSerialize,
    u128: BorshSerialize,
    u64: BorshSerialize,
    u64: BorshSerialize, 

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize this instance into a vector of bytes.

impl Clone for Miner

fn clone(&self) -> Miner

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Miner

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Miner

fn default() -> Miner

Returns the “default value” for a type.

impl Discriminator for Miner

fn discriminator() -> [u8; 8]

impl Owner for Miner

fn owner() -> Pubkey

impl Copy for Miner