Merge pull request #1137 from gregdhill/chore/bitcoin-dep

chore: remove unused bitcoin code, cleanup deps, feature gate parser
interlay · Jul 24, 2023 · 66ef87c · 66ef87c
2 parents ac05c24 + 7df0652
commit 66ef87c
Show file tree

Hide file tree

Showing 17 changed files with 101 additions and 330 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/bitcoin/Cargo.toml b/crates/bitcoin/Cargo.toml
@@ -11,18 +11,15 @@ serde = { version = "1.0.130", default-features = false, features = ["derive"],
 impl-serde = { version = "0.3.1", default-features = false, optional = true }
 sha2 = { version = "0.8.2", default-features = false }
 hex = { version = "0.4.2", default-features = false }
+spin = { version = "0.7.1", default-features = false }
+primitive-types = { version = "0.12.1", default-features = false, features = ["codec", "scale-info"] }
 bitcoin_hashes = { version = "0.7.3", default-features = false }
 secp256k1 = { package = "secp256k1", git = "https://github.com/rust-bitcoin/rust-secp256k1", rev = "8e61874", default-features = false }
-spin = { version = "0.7.1", default-features = false }
-
-# Substrate dependencies
-sp-core = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.31", default-features = false }
-sp-std = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.31", default-features = false }
-frame-support = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.31", default-features = false }
 
 [dev-dependencies]
 mocktopus = "0.8.0"
 secp256k1 = { package = "secp256k1", git = "https://github.com/rust-bitcoin/rust-secp256k1", rev = "8e61874", default-features = false, features = ["rand-std"] }
+frame-support = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.31" }
 
 [features]
 default = ["std"]
@@ -33,10 +30,17 @@ std = [
 	"impl-serde",
 	"sha2/std",
 	"hex/alloc",
+	"primitive-types/std",
+	"primitive-types/serde",
 	"secp256k1/std",
-
-	"sp-core/std",
-	"sp-std/std",
-	"frame-support/std",
 ]
-runtime-benchmarks = []
+parser = []
+runtime-benchmarks = []
+
+[[example]]
+name = "parse-transaction"
+required-features = ["parser"]
+
+[[example]]
+name = "run-proof"
+required-features = ["parser"]
diff --git a/crates/bitcoin/README.md b/crates/bitcoin/README.md
@@ -25,7 +25,7 @@ To add this library to your crate, simply include the following in your crate's
 ```TOML
 [dependencies.bitcoin]
 default_features = false
-git = '../creates/bitcoin'
+git = '../crates/bitcoin'
 ```
 
 Update your crate's `std` feature to include this pallet:

diff --git a/crates/bitcoin/examples/parse-transaction.rs b/crates/bitcoin/examples/parse-transaction.rs
@@ -1,10 +1,7 @@
-extern crate bitcoin;
-extern crate hex;
+use bitcoin::parser::parse_transaction;
 
 const RAW_TRANSACTION: &str = "020000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff0502cb000101ffffffff02400606950000000017a91466c7060feb882664ae62ffad0051fe843e318e85870000000000000000266a24aa21a9ede5c17d15b8b1fa2811b7e6da66ffa5e1aaa05922c69068bf90cd585b95bb46750120000000000000000000000000000000000000000000000000000000000000000000000000";
 
-use bitcoin::parser::parse_transaction;
-
 fn main() {
     let raw_tx = hex::decode(RAW_TRANSACTION).unwrap();
     let tx = parse_transaction(&raw_tx).unwrap();

diff --git a/crates/bitcoin/examples/run-proof.rs b/crates/bitcoin/examples/run-proof.rs
@@ -1,5 +1,3 @@
-extern crate bitcoin;
-
 use bitcoin::{
     merkle::{MerkleProof, PartialTransactionProof},
     parser::parse_transaction,

diff --git a/crates/bitcoin/src/address.rs b/crates/bitcoin/src/address.rs
@@ -1,10 +1,12 @@
 use crate::{types::*, Error, Script};
 use bitcoin_hashes::{hash160::Hash as Hash160, Hash};
 use codec::{Decode, Encode, MaxEncodedLen};
+use primitive_types::{H160, H256};
 use scale_info::TypeInfo;
 use sha2::{Digest, Sha256};
-use sp_core::{H160, H256};
-use sp_std::vec::Vec;
+
+#[cfg(not(feature = "std"))]
+use alloc::vec::Vec;
 
 use secp256k1::{constants::PUBLIC_KEY_SIZE, Error as Secp256k1Error, PublicKey as Secp256k1PublicKey};
 
@@ -175,8 +177,10 @@ impl<'de> serde::Deserialize<'de> for PublicKey {
 }
 
 pub mod global {
+    #[cfg(not(feature = "std"))]
+    use alloc::{vec, vec::Vec};
+    use core::ops::Deref;
     use secp256k1::{ffi::types::AlignedType, AllPreallocated, Secp256k1};
-    use sp_std::{ops::Deref, vec, vec::Vec};
     // this is what lazy_static uses internally
     use spin::Once;
 

diff --git a/crates/bitcoin/src/formatter.rs b/crates/bitcoin/src/formatter.rs
@@ -1,5 +1,7 @@
-use sp_core::U256;
-use sp_std::{prelude::*, vec, vec::Vec};
+use primitive_types::U256;
+
+#[cfg(not(feature = "std"))]
+use alloc::{vec, vec::Vec};
 
 use crate::{merkle::MerkleProof, script::*, types::*, Error, GetCompact};
 

diff --git a/crates/bitcoin/src/lib.rs b/crates/bitcoin/src/lib.rs
@@ -19,9 +19,14 @@
 #![cfg_attr(test, feature(proc_macro_hygiene))]
 #![cfg_attr(not(feature = "std"), no_std)]
 
+#[cfg(not(feature = "std"))]
+extern crate alloc;
+
 #[cfg(test)]
 extern crate mocktopus;
 
+extern crate hex;
+
 mod error;
 pub use error::Error;
 
@@ -36,6 +41,8 @@ pub use script::Script;
 pub mod types;
 
 pub mod formatter;
+
+#[cfg(any(feature = "parser", test))]
 pub mod parser;
 
 pub mod utils;

diff --git a/crates/bitcoin/src/math.rs b/crates/bitcoin/src/math.rs
@@ -1,4 +1,4 @@
-use sp_core::U256;
+use primitive_types::U256;
 
 pub trait GetCompact {
     fn get_compact(self) -> Option<u32>;

diff --git a/crates/bitcoin/src/merkle.rs b/crates/bitcoin/src/merkle.rs
@@ -1,18 +1,16 @@
-#[cfg(test)]
-extern crate mocktopus;
-
-#[cfg(test)]
-use mocktopus::macros::mockable;
-
 use crate::{
-    parser::BytesParser,
-    types::{BlockHeader, CompactUint, H256Le, Transaction},
+    types::{BlockHeader, H256Le, Transaction},
     utils::hash256_merkle_step,
     Error,
 };
 use codec::{Decode, Encode};
 use scale_info::TypeInfo;
-use sp_std::prelude::*;
+
+#[cfg(any(feature = "parser", test))]
+use crate::{parser::BytesParser, types::CompactUint};
+
+#[cfg(not(feature = "std"))]
+use alloc::vec::Vec;
 
 // https://github.com/bitcoin/bitcoin/blob/78dae8caccd82cfbfd76557f1fb7d7557c7b5edb/src/consensus/consensus.h
 const MAX_BLOCK_WEIGHT: u32 = 4_000_000;
@@ -105,7 +103,6 @@ impl MerkleTree {
     }
 }
 
-#[cfg_attr(test, mockable)]
 impl PartialTransactionProof {
     /// Computes the merkle root of the proof partial merkle tree
     pub fn verify_proof(self) -> Result<ProofResult, Error> {
@@ -287,6 +284,7 @@ impl MerkleProof {
     /// # Arguments
     ///
     /// * `merkle_proof` - Raw bytes of the merkle proof
+    #[cfg(any(feature = "parser", test))]
     pub fn parse(merkle_proof: &[u8]) -> Result<MerkleProof, Error> {
         let mut proof_parser = BytesParser::new(merkle_proof);
         let block_header = proof_parser.parse()?;
@@ -319,8 +317,8 @@ mod tests {
 
     use super::*;
 
-    use sp_core::H256;
-    use sp_std::str::FromStr;
+    use primitive_types::H256;
+    use std::str::FromStr;
 
     // curl -s -H 'content-type: application/json' http://satoshi.doc.ic.ac.uk:8332 -d '{
     //   "jsonrpc": "1.0",