Crate bitcoin

source · [−]
Expand description

Rust Bitcoin Library

This is a library that supports the Bitcoin network protocol and associated primitives. It is designed for Rust programs built to work with the Bitcoin network.

It is also written entirely in Rust to illustrate the benefits of strong type safety, including ownership and lifetime, for financial and/or cryptographic software.

See README.md for detailed documentation about development and supported environments.

Available feature flags

  • std - the usual dependency on std (default).
  • secp-recovery - enables calculating public key from a signature and message.
  • base64 - (dependency), enables encoding of PSBTs and message signatures.
  • rand - (dependency), makes it more convenient to generate random values.
  • serde - (dependency), implements serde-based serialization and deserialization.
  • secp-lowmemory - optimizations for low-memory devices.
  • no-std - enables additional features required for this crate to be usable without std. Does not disable std. Depends on hashbrown and core2.

Re-exports

pub use bitcoin_hashes as hashes;
pub use secp256k1;
pub use bech32;
pub use crate::blockdata::block::Block;
pub use crate::blockdata::block::BlockHeader;
pub use crate::blockdata::locktime;
pub use crate::blockdata::locktime::LockTime;
pub use crate::blockdata::locktime::PackedLockTime;
pub use crate::blockdata::script::Script;
pub use crate::blockdata::transaction::SigHashType;
Deprecated
pub use crate::blockdata::transaction::EcdsaSighashType;
pub use crate::blockdata::transaction::OutPoint;
pub use crate::blockdata::transaction::Sequence;
pub use crate::blockdata::transaction::Transaction;
pub use crate::blockdata::transaction::TxIn;
pub use crate::blockdata::transaction::TxOut;
pub use crate::blockdata::witness::Witness;
pub use crate::consensus::encode::VarInt;
pub use crate::hash_types::*;
pub use crate::network::constants::Network;
pub use crate::util::address::Address;
pub use crate::util::address::AddressType;
pub use crate::util::amount::Amount;
pub use crate::util::amount::Denomination;
pub use crate::util::amount::SignedAmount;
pub use crate::util::ecdsa;
pub use crate::util::ecdsa::EcdsaSig;
pub use crate::util::ecdsa::EcdsaSigError;
pub use crate::util::key::PrivateKey;
pub use crate::util::key::PublicKey;
pub use crate::util::merkleblock::MerkleBlock;
pub use crate::util::schnorr;
pub use crate::util::schnorr::SchnorrSig;
pub use crate::util::schnorr::SchnorrSigError;
pub use crate::util::sighash::SchnorrSighashType;
pub use crate::util::psbt;
pub use crate::util::Error;

Modules

blockdata

Bitcoin block data.

consensus

Bitcoin consensus.

error

Contains error types and other error handling tools.

hash_types

Bitcoin hash types.

network

Bitcoin network support.

policy

Bitcoin policy.

util

Utility functions.

Macros

impl_parse_str_through_int

Implements FromStr and TryFrom<{&str, String, Box<str>}> for $to using parse::int, mapping the output using fn

impl_std_error

Impls std::error::Error for the specified type with appropriate attributes, possibly returning source.

impl_tryfrom_str_through_int_single

Implements TryFrom<$from> for $to using parse::int, mapping the output using fn

Structs

KeyPair

Opaque data structure that holds a keypair consisting of a secret and a public key.

XOnlyPublicKey

An x-only public key, used for verification of Schnorr signatures and serialized according to BIP-340.