Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

btc-vanity requires Rust 1.89 or newer. The default build includes Bitcoin CPU search and no optional features.

Install the command-line program

Install the smallest feature set that covers your use:

# Bitcoin on CPU
cargo install btc-vanity

# Bitcoin with experimental GPU support
cargo install btc-vanity --features gpu

# Add one optional chain
cargo install btc-vanity --features ethereum
cargo install btc-vanity --features solana

# Bitcoin, both optional chains, and GPU
cargo install btc-vanity --features all

The Cargo features are:

FeatureAdds
ethereumEthereum key and address support
solanaSolana key and address support
gpuExperimental GPU and Hybrid acceleration through wgpu
allethereum, solana, and gpu

Features are additive. For example, Ethereum with GPU support uses --features ethereum,gpu.

Build a checkout

git clone https://github.com/Emivvvvv/btc-vanity.git
cd btc-vanity
cargo build --release --features all
./target/release/btc-vanity --help

Use the release binary for meaningful performance measurements. Debug builds favor diagnostics over search throughput.

GPU requirements

The gpu feature uses wgpu, which reaches native Metal, Vulkan, or DirectX 12 backends depending on the platform and driver. Building the feature does not guarantee that a usable adapter will be available at runtime.

If explicit GPU initialization fails, update the graphics driver or use --backend cpu. Auto and Hybrid can continue on CPU when GPU work is not available. See Troubleshooting for specific errors.