https://github.com/regolith-labs/ore
ORE is a cryptocurrency everyone can mine.
https://github.com/regolith-labs/ore
solana
Last synced: 11 days ago
JSON representation
ORE is a cryptocurrency everyone can mine.
- Host: GitHub
- URL: https://github.com/regolith-labs/ore
- Owner: regolith-labs
- Created: 2024-01-07T15:24:23.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-05-07T16:19:25.000Z (8 months ago)
- Last Synced: 2025-05-07T17:27:03.359Z (8 months ago)
- Topics: solana
- Language: Rust
- Homepage: https://ore.supply
- Size: 1.92 MB
- Stars: 692
- Watchers: 24
- Forks: 240
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Security: security/fuzzland-audit.pdf
Awesome Lists containing this project
- awesome - regolith-labs/ore - It's time to mine. (Rust)
README
# ORE
ORE is a crypto mining protocol.
## API
- [`Consts`](api/src/consts.rs) – Program constants.
- [`Error`](api/src/error.rs) – Custom program errors.
- [`Event`](api/src/error.rs) – Custom program events.
- [`Instruction`](api/src/instruction.rs) – Declared instructions and arguments.
## Instructions
#### Mining
- [`Automate`](program/src/automate.rs) - Configures a new automation.
- [`Checkpoint`](program/src/checkpoint.rs) - Checkpoints rewards from an prior round.
- [`ClaimORE`](program/src/claim_ore.rs) - Claims ORE mining rewards.
- [`ClaimSOL`](program/src/claim_sol.rs) - Claims SOL mining rewards.
- [`Deploy`](program/src/deploy.rs) – Deploys SOL to claim space on the board.
- [`Initialize`](program/src/initialize.rs) - Initializes program variables.
- [`Log`](program/src/log.rs) – Logs non-truncatable event data.
- [`ReloadSOL`](program/src/reload_sol.rs) - Reloads SOL mining rewards into automation.
- [`Reset`](program/src/reset.rs) - Resets the board for a new round.
#### Staking
- [`Deposit`](program/src/deposit.rs) - Deposits ORE into a stake account.
- [`Withdraw`](program/src/withdraw.rs) - Withdraws ORE from a stake account.
- [`ClaimSeeker`](program/src/claim_seeker.rs) - Claims a Seeker genesis token.
- [`ClaimYield`](program/src/claim_yield.rs) - Claims staking yield.
#### Admin
- [`Bury`](program/src/bury.rs) - Executes a buy-and-bury transaction.
- [`Wrap`](program/src/wrap.rs) - Wraps SOL in the treasury for swap transactions.
- [`SetAdmin`](program/src/set_admin.rs) - Re-assigns the admin authority.
- [`SetFeeCollector`](program/src/set_admin.rs) - Updates the fee collection address.
- [`SetFeeRate`](program/src/set_admin.rs) - Updates the fee charged per swap.
## State
- [`Automation`](api/src/state/automation.rs) - Tracks automation configs.
- [`Board`](api/src/state/board.rs) - Tracks the current round number and timestamps.
- [`Config`](api/src/state/config.rs) - Global program configs.
- [`Miner`](api/src/state/miner.rs) - Tracks a miner's game state.
- [`Round`](api/src/state/round.rs) - Tracks the game state of a given round.
- [`Seeker`](api/src/state/seeker.rs) - Tracks whether a Seeker token has been claimed.
- [`Stake`](api/src/state/stake.rs) - Manages a user's staking activity.
- [`Treasury`](api/src/state/treasury.rs) - Mints, burns, and escrows ORE tokens.
## Tests
To run the test suite, use the Solana toolchain:
```
cargo test-sbf
```
For line coverage, use llvm-cov:
```
cargo llvm-cov
```