Merge upstream

.github/workflows/rust.yml

@@ -24,6 +24,7 @@ jobs:
               DO_BENCH: true
               AS_DEPENDENCY: true
               DO_NO_STD: true
+              DO_DOCS: true
           - rust: 1.29.0
             env:
               AS_DEPENDENCY: true
@@ -82,20 +83,6 @@ jobs:
       - name: run cross test
         run: cross test --target s390x-unknown-linux-gnu
 
-  Docs:
-    name: Docs
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Crate
-        uses: actions/checkout@v2
-      - name: Checkout Toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-      - name: Create Doc
-        run: cargo doc
   Embedded:
     runs-on: ubuntu-latest
     steps:

CHANGELOG.md

@@ -13,7 +13,7 @@
 
 The previous release changed the behavior of `Display` for `ChildNumber`, assuming that any correct usage would not be
 affected. [Issue 608](https://github.com/rust-bitcoin/rust-bitcoin/issues/608) goes into the details of why this isn't
-the case and how we broke both `rust-miniscript` and BDK. 
+the case and how we broke both `rust-miniscript` and BDK.
 
 # 0.26.1 - 2021-06-06 (yanked, see explanation above)
 

CONTRIBUTING.md

@@ -128,7 +128,7 @@ PR authors may also find it useful to run the following script locally in order
 to check that each of the commits within the PR satisfies the requirements
 above, before submitting the PR to review:
 ```shell script
-BITCOIN_MSRV=1.29.0 ./contrib/ci.sh
+BITCOIN_MSRV=1.29.0 ./contrib/test.sh
 ```
 Please replace the value in `BITCOIN_MSRV=1.29.0` with the current MSRV from
 [README.md].

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bitcoin"
-version = "0.28.0-rc.1"
+version = "0.28.0-rc.2"
 authors = ["Andrew Poelstra <[email protected]>"]
 license = "CC0-1.0"
 homepage = "https://github.com/rust-bitcoin/rust-bitcoin/"
@@ -36,7 +36,7 @@ rustdoc-args = ["--cfg", "docsrs"]
 [dependencies]
 bech32 = { version = "0.8.1", default-features = false }
 bitcoin_hashes = { version = "0.10.0", default-features = false }
-secp256k1 = { version = "0.21.2", default-features = false }
+secp256k1 = { version = "0.22.0", default-features = false }
 core2 = { version = "0.3.0", optional = true, default-features = false }
 
 base64-compat = { version = "1.0.0", optional = true }
@@ -47,7 +47,7 @@ hashbrown = { version = "0.8", optional = true }
 [dev-dependencies]
 serde_json = "<1.0.45"
 serde_test = "1"
-secp256k1 = { version = "0.21.2", features = [ "recovery", "rand-std" ] }
+secp256k1 = { version = "0.22.0", features = [ "recovery", "rand-std" ] }
 bincode = "1.3.1"
 # We need to pin ryu (transitive dep from serde_json) to stay compatible with Rust 1.22.0
 ryu = "<1.0.5"

README.md

@@ -1,10 +1,23 @@
-![Continuous integration](https://github.com/rust-bitcoin/rust-bitcoin/workflows/Continuous%20integration/badge.svg)
-[![Safety Dance](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
+<div align="center">
+  <h1>Rust Bitcoin</h1>
 
-# Rust Bitcoin Library
+  <img alt="Rust Bitcoin logo by Hunter Trujillo, see license and source files under /logo" src="./logo/rust-bitcoin.png" width="300" />
+
+  <p>Library with support for de/serialization, parsing and executing on data-structures
+    and network messages related to Bitcoin.
+  </p>
+
+  <p>
+    <a href="https://crates.io/crates/bitcoin"><img alt="Crate Info" src="https://img.shields.io/crates/v/bitcoin.svg"/></a>
+    <a href="https://github.com/rust-bitcoin/rust-bitcoin/blob/master/LICENSE"><img alt="MIT or Apache-2.0 Licensed" src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg"/></a>
+    <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>
+    <a href="https://docs.rs/bitcoin"><img alt="API Docs" src="https://img.shields.io/badge/docs.rs-bitcoin-green"/></a>
+    <a href="https://blog.rust-lang.org/2018/09/13/Rust-1.29.html"><img alt="Rustc Version 1.29+" src="https://img.shields.io/badge/rustc-1.29%2B-lightgrey.svg"/></a>
+    <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>
+    <img alt="Lines of code" src="https://img.shields.io/tokei/lines/github/rust-bitcoin/rust-bitcoin">
+  </p>
+</div>
 
-Library with support for de/serialization, parsing and executing on data
-structures and network messages related to Bitcoin.
 
 [Documentation](https://docs.rs/bitcoin/)
 
@@ -104,7 +117,7 @@ You can run tests with:
 cargo test
 ```
 
-Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/) for more detailed instructions. 
+Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/) for more detailed instructions.
 
 ## Pull Requests
 

contrib/test.sh

@@ -37,27 +37,27 @@ cargo test --verbose
 
 if [ "$DO_NO_STD" = true ]
 then
-echo "********* Testing no-std build *************"
-  # Build no_std, to make sure that cfg(test) doesn't hide any issues
-  cargo build --verbose --features="no-std" --no-default-features
+    echo "********* Testing no-std build *************"
+    # Build no_std, to make sure that cfg(test) doesn't hide any issues
+    cargo build --verbose --features="no-std" --no-default-features
 
-  # Build std + no_std, to make sure they are not incompatible
-  cargo build --verbose --features="no-std"
+    # Build std + no_std, to make sure they are not incompatible
+    cargo build --verbose --features="no-std"
 
-  # Test no_std
-  cargo test --verbose --features="no-std" --no-default-features
+    # Test no_std
+    cargo test --verbose --features="no-std" --no-default-features
 
-  # Build all features
-  cargo build --verbose --features="no-std $FEATURES" --no-default-features
+    # Build all features
+    cargo build --verbose --features="no-std $FEATURES" --no-default-features
 
-  # Build specific features
-  for feature in ${FEATURES}
-  do
-      cargo build --verbose --features="no-std $feature"
-  done
+    # Build specific features
+    for feature in ${FEATURES}
+    do
+        cargo build --verbose --features="no-std $feature"
+    done
 
-  cargo run --example bip32 7934c09359b234e076b9fa5a1abfd38e3dc2a9939745b7cc3c22a48d831d14bd
-  cargo run --no-default-features --features no-std --example bip32 7934c09359b234e076b9fa5a1abfd38e3dc2a9939745b7cc3c22a48d831d14bd
+    cargo run --example bip32 7934c09359b234e076b9fa5a1abfd38e3dc2a9939745b7cc3c22a48d831d14bd
+    cargo run --no-default-features --features no-std --example bip32 7934c09359b234e076b9fa5a1abfd38e3dc2a9939745b7cc3c22a48d831d14bd
 fi
 
 # Test each feature
@@ -67,6 +67,11 @@ do
     cargo test --verbose --features="$feature"
 done
 
+# Build the docs if told to (this only works with the nightly toolchain)
+if [ "$DO_DOCS" = true ]; then
+    RUSTDOCFLAGS="--cfg docsrs" cargo doc --all --features="$FEATURES"
+fi
+
 # Fuzz if told to
 if [ "$DO_FUZZ" = true ]
 then

logo/README.md

@@ -0,0 +1,32 @@
+# Rust Bitcoin Logo
+
+## Files
+
+Included are:
+
+- [rust-bitcoin-inkscape.svg](./rust-bitcoin-inkscape.svg) - The Inkscape source file with the things used to make the logo in case adjustments are desired
+- [rust-bitcoin-optimized.svg](./rust-bitcoin-optimized.svg) - An optimized SVG for embedding or rendering at any size desired
+- [rust-bitcoin.png](./rust-bitcoin.png) - The PNG logo rendered at 300px used by this project
+- [rust-bitcoin-large.png](./rust-bitcoin-large.png) - A larger size 1024px x 1024px for convenience for embedding in presentations
+
+## Author
+
+Hunter Trujillo, @cryptoquick on [Twitter](https://twitter.com/cryptoquick), [GitHub](https://github.com/cryptoquick), and Telegram.
+
+## License
+
+Licensed in the public domain under [CC0 1.0 Universal Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/), and the author of this work rescinds all claims to copyright or coercion or acts of force from any nation state over this work for any purpose
+
+Bitcoin Logo is licensed under the CC Public Domain Dedication: <https://bitcoin.stackexchange.com/a/53422> and <https://bitcointalk.org/index.php?topic=1631.0>
+
+Rust Logo is licensed under CC-BY, which allows reuse and modifications for any purpose, as long as distributors give appropriate credit and indicate changes have been made. See here: <https://www.rust-lang.org/policies/media-guide>
+
+## Acknowledgements
+
+Acknowledgement for the runners up in this PR: https://github.com/rust-bitcoin/rust-bitcoin/pull/891#issuecomment-1074476858
+
+In particular, the Rust Bitcoin Wizard gear was an incredibly inspired piece of art. Also, the meshed gears design was beloved by some but not all.
+
+Thank you to the Rust Bitcoin maintainers and community, your timely responses and guidance was appreciated.
+
+Also, thank you to the voters on the Rust in Bitcoin Telegram group: <https://t.me/rust_in_bitcoin/321>.