Skip to content
Hyburn

Hyburn / Mine

Mining guide

Choose one implementation. The same protocol, in four languages.

Run a command-line miner to burn HYPE and claim HYBURN. Rewards become claimable when a round ends, with no claim deadline. Anyone can submit a claim for you; the tokens always go to your address. This website does not connect to your wallet.

Before you start

  • Use a dedicated wallet that holds only the HYPE you intend to burn plus a little for gas. Never your main wallet.
  • Burned HYPE does not come back. The miner will not ask twice.
  • Every burn names the round it is for. If a transaction lands late, the contract rejects it and your HYPE is returned.

1. Get the source

Download or clone the repository, then open a terminal in its root folder. You need Git to clone it. Review the miner source before using a key.

Source: https://github.com/hyburnprotocol/hyburn.

The commands below use Bash or Zsh on macOS/Linux, or Bash inside WSL on Windows. Choose just one language; each implementation supports the same commands.

2. Install one miner

Each block starts from the repository root. Keep that terminal in the chosen language folder for the remaining steps. The alias makes hyburn work in that shell; it is not a system-wide installation.

PythonReference implementation

Requires: Python 3.10+ with pip and venv support.

cd cli/python
python3 -m venv .venv
.venv/bin/python -m pip install -r requirements.txt
alias hyburn='.venv/bin/python hyburn.py'

Without the alias, replace hyburn in every example with .venv/bin/python hyburn.py. Repeat the alias command after opening a new terminal, from this same folder.

Node.jsJavaScript implementation

Requires: Node.js 22 with npm.

cd cli/node
npm ci
alias hyburn='node hyburn.mjs'

Without the alias, replace hyburn in every example with node hyburn.mjs. Repeat the alias command after opening a new terminal, from this same folder.

GoCompiled binary

Requires: Go 1.24+; go build downloads the module dependencies.

cd cli/go
go build -o hyburn .
alias hyburn='./hyburn'

Without the alias, replace hyburn in every example with ./hyburn. Repeat the alias command after opening a new terminal, from this same folder.

RustCompiled binary

Requires: An up-to-date Rust toolchain with Cargo and a system linker. Cargo downloads and compiles the dependencies.

cd cli/rust
cargo build --release --locked
alias hyburn='./target/release/hyburn'

Without the alias, replace hyburn in every example with ./target/release/hyburn. Repeat the alias command after opening a new terminal, from this same folder.

3. Set the deployment

Use the published Miner address and deployment block from the official deployment record. Replace the placeholders before running these commands.

export HYBURN_MINER=0x951258b9c1C625536c25A6ECe943aA75B0386250
export HYBURN_DEPLOY_BLOCK=47024793

The miner never takes a private key as a command-line argument. HYBURN_RPC defaults to https://rpc.hyperliquid.xyz/evm.

Check the deployment without loading a key:

hyburn status

Before genesis, this reports that mining has not started. A connection or address error must be resolved before continuing.

4. Load your mining wallet

Use an existing encrypted Ethereum JSON keystore exported from your wallet. The miner reads this file and prompts for its password; it does not create the file.

export HYBURN_KEYSTORE="$HOME/.hyburn/miner.json"

Alternatively, unattended setups support HYBURN_PRIVATE_KEY. Use one key source. If both are set, the keystore takes precedence.

5. Check, then mine

After genesis, estimate one minimum-size burn without sending it. This still requires your key and enough HYPE for the burn plus estimated gas.

hyburn burn 0.000999 --dry-run

When ready, this example makes at most two burns of 0.000999 HYPE, plus gas. It waits until 30 seconds before each round ends.

hyburn mine --amount 0.000999 --at 30 --budget 0.001998 --rounds 2

After the final round ends, claim any remaining reward and inspect your history:

hyburn claim
hyburn history

--budget counts HYPE burned during this run, excludes gas, and resets when the process restarts. Keep extra HYPE available for transaction fees.

Commands

CommandWhat it does
statusCurrent round and time left, HYPE burned so far, HYBURN per HYPE right now, your position and unclaimed HYBURN.
burn <hype>Burn once into the current round. Claims your finished rounds in the same transaction.
mineRun continuously: burn every round according to the options below, claim as you go. Ctrl-C stops after the current transaction.
claimClaim every finished round you took part in.
historyYour rounds: burned, round total, share, HYBURN, claimed or not.

Options for mine

OptionMeaning
--amount <hype>HYPE to burn per round. Required.
--max-cost <hype>Only burn if the round's HYPE per HYBURN, counting your own burn, is at or below this at the moment of sending; skip the round otherwise. This is a condition, not a guarantee: burns by others after yours in the same round lower everyone's payout, so the final cost can be higher.
--at <seconds>Send this many seconds before the round ends. Default 30. Sending in the final second exposes you to the last-block risk described in the whitepaper.
--budget <hype>Stop after this much HYPE has been burned in total.
--rounds <n>Stop after this many burns.
--dry-runEstimate and print what would be sent; send nothing.

Without a miner

Both actions are plain contract calls from any explorer's write tab: burn(expectedRoundId) with the HYPE as value, and claimMany(roundIds, account). currentRoundId() tells you the round to name.