grunch / rana

Nostr public key mining tool

Rana 🐸

Mine public keys that can be used with nostr.

This is based on nip13 example.

Provide the desired difficulty or the vanity prefix as arguments. See below.

Requirements:

0. You need Rust version 1.64 or higher to compile.

Install

Using Cargo to install (requires ~/.cargo/bin to be in PATH)

$ cargo install rana

Compile and execute it:

To compile on Ubuntu/Pop!_OS/Debian, please install cargo, then run the following commands:

$ sudo apt update
$ sudo apt install -y cmake build-essential

Then clone the repo, build and run:

$ git clone https://github.com/grunch/rana.git
$ cd rana
$ cargo run --release

By default it will generate a public key with a difficulty of 10 but you can customize its difficulty or vanity prefix with the proper parameters.

Usage:

Options:
  -d, --difficulty <DIFFICULTY>
          Enter the number of starting bits that should be 0. [default: 10]
  -v, --vanity <VANITY_PREFIX>
          Enter the prefix your public key should have when expressed
          as hexadecimal.
  -n, --vanity-n-prefix <VANITY_NPUB_PREFIXES_RAW_INPUT>
          Enter the prefix your public key should have when expressed
          in npub format (Bech32 encoding). Specify multiple vanity
          targets as a comma-separated list.
  -s, --vanity-n-suffix <VANITY_NPUB_SUFFIXES_RAW_INPUT>
          Enter the suffix your public key should have when expressed
          in npub format (Bech32 encoding). Specify multiple vanity
          targets as a comma-separated list.
  -c, --cores <NUM_CORES>
          Number of processor cores to use
  -r, --restore <MNEMONIC_PHRASE>
          Restore from mnemonic to public private key
  -g, --generate <WORD_COUNT>
          Word count of mnemonic to be generated. Should be either 12,18 or 24
  -p, --passphrase <WORD_COUNT>
          Passphrase used for restoring mnemonic to keypair
  -q, --qr
          Print QR code of the private key
  -w, --verbose_output
          Print verbose ouput of non-matching public keys

Examples:

$ cargo run --release -- --difficulty=20

# Vanity only accepts hexadecimal values. DEAD corresponds to https://www.hexdictionary.com/hex/DEAD, not an example username string.
$ cargo run --release -- --vanity=dead

$ cargo run --release -- --vanity-n-prefix=rana

$ cargo run --release -- --vanity-n-prefix=rana,h0dl,n0strfan

$ cargo run --release -- -n=rana,h0dl,n0strfan

$ cargo run --release -- --vanity-n-suffix=ranaend

# You can combine prefix and suffix
$ cargo run --release -- -n=rana,h0dl,n0strfan -s theend,end

# Generate key pair with 12 words mnemonic
$ cargo run --release -- -g 12

# Restore key pair from mnemonic. Use quotes and separate each word with a space
$ cargo run --release -- -r "congress evoke onion donate fantasy soccer project fiction envelope body faith mean"

If you have it installed with cargo install:

$ rana --difficulty=20

$ rana --vanity=dead

$ rana --vanity-n-prefix=rana

$ rana -n=rana,h0dl,n0strfan

$ rana -n=rana,h0dl,n0strfan -s theend,end

Keep in mind that you cannot specify a difficulty and a vanity prefix at the same time. Also, the more requirements you have, the longer it will take to reach a satisfactory public key.

Searching for multiple vanity targets at once

Specifying multiple vanity-n-* targets allows you to leverage the work you've already done to generate each new npub candidate. Searching a candidate npub for additional targets is incredibly fast because it's just a trivial string compare.

Statistically speaking, searching for rana,h0dl should take half the time that searching for rana and then doing a second, separate search for hodl would take.