API Reference BitcoinLib v0.4.2

modules

Modules

High level bitcoin operations

Bitcoin address management

Implementation of Bech32 addresses

Implementation of P2PKH addresses

Implementation of P2SH-P2WPKH addresses

Implementation of P2WPKH addresses

Implementation of P2WSH addresses

Represents a Bitcoin Block

Represents a Bitcoin block header

Converts a list of bytes into a list of transactions

Cryptography functions

Bitwise operations

Cryptography helper functions

Elliptic curve cryptography

WIF Bitcoin private key format management

A way to represent binaries in a human readable format that fits what's found on the web related to keys and addresses

Can parse derivation paths string format into a native format

Single purpose module that aims to simplify DerivationPath by isolating string parsing business logic

Splits the key space into independent user identities.

Determines which change chain is being used, either receiving or change.

Determines which coin type is being used, either bitcoin mainnet or bitcoin testnet.

Addresses are numbered from index 0 in sequentially increasing manner. This number is used as child index in BIP32 derivation.

Determines which address space is being used, either bip44, bip49 or bip84.

Extracts the first value of a derivation path, which is public or private.

Single purpose module that's responsible to transform a list of integer into a DerivationPath values structure

Computing entropy from different sources, mostly for seed phrase creation

A fingerprint is a small hash of a public key

Computes HMAC on either a public or a private key in the aim of computing a child key

A seed phrase can generate a private key. It is a human friendly way to store private keys for disaster recovery.

Checksum needed to generate a seed phrase

A list of all the words that can be contained in a private key seed phrase

Bitcoin extended private key management module

Computes a private key from a derivation path

Calculates direct childs from a private key based on a given index, and maybe a hardened flag

Bitcoin extended public key management module

Computes a public key from a derivation path

Calculates direct childs from a public key based on a given index

Extended public key deserialization module

Extended public key serialization module

Script manipulation module

Opcode behaviour, allowing execution and returning the opcode's integer value

Converts back and forts from script to opcode list

Adds between 1 and 75 bytes of data into the stack

Converts scripts into opcode lists

P2PKH helper that can issue scripts out of simple parameters

P2SH helper that can issue scripts out of simple parameters

P2WPKH helper that can issue scripts out of simple parameters

Truthness evaluator for script execution outcomes

Extracts a variable length integer from a binary

Extracts a keypair from a binary according to the specification

Extracts a keypair's key from a binary according to the specification

Extracts a keypair's value from a binary according to the specification

Extracts a Keypair list from from a binary according to the specification

Transform binaries into Transactions

Can convert a Transaction into binary formats

Tasks applied to a list of inputs

Tasks applied to a list of outputs

Signs transactions

A simplified version of a %BitcoinLib.Transaction that can be filled with human readable formats

A simplified version of a %BitcoinLib.Transaction.Input that can be filled with human readable formats

A simplified version of a %BitcoinLib.Transaction.Output that can be filled with human readable formats

Witness section of a P2SH-P2WPKH transaction