ore/README.md

ORE

Digital gold, accelerated.

API

• Consts – Program constants.
• Error – Custom program errors.
• Event – Custom program events.
• Instruction – Declared instructions and arguments.

Instructions

• Bury - Swap committed tokens into ORE and burns it.
• Close - Close a commit account.
• Deploy - Deploy capital to mine the current block.
• Initialize - Initialize the program.
• Payout - Payout the block reward to the winning commit.
• Reset - Start the next block.

State

• Block - A singleton account tracking rounds of commits.
• Proof - (Deprecated) An account which tracks a miner's current hash and current stake.
• Treasury – The mint authority on the ORE token.
• Commit - Capital deployed by a miner in the current block.

Tests

To run the test suite, use the Solana toolchain:

cargo test-sbf

For line coverage, use llvm-cov:

cargo llvm-cov