ckb-devrel · EthanYuan · Nov 9, 2023 · Dec 7, 2023 · Jan 9, 2024 · Dec 2, 2024
diff --git a/Cargo-minimal.lock b/Cargo-minimal.lock
@@ -32,7 +32,7 @@ dependencies = [
 
 [[package]]
 name = "bitcoin"
-version = "0.31.0"
+version = "0.31.1"
 dependencies = [
  "base64",
  "bech32",

diff --git a/Cargo-recent.lock b/Cargo-recent.lock
@@ -31,7 +31,7 @@ dependencies = [
 
 [[package]]
 name = "bitcoin"
-version = "0.31.0"
+version = "0.31.1"
 dependencies = [
  "base64",
  "bech32",

diff --git a/README.md b/README.md
@@ -1,220 +1,15 @@
-<div align="center">
-  <h1>Rust Bitcoin</h1>
+## Rust Dogecoin
 
-  <img alt="Rust Bitcoin logo by Hunter Trujillo, see license and source files under /logo" src="./logo/rust-bitcoin.png" width="300" />
+This project is a fork of [rust-bitcoin](./rust-bitcoin.md), modified to support [Dogecoin] SPV (Simplified Payment Verification) on [CKB] (Nervos Blockchain). It retains most of the original rust-bitcoin functionality, with the following specific changes:
 
-  <p>Library with support for de/serialization, parsing and executing on data-structures
-    and network messages related to Bitcoin.
-  </p>
+- Dogecoin Header Deserialization: Modifications to handle the deserialization of Dogecoin headers.
+- AuxPow Validation: Added logic to validate AuxPow (Auxiliary Proof-of-Work) as required by Dogecoin.
 
-  <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="CC0 1.0 Universal Licensed" src="https://img.shields.io/badge/license-CC0--1.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/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>
-    <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>
-    <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>
-  </p>
-</div>
+## Projects Using This Library
 
-[Documentation](https://docs.rs/bitcoin/)
+- [ckb-dogecoin-spv](https://github.com/ckb-devrel/ckb-dogecoin-spv)
+- [ckb-dogecoin-spv-service](https://github.com/ckb-devrel/ckb-dogecoin-spv-service)
 
-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](https://docs.rs/miniscript/latest/miniscript/psbt/index.html) to finalize.
-
-For JSONRPC interaction with Bitcoin Core, it is recommended to use
-[rust-bitcoincore-rpc](https://github.com/rust-bitcoin/rust-bitcoincore-rpc).
-
-It is recommended to always use [cargo-crev](https://github.com/crev-dev/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](https://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](https://web.libera.chat/?channel=#bitcoin-rust) on
-[libera.chat](https://libera.chat).
-
-For more information please see `./CONTRIBUTING.md`.
-
-## Minimum Supported Rust Version (MSRV)
-
-This library should always compile with any combination of features on **Rust 1.48.0**.
-
-To build with the MSRV you will likely need to pin a bunch of dependencies, see `./contrib/test.sh`
-for the current list.
-
-## External dependencies
-
-We integrate with a few external libraries, most notably `serde`. These
-are available via feature flags. To ensure compatibility and MSRV stability we
-provide two lock files as a means of inspecting compatible versions:
-`Cargo-minimal.lock` containing minimal versions of dependencies and
-`Cargo-recent.lock` containing recent versions of dependencies tested in our CI.
-
-We do not provide any guarantees about the content of these lock files outside
-of "our CI didn't fail with these versions". Specifically, we do not guarantee
-that the committed hashes are free from malware. It is your responsibility to
-review them.
-
-## Installing Rust
-
-Rust can be installed using your package manager of choice or [rustup.rs](https://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 cargo feature `std` is enabled by default. At least one of the features `std` or `no-std` or
-both must be enabled.
-
-Enabling the `no-std` feature does not disable `std`. To disable the `std` feature you must disable
-default features. The `no-std` feature only enables additional features required for this crate to
-be usable without `std`. Both can be enabled without conflict.
-
-The library can be built and tested using [`cargo`](https://github.com/rust-lang/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](https://doc.rust-lang.org/stable/cargo/) for more
-detailed instructions.
-
-### Just
-
-We support [`just`](https://just.systems/man/en/) for running dev workflow commands. Run `just` from
-your shell to see list available sub-commands.
-
-### 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'
-```
-
-## Testing
-
-Unit and integration tests are available for those interested, along with benchmarks. For project
-developers, especially new contributors looking for something to work on, we do:
-
-- Fuzz testing with [`Hongfuzz`](https://github.com/rust-fuzz/honggfuzz-rs)
-- Mutation testing with [`Mutagen`](https://github.com/llogiq/mutagen)
-- Code verification with [`Kani`](https://github.com/model-checking/kani)
-
-There are always more tests to write and more bugs to find, contributions to our testing efforts
-extremely welcomed. Please consider testing code a first class citizen, we definitely do take PRs
-improving and cleaning up test code.
-
-### Unit/Integration tests
-
-Run as for any other Rust project `cargo test --all-features`.
-
-### 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`.
-
-### Mutation tests
-
-We have started doing mutation testing with [mutagen](https://github.com/llogiq/mutagen). To run
-these tests first install the latest dev version with `cargo +nightly install --git https://github.com/llogiq/mutagen`
-then run with `RUSTFLAGS='--cfg=mutate' cargo +nightly mutagen`.
-
-### Code verification
-
-We have started using [kani](https://github.com/model-checking/kani), install with `cargo install --locked kani-verifier`
- (no need to run `cargo kani setup`). Run the tests with `cargo kani`.
-
-## 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](https://github.com/nektos/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
-
-Since the altcoin landscape includes projects which [frequently appear and disappear, and are poorly
-designed anyway](https://download.wpsoftware.net/bitcoin/alts.pdf) we do not support any altcoins.
-Supporting Bitcoin properly is already difficult enough and we do not want to increase the
-maintenance burden and decrease API stability by adding support for other coins.
-
-Our code is public domain so by all means fork it and go wild :)
-
-
-## Release Notes
-
-Release notes are done per crate, see:
-
-- [bitcoin CHANGELOG](bitcoin/CHANGELOG.md)
-- [hashes CHANGELOG](hashes/CHANGELOG.md)
-- [internals CHANGELOG](internals/CHANGELOG.md)
-
-
-## Licensing
-
-The code in this project is licensed under the [Creative Commons CC0 1.0 Universal license](LICENSE).
-We use the [SPDX license list](https://spdx.org/licenses/) and [SPDX IDs](https://spdx.dev/ids/).
+[Dogecoin]: https://dogecoin.org
+[Bitcoin]: https://bitcoin.org
+[CKB]: https://github.com/nervosnetwork/ckb
diff --git a/bitcoin/CHANGELOG.md b/bitcoin/CHANGELOG.md
@@ -1,4 +1,9 @@
-# 0.31.1 - 2023-10-18
+# 0.31.1 - 2024-01-09
+
+- Fix bug in `FeeRate::checked_mul_by_weight` [#2128](https://github.com/rust-bitcoin/rust-bitcoin/pull/2182)
+- Add BIP-32 types remove in 0.31 back in and mark as deprecated [#2258](https://github.com/rust-bitcoin/rust-bitcoin/pull/2258)
+
+# 0.31.0 - 2023-10-18
 
 - Bump MSRV to Rust 1.48.0 [#1729](https://github.com/rust-bitcoin/rust-bitcoin/pull/1729)
 - Add new example code for signature verification [#1776](https://github.com/rust-bitcoin/rust-bitcoin/pull/1776)

diff --git a/bitcoin/Cargo.toml b/bitcoin/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bitcoin"
-version = "0.31.0"
+version = "0.31.1"
 authors = ["Andrew Poelstra <apoelstra@wpsoftware.net>"]
 license = "CC0-1.0"
 repository = "https://github.com/rust-bitcoin/rust-bitcoin/"
@@ -40,6 +40,7 @@ bech32 = { version = "0.10.0-beta", default-features = false }
 hashes = { package = "bitcoin_hashes", version = "0.13.0", default-features = false }
 secp256k1 = { version = "0.28.0", default-features = false, features = ["hashes"] }
 hex_lit = "0.1.1"
+scrypt = { version = "0.11", default-features = false, features = ["simple"] }
 
 base64 = { version = "0.21.3", optional = true }
 # Only use this feature for no-std builds, otherwise use bitcoinconsensus-std.

diff --git a/bitcoin/src/bip32.rs b/bitcoin/src/bip32.rs
@@ -36,6 +36,14 @@ const VERSION_BYTES_TESTNETS_PUBLIC: [u8; 4] = [0x04, 0x35, 0x87, 0xCF];
 /// Version bytes for extended private keys on any of the testnet networks.
 const VERSION_BYTES_TESTNETS_PRIVATE: [u8; 4] = [0x04, 0x35, 0x83, 0x94];
 
+/// The old name for xpub, extended public key.
+#[deprecated(since = "0.31.0", note = "use xpub instead")]
+pub type ExtendendPubKey = Xpub;
+
+/// The old name for xpriv, extended public key.
+#[deprecated(since = "0.31.0", note = "use xpriv instead")]
+pub type ExtendendPrivKey = Xpriv;
+
 /// A chain code
 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct ChainCode([u8; 32]);

diff --git a/bitcoin/src/blockdata/block.rs b/bitcoin/src/blockdata/block.rs
@@ -122,7 +122,7 @@ impl fmt::Debug for Header {
 #[derive(Copy, PartialEq, Eq, Clone, Debug, PartialOrd, Ord, Hash)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
-pub struct Version(i32);
+pub struct Version(pub i32);
 
 impl Version {
     /// The original Bitcoin Block v1.
@@ -433,15 +433,21 @@ pub enum ValidationError {
     BadProofOfWork,
     /// The `target` field of a block header did not match the expected difficulty.
     BadTarget,
+    /// No auxpow on block with auxpow version.
+    BadVersion,
+    /// The block has an invalid auxpow.
+    BadAuxPow(String),
 }
 
 impl fmt::Display for ValidationError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         use ValidationError::*;
 
-        match *self {
+        match self {
             BadProofOfWork => f.write_str("block target correct but not attained"),
             BadTarget => f.write_str("block target incorrect"),
+            BadVersion => f.write_str("block version incorrect"),
+            BadAuxPow(msg) => write!(f, "block has invalid auxpow: {}", msg),
         }
     }
 }
@@ -452,7 +458,7 @@ impl std::error::Error for ValidationError {
         use self::ValidationError::*;
 
         match *self {
-            BadProofOfWork | BadTarget => None,
+            BadProofOfWork | BadTarget | BadVersion | BadAuxPow(_) => None,
         }
     }
 }

diff --git a/bitcoin/src/blockdata/fee_rate.rs b/bitcoin/src/blockdata/fee_rate.rs
@@ -82,10 +82,12 @@ impl FeeRate {
 
     /// Checked weight multiplication.
     ///
-    /// Computes `self * rhs` where rhs is of type Weight. `None` is returned if an overflow
-    /// occurred.
+    /// Computes the absolute fee amount for a given [`Weight`] at this fee rate.
+    ///
+    /// `None` is returned if an overflow occurred.
     pub fn checked_mul_by_weight(self, rhs: Weight) -> Option<Amount> {
-        self.0.checked_mul(rhs.to_wu()).map(Amount::from_sat)
+        let sats = self.0.checked_mul(rhs.to_wu())?.checked_add(999)? / 1000;
+        Some(Amount::from_sat(sats))
     }
 
     /// Calculates fee by multiplying this fee rate by weight, in weight units, returning `None`
@@ -95,13 +97,14 @@ impl FeeRate {
     ///
     /// # Examples
     ///
-    /// ```no_run
+    /// ```
     /// # use bitcoin::{absolute, transaction, FeeRate, Transaction};
     /// # // Dummy transaction.
     /// # let tx = Transaction { version: transaction::Version::ONE, lock_time: absolute::LockTime::ZERO, input: vec![], output: vec![] };
     ///
     /// let rate = FeeRate::from_sat_per_vb(1).expect("1 sat/vbyte is valid");
-    /// let fee = rate.fee_wu(tx.weight());
+    /// let fee = rate.fee_wu(tx.weight()).unwrap();
+    /// assert_eq!(fee.to_sat(), tx.vsize() as u64);
     /// ```
     pub fn fee_wu(self, weight: Weight) -> Option<Amount> { self.checked_mul_by_weight(weight) }
 
@@ -209,12 +212,20 @@ mod tests {
 
     #[test]
     fn checked_weight_mul_test() {
-        let weight = Weight::from_wu(10);
-        let fee: Amount = FeeRate(10).checked_mul_by_weight(weight).expect("expected Amount");
+        let weight = Weight::from_vb(10).unwrap();
+        let fee: Amount = FeeRate::from_sat_per_vb(10)
+            .unwrap()
+            .checked_mul_by_weight(weight)
+            .expect("expected Amount");
         assert_eq!(Amount::from_sat(100), fee);
 
         let fee = FeeRate(10).checked_mul_by_weight(Weight::MAX);
         assert!(fee.is_none());
+
+        let weight = Weight::from_vb(3).unwrap();
+        let fee_rate = FeeRate::from_sat_per_vb(3).unwrap();
+        let fee = fee_rate.checked_mul_by_weight(weight).unwrap();
+        assert_eq!(Amount::from_sat(9), fee);
     }
 
     #[test]