ore/README.md

ORE

It's time to mine.

Summary

ORE is a crypto mining game on the Solana blockchain. Players compete to earn cryptocurrency by prospecting on blocks rich with digital treasure.

API

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

Instructions

User

• Claim - Claims miner rewards.
• Close - Closes a block account.
• Initialize - Initializes the program.
• Log – Logs events as non-truncatable data.
• Mine - Submits hashes for scoring.
• Open - Opens a new block.
• Reset – Resets the hashpower market for the next block.
• Swap - Executes a buy or sell in the hashpower market.

Admin

• SetAdmin - Re-assigns the admin authority.
• SetFeeCollector - Updates the fee collection address.
• SetFeeRate - Updates the fee charged per swap.

State

• Block - A round in the game.
• Config - Global program configuration.
• Market - Hashpower market.
• Miner - Tracks a miner state and history.
• Treasury - The mint authority of the ORE token.

Block lifecycle

• Open a block with an upcoming ID.
• Reset to move the market forward, and begin trading.
• Swap to trade hashpower in the market for the current block.
• Trading ends automatically once the end slot is reached.
• Reset to move market forward again, and record the slot hash for the ended block.
• Mine to submit the best hash within your available nonce range.
• Close to return rent and transfer block reward to the winning miner for claiming.
• Claim to claim block reward.

Tests

To run the test suite, use the Solana toolchain:

cargo test-sbf

For line coverage, use llvm-cov:

cargo llvm-cov