ORE is a crypto mining protocol.
This project uses make for build automation. Install it for your platform:
macOS:
xcode-select --installLinux (Debian/Ubuntu):
sudo apt-get update
sudo apt-get install build-essentialLinux (Fedora/RHEL):
sudo dnf install makeWindows:
- Install via Chocolatey:
choco install make - Or use WSL and follow Linux instructions
- Quick Start Guide - Get started with ORE mining
- Makefile Reference - All available make commands
- Scripts Documentation - Automation scripts guide
Consts– Program constants.Error– Custom program errors.Event– Custom program events.Instruction– Declared instructions and arguments.
Automate- Configures a new automation.Checkpoint- Checkpoints rewards from an prior round.ClaimORE- Claims ORE mining rewards.ClaimSOL- Claims SOL mining rewards.Deploy– Deploys SOL to claim space on the board.Initialize- Initializes program variables.Log– Logs non-truncatable event data.Reset- Resets the board for a new round.Reset- Resets the board for a new round.
Deposit- Deposits ORE into a stake account.Withdraw- Withdraws ORE from a stake account.ClaimSeeker- Claims a Seeker genesis token.ClaimYield- Claims staking yield.
Bury- Executes a buy-and-bury transaction.Wrap- Wraps SOL in the treasury for swap transactions.SetAdmin- Re-assigns the admin authority.SetFeeCollector- Updates the fee collection address.SetFeeRate- Updates the fee charged per swap.
Automation- Tracks automation configs.Board- Tracks the current round number and timestamps.Config- Global program configs.Miner- Tracks a miner's game state.Round- Tracks the game state of a given round.Seeker- Tracks whether a Seeker token has been claimed.Stake- Manages a user's staking activity.Treasury- Mints, burns, and escrows ORE tokens.
To run the test suite, use the Solana toolchain:
cargo test-sbf
For line coverage, use llvm-cov:
cargo llvm-cov