For the complete documentation index, see llms.txt. This page is also available as Markdown.

Run a Miner

Running a Stacks miner is running a Stacks node with extra configuration: a funded Bitcoin wallet, a mining key, and burnchain settings that let the node send block-commits.

These guides cover both a testnet and a mainnet miner.

Required Bitcoin wallet configuration

From stacks-core 4.0.2, a mining node must set burnchain.wallet_name to a wallet that already exists in your Bitcoin Core node:

Use the name of your own wallet. The name accepts ASCII letters, digits, and . _ - /. The node loads the wallet at startup and never creates it, so create or restore it in Bitcoin Core first. This applies on every Bitcoin Core version, and it restores compatibility with Bitcoin Core 31 and later, which removed the default unnamed wallet.

Loading lasts for the current bitcoind session. Set wallet=<name> in bitcoin.conf so the wallet is loaded again after a bitcoind restart. Nothing reloads it if bitcoind restarts while the Stacks node keeps running.

Condition
Startup failure

wallet_name unset or empty on a miner

Config is missing the setting burnchain.wallet_name (mandatory and non-empty for miners)

Named wallet not present in Bitcoin Core

FATAL: Configured bitcoin wallet <name> was not found; create or restore it before starting the miner

Bitcoin Core unreachable

FATAL: unable to load a bitcoin wallet after 6 attempts, exiting

Followers and mock miners do not use wallet RPCs and can leave wallet_name unset. On Bitcoin Core 31 and later, migratewallet can split a legacy wallet into a primary and a <name>_watchonly wallet. Set wallet_name to the one holding the miner's watched addresses.

Last updated

Was this helpful?