bitcoinsv/lib.rs
1//! Bitcoin SV library for Rust.
2//!
3//! This library is a work in progress. It is intended to provide a full featured library for using Bitcoin SV
4//! in Rust applications at the infrastructure level. It is not intended to be a wallet or a client.
5//!
6//! This library is opinionated, in the sense that it does not stick to convention; the library presents
7//! a view of Bitcoin that is possibly different from the norm. The library is not a translation of some
8//! other more established library, it is a re-write from ground level principles.
9//!
10//! * the library defines [BlockchainId] to distinguish between "mainnet", "testnet",
11//! etc, not "networks". The key feature that distinguishes these blockchains is the genesis block
12//! not the network. The P2P network is just a means for software to communicate, it does not define
13//! the blockchain.
14//!
15//! * the library will probably never support old versions of Bitcoin. Support for old versions is dead
16//! code and will be removed as quickly as possible.
17//!
18//! [BlockchainId]: crate::bitcoin::BlockchainId
19
20/// Functionality related to the core of Bitcoin SV. Transactions, Block Headers, etc.
21pub mod bitcoin;
22
23/// Utility functions.
24pub mod util;
25
26mod result;
27pub use result::{Error, Result};