milksad

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

Go to file

Andrew Poelstra 1d0b0e6ed8 Merge rust-bitcoin/rust-bitcoin#1323 : [blockdata::Witness] New Features: Index<usize>, nth(index), and get_tapscript `3c0d5aed73` Add get_tapscript to Witness (junderw) `4226d60205` Add Index<usize> and nth(index) to Witness (junderw) Pull request description: Ref: https://github.com/rust-bitcoin/rust-bitcoin/pull/672#issuecomment-980636502 [Add Index<usize> and nth(index) to Witness](`4226d60205`) [`4226d60`](`4226d60205`) Arbitrary indexing into Witness fixes the API of last and second_to_last to be more flexible. This patch started off as an addition of third_to_last, but ended up evolving into arbitrary indexing to allow for future use cases. A list of the indices of the start byte for each witness element is stored as an ordered contiguous group of u32s represented as 4 bytes each in the Vec<u8> contents. The bytes are stored using to_ne_bytes for performance reasons. A helper function is added to the tests to allow for easier contruction of the contents Vec in test vectors. u32 was chosen because 22 bits are needed to store 4,000,000 which is the maximum weight limit for a block. This might need to be reworked in the event of consensus limits increasing, but u32 can hold 1000x the current limit, so it should be fine for the forseeable future. The push and consensus_deserialize functions utilize rotate_left and rotate_right to move the indices to the end of the new allocation. Depending on the size of the data, this might be more of a performance hit than just allocating a new temporary Vec to store the indices and append them after parsing is completed. However, for a majority of cases rotating the indices should be faster. Suggestions to use VecDeque instead of Vec for contents necessitate other considerations, since it is not a public facing change, those optimizations can be dealt with in future patches. The Index<usize> trait is implemented using the new nth method with expect. The Iter struct is reworked to make use of the new data representation. This new data structure makes it trivial to implement DoubleEndedIterator and other such traits, but I have decided to leave this as out of scope for this patch. --- [Add get_tapscript to Witness](`a7501d9599`) [a7501d9](`a7501d9599`) This new method will check the last witness element to see if it starts with 0x50, and depending on the result it will return the second to last or third to last witness element according to BIP341. In its current state, Witness can not know what type of script it is fulfilling, so it is up to the caller to verify if the previous output is a taproot output or not. --- Edit: This is the previous PR body: > In a taproot script payment with annex, quick access to the 3rd to last element (which is the actual script in this case) is convenient. > > This feels like kicking the can down the road again, but I think it's a nice to have method. > > RCasatta dr-orlovsky were discussing this issue. I would like to ask if they have any thoughts on the addition of this. ACKs for top commit: tcharding: ACK `3c0d5aed73` apoelstra: ACK `3c0d5aed73` Kixunil: ACK `3c0d5aed73` Tree-SHA512: 0038eed6ad56786b8dd6d98db0d1846753b8b25de0bc1089cdc75d5850d0ccc66dde9a10be7fe09589ad7db118fd50ee9f7993695968df5c389457ccfcdaa761		2022-11-07 21:43:27 +00:00
.github/workflows	Add Target and Difficulty types	2022-09-28 04:16:59 +10:00
bitcoin	Merge rust-bitcoin/rust-bitcoin#1323 : [blockdata::Witness] New Features: Index<usize>, nth(index), and get_tapscript	2022-11-07 21:43:27 +00:00
contrib	Add a workspace to the top level directory.	2022-09-13 08:44:57 +10:00
embedded	Add a workspace to the top level directory.	2022-09-13 08:44:57 +10:00
fuzz	Move amount module out of util	2022-10-21 10:16:49 +11:00
githooks	Add clippy to pre-commit githook	2022-06-23 16:18:28 +10:00
internals	Remove into_bytes from impl_array_newtype	2022-11-05 06:57:40 +11:00
logo	Add Rust-Bitcoin logo and project header.	2022-03-22 20:30:33 -06:00
.actrc	feat: Support running CI locally with `act`	2022-02-17 21:11:30 +01:00
.gitignore	Fix `no_std` MSRV	2022-04-25 11:14:41 -05:00
CHANGELOG.md	Add a CHANGELOG entry for 0.28.2	2022-11-02 00:19:26 +00:00
CONTRIBUTING.md	Merge rust-bitcoin/rust-bitcoin#1125 : Update docs on rustfmt	2022-09-14 13:34:49 +00:00
Cargo.toml	Introduce bitcoin-internals crate	2022-09-13 08:59:57 +10:00
LICENSE	Add LICENSE file with CC0 in it	2014-07-18 17:37:13 -07:00
README.md	Remove stale MSRV docs	2022-07-26 11:04:45 +10:00
clippy.toml	Update MSRV in clippy.toml	2022-04-26 10:39:40 +02:00
rustfmt.toml	Add a workspace to the top level directory.	2022-09-13 08:44:57 +10: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 v0 de/serialization and all but the Input Finalizer role. Use rust-miniscript to finalize.

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

It is recommended to always use cargo-crev to verify the trustworthiness of each of your dependencies, including this one.

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.

For more information please see ./CONTRIBUTING.md.

Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features (minus no-std) on Rust 1.41.1 or Rust 1.47 with no-std.

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.

Building the docs

We build docs with the nightly toolchain, you may wish to use the following shell alias to check your documentation changes build correctly.

alias build-docs='RUSTDOCFLAGS="--cfg docsrs" cargo +nightly rustdoc --features="$FEATURES" -- -D rustdoc::broken-intra-doc-links'

Running benchmarks

We use a custom Rust compiler configuration conditional to guard the bench mark code. To run the bench marks use: RUSTFLAGS='--cfg=bench' cargo +nightly bench.

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.

Githooks

To assist devs in catching errors before running CI we provide some githooks. If you do not already have locally configured githooks you can use the ones in this repository by running, in the root directory of the repository:

git config --local core.hooksPath githooks/

Alternatively add symlinks in your .git/hooks directory to any of the githooks we provide.

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. We use the SPDX license list and SPDX IDs.