Merge pull request #11 from yangby-cryptape/feature/add-flags

feat: add 8 bit-flags into script type args to control features

Author: Flouse

Cargo.lock

@@ -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 = "2464c8f"
+rev = "837a307"
 default-features = false
 features = ["no-std"]

contracts/ckb-bitcoin-spv-type-lock/Cargo.toml

@@ -21,19 +21,22 @@ pub(crate) fn reorg_clients(inputs: &[usize], outputs: &[usize], script_hash: &[
     // - the expected client ids, which will be the new tip client id and the ids of all the cleared clients.
     // - the height of the old tip client.
     // - the id of the last client, whose blocks are all in main chain.
+    // - the flags in SPV script args
     let (
         expected_info,
         expected_tip_client_id,
         expected_client_ids,
         previous_tip_height,
         fork_client_id,
+        flags,
     ) = {
         let (
             mut input_info,
             expected_tip_client_id,
             expected_client_ids,
             previous_tip_height,
             fork_client_id,
+            flags,
         ) = load_inputs(inputs)?;
         input_info.tip_client_id = expected_tip_client_id;
         (
@@ -42,6 +45,7 @@ pub(crate) fn reorg_clients(inputs: &[usize], outputs: &[usize], script_hash: &[
             expected_client_ids,
             previous_tip_height,
             fork_client_id,
+            flags,
         )
     };
     // Checks the output info cell and the output client cells;
@@ -76,12 +80,12 @@ pub(crate) fn reorg_clients(inputs: &[usize], outputs: &[usize], script_hash: &[
         }
     };
 
-    expected_input_client.verify_new_client(&output_client, update)?;
+    expected_input_client.verify_new_client(&output_client, update, flags)?;
 
     Ok(())
 }
 
-fn load_inputs(inputs: &[usize]) -> Result<(SpvInfo, u8, Vec<u8>, u32, u8)> {
+fn load_inputs(inputs: &[usize]) -> Result<(SpvInfo, u8, Vec<u8>, u32, u8, u8)> {
     let mut client_ids_with_indexes = Vec::new();
     let mut input_info_opt = None;
     for i in inputs {
@@ -135,16 +139,17 @@ fn load_inputs(inputs: &[usize]) -> Result<(SpvInfo, u8, Vec<u8>, u32, u8)> {
         }
     };
 
-    let clients_count: 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();
-        SpvTypeArgsReader::from_slice(script_args_slice)
-            .map_err(|_| SysError::Encoding)?
-            .clients_count()
-            .into()
+        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)
     };
-    debug!("clients count: {clients_count}");
+    debug!("clients count: {clients_count}, flags: {flags:08b}");
 
     let mut client_ids = client_ids_with_indexes
         .into_iter()
@@ -179,6 +184,7 @@ fn load_inputs(inputs: &[usize]) -> Result<(SpvInfo, u8, Vec<u8>, u32, u8)> {
         expected_client_ids,
         tip_height,
         fork_client_id,
+        flags,
     ))
 }
 

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

@@ -23,10 +23,10 @@ pub(crate) fn update_client(
     // - 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) = {
-        let (mut input_info, tip_client_id, expected_client_id) = load_inputs(inputs)?;
+    let (expected_info, tip_client_id, expected_client_id, flags) = {
+        let (mut input_info, tip_client_id, expected_client_id, flags) = load_inputs(inputs)?;
         input_info.tip_client_id = expected_client_id;
-        (input_info, tip_client_id, expected_client_id)
+        (input_info, tip_client_id, expected_client_id, flags)
     };
     // Checks the output info cell, then returns the client cell and the index of the info cell.
     let (output_client, output_info_index) = load_outputs(outputs, &expected_info)?;
@@ -52,12 +52,12 @@ pub(crate) fn update_client(
         }
     };
 
-    expected_input_client.verify_new_client(&output_client, update)?;
+    expected_input_client.verify_new_client(&output_client, update, flags)?;
 
     Ok(())
 }
 
-fn load_inputs(inputs: (usize, usize)) -> Result<(SpvInfo, u8, u8)> {
+fn load_inputs(inputs: (usize, usize)) -> 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,24 +90,25 @@ fn load_inputs(inputs: (usize, usize)) -> Result<(SpvInfo, u8, u8)> {
     let input_client_id: u8 = packed_input_client.id().into();
     debug!("input client id = {input_client_id}");
 
-    let clients_count: 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();
-        SpvTypeArgsReader::from_slice(script_args_slice)
-            .map_err(|_| SysError::Encoding)?
-            .clients_count()
-            .into()
+        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)
     };
-    debug!("clients count: {clients_count}");
+    debug!("clients count: {clients_count}, flags: {flags:08b}");
 
     let expected_client_id = utilities::next_client_id(input_info.tip_client_id, clients_count);
     debug!("expected client id = {expected_client_id}");
     if input_client_id != expected_client_id {
         return Err(InternalError::UpdateInputClientIdIsMismatch.into());
     }
 
-    Ok((input_info, tip_client_id, expected_client_id))
+    Ok((input_info, tip_client_id, expected_client_id, flags))
 }
 
 fn load_outputs(

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

@@ -17,9 +17,9 @@ walkdir = "2.4"
 [dev-dependencies.ckb-bitcoin-spv-prover]
 version = "0.1.0"
 git = "https://github.com/ckb-cell/ckb-bitcoin-spv"
-rev = "2464c8f"
+rev = "837a307"
 
 [dev-dependencies.ckb-bitcoin-spv-verifier]
 version = "0.1.0"
 git = "https://github.com/ckb-cell/ckb-bitcoin-spv"
-rev = "2464c8f"
+rev = "837a307"