ORE Boost

ORE Boost is a staking program for earning multipliers on ORE mining rewards.

API

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

Instructions

• Close – Closes a stake account.
• Deposit – Deposits tokens into a stake account.
• Initialize – Initializes the program and creates the global accounts.
• New – Creates a new boost account.
• Open – Opens a new stake account.
• UpdateAdmin – Updates the admin key.
• UpdateBoost – Updates the data on a boost.
• Withdraw – Withdraws tokens from a stake account.
• Rotate – Rotates the reservation to a randomly selected boost according to their unclaimed ORE weight.
• Rebase – Adds a staker to the checkpoint, distributing rewards, and committing pending stake.
• Register – Opens a reservation account for a miner.
• Claim – Allows a staker to claim their rewards.

State

• Boost - An account (1 per mint) which records how much of a multiplier should be paid out for staked tokens of a given mint.
• Config – A singleton account which manages program-wide variables.
• Stake - An account (1 per user per mint) which records how many tokens of a given mint a user has staked.
• Checkpoint - An account (1 per boost) which records the current state of the staking checkpoint.
• Directory - A singleton account listing which boosts are active.

Tests

To run the test suite, use the Solana toolchain:

cargo test-sbf

For line coverage, use llvm-cov:

cargo llvm-cov