# Packages
No description provided by the author
# Functions
AssembleSpvProof assembles a proof that a given transaction was included in the blockchain and has accumulated the required number of confirmations.
ComputeHash computes the Hash for the provided data.
ExtractPublicKeyHash extracts the public key hash from a P2WPKH or P2PKH script.
GetScriptType gets the ScriptType of the given Script.
NewHash creates a new Hash instance using the given byte slice.
NewHashFromString creates a new Hash instance using the given string.
NewScriptFromVarLenData construct a Script instance based on the provided variable length data prepended with a CompactSizeUint.
NewTransactionBuilder constructs a new TransactionBuilder instance.
No description provided by the author
No description provided by the author
PayToPublicKeyHash constructs a P2PKH script for the provided 20-byte public key hash.
PayToScriptHash constructs a P2SH script for the provided 20-byte script hash.
PayToWitnessPublicKeyHash constructs a P2WPKH script for the provided 20-byte public key hash.
PayToWitnessScriptHash constructs a P2WSH script for the provided 32-byte witness script hash.
PublicKeyHash constructs the 20-byte public key hash by applying SHA-256 then RIPEMD-160 on the provided ECDSA public key.
ScriptHash constructs the 20-byte script hash by applying SHA-256 then RIPEMD-160 on the provided Script.
WitnessScriptHash constructs the 32-byte witness script hash by applying single SHA-256 on the provided Script.
# Constants
BlockHeaderByteLength is the byte length of a serialized block header.
HashByteLength is the byte length of the Hash type.
InternalByteOrder represents the internal byte order used by the Bitcoin protocol.
Bitcoin networks enumeration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Bitcoin networks enumeration.
ReversedByteOrder represents the "human" byte order.
Standard is the traditional transaction serialization format [version][inputs][outputs][locktime].
Bitcoin networks enumeration.
Bitcoin networks enumeration.
Witness is the witness transaction serialization format [version][marker][flag][inputs][outputs][witness][locktime] introduced by BIP-0141.
# Structs
BlockHeader represents the header of a Bitcoin block.
SignatureContainer is a helper type holding signature data.
SpvProof contains data required to perform a proof that a given transaction was included in the Bitcoin blockchain.
Transaction represents a Bitcoin transaction.
TransactionBuilder is a component that is responsible for the whole transaction creation process.
TransactionFeeEstimator is a component allowing to estimate the total fee for the given transaction virtual size.
TransactionInput represents a Bitcoin transaction input.
TransactionMerkleProof holds information about the merkle branch to a confirmed transaction.
TransactionOutpoint represents a Bitcoin transaction outpoint.
TransactionOutput represents a Bitcoin transaction output.
TransactionSizeEstimator is a component allowing to estimate the size of a Bitcoin transaction of the provided shape, without constructing it.
UnspentTransactionOutput represents an unspent output (UTXO) of a Bitcoin transaction.
# Interfaces
Chain defines an interface meant to be used for interaction with the Bitcoin chain.
# Type aliases
ByteOrder represents the byte order used by the Bitcoin byte arrays.
CompactSizeUint is a documentation type that is supposed to capture the details of the Bitcoin's CompactSize Unsigned Integer.
Hash represents the double SHA-256 of some arbitrary data using the InternalByteOrder.
Network is a type used for Bitcoin networks enumeration.
Script represents an arbitrary Bitcoin script, NOT prepended with the byte-length of the script.
ScriptType represents the possible types of Script.
TransactionSerializationFormat represents the Bitcoin transaction serialization format.