From 42fc923cb100f4ebf95b3085018cac280d883edf Mon Sep 17 00:00:00 2001 From: Hardhat Chad Date: Fri, 6 Jun 2025 09:39:14 -0700 Subject: [PATCH] comments --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index df91d1e..93183f6 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,17 @@ ## Instructions -- [`Open`](program/src/open.rs) - Opens a new block for mining. -- [`Close`](program/src/close.rs) - Closes a block and pays out rewards. -- [`Mine`](program/src/mine.rs) - Mines the current block by computing hashes. +- [`Open`](program/src/open.rs) - Open a new block. +- [`Close`](program/src/close.rs) - Close a block and pay out the reward. +- [`Mine`](program/src/mine.rs) - Mine the current block. - [`Swap`](program/src/swap.rs) - Trade in a hashpower market. ## State - [`Block`](api/src/state/block.rs) - A period of time for mining. - [`Config`](api/src/state/config.rs) - Global program configuration. - [`Market`](api/src/state/market.rs) - Hashpower market for a given block. -- [`Miner`](api/src/state/miner.rs) - Tracks a user's mining state. -- [`Treasury`](api/src/state/treasury.rs) - The mint authority on the ORE token. +- [`Miner`](api/src/state/miner.rs) - Tracks a miner state and history. +- [`Treasury`](api/src/state/treasury.rs) - The mint authority of the ORE token. ## Tests