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

• Bet - Creates a wager on the current block.
• Bury - Swaps bets into ORE and burns it.
• Close - Closes a wager account.
• Initialize - Initializes the program.
• Payout - Distributes the block reward to the winner.
• Reset - Resets the program for the next block.

State

• Block - A singleton account tracking rounds of wagering.
• Proof - (Deprecated) An account which tracks a miner's current hash and current stake.
• Treasury – The ORE mint authority.
• Wager - A bet placed by a user.

Tests

To run the test suite, use the Solana toolchain:

cargo test-sbf

For line coverage, use llvm-cov:

cargo llvm-cov