Merge pull request #39 from EthanYuan/support-signet

feat: support btc chain type signet

Cargo.toml

@@ -40,7 +40,7 @@ ckb-hash          = "0.115.0-rc2"
 [dependencies.ckb-bitcoin-spv-verifier]
 version = "0.1.0"
 git = "https://github.com/ckb-cell/ckb-bitcoin-spv"
-rev = "a6fce4b"
+rev = "bfc71d7"
 
 [features]
 default = ["default-tls"]

src/cli/init.rs

@@ -4,7 +4,7 @@ use std::{collections::HashMap, path::PathBuf};
 
 use bitcoin::blockdata::constants::DIFFCHANGE_INTERVAL;
 use ckb_bitcoin_spv_verifier::{
-    constants::FLAG_DISABLE_DIFFICULTY_CHECK,
+    constants::{FLAG_CHAIN_TYPE_MAINNET, FLAG_CHAIN_TYPE_SIGNET, FLAG_CHAIN_TYPE_TESTNET},
     types::{core::Hash as BitcoinHash, packed, prelude::Pack as VPack},
 };
 use ckb_jsonrpc_types::TransactionView;
@@ -31,7 +31,7 @@ use ckb_types::{
     prelude::*,
     H256,
 };
-use clap::{Args as ClapArgs, Parser};
+use clap::{Args as ClapArgs, Parser, ValueEnum};
 use secp256k1::SecretKey;
 
 use crate::{
@@ -78,14 +78,9 @@ pub struct Args {
     #[clap(flatten)]
     pub(crate) spv_owner: super::SpvOwner,
 
-    /// Disable the on-chain difficulty check.
-    ///
-    /// ### Warning
-    ///
-    /// For testing purpose only.
-    /// Do NOT enable this flag in production environment.
+    /// Bitcoin chain type.
     #[arg(long)]
-    pub(crate) disable_difficulty_check: bool,
+    pub(crate) bitcoin_chain_type: BitcoinChainType,
 
     /// Perform all steps without sending.
     #[arg(long, hide = true)]
@@ -104,14 +99,22 @@ pub struct CodeHash {
     pub(crate) spv_contract_type_hash: Option<H256>,
 }
 
+#[derive(Clone, PartialEq, ValueEnum)]
+pub enum BitcoinChainType {
+    Mainnet,
+    Testnet,
+    Signet,
+}
+
 impl Args {
     // TODO Split this method into several smaller methods.
     pub fn execute(&self) -> Result<()> {
         log::info!("Try to initialize a Bitcoin SPV instance on CKB");
 
-        if self.disable_difficulty_check && self.ckb.network == NetworkType::Mainnet {
-            let msg = "For safety, the option `self.disable_difficulty_check` \
-                are not allowed on the mainnet";
+        if self.bitcoin_chain_type != BitcoinChainType::Mainnet
+            && self.ckb.network == NetworkType::Mainnet
+        {
+            let msg = "The Bitcoin chain type is not mainnet, but the CKB network is mainnet";
             return Err(Error::other(msg));
         }
 
@@ -182,8 +185,10 @@ impl Args {
             let type_id_array = calculate_type_id(input0.cell_input(), cells_count);
             let type_id = BitcoinHash::from_bytes_ref(&type_id_array);
             let mut flags = 0u8;
-            if self.disable_difficulty_check {
-                flags |= FLAG_DISABLE_DIFFICULTY_CHECK;
+            match self.bitcoin_chain_type {
+                BitcoinChainType::Mainnet => flags |= FLAG_CHAIN_TYPE_MAINNET,
+                BitcoinChainType::Testnet => flags |= FLAG_CHAIN_TYPE_TESTNET,
+                BitcoinChainType::Signet => flags |= FLAG_CHAIN_TYPE_SIGNET,
             }
             let args = packed::SpvTypeArgs::new_builder()
                 .type_id(type_id.pack())

src/cli/serve.rs

@@ -181,6 +181,7 @@ impl Args {
                     let (spv_client, spv_update) = storage.generate_spv_client_and_spv_update(
                         spv_tip_height,
                         self.spv_headers_update_limit,
+                        input.info.get_flags()?,
                     )?;
 
                     let tx_hash =
@@ -193,8 +194,11 @@ impl Args {
 
                     let spv_tip_height = input.curr.client.headers_mmr_root.max_height;
 
-                    let (spv_client, spv_update) = storage
-                        .generate_spv_client_and_spv_update(spv_tip_height, NonZeroU32::MAX)?;
+                    let (spv_client, spv_update) = storage.generate_spv_client_and_spv_update(
+                        spv_tip_height,
+                        NonZeroU32::MAX,
+                        input.info.get_flags()?,
+                    )?;
 
                     let tx_hash =
                         self.reorg_spv_cells(&spv_service, input, spv_client, spv_update)?;

src/components/ckb_client.rs

@@ -60,6 +60,24 @@ impl SpvInfoCell {
             0
         }
     }
+
+    pub(crate) fn get_flags(&self) -> Result<u8> {
+        let script_args = self
+            .cell
+            .output
+            .type_()
+            .to_opt()
+            .ok_or_else(|| Error::other("the SPV info cell has no type script"))?
+            .args();
+        let script_args_slice = script_args.as_reader().raw_data();
+        let args = packed::SpvTypeArgsReader::from_slice(script_args_slice).map_err(|err| {
+            let msg =
+                format!("failed to parse the type script args for the SPV info cell since {err}");
+            Error::other(msg)
+        })?;
+        let flags: u8 = args.flags().into();
+        Ok(flags)
+    }
 }
 
 pub trait CkbRpcClientExtension {

src/components/storage/prelude.rs

@@ -153,6 +153,7 @@ pub(crate) trait BitcoinSpvStorage: InternalBitcoinSpvStorage {
         &self,
         prev_height: u32,
         limit: NonZeroU32,
+        flags: u8,
     ) -> Result<(SpvClient, packed::SpvUpdate)> {
         let mut tip_height = self.get_tip_bitcoin_height()?;
         if tip_height > prev_height.saturating_add(limit.into()) {
@@ -200,7 +201,7 @@ pub(crate) trait BitcoinSpvStorage: InternalBitcoinSpvStorage {
                     tip_header.time
                 );
                 let next_target =
-                    calculate_next_target(curr_target, start_header.time, tip_header.time);
+                    calculate_next_target(curr_target, start_header.time, tip_header.time, flags);
                 log::trace!("calculated new target  {next_target:#x}");
                 let next_bits = next_target.to_compact_lossy();
                 let next_target: Target = next_bits.into();