Merge pull request #32 from EthanYuan/fix-reorg-no-common-ancestor

fix: add reset operation for Testnet 3

Author: EthanYuan

Diff for: Cargo.lock

@@ -1,2 +1,2 @@
 6bbea4820329050e1fc65f9c15cab5948b824c73aa3430d7d92b793c53ca66b6  build/release/can-update-without-ownership-lock
-cd553a3858df32dbf051957ec97014200e632fed016084b28b25fcbbc49863d1  build/release/ckb-bitcoin-spv-type-lock
+57e463512f0899b2523b4ac6a7e717797a92fdb1b3c565cc5f304bb6001f2656  build/release/ckb-bitcoin-spv-type-lock

Diff for: checksums.txt

@@ -1,6 +1,6 @@
 [package]
 name = "ckb-bitcoin-spv-type-lock"
-version = "0.2.0"
+version = "0.2.1"
 authors = ["Boyu Yang <[email protected]>"]
 edition = "2021"
 license = "MIT"
@@ -15,6 +15,6 @@ ckb-hash = { version = "0.112.1", default-features = false, features = ["ckb-con
 [dependencies.ckb-bitcoin-spv-verifier]
 version = "0.1.0"
 git = "https://github.com/ckb-cell/ckb-bitcoin-spv"
-rev = "bfc71d7"
+rev = "1ccd114"
 default-features = false
 features = ["no-std"]

Diff for: contracts/ckb-bitcoin-spv-type-lock/Cargo.toml

@@ -1,12 +1,13 @@
 use alloc::vec::Vec;
 
+use ckb_bitcoin_spv_verifier::types::core::BitcoinChainType;
 #[cfg(debug_assertions)]
 use ckb_std::ckb_types::prelude::*;
 use ckb_std::{ckb_constants::Source, debug, high_level as hl};
 
 use crate::{
     error::{InternalError, Result},
-    operations,
+    operations, utilities,
 };
 
 pub fn main() -> Result<()> {
@@ -15,6 +16,11 @@ pub fn main() -> Result<()> {
     let script_hash = hl::load_script_hash()?;
     debug!("script hash = {:#x}", script_hash.pack());
 
+    let type_args = utilities::load_spv_type_args()?;
+    let clients_count = usize::from(type_args.clients_count);
+    let cells_count = 1 + clients_count;
+    let flags = type_args.flags;
+
     // Find all input cells which use current script.
     let indexes_of_inputs = {
         let mut indexes = Vec::new();
@@ -55,28 +61,36 @@ pub fn main() -> Result<()> {
     match (indexes_of_inputs.len(), indexes_of_outputs.len()) {
         (0, _) => {
             debug!("create all cells");
-            operations::create_cells(&indexes_of_outputs)?;
+            operations::create_cells(&indexes_of_outputs, type_args)?;
         }
         (_, 0) => {
             debug!("destroy all cells");
-            operations::destroy_cells(&indexes_of_inputs)?;
+            operations::destroy_cells(&indexes_of_inputs, type_args)?;
         }
         (2, 2) => {
             debug!("update a client cell and the info cell");
             operations::update_client(
                 (indexes_of_inputs[0], indexes_of_inputs[1]),
                 (indexes_of_outputs[0], indexes_of_outputs[1]),
                 script_hash.as_slice(),
+                type_args,
             )?;
         }
-        (m, n) if m == n && m > 2 => {
+        (m, n) if m == n && m > 2 && m < cells_count => {
             debug!("reorg client cells");
             operations::reorg_clients(
                 &indexes_of_inputs,
                 &indexes_of_outputs,
                 script_hash.as_slice(),
+                type_args,
             )?;
         }
+        (m, n)
+            if m == n && m > 2 && m == cells_count && BitcoinChainType::Testnet == flags.into() =>
+        {
+            debug!("reset all cells");
+            operations::reset_cells()?;
+        }
         (_m, _n) => {
             debug!("unknown operation: {_m} inputs and {_n} outputs");
             return Err(InternalError::UnknownOperation.into());

Diff for: contracts/ckb-bitcoin-spv-type-lock/src/entry.rs

@@ -1,5 +1,6 @@
 use ckb_bitcoin_spv_verifier::types::{
-    packed::{SpvBootstrapReader, SpvClientReader, SpvInfoReader, SpvTypeArgsReader},
+    core::SpvTypeArgs,
+    packed::{SpvBootstrapReader, SpvClientReader, SpvInfoReader},
     prelude::*,
 };
 use ckb_std::{ckb_constants::Source, debug, error::SysError, high_level as hl};
@@ -9,7 +10,7 @@ use crate::{
     utilities,
 };
 
-pub(crate) fn create_cells(indexes: &[usize]) -> Result<()> {
+pub(crate) fn create_cells(indexes: &[usize], type_args: SpvTypeArgs) -> Result<()> {
     if indexes.len() < 1 + 1 + 2 {
         return Err(InternalError::CreateNotEnoughCells.into());
     }
@@ -18,14 +19,6 @@ pub(crate) fn create_cells(indexes: &[usize]) -> Result<()> {
     }
     // Checks args of the client type script, then returns the clients count;
     let clients_count = {
-        let type_args = {
-            let script = hl::load_script()?;
-            let script_args = script.args();
-            let script_args_slice = script_args.as_reader().raw_data();
-            SpvTypeArgsReader::from_slice(script_args_slice)
-                .map_err(|_| SysError::Encoding)?
-                .unpack()
-        };
         let clients_count = usize::from(type_args.clients_count);
         let cells_count = 1 + clients_count;
         if indexes.len() != cells_count {

Diff for: contracts/ckb-bitcoin-spv-type-lock/src/operations/create.rs

@@ -1,19 +1,11 @@
-use ckb_bitcoin_spv_verifier::types::{packed::SpvTypeArgsReader, prelude::*};
-use ckb_std::{debug, error::SysError, high_level as hl};
+use ckb_bitcoin_spv_verifier::types::core::SpvTypeArgs;
+use ckb_std::debug;
 
 use crate::error::{InternalError, Result};
 
-pub(crate) fn destroy_cells(indexes: &[usize]) -> Result<()> {
+pub(crate) fn destroy_cells(indexes: &[usize], type_args: SpvTypeArgs) -> Result<()> {
     debug!("destroyed count: {}", indexes.len());
-    let clients_count: u8 = {
-        let script = hl::load_script()?;
-        let script_args = script.args();
-        let script_args_slice = script_args.as_reader().raw_data();
-        SpvTypeArgsReader::from_slice(script_args_slice)
-            .map_err(|_| SysError::Encoding)?
-            .clients_count()
-            .into()
-    };
+    let clients_count = type_args.clients_count;
     debug!("clients count: {clients_count}");
     let cells_count = 1 + usize::from(clients_count);
     debug!("cells count: {cells_count}");

Diff for: contracts/ckb-bitcoin-spv-type-lock/src/operations/destroy.rs

@@ -1,9 +1,11 @@
 mod create;
 mod destroy;
 mod reorg;
+mod reset;
 mod update;
 
 pub(crate) use self::create::create_cells;
 pub(crate) use self::destroy::destroy_cells;
 pub(crate) use self::reorg::reorg_clients;
+pub(crate) use self::reset::reset_cells;
 pub(crate) use self::update::update_client;

Diff for: contracts/ckb-bitcoin-spv-type-lock/src/operations/mod.rs

@@ -1,8 +1,8 @@
 use alloc::vec::Vec;
 
 use ckb_bitcoin_spv_verifier::types::{
-    core::{BitcoinChainType, SpvClient, SpvInfo, U256},
-    packed::{self, SpvClientReader, SpvInfoReader, SpvTypeArgsReader, SpvUpdateReader},
+    core::{BitcoinChainType, SpvClient, SpvInfo, SpvTypeArgs, U256},
+    packed::{self, SpvClientReader, SpvInfoReader, SpvUpdateReader},
     prelude::*,
 };
 #[cfg(debug_assertions)]
@@ -14,7 +14,12 @@ use crate::{
     utilities,
 };
 
-pub(crate) fn reorg_clients(inputs: &[usize], outputs: &[usize], script_hash: &[u8]) -> Result<()> {
+pub(crate) fn reorg_clients(
+    inputs: &[usize],
+    outputs: &[usize],
+    script_hash: &[u8],
+    type_args: SpvTypeArgs,
+) -> Result<()> {
     // Checks the ids of the input client cells, then returns
     // - expected output info cell base on the input info cell,
     // - the new tip client id.
@@ -37,7 +42,7 @@ pub(crate) fn reorg_clients(inputs: &[usize], outputs: &[usize], script_hash: &[
             previous_chain_work,
             fork_client_id,
             flags,
-        ) = load_inputs(inputs)?;
+        ) = load_inputs(inputs, type_args)?;
         input_info.tip_client_id = expected_tip_client_id;
         (
             input_info,
@@ -96,7 +101,10 @@ pub(crate) fn reorg_clients(inputs: &[usize], outputs: &[usize], script_hash: &[
     Ok(())
 }
 
-fn load_inputs(inputs: &[usize]) -> Result<(SpvInfo, u8, Vec<u8>, U256, u8, u8)> {
+fn load_inputs(
+    inputs: &[usize],
+    type_args: SpvTypeArgs,
+) -> Result<(SpvInfo, u8, Vec<u8>, U256, u8, u8)> {
     let mut client_ids_with_indexes = Vec::new();
     let mut input_info_opt = None;
     for i in inputs {
@@ -153,16 +161,7 @@ fn load_inputs(inputs: &[usize]) -> Result<(SpvInfo, u8, Vec<u8>, U256, u8, u8)>
         }
     };
 
-    let (clients_count, flags) = {
-        let script = hl::load_script()?;
-        let script_args = script.args();
-        let script_args_slice = script_args.as_reader().raw_data();
-        let args =
-            SpvTypeArgsReader::from_slice(script_args_slice).map_err(|_| SysError::Encoding)?;
-        let clients_count: u8 = args.clients_count().into();
-        let flags: u8 = args.flags().into();
-        (clients_count, flags)
-    };
+    let (clients_count, flags) = (type_args.clients_count, type_args.flags);
     debug!("clients count: {clients_count}, flags: {flags:08b}");
 
     let mut client_ids = client_ids_with_indexes

Diff for: contracts/ckb-bitcoin-spv-type-lock/src/operations/reorg.rs

@@ -0,0 +1,5 @@
+use crate::error::Result;
+
+pub(crate) fn reset_cells() -> Result<()> {
+    Ok(())
+}

Diff for: contracts/ckb-bitcoin-spv-type-lock/src/operations/reset.rs

@@ -1,8 +1,8 @@
 use alloc::vec::Vec;
 
 use ckb_bitcoin_spv_verifier::types::{
-    core::{SpvClient, SpvInfo},
-    packed::{self, SpvClientReader, SpvInfoReader, SpvTypeArgsReader, SpvUpdateReader},
+    core::{SpvClient, SpvInfo, SpvTypeArgs},
+    packed::{self, SpvClientReader, SpvInfoReader, SpvUpdateReader},
     prelude::*,
 };
 #[cfg(debug_assertions)]
@@ -18,13 +18,15 @@ pub(crate) fn update_client(
     inputs: (usize, usize),
     outputs: (usize, usize),
     script_hash: &[u8],
+    type_args: SpvTypeArgs,
 ) -> Result<()> {
     // Checks the id of the input client cell, then returns
     // - expected output info cell base on the input info cell,
     // - the tip client id.
     // - the expected client id, which will be the next tip client id.
     let (expected_info, tip_client_id, expected_client_id, flags) = {
-        let (mut input_info, tip_client_id, expected_client_id, flags) = load_inputs(inputs)?;
+        let (mut input_info, tip_client_id, expected_client_id, flags) =
+            load_inputs(inputs, type_args)?;
         input_info.tip_client_id = expected_client_id;
         (input_info, tip_client_id, expected_client_id, flags)
     };
@@ -57,7 +59,7 @@ pub(crate) fn update_client(
     Ok(())
 }
 
-fn load_inputs(inputs: (usize, usize)) -> Result<(SpvInfo, u8, u8, u8)> {
+fn load_inputs(inputs: (usize, usize), type_args: SpvTypeArgs) -> Result<(SpvInfo, u8, u8, u8)> {
     debug!("load cell data of inputs[{}]", inputs.0);
     let input_data_0 = hl::load_cell_data(inputs.0, Source::Input)?;
     debug!("load cell data of inputs[{}]", inputs.1);
@@ -90,16 +92,7 @@ fn load_inputs(inputs: (usize, usize)) -> Result<(SpvInfo, u8, u8, u8)> {
     let input_client_id: u8 = packed_input_client.id().into();
     debug!("input client id = {input_client_id}");
 
-    let (clients_count, flags) = {
-        let script = hl::load_script()?;
-        let script_args = script.args();
-        let script_args_slice = script_args.as_reader().raw_data();
-        let args =
-            SpvTypeArgsReader::from_slice(script_args_slice).map_err(|_| SysError::Encoding)?;
-        let clients_count: u8 = args.clients_count().into();
-        let flags: u8 = args.flags().into();
-        (clients_count, flags)
-    };
+    let (clients_count, flags) = (type_args.clients_count, type_args.flags);
     debug!("clients count: {clients_count}, flags: {flags:08b}");
 
     let expected_client_id = utilities::next_client_id(input_info.tip_client_id, clients_count);

Diff for: contracts/ckb-bitcoin-spv-type-lock/src/operations/update.rs

@@ -1,5 +1,10 @@
 mod type_id;
 
+use ckb_bitcoin_spv_verifier::types::{core::SpvTypeArgs, packed::SpvTypeArgsReader, prelude::*};
+use ckb_std::{error::SysError, high_level as hl};
+
+use crate::error::Result;
+
 pub(crate) use self::type_id::load_then_calculate_type_id;
 
 pub(crate) fn prev_client_id(current: u8, count: u8) -> u8 {
@@ -17,3 +22,13 @@ pub(crate) fn next_client_id(current: u8, count: u8) -> u8 {
         0
     }
 }
+
+pub(crate) fn load_spv_type_args() -> Result<SpvTypeArgs> {
+    let script = hl::load_script()?;
+    let script_args = script.args();
+    let script_args_slice = script_args.as_reader().raw_data();
+    let args = SpvTypeArgsReader::from_slice(script_args_slice)
+        .map_err(|_| SysError::Encoding)?
+        .unpack();
+    Ok(args)
+}