https://github.com/regolith-labs/ore

ORE is a cryptocurrency everyone can mine.
https://github.com/regolith-labs/ore

solana

Last synced: 8 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 (10 months ago)
• Default Branch: master
• Last Pushed: 2024-10-25T22:35:31.000Z (14 days ago)
• Last Synced: 2024-10-31T12:15:41.249Z (9 days ago)
• Topics: solana
• Language: Rust
• Homepage: https://ore.supply
• Size: 1.77 MB
• Stars: 686
• Watchers: 23
• Forks: 233
• Open Issues: 33
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - regolith-labs/ore - ORE is a cryptocurrency everyone can mine. (Rust)

README

        
# ORE

**ORE is a cryptocurrency everyone can mine.**

## 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

- [`Claim`](program/src/claim.rs) – Distributes ORE from the treasury to a miner.

- [`Close`](program/src/close.rs) – Closes a proof account returns the rent to the owner.

- [`Open`](program/src/open.rs) – Opens a new proof account for a miner.

- [`Mine`](program/src/mine.rs) – Verifies a hash and increments a miner's claimable balance.

- [`Reset`](program/src/reset.rs) – Resets the program for a new epoch.

- [`Update`](program/src/update.rs) – Updates a proof account's miner authority.

- [`Upgrade`](program/src/upgrade.rs) – Migrates ORE v1 tokens to ORE v2, one-for-one.

- [`Initialize`](program/src/initialize.rs) – Initializes the program and creates the global accounts.

## State

 - [`Bus`](api/src/state/bus.rs) - An account (8 total) which tracks and limits the amount ORE mined each epoch.

 - [`Config`](api/src/state/config.rs) – A singleton account which manages program-wide variables.

 - [`Proof`](api/src/state/proof.rs) - An account (1 per user) which tracks a miner's current hash and current stake.

 - [`Treasury`](api/src/state/treasury.rs) – A singleton account which has authority to mint ORE and holds onto user stake.

## Tests

To run the test suite, use the Solana toolchain: 

```

cargo test-sbf

```

For line coverage, use llvm-cov:

```

cargo llvm-cov

```