Struct ProtocolConfig 

pub struct ProtocolConfig {

    pub genesis_slot: u64,
    pub min_weight: u64,
    pub slot_length: u64,
    pub registration_phase_length: u64,
    pub active_phase_length: u64,
    pub report_work_phase_length: u64,
    pub network_fee: u64,
    pub cpi_context_size: u64,
    pub finalize_counter_limit: u64,
    pub place_holder: Pubkey,
    pub place_holder_a: u64,
    pub place_holder_b: u64,
    pub place_holder_c: u64,
    pub place_holder_d: u64,
    pub place_holder_e: u64,
    pub place_holder_f: u64,
}

Epoch Phases:

1. Registration
2. Active
3. Report Work
4. Post (Epoch has ended, and rewards can be claimed.)

• There is always an active phase in progress, registration and report work phases run in parallel to a currently active phase.

Fields

genesis_slot: u64

Solana slot when the protocol starts operating.

min_weight: u64

Minimum weight required for a forester to register to an epoch.

slot_length: u64

Light protocol slot length

registration_phase_length: u64

Foresters can register for this phase.

active_phase_length: u64

Foresters can perform work in this phase.

report_work_phase_length: u64

Foresters can report work to receive performance based rewards in this phase.

network_fee: u64

cpi_context_size: u64

finalize_counter_limit: u64

place_holder: Pubkey

Placeholder for future protocol updates.

place_holder_a: u64

place_holder_b: u64

place_holder_c: u64

place_holder_d: u64

place_holder_e: u64

place_holder_f: u64

Implementations

impl ProtocolConfig

pub fn testnet_default() -> Self

impl ProtocolConfig

Light Epoch Example:

Diagram of epochs 0 and 1. Registration 0 starts at genesis slot. |–– Registration 0 ––|—————— Active 0 ——|–– Report Work 0 ––|–– Post 0 –– |– Registration 1 –|—————— Active 1 —————– (Post epoch does not end unlike the other phases.)

let genesis = 0; let registration_phase_length = 100; let active_phase_length = 1000; let report_work_phase_length = 100; let slot = 10;

To get the latest registry epoch:

• slot = 0; let current_registry_epoch = (slot - genesis) / active_phase_length; current_registry_epoch = (0 - 0) / 1000 = 0; first active phase starts at genesis + registration_phase_length = 0 + 100 = 100;

To get the current active epoch:

• slot = 100; let current_active_epoch = (slot - genesis - registration_phase_length) / active_phase_length; current_active_epoch = (100 - 0 - 100) / 1000 = 0;

Epoch 0:

• Registration 0: 0 - 100
• Active 0: 100 - 1100
• Report Work 0: 1100 - 1200
• Post 0: 1200 - inf

Epoch 1:

• Registration 1: 1000 - 1100
• Active 1: 1100 - 2100
• Report Work 1: 2100 - 2200
• Post 1: 2200 - inf

Epoch 2:

• Registration 2: 2000 - 2100
• Active 2: 2100 - 3100
• Report Work 2: 3100 - 3200
• Post 2: 3200 - inf

pub fn get_latest_register_epoch(&self, slot: u64) -> Result<u64>

Current epoch including registration phase.

pub fn get_current_epoch(&self, slot: u64) -> u64

pub fn get_current_active_epoch(&self, slot: u64) -> Result<u64>

pub fn get_latest_register_epoch_progress(&self, slot: u64) -> Result<u64>

pub fn get_current_active_epoch_progress(&self, slot: u64) -> u64

pub fn is_registration_phase(&self, slot: u64) -> Result<u64>

In the last part of the active phase the registration phase starts. Returns end slot of the registration phase/start slot of the next active phase.

pub fn is_active_phase(&self, slot: u64, epoch: u64) -> Result<()>

pub fn is_report_work_phase(&self, slot: u64, epoch: u64) -> Result<()>

pub fn is_post_epoch(&self, slot: u64, epoch: u64) -> Result<()>

Trait Implementations

impl BorshDeserialize for ProtocolConfig

where u64: BorshDeserialize, Pubkey: BorshDeserialize,

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

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.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for ProtocolConfig

where u64: BorshSerialize, Pubkey: BorshSerialize,

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

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

Serialize this instance into a vector of bytes.

impl Clone for ProtocolConfig

fn clone(&self) -> ProtocolConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolConfig

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

Formats the value using the given formatter.

impl Default for ProtocolConfig

fn default() -> Self

Returns the “default value” for a type.

impl IdlBuild for ProtocolConfig

fn create_type() -> Option<IdlTypeDef>

Create an IDL type definition for the type.

fn insert_types(types: &mut BTreeMap<String, IdlTypeDef>)

Insert all types that are included in the current type definition to the given map.

fn get_full_path() -> String

Get the full module path of the type.

impl PartialEq for ProtocolConfig

fn eq(&self, other: &ProtocolConfig) -> 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 Copy for ProtocolConfig

impl Eq for ProtocolConfig

impl StructuralPartialEq for ProtocolConfig