Struct quarry_mine::Quarry

pub struct Quarry {
    pub rewarder: Pubkey,
    pub token_mint_key: Pubkey,
    pub bump: u8,
    pub index: u16,
    pub token_mint_decimals: u8,
    pub famine_ts: i64,
    pub last_update_ts: i64,
    pub rewards_per_token_stored: u128,
    pub annual_rewards_rate: u64,
    pub rewards_share: u64,
    pub total_tokens_deposited: u64,
    pub num_miners: u64,
}

A pool which distributes tokens to its Miners.

Fields

rewarder: Pubkey

Rewarder which manages this quarry

token_mint_key: Pubkey

LP token this quarry is designated to

bump: u8

Bump.

index: u16

Index of the Quarry.

token_mint_decimals: u8

Decimals on the token Mint.

famine_ts: i64

Timestamp when quarry rewards cease

last_update_ts: i64

Timestamp of last checkpoint

rewards_per_token_stored: u128

Rewards per token stored in the quarry

annual_rewards_rate: u64

Amount of rewards distributed to the quarry per year.

rewards_share: u64

Rewards shared allocated to this quarry

total_tokens_deposited: u64

Total number of tokens deposited into the quarry.

num_miners: u64

Number of Miners.

Implementations

impl Quarry

pub const LEN: usize = 132usize

impl Quarry

pub fn update_rewards_internal(
    &mut self,
    current_ts: i64,
    rewarder: &Rewarder,
    payroll: &Payroll
) -> Result<()>

Updates the quarry by synchronizing its rewards rate with the rewarder.

pub fn update_rewards_and_miner(
    &mut self,
    miner: &mut Miner,
    rewarder: &Rewarder,
    current_ts: i64
) -> Result<()>

Updates the quarry and miner with the latest info. https://github.com/Synthetixio/synthetix/blob/aeee6b2c82588681e1f99202663346098d1866ac/contracts/StakingRewards.sol#L158

pub fn process_stake_action_internal(
    &mut self,
    action: StakeAction,
    current_ts: i64,
    rewarder: &Rewarder,
    miner: &mut Miner,
    amount: u64
) -> Result<()>

Processes a StakeAction for a Miner,

Trait Implementations

impl AccountDeserialize for Quarry

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 Quarry

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

Serializes the account data into writer.

impl BorshDeserialize for Quarry where
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize,
    u8: BorshDeserialize,
    u16: BorshDeserialize,
    u8: BorshDeserialize,
    i64: BorshDeserialize,
    i64: BorshDeserialize,
    u128: BorshDeserialize,
    u64: BorshDeserialize,
    u64: 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 Quarry where
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize,
    u8: BorshSerialize,
    u16: BorshSerialize,
    u8: BorshSerialize,
    i64: BorshSerialize,
    i64: BorshSerialize,
    u128: BorshSerialize,
    u64: BorshSerialize,
    u64: 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 Quarry

fn clone(&self) -> Quarry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Quarry

fn default() -> Quarry

Returns the “default value” for a type.

impl Discriminator for Quarry

fn discriminator() -> [u8; 8]

impl From<Quarry> for Payroll

fn from(quarry: Quarry) -> Self

Create a Payroll from a Quarry.

impl Owner for Quarry

fn owner() -> Pubkey

impl Copy for Quarry