Struct Epoch

pub struct Epoch {
    pub epoch: u64,
    pub epoch_pda: Pubkey,
    pub forester_epoch_pda: Pubkey,
    pub phases: EpochPhases,
    pub state: EpochState,
    pub merkle_trees: Vec<TreeForesterSchedule>,
}

Fields

epoch: u64

epoch_pda: Pubkey

forester_epoch_pda: Pubkey

phases: EpochPhases

state: EpochState

merkle_trees: Vec<TreeForesterSchedule>

Implementations

impl Epoch

pub async fn slots_until_next_epoch_registration<R>( rpc: &mut R, protocol_config: &ProtocolConfig, ) -> Result<EpochRegistration, RpcError>

where R: RpcConnection,

returns slots until next epoch and that epoch registration is open if

pub async fn register<R>( rpc: &mut R, protocol_config: &ProtocolConfig, authority: &Keypair, ) -> Result<Option<Epoch>, RpcError>

where R: RpcConnection,

creates forester account and fetches epoch account

pub fn fetch_registered()

forester account and epoch account already exist -> fetch accounts and init

pub async fn fetch_account_and_add_trees_with_schedule<R>( &mut self, rpc: &mut R, trees: &[TreeAccounts], ) -> Result<(), RpcError>

where R: RpcConnection,

pub fn add_trees_with_schedule( &mut self, forester_epoch_pda: &ForesterEpochPda, epoch_pda: &EpochPda, trees: &[TreeAccounts], current_solana_slot: u64, )

Internal function to init Epoch struct with registered account

1. calculate epoch phases
2. set current epoch state
3. derive tree schedule for all input trees

pub fn update_state(&mut self, current_solana_slot: u64) -> EpochState

pub fn execute_active_phase()

execute active phase test: (multi thread)

• iterate over all trees, check whether eligible and empty queues

forester:

• start a new thread per tree
• this thread will sleep when it is not elibile and wake up with some buffer time prior to the start of the slot
• threads shut down when the active phase ends

pub fn execute_report_work_phase()

report work phase: (single thread)

• free Merkle tree memory
• execute report work tx (single thread)

pub fn execute_post_phase()

post phase: (single thread)

• claim rewards
• close forester epoch account

Trait Implementations

impl Clone for Epoch

fn clone(&self) -> Epoch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Epoch

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

Formats the value using the given formatter.

impl Default for Epoch

fn default() -> Epoch

Returns the “default value” for a type.

impl PartialEq for Epoch

fn eq(&self, other: &Epoch) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Epoch

impl StructuralPartialEq for Epoch