Merge pull request #7 from chaintope/tapyrus_chain_crate

tapyrify the chain crate

Author: Yamaguchi

.github/workflows/code_coverage.yml

@@ -38,8 +38,12 @@ jobs:
           python-version: '3.9'
       - name: Install python dependencies
         run: pip install hwi==2.1.1 protobuf==3.20.1
-      - name: Test
+      - name: Test Chain
+        working-directory: ./crates/chain
         run: cargo test --all-features
+      - name: "[Pending]Test"
+#        run: cargo test --all-features
+        run: echo "Pending other crates"
       - name: Make coverage directory
         run: mkdir coverage
       - name: Run grcov

.github/workflows/cont_integration.yml

@@ -14,7 +14,7 @@ jobs:
             clippy: true
           - version: 1.63.0 # MSRV
         features:
-          - --no-default-features
+          - --no-default-features --features tapyrus/no-std,miniscript/no-std,hashbrown
           - --all-features
     steps:
       - name: checkout
@@ -35,10 +35,18 @@ jobs:
           cargo update -p home --precise "0.5.5"
           cargo update -p proptest --precise "1.2.0"
           cargo update -p url --precise "2.5.0"
-      - name: Build
+      - name: Build Chain
+        working-directory: ./crates/chain
         run: cargo build ${{ matrix.features }}
-      - name: Test
+      - name: "[Pending]Build"
+        run: echo "Pending other crates"
+#        run: cargo build ${{ matrix.features }}
+      - name: Test Chain
+        working-directory: ./crates/chain
         run: cargo test ${{ matrix.features }}
+      - name: "[Pending]Test"
+        run: echo "Pending other crates"
+#        run: cargo test ${{ matrix.features }}
 
   check-no-std:
     name: Check no_std
@@ -58,15 +66,17 @@ jobs:
       - name: Check bdk_chain
         working-directory: ./crates/chain
         # TODO "--target thumbv6m-none-eabi" should work but currently does not
-        run: cargo check --no-default-features --features bitcoin/no-std,miniscript/no-std,hashbrown
-      - name: Check bdk wallet
+        run: cargo check --no-default-features --features tapyrus/no-std,miniscript/no-std,hashbrown
+      - name: "[Pending]Check bdk wallet"
         working-directory: ./crates/wallet
         # TODO "--target thumbv6m-none-eabi" should work but currently does not
-        run: cargo check --no-default-features --features bitcoin/no-std,miniscript/no-std,bdk_chain/hashbrown
-      - name: Check esplora
+        run: echo "Pending"
+#        run: cargo check --no-default-features --features tapyrus/no-std,miniscript/no-std,bdk_chain/hashbrown
+      - name: "[Pending]Check esplora"
         working-directory: ./crates/esplora
         # TODO "--target thumbv6m-none-eabi" should work but currently does not
-        run: cargo check --no-default-features --features bitcoin/no-std,miniscript/no-std,bdk_chain/hashbrown
+        run: echo "Pending"
+#        run: cargo check --no-default-features --features tapyrus/no-std,miniscript/no-std,bdk_chain/hashbrown
 
   check-wasm:
     name: Check WASM
@@ -90,12 +100,14 @@ jobs:
             target: "wasm32-unknown-unknown"
       - name: Rust Cache
         uses: Swatinem/[email protected]
-      - name: Check bdk wallet
+      - name: "[Pending]Check bdk wallet"
         working-directory: ./crates/wallet
-        run: cargo check --target wasm32-unknown-unknown --no-default-features --features bitcoin/no-std,miniscript/no-std,bdk_chain/hashbrown,dev-getrandom-wasm
-      - name: Check esplora
+        run: echo "Pending"
+#        run: cargo check --target wasm32-unknown-unknown --no-default-features --features tapyrus/no-std,miniscript/no-std,bdk_chain/hashbrown,dev-getrandom-wasm
+      - name: "[Pending]Check esplora"
         working-directory: ./crates/esplora
-        run: cargo check --target wasm32-unknown-unknown --no-default-features --features bitcoin/no-std,miniscript/no-std,bdk_chain/hashbrown,async
+        run: echo "Pending"
+#        run: cargo check --target wasm32-unknown-unknown --no-default-features --features tapyrus/no-std,miniscript/no-std,bdk_chain/hashbrown,async
 
   fmt:
     name: Rust fmt
