11<div align =" center " >
2- <h1 >Rust Bitcoin</h1 >
3-
4- <img alt =" Rust Bitcoin logo by Hunter Trujillo, see license and source files under /logo " src =" ./logo/rust-bitcoin.png " width =" 300 " />
2+ <h1 >Rust Coordinate</h1 >
53
64 <p >Library with support for de/serialization, parsing and executing on data-structures
7- and network messages related to Bitcoin.
8- </p >
9-
10- <p >
11- <a href="https://crates.io/crates/bitcoin"><img alt="Crate Info" src="https://img.shields.io/crates/v/bitcoin.svg"/></a>
12- <a href="https://github.com/rust-bitcoin/rust-bitcoin/blob/master/LICENSE"><img alt="CC0 1.0 Universal Licensed" src="https://img.shields.io/badge/license-CC0--1.0-blue.svg"/></a>
13- <a href="https://github.com/rust-bitcoin/rust-bitcoin/actions?query=workflow%3AContinuous%20integration"><img alt="CI Status" src="https://github.com/rust-bitcoin/rust-bitcoin/workflows/Continuous%20integration/badge.svg"></a>
14- <a href="https://docs.rs/bitcoin"><img alt="API Docs" src="https://img.shields.io/badge/docs.rs-bitcoin-green"/></a>
15- <a href="https://blog.rust-lang.org/2020/02/27/Rust-1.48.0.html"><img alt="Rustc Version 1.48.0+" src="https://img.shields.io/badge/rustc-1.48.0%2B-lightgrey.svg"/></a>
16- <a href="https://gnusha.org/bitcoin-rust/"><img alt="Chat on IRC" src="https://img.shields.io/badge/irc-%23bitcoin--rust%20on%20libera.chat-blue"></a>
17- <a href="https://github.com/model-checking/kani"><imp alt="kani" src="https://github.com/rust-bitcoin/rust-bitcoin/actions/workflows/kani.yaml/badge.svg"></a>
5+ and network messages related to Coordinate.
186 </p >
197</div >
208
@@ -28,9 +16,6 @@ Supports (or should support)
2816* Private keys and address creation, de/serialization and validation (including full BIP32 support)
2917* PSBT v0 de/serialization and all but the Input Finalizer role. Use [ rust-miniscript] ( https://docs.rs/miniscript/latest/miniscript/psbt/index.html ) to finalize.
3018
31- For JSONRPC interaction with Bitcoin Core, it is recommended to use
32- [ rust-bitcoincore-rpc] ( https://github.com/rust-bitcoin/rust-bitcoincore-rpc ) .
33-
3419It is recommended to always use [ cargo-crev] ( https://github.com/crev-dev/cargo-crev ) to verify the
3520trustworthiness of each of your dependencies, including this one.
3621
@@ -57,15 +42,6 @@ please let us know, so we can know how large the interest is and possibly decide
5742Currently can be found on [ docs.rs/bitcoin] ( https://docs.rs/bitcoin/ ) . Patches to add usage examples
5843and to expand on existing docs would be extremely appreciated.
5944
60- ## Contributing
61-
62- Contributions are generally welcome. If you intend to make larger changes please discuss them in an
63- issue before PRing them to avoid duplicate work and architectural mismatches. If you have any
64- questions or ideas you want to discuss please join us in
65- [ #bitcoin-rust] ( https://web.libera.chat/?channel=#bitcoin-rust ) on
66- [ libera.chat] ( https://libera.chat ) .
67-
68- For more information please see ` ./CONTRIBUTING.md ` .
6945
7046## Minimum Supported Rust Version (MSRV)
7147
@@ -74,19 +50,6 @@ This library should always compile with any combination of features on **Rust 1.
7450To build with the MSRV you will likely need to pin a bunch of dependencies, see ` ./contrib/test.sh `
7551for the current list.
7652
77- ## External dependencies
78-
79- We integrate with a few external libraries, most notably ` serde ` . These
80- are available via feature flags. To ensure compatibility and MSRV stability we
81- provide two lock files as a means of inspecting compatible versions:
82- ` Cargo-minimal.lock ` containing minimal versions of dependencies and
83- ` Cargo-recent.lock ` containing recent versions of dependencies tested in our CI.
84-
85- We do not provide any guarantees about the content of these lock files outside
86- of "our CI didn't fail with these versions". Specifically, we do not guarantee
87- that the committed hashes are free from malware. It is your responsibility to
88- review them.
89-
9053## Installing Rust
9154
9255Rust can be installed using your package manager of choice or [ rustup.rs] ( https://rustup.rs ) . The
@@ -195,23 +158,6 @@ git config --local core.hooksPath githooks/
195158
196159Alternatively add symlinks in your ` .git/hooks ` directory to any of the githooks we provide.
197160
198- ## Policy on Altcoins/Altchains
199-
200- Since the altcoin landscape includes projects which [ frequently appear and disappear, and are poorly
201- designed anyway] ( https://download.wpsoftware.net/bitcoin/alts.pdf ) we do not support any altcoins.
202- Supporting Bitcoin properly is already difficult enough and we do not want to increase the
203- maintenance burden and decrease API stability by adding support for other coins.
204-
205- Our code is public domain so by all means fork it and go wild :)
206-
207-
208- ## Release Notes
209-
210- Release notes are done per crate, see:
211-
212- - [ bitcoin CHANGELOG] ( bitcoin/CHANGELOG.md )
213- - [ hashes CHANGELOG] ( hashes/CHANGELOG.md )
214- - [ internals CHANGELOG] ( internals/CHANGELOG.md )
215161
216162
217163## Licensing
0 commit comments