sigildocs

(sigil bitcoin keys)

(sigil bitcoin keys) — Bitcoin key, address, BIP32, and BIP39 helpers

Exports

bitcoin-networkprocedure

Bitcoin network parameters used by key and address encoders.

bitcoin-network?procedure

Test if a value is a bitcoin-network struct.

bitcoin-network-nameprocedure

Get the name field of a bitcoin-network struct.

bitcoin-network-wifprocedure

Get the wif field of a bitcoin-network struct.

bitcoin-network-p2pkhprocedure

Get the p2pkh field of a bitcoin-network struct.

bitcoin-network-p2shprocedure

Get the p2sh field of a bitcoin-network struct.

bitcoin-network-bech32procedure

Get the bech32 field of a bitcoin-network struct.

bitcoin-network-xprvprocedure

Get the xprv field of a bitcoin-network struct.

bitcoin-network-xpubprocedure

Get the xpub field of a bitcoin-network struct.

bitcoin-mainnetvariable

Mainnet address and extended-key version constants.

bitcoin-testnetvariable

Testnet address and extended-key version constants.

extended-private-keyprocedure

BIP32 extended private key record.

extended-private-key?procedure

Test if a value is a extended-private-key struct.

extended-private-key-networkprocedure

Get the network field of a extended-private-key struct.

extended-private-key-depthprocedure

Get the depth field of a extended-private-key struct.

extended-private-key-parent-fingerprintprocedure

Get the parent-fingerprint field of a extended-private-key struct.

extended-private-key-child-numberprocedure

Get the child-number field of a extended-private-key struct.

extended-private-key-chain-codeprocedure

Get the chain-code field of a extended-private-key struct.

extended-private-key-private-keyprocedure

Get the private-key field of a extended-private-key struct.

%extended-public-key--typevariable

Get the private-key field of a extended-private-key struct.

extended-public-keyprocedure

BIP32 extended public key record.

extended-public-key?procedure

Test if a value is a extended-public-key struct.

extended-public-key-networkprocedure

Get the network field of a extended-public-key struct.

extended-public-key-depthprocedure

Get the depth field of a extended-public-key struct.

extended-public-key-parent-fingerprintprocedure

Get the parent-fingerprint field of a extended-public-key struct.

extended-public-key-child-numberprocedure

Get the child-number field of a extended-public-key struct.

extended-public-key-chain-codeprocedure

Get the chain-code field of a extended-public-key struct.

extended-public-key-public-keyprocedure

Get the public-key field of a extended-public-key struct.

%bip32-key-origin--typevariable

Get the public-key field of a extended-public-key struct.

bip32-key-originprocedure

BIP32 key-origin metadata used by descriptors and PSBT derivations.

bip32-key-origin?procedure

Test if a value is a bip32-key-origin struct.

bip32-key-origin-fingerprintprocedure

Get the fingerprint field of a bip32-key-origin struct.

bip32-key-origin-pathprocedure

Get the path field of a bip32-key-origin struct.

private-key->wifprocedure

Encode a 32-byte private key as Wallet Import Format.

network selects the WIF version byte. compressed? controls whether the compressed-public-key marker is included in the payload.

wif->private-keyprocedure

Decode a Wallet Import Format string.

Returns (key network . compressed?).

private-key->public-keyprocedure

Derive a compressed public key from a 32-byte secp256k1 private key.

public-key?procedure

Return true when key is a valid compressed or uncompressed public key.

compressed-public-key?procedure

Return true when key is a valid 33-byte compressed public key.

x-only-public-keyprocedure

Convert a serialized public key into a 32-byte x-only public key.

public-key->p2pkh-addressprocedure

Derive a Base58Check P2PKH address from a serialized public key.

script-hash->p2sh-addressprocedure

Encode a 20-byte script hash as a Base58Check P2SH address.

public-key->p2wpkh-addressprocedure

Derive a native SegWit P2WPKH address from a serialized public key.

script->p2wsh-addressprocedure

Derive a native SegWit P2WSH address from a witness script.

x-only-public-key->p2tr-addressprocedure

Encode a 32-byte x-only public key as a native Taproot address.

fingerprintprocedure

Return the BIP32 4-byte key fingerprint for a serialized public key.

extended-private-key->public-keyprocedure

Neuter an extended private key into the matching extended public key.

bip32-master-keyprocedure

Derive a BIP32 master extended private key from seed bytes.

bip32-private-childprocedure

Derive a BIP32 private child key.

Hardened children use child numbers greater than or equal to #x80000000.

bip32-public-childprocedure

Derive a non-hardened BIP32 public child key.

bip32-path->listprocedure

Parse an absolute BIP32 path into child numbers.

bip32-path->stringprocedure

Format child numbers as an absolute BIP32 path.

bip32-key-origin-parseprocedure

Parse [fingerprint/path] BIP32 key-origin text.

bip32-key-origin->stringprocedure

Format BIP32 key-origin metadata as [fingerprint/path].

bip32-derive-pathprocedure

Derive a BIP32 path such as m/84'/0'/0'/0/0.

The input key may be an extended private key or extended public key.

bip32-hardened-indexprocedure

Convert a non-hardened child index into a hardened BIP32 index.

bip32-account-pathprocedure

Build a BIP43 account path m/purpose'/coin_type'/account'.

bip44-account-pathprocedure

BIP44 legacy P2PKH account path.

bip49-account-pathprocedure

BIP49 nested SegWit account path.

bip84-account-pathprocedure

BIP84 native SegWit account path.

bip86-account-pathprocedure

BIP86 Taproot key-path account path.

bip32-account-keyprocedure

Derive an account-level extended key for a BIP43 purpose.

bip44-account-keyprocedure

Derive a BIP44 account key from a master extended key.

bip49-account-keyprocedure

Derive a BIP49 account key from a master extended key.

bip84-account-keyprocedure

Derive a BIP84 account key from a master extended key.

bip86-account-keyprocedure

Derive a BIP86 account key from a master extended key.

bip32-chain-keyprocedure

Derive an external (#f) or change (#t) chain from an account key.

bip32-address-keyprocedure

Derive an address key at /change/index from an account key.

bip32-xprv->stringprocedure

Serialize a BIP32 extended private key as Base58Check text.

bip32-xpub->stringprocedure

Serialize a BIP32 extended public key as Base58Check text.

bip32-xprv->slip132-stringprocedure

Serialize an extended private key with a SLIP-132 version prefix.

bip32-xpub->slip132-stringprocedure

Serialize an extended public key with a SLIP-132 version prefix.

string->bip32-xprvprocedure

Parse a Base58Check BIP32 extended private key.

string->bip32-xpubprocedure

Parse a Base58Check BIP32 extended public key.

string->bip32-slip132-xprvprocedure

Parse a SLIP-132 extended private key into the standard key record.

string->bip32-slip132-xpubprocedure

Parse a SLIP-132 extended public key into the standard key record.

bip39-entropy->mnemonicprocedure

Convert BIP39 entropy bytes into an English mnemonic sentence.

bip39-mnemonic->entropyprocedure

Convert a BIP39 English mnemonic sentence back to entropy bytes.

bip39-mnemonic->seedprocedure

Derive a 64-byte BIP39 seed from a mnemonic and optional passphrase.