@@ -127,4 +139,10 @@ jobs:
       - uses: actions-rs/clippy-check@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all-features --all-targets -- -D warnings
+          args: --manifest-path crates/chain/Cargo.toml --all-features --all-targets -- -D warnings
+#      - uses: actions-rs/clippy-check@v1
+#        with:
+#          token: ${{ secrets.GITHUB_TOKEN }}
+#          args: --all-features --all-targets -- -D warnings
+      - name: "[Pending]Clippy"
+        run: echo "Pending other crates"

.github/workflows/nightly_docs.yml

@@ -18,40 +18,16 @@ jobs:
       - name: Rust Cache
         uses: Swatinem/[email protected]
       - name: Build docs
+        working-directory: ./crates/chain
         run: cargo doc --no-deps
         env:
           RUSTDOCFLAGS: '--cfg docsrs -Dwarnings'
+#      - name: Build docs
+#        run: cargo doc --no-deps
+#        env:
+#          RUSTDOCFLAGS: '--cfg docsrs -Dwarnings'
       - name: Upload artifact
         uses: actions/upload-artifact@v2
         with:
           name: built-docs
           path: ./target/doc/*
-
-  publish_docs:
-    name: 'Publish docs'
-    if: github.ref == 'refs/heads/master'
-    needs: [build_docs]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout `bitcoindevkit.org`
-        uses: actions/checkout@v2
-        with:
-          ssh-key: ${{ secrets.DOCS_PUSH_SSH_KEY }}
-          repository: bitcoindevkit/bitcoindevkit.org
-          ref: master
-      - name: Create directories
-        run: mkdir -p ./docs/.vuepress/public/docs-rs/bdk/nightly
-      - name: Remove old latest
-        run: rm -rf ./docs/.vuepress/public/docs-rs/bdk/nightly/latest
-      - name: Download built docs
-        uses: actions/download-artifact@v1
-        with:
-          name: built-docs
-          path: ./docs/.vuepress/public/docs-rs/bdk/nightly/latest
-      - name: Configure git
-        run: git config user.email "[email protected]" && git config user.name "github-actions"
-      - name: Commit
-        continue-on-error: true         # If there's nothing to commit this step fails, but it's fine
-        run: git add ./docs/.vuepress/public/docs-rs && git commit -m "Publish autogenerated nightly docs"
-      - name: Push
-        run: git push origin master

crates/chain/Cargo.toml

@@ -14,18 +14,18 @@ readme = "README.md"
 
 [dependencies]
 # For no-std, remember to enable the bitcoin/no-std feature
-bitcoin = { version = "0.31.0", default-features = false }
+tapyrus = { git = "https://github.com/chaintope/rust-tapyrus", branch = "update_on_bitcoin_0.31.x", default-features = false, subdirectory = "tapyrus" }
 serde_crate = { package = "serde", version = "1", optional = true, features = ["derive", "rc"] }
 
 # Use hashbrown as a feature flag to have HashSet and HashMap from it.
 hashbrown = { version = "0.9.1", optional = true, features = ["serde"] }
-miniscript = { version = "11.0.0", optional = true, default-features = false }
+miniscript = { git = "https://github.com/chaintope/rust-miniscript", branch = "master", optional = true, default-features = false }
 
 [dev-dependencies]
 rand = "0.8"
 proptest = "1.2.0"
 
 [features]
 default = ["std", "miniscript"]
-std = ["bitcoin/std", "miniscript?/std"]
-serde = ["serde_crate", "bitcoin/serde", "miniscript?/serde"]
+std = ["tapyrus/std", "miniscript?/std"]
+serde = ["serde_crate", "tapyrus/serde", "miniscript?/serde"]

crates/chain/src/chain_data.rs

@@ -1,4 +1,4 @@
-use bitcoin::{hashes::Hash, BlockHash, OutPoint, TxOut, Txid};
+use tapyrus::{hashes::Hash, BlockHash, OutPoint, TxOut, Txid};
 
 use crate::{Anchor, AnchorFromBlockPosition, COINBASE_MATURITY};
 
@@ -110,7 +110,7 @@ impl Anchor for BlockId {
 }
 
 impl AnchorFromBlockPosition for BlockId {
-    fn from_block_position(_block: &bitcoin::Block, block_id: BlockId, _tx_pos: usize) -> Self {
+    fn from_block_position(_block: &tapyrus::Block, block_id: BlockId, _tx_pos: usize) -> Self {
         block_id
     }
 }
@@ -176,7 +176,7 @@ impl Anchor for ConfirmationHeightAnchor {
 }
 
 impl AnchorFromBlockPosition for ConfirmationHeightAnchor {
-    fn from_block_position(_block: &bitcoin::Block, block_id: BlockId, _tx_pos: usize) -> Self {
+    fn from_block_position(_block: &tapyrus::Block, block_id: BlockId, _tx_pos: usize) -> Self {
         Self {
             anchor_block: block_id,
             confirmation_height: block_id.height,
@@ -216,7 +216,7 @@ impl Anchor for ConfirmationTimeHeightAnchor {
 }
 
 impl AnchorFromBlockPosition for ConfirmationTimeHeightAnchor {
-    fn from_block_position(block: &bitcoin::Block, block_id: BlockId, _tx_pos: usize) -> Self {
+    fn from_block_position(block: &tapyrus::Block, block_id: BlockId, _tx_pos: usize) -> Self {
         Self {
             anchor_block: block_id,
             confirmation_height: block_id.height,

crates/chain/src/descriptor_ext.rs

@@ -2,7 +2,7 @@ use crate::{
     alloc::{string::ToString, vec::Vec},
     miniscript::{Descriptor, DescriptorPublicKey},
 };
-use bitcoin::hashes::{hash_newtype, sha256, Hash};
+use tapyrus::hashes::{hash_newtype, sha256, Hash};
 
 hash_newtype! {
     /// Represents the ID of a descriptor, defined as the sha256 hash of
@@ -32,7 +32,7 @@ impl DescriptorExt for Descriptor<DescriptorPublicKey> {
             .expect("descriptor can't have hardened derivation")
             .script_pubkey()
             .dust_value()
-            .to_sat()
+            .to_tap()
     }
 
     fn descriptor_id(&self) -> DescriptorId {

crates/chain/src/example_utils.rs

@@ -1,6 +1,6 @@
 #![allow(unused)]
 use alloc::vec::Vec;
-use bitcoin::{
+use tapyrus::{
     consensus,
     hashes::{hex::FromHex, Hash},
     Transaction,
@@ -19,7 +19,7 @@ pub fn tx_from_hex(s: &str) -> Transaction {
 }
 
 pub fn new_hash<H: Hash>(s: &str) -> H {
-    <H as bitcoin::hashes::Hash>::hash(s.as_bytes())
+    <H as tapyrus::hashes::Hash>::hash(s.as_bytes())
 }
 
 pub fn new_block_id(height: u32, hash: &str) -> BlockId {

crates/chain/src/indexed_tx_graph.rs

@@ -1,7 +1,7 @@
 //! Contains the [`IndexedTxGraph`] and associated types. Refer to the
 //! [`IndexedTxGraph`] documentation for more.
 use alloc::vec::Vec;
-use bitcoin::{Block, OutPoint, Transaction, TxOut, Txid};
+use tapyrus::{Block, OutPoint, Transaction, TxOut, Txid};
 
 use crate::{
     tx_graph::{self, TxGraph},

crates/chain/src/keychain.rs

@@ -12,7 +12,7 @@
 
 #[cfg(feature = "miniscript")]
 mod txout_index;
-use bitcoin::Amount;
+use tapyrus::Amount;
 #[cfg(feature = "miniscript")]
 pub use txout_index::*;
 

crates/chain/src/keychain/txout_index.rs

@@ -5,11 +5,11 @@ use crate::{
     spk_iter::BIP32_MAX_INDEX,
     DescriptorExt, DescriptorId, SpkIterator, SpkTxOutIndex,
 };
-use bitcoin::{hashes::Hash, Amount, OutPoint, Script, SignedAmount, Transaction, TxOut, Txid};
 use core::{
     fmt::Debug,
     ops::{Bound, RangeBounds},
 };
+use tapyrus::{hashes::Hash, Amount, OutPoint, Script, SignedAmount, Transaction, TxOut, Txid};
 
 use crate::Append;
 
@@ -149,10 +149,10 @@ const DEFAULT_LOOKAHEAD: u32 = 25;
 ///
 /// let mut txout_index = KeychainTxOutIndex::<MyKeychain>::default();
 ///
-/// # let secp = bdk_chain::bitcoin::secp256k1::Secp256k1::signing_only();
-/// # let (external_descriptor,_) = Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, "tr([73c5da0a/86'/0'/0']xprv9xgqHN7yz9MwCkxsBPN5qetuNdQSUttZNKw1dcYTV4mkaAFiBVGQziHs3NRSWMkCzvgjEe3n9xV8oYywvM8at9yRqyaZVz6TYYhX98VjsUk/0/*)").unwrap();
-/// # let (internal_descriptor,_) = Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, "tr([73c5da0a/86'/0'/0']xprv9xgqHN7yz9MwCkxsBPN5qetuNdQSUttZNKw1dcYTV4mkaAFiBVGQziHs3NRSWMkCzvgjEe3n9xV8oYywvM8at9yRqyaZVz6TYYhX98VjsUk/1/*)").unwrap();
-/// # let (descriptor_42, _) = Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, "tr([73c5da0a/86'/0'/0']xprv9xgqHN7yz9MwCkxsBPN5qetuNdQSUttZNKw1dcYTV4mkaAFiBVGQziHs3NRSWMkCzvgjEe3n9xV8oYywvM8at9yRqyaZVz6TYYhX98VjsUk/2/*)").unwrap();
+/// # let secp = bdk_chain::tapyrus::secp256k1::Secp256k1::signing_only();
+/// # let (external_descriptor,_) = Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, "pkh([73c5da0a/86'/0'/0']xprv9xgqHN7yz9MwCkxsBPN5qetuNdQSUttZNKw1dcYTV4mkaAFiBVGQziHs3NRSWMkCzvgjEe3n9xV8oYywvM8at9yRqyaZVz6TYYhX98VjsUk/0/*)").unwrap();
+/// # let (internal_descriptor,_) = Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, "pkh([73c5da0a/86'/0'/0']xprv9xgqHN7yz9MwCkxsBPN5qetuNdQSUttZNKw1dcYTV4mkaAFiBVGQziHs3NRSWMkCzvgjEe3n9xV8oYywvM8at9yRqyaZVz6TYYhX98VjsUk/1/*)").unwrap();
+/// # let (descriptor_42, _) = Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, "pkh([73c5da0a/86'/0'/0']xprv9xgqHN7yz9MwCkxsBPN5qetuNdQSUttZNKw1dcYTV4mkaAFiBVGQziHs3NRSWMkCzvgjEe3n9xV8oYywvM8at9yRqyaZVz6TYYhX98VjsUk/2/*)").unwrap();
 /// let _ = txout_index.insert_descriptor(MyKeychain::External, external_descriptor);
 /// let _ = txout_index.insert_descriptor(MyKeychain::Internal, internal_descriptor);
 /// let _ = txout_index.insert_descriptor(MyKeychain::MyAppUser { user_id: 42 }, descriptor_42);
@@ -248,7 +248,7 @@ impl<K: Clone + Ord + Debug> Indexer for KeychainTxOutIndex<K> {
         }
     }
 
-    fn index_tx(&mut self, tx: &bitcoin::Transaction) -> Self::ChangeSet {
+    fn index_tx(&mut self, tx: &tapyrus::Transaction) -> Self::ChangeSet {
         let mut changeset = super::ChangeSet::<K>::default();
         for (op, txout) in tx.output.iter().enumerate() {
             changeset.append(self.index_txout(OutPoint::new(tx.txid(), op as u32), txout));
@@ -270,7 +270,7 @@ impl<K: Clone + Ord + Debug> Indexer for KeychainTxOutIndex<K> {
         self.apply_changeset(changeset)
     }
 
-    fn is_tx_relevant(&self, tx: &bitcoin::Transaction) -> bool {
+    fn is_tx_relevant(&self, tx: &tapyrus::Transaction) -> bool {
         self.inner.is_relevant(tx)
     }
 }