comments

src/state/bus.rs

@@ -6,6 +6,9 @@ use crate::{
     utils::{AccountDiscriminator, Discriminator},
 };
 
+/// Bus accounts are responsible for distributing mining rewards.
+/// There are 8 busses total to minimize write-lock contention and allow for parallel mine operations.
+/// Every epoch, the bus account rewards counters are topped up to 0.25 ORE each (2 ORE split amongst 8 busses).
 #[repr(C)]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, ShankAccount, Zeroable)]
 pub struct Bus {

src/state/hash.rs

@@ -5,6 +5,7 @@ use solana_program::keccak::{Hash as KeccakHash, HASH_BYTES};
 
 use crate::impl_to_bytes;
 
+/// Hash is an equivalent type to solana_program::keccak::Hash which supports bytemuck serialization.
 #[repr(C)]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 pub struct Hash(pub [u8; HASH_BYTES]);

src/state/proof.rs

@@ -8,6 +8,8 @@ use crate::{
     utils::{AccountDiscriminator, Discriminator},
 };
 
+/// Proof accounts track a miner's current hash, claimable rewards, and lifetime stats.
+/// Every miner is allowed one proof account which is required by the program to mine or claim rewards.
 #[repr(C)]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, ShankAccount, Zeroable)]
 pub struct Proof {

src/state/treasury.rs

@@ -8,6 +8,8 @@ use crate::{
     utils::{AccountDiscriminator, Discriminator},
 };
 
+/// Treasury is a singleton account which manages all program wide variables.
+/// It is the mint authority for the Ore token and also the authority of the program-owned token account.
 #[repr(C)]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, ShankAccount, Zeroable)]
 pub struct Treasury {
@@ -20,8 +22,8 @@ pub struct Treasury {
     /// The hash difficulty.
     pub difficulty: Hash,
 
-    /// The timestamp of the start of the current epoch.
-    pub epoch_start_at: i64,
+    /// The timestamp of the reset invocation.
+    pub last_reset_at: i64,
 
     /// The reward rate to payout to miners for submiting valid hashes.
     pub reward_rate: u64,