milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
Custom fork of rust-bitcoin with unsafe modifications for higher speed. Unsuitable for production.
528 Commits 1 Branch 0 Tags 21 MiB
Rust 99%
Shell 1%
Go to file
Carl Dong b88f00c698 Add bitcoin_hashes dependency, rename some features 
Because features and dependencies share the same namespace, and we want
to pass down the optional dependence on serde to bitcoin_hashes, we need
to rename the feature to something other than serde. Right now only
features can be passed down to dependencies.

Note that we could have also renamed the dependency to something like
serde-dep and kept the same feature name, however, dependency renaming
has only been available since cargo 0.27.0

Features that represent optional dependencies have been prefixed with
'use-'. The travis file has also been modified to conform to this
change.
 		2019-01-24 11:31:07 -05:00
fuzz Merge pull request #179 from apoelstra/2018-10-fuzz-outpoint 2018-12-03 18:18:13 +00:00
src Add bitcoin_hashes dependency, rename some features 2019-01-24 11:31:07 -05:00
.gitignore hfuzz: separate _workspace and _input directories, add workspace to .gitignore 2018-04-16 21:42:09 +00:00
.travis.yml Add bitcoin_hashes dependency, rename some features 2019-01-24 11:31:07 -05:00
CHANGELOG.md bump version to 0.16 2019-01-15 19:07:53 +00:00
Cargo.toml Add bitcoin_hashes dependency, rename some features 2019-01-24 11:31:07 -05:00
LICENSE Add LICENSE file with CC0 in it 2014-07-18 17:37:13 -07:00
README.md move README changelog stuff into CHANGELOG.md 2018-11-03 15:42:20 +00:00

README.md

Status

Rust Bitcoin Library

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

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)
  • 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-jsonrpc which uses the underlying strason library which parses decimal numbers as strings, preventing precision errors.

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.

Documentation

Currently the documentation is very sparse. Patches to add usage examples and to expand on existing docs would be extremely appreciated.

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