Skip to content

Latest commit

 

History

History
69 lines (52 loc) · 3.24 KB

README.md

File metadata and controls

69 lines (52 loc) · 3.24 KB
Raw

piratepaperwallet

piratepaperwallet is a Pirate Sapling paper wallet generator that can run completely offline. You can run it on an air-gapped computer to generate your shielded z-addresses, which will allow you to keep your keys completely offline.

Download

piratepaperwallet is available as pre-built binaries from our release page. Download the zip file for your platform, extract it and run the ./piratepaperwallet binary.

Generating wallets

To generate a pirate paper wallet, simply run ./piratepaperwallet

You'll be asked to type some random characters that will add entropy to the random number generator. Run with --help to see all options

Saving as PDFs

To generate a pirate paper wallet and save it as a PDF, run ./piratepaperwallet -z 3 --format pdf piratepaper-output.pdf

This will generate 3 shielded z-addresses and their corresponding private keys, and save them in a PDF file called piratepaper-output.pdf

Vanity Addresses

You can generate a "vanity address" (that is, an address starting with a given prefix) by specifying a --vanity argument with the prefix you want.

Note that generating vanity addresses with a prefix longer than 4-5 characters is computationally expensive. You can run it on multiple CPUs on your computer by specifying the --threads option.

Compiling from Source

piratepaperwallet is built with rust. To compile from source, you install Rust. Basically, you need to:

curl https://sh.rustup.rs -sSf | sh

Checkout the piratepaperwallet repository and build the CLI

git clone https://github.com/mrmlynch/piratepaperwallet.git
cd piratepaperwallet/cli
cargo build --release

The binary is available in the piratepaperwallet/cli/target/release folder.

Run without network

If you are running a newish version of Linux, you can be doubly sure that the process is not contacting the network by running piratepaperwallet without the network namespace.

sudo unshare -n ./target/release/piratepaperwallet

unshare -n runs the process without a network interface which means you can be sure that your data is not being sent across the network.

Help options

USAGE:
    piratepaperwallet [FLAGS] [OPTIONS] [output]

FLAGS:
    -h, --help       Prints help information
    -n, --nohd       Don't reuse HD keys. Normally, piratepaperwallet will use the same HD key to derive multiple
                     addresses. This flag will use a new seed for each address
    -V, --version    Prints version information

OPTIONS:
    -e, --entropy <entropy>       Provide additional entropy to the random number generator. Any random string,
                                  containing 32-64 characters
    -f, --format <FORMAT>         What format to generate the output in [default: json]  [possible values: pdf, json]

    --threads <threads>       Number of threads to use for the vanity address generator. Set this to the number of
                                  CPUs you have [default: 1]
    --vanity <vanity>         Generate a vanity address with the given prefix
    -z, --zaddrs <z_addresses>    Number of Z addresses (Sapling) to generate [default: 1]

ARGS:
    <output>    Name of output file.