milksad

Custom fork of rust-bitcoin with unsafe modifications for higher speed. Unsuitable for production.

Go to file

Andrew Poelstra a898797b07 Merge rust-bitcoin/rust-bitcoin#924 : Improvements to taproot script iterator `3c59897598` Removed IntoIterator for TapTree implementation (Dr Maxim Orlovsky) `7a5482d23a` Rename LeafInfo into ScriptLeaf (Dr Maxim Orlovsky) `2b8d96581a` Rename TapTree::iter into TapTree::script_leaves (Dr Maxim Orlovsky) `6f871ba47d` Add convenience LeafInfo::depth method (Dr Maxim Orlovsky) `3c502ffc2d` Making all LeafInfo fields private (Dr Maxim Orlovsky) `d655ff3e93` Make TapTreeIterator use LeafInfo (Dr Maxim Orlovsky) `79345fcd02` LeafInfo field accessor methods (Dr Maxim Orlovsky) `5958466678` Make LeafInfo::leaf_hash public and change its name and return type (Dr Maxim Orlovsky) `c83893d497` Make taproot LeafInfo public (Dr Maxim Orlovsky) Pull request description: This PR makes existing taproot script iterator to iterate `LeafScript` values instead of constructed `(u8, &Script)`. First, this is more idiomatic (iterator should not construct value but iterate through real internal representation); second information about merkle path of the scripts is required for me downstream to implement OP_RETURN taproot commitments. The PR also removes unnecessary iterator type, replacing it with a slice iterator type from the core rust library. I am asking to include this PR into RC fix scope, since it is required downstream. ACKs for top commit: sanket1729: ACK `3c59897598`. Reviewed the range-diff with the post that I previously ACKed Tree-SHA512: 99e341443987204a8aba20869c750bd80a725f3d49d1b5731d554dff7377181b02a4517f8b390101afb2957135dbb255c6e360f90cadd6ee07b17eb14fd30af5		2022-04-20 01:33:37 +00:00
.github/workflows	Build the docs with test.sh	2022-03-09 08:18:48 +11:00
contrib	Build the docs with test.sh	2022-03-09 08:18:48 +11:00
embedded	Clean up embedded test memory configuration	2021-08-02 22:09:14 +02:00
examples	improve example: take hex-encoded seed instead of WIF in bip32 example	2022-01-10 06:59:49 +07:00
fuzz	Add fuzzing for Witness struct	2021-12-28 09:56:41 +01:00
logo	Add Rust-Bitcoin logo and project header.	2022-03-22 20:30:33 -06:00
src	Removed IntoIterator for TapTree implementation	2022-04-19 20:32:13 +02:00
test_data	Separate merge logic out of Map trait	2022-02-23 09:03:16 +00:00
.actrc	feat: Support running CI locally with `act`	2022-02-17 21:11:30 +01:00
.gitignore	Removed Intellij idea files from .gitignore	2020-10-11 21:51:03 -05:00
CHANGELOG.md	Remove misc whitespace	2022-03-28 10:42:22 -07:00
CONTRIBUTING.md	Use correct script name	2022-03-08 15:23:51 +11:00
Cargo.toml	rust-bitcoin 0.28.0-rc.2	2022-03-28 10:42:22 -07:00
LICENSE	Add LICENSE file with CC0 in it	2014-07-18 17:37:13 -07:00
README.md	Add Rust-Bitcoin logo and project header.	2022-03-22 20:30:33 -06:00
clippy.toml	Fixed a bunch of clippy lints, added clippy.toml	2021-12-21 22:50:13 +01:00
rustfmt.toml	Add a disabled rustfmt.toml	2022-01-21 10:00:46 +11:00

README.md

Rust Bitcoin

Library with support for de/serialization, parsing and executing on data-structures and network messages related to Bitcoin.

Lines of code

Documentation

Supports (or should support)

De/serialization of Bitcoin protocol network messages
De/serialization of blocks and transactions
Script de/serialization
Private keys and address creation, de/serialization and validation (including full BIP32 support)
PSBT creation, manipulation, merging and finalization
Pay-to-contract support as in Appendix A of the Blockstream sidechains whitepaper

For JSONRPC interaction with Bitcoin Core, it is recommended to use rust-bitcoincore-rpc.

Known limitations

Consensus

This library must not be used for consensus code (i.e. fully validating blockchain data). It technically supports doing this, but doing so is very ill-advised because there are many deviations, known and unknown, between this library and the Bitcoin Core reference implementation. In a consensus based cryptocurrency such as Bitcoin it is critical that all parties are using the same rules to validate data, and this library is simply unable to implement the same rules as Core.

Given the complexity of both C++ and Rust, it is unlikely that this will ever be fixed, and there are no plans to do so. Of course, patches to fix specific consensus incompatibilities are welcome.

Support for 16-bit pointer sizes

16-bit pointer sizes are not supported and we can't promise they will be. If you care about them please let us know, so we can know how large the interest is and possibly decide to support them.

Documentation

Currently can be found on docs.rs/bitcoin. Patches to add usage examples and to expand on existing docs would be extremely appreciated.

Contributing

Contributions are generally welcome. If you intend to make larger changes please discuss them in an issue before PRing them to avoid duplicate work and architectural mismatches. If you have any questions or ideas you want to discuss please join us in #bitcoin-rust on libera.chat.

Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features on Rust 1.29.

Because some dependencies have broken the build in minor/patch releases, to compile with 1.29.0 you will need to run the following version-pinning command:

cargo update -p cc --precise "1.0.41" --verbose

In order to use the use-serde feature or to build the unit tests with 1.29.0, the following version-pinning commands are also needed:

cargo update --package "serde" --precise "1.0.98"
cargo update --package "serde_derive" --precise "1.0.98"

For the feature base64 to work with 1.29.0 we also need to pin byteorder:

cargo update -p byteorder --precise "1.3.4"

Installing Rust

Rust can be installed using your package manager of choice or rustup.rs. The former way is considered more secure since it typically doesn't involve trust in the CA system. But you should be aware that the version of Rust shipped by your distribution might be out of date. Generally this isn't a problem for rust-bitcoin since we support much older versions than the current stable one (see MSRV section).

Building

The library can be built and tested using cargo:

git clone git@github.com:rust-bitcoin/rust-bitcoin.git
cd rust-bitcoin
cargo build

You can run tests with:

cargo test

Please refer to the cargo documentation for more detailed instructions.

Pull Requests

Every PR needs at least two reviews to get merged. During the review phase maintainers and contributors are likely to leave comments and request changes. Please try to address them, otherwise your PR might get closed without merging after a longer time of inactivity. If your PR isn't ready for review yet please mark it by prefixing the title with WIP: .

CI Pipeline

The CI pipeline requires approval before being run on each MR.

In order to speed up the review process the CI pipeline can be run locally using act. The fuzz and Cross jobs will be skipped when using act due to caching being unsupported at this time. We do not actively support act but will merge PRs fixing act issues.

Policy on Altcoins/Altchains

Patches which add support for non-Bitcoin cryptocurrencies by adding constants to existing enums (e.g. to set the network message magic-byte sequence) are welcome. Anything more involved will be considered on a case-by-case basis, as the altcoin landscape includes projects which frequently appear and disappear, and are poorly designed anyway and keeping the codebase maintainable is a large priority.

In general, things that improve cross-chain compatibility (e.g. support for cross-chain atomic swaps) are more likely to be accepted than things which support only a single blockchain.

Release Notes

See CHANGELOG.md.

Licensing

The code in this project is licensed under the Creative Commons CC0 1.0 Universal license.