update comments

api/src/instruction.rs

@@ -16,6 +16,7 @@ use crate::{
 #[derive(Clone, Copy, Debug, Eq, PartialEq, TryFromPrimitive)]
 #[rustfmt::skip]
 pub enum OreInstruction {
+    // User
     Claim = 0,
     Close = 1,
     Mine = 2,
@@ -25,6 +26,7 @@ pub enum OreInstruction {
     Update = 6,
     Upgrade = 7,
 
+    // Admin
     Initialize = 100,
 }
 
@@ -96,6 +98,15 @@ impl_instruction_from_bytes!(ClaimArgs);
 impl_instruction_from_bytes!(StakeArgs);
 impl_instruction_from_bytes!(UpgradeArgs);
 
+/// Builds an auth instruction.
+pub fn auth(proof: Pubkey) -> Instruction {
+    Instruction {
+        program_id: NOOP_PROGRAM_ID,
+        accounts: vec![],
+        data: proof.to_bytes().to_vec(),
+    }
+}
+
 /// Builds a claim instruction.
 pub fn claim(signer: Pubkey, beneficiary: Pubkey, amount: u64) -> Instruction {
     let proof = Pubkey::find_program_address(&[PROOF, signer.as_ref()], &crate::id()).0;
@@ -139,15 +150,6 @@ pub fn close(signer: Pubkey) -> Instruction {
     }
 }
 
-/// Builds an auth instruction.
-pub fn auth(proof: Pubkey) -> Instruction {
-    Instruction {
-        program_id: NOOP_PROGRAM_ID,
-        accounts: vec![],
-        data: proof.to_bytes().to_vec(),
-    }
-}
-
 /// Builds a mine instruction.
 pub fn mine(
     signer: Pubkey,

api/src/state/bus.rs

@@ -4,8 +4,8 @@ use crate::utils::{impl_account_from_bytes, impl_to_bytes, Discriminator};
 
 use super::AccountDiscriminator;
 
-/// Bus accounts are responsible for distributing mining rewards.
-/// There are 8 busses total to minimize write-lock contention and allow for parallel mine operations.
+/// Bus accounts are responsible for distributing mining rewards. There are 8 busses total
+/// to minimize write-lock contention and allow Solana to process mine instructions in parallel.
 #[repr(C)]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 pub struct Bus {
@@ -16,7 +16,7 @@ pub struct Bus {
     pub rewards: u64,
 
     /// The rewards this bus would have paid out in the current epoch if there no limit.
-    /// Used to calculate the updated reward rate.
+    /// This is used to calculate the updated reward rate.
     pub theoretical_rewards: u64,
 
     /// The largest known stake balance seen by the bus this epoch.

api/src/state/config.rs

@@ -4,7 +4,7 @@ use crate::utils::{impl_account_from_bytes, impl_to_bytes, Discriminator};
 
 use super::AccountDiscriminator;
 
-/// Config is a singleton account which manages admin configurable variables.
+/// Config is a singleton account which manages program global variables.
 #[repr(C)]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 pub struct Config {

api/src/state/treasury.rs

@@ -4,8 +4,8 @@ use crate::utils::{impl_account_from_bytes, impl_to_bytes, Discriminator};
 
 use super::AccountDiscriminator;
 
-/// 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.
+/// Treasury is a singleton account which is the mint authority for the ORE token and the authority of
+/// the program's global token account.
 #[repr(C)]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 pub struct Treasury {}