btc-vanity

v 2.1.0

A blazingly fast vanity address generator written with the Rust programming language. Supporting Bitcoin (always included), Ethereum, and Solana (via optional features).

With btc-vanity, you can generate wallets that have custom addresses with prefixes, suffixes, substrings, or even regex patterns. It's designed for speed, flexibility, and security.

You can easily run the btc-vanity terminal application locally or use it as a library to create your vanity keypairs securely.

Key Features

Multi-Chain Support:

• Bitcoin: Always included.
• Ethereum: Enabled via the ethereum feature.
• Solana: Enabled via the solana feature.

Advanced Customization: Match prefixes, suffixes, substrings, or regex-based patterns with optional case insensitivity.
Blazingly Fast Performance: Fully utilize your hardware with customizable thread counts.
Batch File Support: Bulk generate addresses using input files with desired patterns.

Installation

Caution

btc-vanity has recently migrated to version 2. Please use it cautiously.

CLI

Install the binary using cargo:

cargo install btc-vanity  # Installs Bitcoin support only (default)
cargo install btc-vanity --features ethereum  # Installs with Ethereum support
cargo install btc-vanity --features solana    # Installs with Solana support
cargo install btc-vanity --features all       # Installs with all features (Bitcoin, Ethereum, Solana)

Important: You must use the --features flag to enable Ethereum and/or Solana support. If you omit the flag, you'll only get Bitcoin functionality.

Library

Include btc-vanity in your Cargo.toml:

[dependencies]
btc-vanity = "2.1.0"  # Bitcoin support only

# For Ethereum support:
# btc-vanity = { version = "2.1.0", features = ["ethereum"] }

# For Solana support:
# btc-vanity = { version = "2.1.0", features = ["solana"] }

# For all features:
# btc-vanity = { version = "2.1.0", features = ["all"] }

Crate on crates.io
Documentation on docs.rs

CLI Usage

Basic CLI Syntax

The CLI tool provides several options to customize your address generation:

$ btc-vanity [OPTIONS] <PATTERN>

Blockchain Selection

• --btc: Generates Bitcoin keypairs and addresses. (Always available)
• --eth: Generates Ethereum keypairs and addresses. (Requires the ethereum feature)
• --sol: Generates Solana keypairs and addresses. (Requires the solana feature)

General Options

• -i, --input-file <FILE>: Reads patterns and flags from the specified file (one pattern per line).
• -o, --output-file <FILE>: Saves generated wallet details to the specified file.
• -t, --threads <N>: Sets the number of threads for address generation.
• -f, --force-flags: Forces CLI flags to override flags in the input file.
• -d, --disable-fast: Disables fast mode (allows longer patterns).

Matching Options

• -p, --prefix: Matches the pattern as a prefix (default).
• -s, --suffix: Matches the pattern as a suffix.
• -a, --anywhere: Matches the pattern anywhere in the address.
• -r, --regex <REGEX>: Matches addresses using a regular expression.
• -c, --case-sensitive: Enables case-sensitive matching.

Bitcoin CLI Examples

These examples always work, as Bitcoin support is always included.

Generate a Bitcoin address with prefix 1Emiv (case-insensitive):

$ btc-vanity Emiv

Generate a Bitcoin address containing the substring test (case-sensitive):

$ btc-vanity -a -c test

Generate a Bitcoin address using a regex pattern ^1E.*T$:

$ btc-vanity -r "^1E.*T$"

Generate multiple Bitcoin addresses and save to wallets.txt:

Note

-f flag will override any pattern flags inside the input-file.txt. For example if there line emiv -s --eth will become emiv -p --btc -c. The resulting wallet will be printed in wallets.txt.

$ btc-vanity -f --btc -p -c -i input-file.txt -o wallets.txt

Ethereum and Solana CLI Examples

Important: These commands require that you installed btc-vanity with the appropriate features (see Installation section above). Generate an Ethereum address starting with 0xdead with 8 threads:

# Ensure you installed with: cargo install btc-vanity --features ethereum
$ btc-vanity --eth -t 8 dead

Generate a Solana address ending with 123:

# Ensure you installed with: cargo install btc-vanity --features solana
$ btc-vanity --sol -s 123

Library Usage

Here are some usage examples of btc-vanity as a library.

Generate a Bitcoin Vanity Address

Find a Bitcoin address that contains the substring emiv (case-insensitive) using 16 threads:

use btc_vanity::{BitcoinKeyPair, VanityAddr, VanityMode};

let vanity_address: BitcoinKeyPair = VanityAddr::generate(
            "emiv", // Desired substring
            16,     // Number of threads
            false,  // Case-insensitive
            true,   // Enable fast mode
            VanityMode::Anywhere // Match substring anywhere in the address
            ).unwrap();

