milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Merge rust-bitcoin/rust-bitcoin#2855: bitcoin: Update crate level docs 

4bb9240992 bitcoin: Add comment to manifest (Tobin C. Harding)
c6c70a721e bitcoin: Update feature docs (Tobin C. Harding)
7712e5d891 bitcoin: Use 100 colum width in crate level docs (Tobin C. Harding)

Pull request description:

  Update stale crate level docs in `bitcoin`. Done as two separate patches so the last one is trivial to review, whitespace only.

ACKs for top commit:
  Kixunil:
    ACK 4bb9240992
  apoelstra:
    ACK 4bb9240992

Tree-SHA512: b9d5474f7e7a0576f535df428ea20084acbcb74d0576e7f2934c547dd2c54f4a939d73ec547b3b254105a45c2372113c65ce136be1eabd63701259a3a6de3737
This commit is contained in:
merge-script 2024-07-06 13:02:56 +00:00
parent 1c96da080d 4bb9240992
commit 59a3b2b683
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
2 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
bitcoin/Cargo.toml
View File

@ -13,6 +13,7 @@ edition = "2021"
rust-version = "1.56.1" rust-version = "1.56.1"
exclude = ["tests", "contrib"] exclude = ["tests", "contrib"]
# If you change features or optional dependencies in any way please update the "# Cargo features" section in lib.rs as well.
[features] [features]
default = [ "std", "secp-recovery" ] default = [ "std", "secp-recovery" ]
std = ["base58/std", "bech32/std", "hashes/std", "hex/std", "internals/std", "io/std", "secp256k1/std", "units/std"] std = ["base58/std", "bech32/std", "hashes/std", "hex/std", "internals/std", "io/std", "secp256k1/std", "units/std"]

40
bitcoin/src/lib.rs
View File

@ -2,32 +2,30 @@
//! # Rust Bitcoin Library //! # Rust Bitcoin Library
//! //!
//! This is a library that supports the Bitcoin network protocol and associated //! This is a library that supports the Bitcoin network protocol and associated primitives. It is
//! primitives. It is designed for Rust programs built to work with the Bitcoin //! designed for Rust programs built to work with the Bitcoin network.
//! network.
//! //!
//! Except for its dependency on libsecp256k1 (and optionally libbitcoinconsensus), //! Except for its dependency on libsecp256k1 (and optionally libbitcoinconsensus), this library is
//! this library is written entirely in Rust. It illustrates the benefits of //! written entirely in Rust. It illustrates the benefits of strong type safety, including ownership
//! strong type safety, including ownership and lifetime, for financial and/or cryptographic software. //! and lifetime, for financial and/or cryptographic software.
//! //!
//! See README.md for detailed documentation about development and supported //! See README.md for detailed documentation about development and supported environments.
//! environments.
//! //!
//! ## Available feature flags //! # Cargo features
//! //!
//! * `std` - the usual dependency on `std` (default). //! * `base64` (dependency) - enables encoding of PSBTs and message signatures.
//! * `secp-recovery` - enables calculating public key from a signature and message. //! * `bitcoinconsensus` (dependency) - enables validating scripts and transactions.
//! * `base64` - (dependency), enables encoding of PSBTs and message signatures. //! * `bitcoinconsensus-std` - same as `bitcoinconsensus` but also enables `std` here and in the
//! * `rand` - (dependency), makes it more convenient to generate random values. //! `bitcoinconsensus` crate. Additionally, enables returning
//! * `serde` - (dependency), implements `serde`-based serialization and //! `bitcoinconsensus::Error` from `std::error::Error::source()`.
//! deserialization. //! * `default` - enables `std` and `secp-recovery`.
//! * `ordered` (dependency) - adds implementations of `ArbitraryOrd` to some structs.
//! * `rand` (transitive dependency) - makes it more convenient to generate random values.
//! * `rand-std` - same as `rand` but also enables `std` here and in `secp256k1`.
//! * `serde` (dependency) - implements `serde`-based serialization and deserialization.
//! * `secp-lowmemory` - optimizations for low-memory devices. //! * `secp-lowmemory` - optimizations for low-memory devices.
//! * `bitcoinconsensus-std` - enables `std` in `bitcoinconsensus` and communicates it //! * `secp-recovery` - enables calculating public key from a signature and message.
//! to this crate so it knows how to implement //! * `std` - the usual dependency on `std`.
//! `std::error::Error`. At this time there's a hack to
//! achieve the same without this feature but it could
//! happen the implementations diverge one day.
//! * `ordered` - (dependency), adds implementations of `ArbitraryOrdOrd` to some structs.
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)] #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
// Experimental features we need. // Experimental features we need.