API Reference BitcoinLib v0.2.0-pre1
modules
Modules
High level bitcoin operations
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
Bitcoin address management
Can parse derivation paths string format into a native format
A derivation path is composed of levels of childrens, which have integer values and can be hardened
Single purpose module that aims to simplify DerivationPath by isolating string parsing business logic
Single purpose module that's responsible to transform a list of integer into a DerivationPath values structure
Computing entropy from different sources, mostly for mnemonic seed 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
Compute a mnemonic seed from a private key
Checksum needed to generate a mnemonic seed
A list of all the words that can be contained in a private key seed
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
Converts public keys into Bitcoin addresses of different formats
Implementation of Bech32 addresses
Implementation of P2PKH addresses
Implementation of P2SH-P2WPKH addresses
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
Bitcoin Public Key Hash module
Script manipulation module
Based on that table https://i.stack.imgur.com/iXfVX.png
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
Script execution outcomes are based on this https://learnmeabitcoin.com/technical/script#what-makes-a-script-valid
P2PKH helper that can issue scripts out of simple parameters
P2SH 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
Can convert a Transaction into binary formats
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