println!("Vanity address:\n\
          private_key (WIF): {}\n\
          public_key (compressed): {}\n\
          address (compressed): {}\n",
          vanity_address.get_wif_private_key(),
          vanity_address.get_comp_public_key(),
          vanity_address.get_comp_address());

Generate an Ethereum Vanity Address

Requires the ethereum feature. Match an Ethereum address with the prefix 0xdead using 8 threads:

# #[cfg(feature = "ethereum")] // Important: Only compile this example with the feature!
# {
use btc_vanity::{EthereumKeyPair, VanityAddr, VanityMode};

let vanity_address: EthereumKeyPair = VanityAddr::generate(
            "dead", // Desired prefix
            8,      // Number of threads
            false,  // Case-insensitive (Case sensitivity not supported on ETH generation)
            true,   // Enable fast mode
            VanityMode::Prefix // Match substring at the start
            ).unwrap();

println!("Ethereum vanity address:\n\
          private_key (hex): {}\n\
          public_key (hex): {}\n\
          address (hex): {}\n",
          vanity_address.get_private_key_as_hex(),
          vanity_address.get_public_key_as_hex(),
          vanity_address.get_address_with_prefix());
# }

Generate a Solana Vanity Address

Requires the solana feature.

Create a Solana address with meow anywhere in the address (case-sensitive) using 4 threads:

# #[cfg(feature = "solana")] // Important: Only compile this example with the feature!
# {
use btc_vanity::{SolanaKeyPair, VanityAddr, VanityMode}; // Removed KeyPairGenerator

let vanity_address: SolanaKeyPair = VanityAddr::generate(
            "meow",  // Desired substring
            4,      // Number of threads
            true,   // Case-sensitive
            true,   // Enable fast mode
            VanityMode::Anywhere // Match substring anywhere in the address
            ).unwrap();

println!("Solana vanity address:\n\
          private_key (Base58): {}\n\
          public_key (Base58): {}\n\
          address (Base58): {}\n",
          vanity_address.get_private_key_as_base58(),
          vanity_address.get_public_key_as_base58(),
          vanity_address.get_address());

# }

Regex Matching for Bitcoin Addresses

Find a Bitcoin address that matches a regex pattern ^1E.ET.*T$ with using 12 threads:

use btc_vanity::{BitcoinKeyPair, VanityAddr};

let vanity_address = VanityAddr::generate_regex::<BitcoinKeyPair>(
            "^1E.*ET.*T$", // The regex pattern
            12            // Number of threads
            ).unwrap();

println!("Bitcoin regex-matched vanity address:\n\
          private_key (WIF): {}\n\
          public_key (compressed): {}\n\
          address (compressed): {}\n",
          vanity_address.get_wif_private_key(),
          vanity_address.get_comp_public_key(),
          vanity_address.get_comp_address());

Contributing

Contributions are welcome! If you’d like to improve btc-vanity or add support for additional chains, feel free to open an issue or submit a pull request on GitHub.

Disclaimer

USE WITH CAUTION AND UNDERSTANDING

btc-vanity is a tool designed to assist users in generating customized vanity Bitcoin, Solana, and Ethereum addresses using the Rust programming language. While btc-vanity aims to provide a secure and efficient method for generating vanity addresses, it is essential to exercise caution and follow the best security practices.

1. Security Awareness: Generating and using vanity addresses involves the creation of private keys and public addresses. Private keys grant control over the associated funds. It is crucial to understand the risks involved in managing private keys and to never share them with anyone. Keep your private keys stored securely and never expose them to potential threats.

2. Risk of Loss: Improper use of btc-vanity, mishandling of private keys, or failure to follow security guidelines may result in the loss of Bitcoin, Solana, or Ethereum funds. Always double-check the addresses generated and verify their accuracy before using them for transactions.

3. Verification: Before utilizing any vanity address generated by btc-vanity, thoroughly verify the integrity of the software and the generated addresses. Only use versions of btc-vanity obtained from reputable sources, such as the official crates.io page.

4. Backup and Recovery: Maintain proper backups of your private keys and any relevant data. In the event of device failure, loss, or corruption, having secure backups will help prevent irreversible loss of funds.

5. Use at Your Own Risk: The btc-vanity software is provided "as is," without any warranties or guarantees. The author(s) and contributors of btc-vanity shall not be held responsible for any direct or indirect damages, losses, or liabilities resulting from the use or misuse of this software.

6. Educational Purposes: btc-vanity is intended for educational and personal use. It is your responsibility to ensure compliance with any legal, regulatory, or tax requirements in your jurisdiction related to Bitcoin, Solana, Ethereum, and cryptocurrency usage.

By using btc-vanity, you acknowledge and accept the risks associated with generating vanity addresses and handling private keys. It is your responsibility to exercise diligence, follow security best practices, and be aware of potential risks.

Remember, the security of your cryptocurrency holdings is paramount. Always prioritize the safety and security of your assets.