From e0218f31aca8cd7783646df89b7cd67ebd020914 Mon Sep 17 00:00:00 2001 From: jolestar Date: Fri, 6 Dec 2024 17:53:03 +0800 Subject: [PATCH] [bbn] Init BBN Cap 3 global parameters --- frameworks/bitcoin-move/doc/README.md | 1 + frameworks/bitcoin-move/doc/bbn.md | 107 ++++++++++++++++++++- frameworks/bitcoin-move/doc/bbn_updater.md | 67 +++++++++++++ frameworks/bitcoin-move/doc/bitcoin.md | 1 + frameworks/bitcoin-move/sources/bbn.move | 106 ++++++++++++++++++-- 5 files changed, 269 insertions(+), 13 deletions(-) create mode 100644 frameworks/bitcoin-move/doc/bbn_updater.md diff --git a/frameworks/bitcoin-move/doc/README.md b/frameworks/bitcoin-move/doc/README.md index c3ff1b6460..27144daf0e 100644 --- a/frameworks/bitcoin-move/doc/README.md +++ b/frameworks/bitcoin-move/doc/README.md @@ -13,6 +13,7 @@ This is the reference documentation of the Bitcoin Move Framework. - [`0x4::bbn`](bbn.md#0x4_bbn) +- [`0x4::bbn_updater`](bbn_updater.md#0x4_bbn_updater) - [`0x4::bitcoin`](bitcoin.md#0x4_bitcoin) - [`0x4::bitcoin_hash`](bitcoin_hash.md#0x4_bitcoin_hash) - [`0x4::bitcoin_multisign_validator`](bitcoin_multisign_validator.md#0x4_bitcoin_multisign_validator) diff --git a/frameworks/bitcoin-move/doc/bbn.md b/frameworks/bitcoin-move/doc/bbn.md index 806dad7b0f..0320bded59 100644 --- a/frameworks/bitcoin-move/doc/bbn.md +++ b/frameworks/bitcoin-move/doc/bbn.md @@ -17,8 +17,11 @@ - [Constants](#@Constants_0) - [Function `genesis_init`](#0x4_bbn_genesis_init) - [Function `init_for_upgrade`](#0x4_bbn_init_for_upgrade) +- [Function `init_bbn_global_param_v2`](#0x4_bbn_init_bbn_global_param_v2) - [Function `is_possible_bbn_tx`](#0x4_bbn_is_possible_bbn_tx) +- [Function `is_possible_bbn_transaction`](#0x4_bbn_is_possible_bbn_transaction) - [Function `process_bbn_tx_entry`](#0x4_bbn_process_bbn_tx_entry) +- [Function `process_bbn_transaction`](#0x4_bbn_process_bbn_transaction) - [Function `add_temp_state`](#0x4_bbn_add_temp_state) - [Function `contains_temp_state`](#0x4_bbn_contains_temp_state) - [Function `borrow_temp_state`](#0x4_bbn_borrow_temp_state) @@ -34,6 +37,7 @@ - [Function `staking_time`](#0x4_bbn_staking_time) - [Function `staking_value`](#0x4_bbn_staking_value) - [Function `is_expired`](#0x4_bbn_is_expired) +- [Function `is_expired_at`](#0x4_bbn_is_expired_at) 
use 0x1::option;
@@ -46,7 +50,6 @@
 use 0x2::sort;
 use 0x2::type_info;
 use 0x3::bitcoin_address;
-use 0x4::bitcoin;
 use 0x4::opcode;
 use 0x4::script_buf;
 use 0x4::taproot_builder;
@@ -179,6 +182,51 @@
 
 
 
+
+
+
+
+
const BBN_V1_ACTIVATION_HEIGHT: u64 = 864790;
+

+
+
+
+
+
+
+
+
const BBN_V1_CAP_HEIGHT: u64 = 864799;
+

+
+
+
+
+
+
+
+
const BBN_V2_ACTIVATION_HEIGHT: u64 = 874088;
+

+
+
+
+
+
+
+
+
const BBN_V2_CAP_HEIGHT: u64 = 875087;
+

+
+
+
+
+
+
+
+
const DeprecatedFunction: u64 = 16;
+

+
+
+
 
 
 
@@ -336,15 +384,40 @@
 
 
 
+
+
+## Function `init_bbn_global_param_v2`
+
+BBN global param version 2 initialization
+
+
+
entry fun init_bbn_global_param_v2()
+

+
+
+
 
 
 ## Function `is_possible_bbn_tx`
 
+Deprecated function
+Use bbn_updater::is_possible_bbn_tx instead
+
+
+
public fun is_possible_bbn_tx(_txid: address): bool
+

+
+
+
+
+
+## Function `is_possible_bbn_transaction`
+
 Check if the transaction is a possible Babylon transaction
 If the transaction contains an OP_RETURN output with the correct tag, it is considered a possible Babylon transaction
 
 
-
public fun is_possible_bbn_tx(txid: address): bool
+
public fun is_possible_bbn_transaction(block_height: u64, tx: &types::Transaction): bool
 

 
 
@@ -353,9 +426,22 @@ If the transaction contains an OP_RETURN output with the correct tag, it is cons
 
 ## Function `process_bbn_tx_entry`
 
+Deprecated function
+Use bbn_updater::process_bbn_tx_entry instead
 
 
-
public entry fun process_bbn_tx_entry(txid: address)
+
public entry fun process_bbn_tx_entry(_txid: address)
+

+
+
+
+
+
+## Function `process_bbn_transaction`
+
+
+
+
public(friend) fun process_bbn_transaction(block_height: u64, tx: &types::Transaction)
 

 
 
@@ -521,7 +607,20 @@ If the transaction contains an OP_RETURN output with the correct tag, it is cons
 
 ## Function `is_expired`
 
+Deprecated function
+Use bbn_updater::is_expired instead
+
+
+
public fun is_expired(_stake: &bbn::BBNStakeSeal): bool
+

+
+
+
+
+
+## Function `is_expired_at`
+
 
 
-
public fun is_expired(stake: &bbn::BBNStakeSeal): bool
+
public fun is_expired_at(stake: &bbn::BBNStakeSeal, current_block_height: u64): bool
 

diff --git a/frameworks/bitcoin-move/doc/bbn_updater.md b/frameworks/bitcoin-move/doc/bbn_updater.md
new file mode 100644
index 0000000000..85341b5170
--- /dev/null
+++ b/frameworks/bitcoin-move/doc/bbn_updater.md
@@ -0,0 +1,67 @@
+
+
+
+# Module `0x4::bbn_updater`
+
+
+
+-  [Constants](#@Constants_0)
+-  [Function `is_possible_bbn_tx`](#0x4_bbn_updater_is_possible_bbn_tx)
+-  [Function `process_bbn_tx_entry`](#0x4_bbn_updater_process_bbn_tx_entry)
+-  [Function `is_expired`](#0x4_bbn_updater_is_expired)
+
+
+
use 0x1::option;
+use 0x4::bbn;
+use 0x4::bitcoin;
+use 0x4::types;
+

+
+
+
+
+
+## Constants
+
+
+
+
+
+
+
const ErrorTransactionNotFound: u64 = 1;
+

+
+
+
+
+
+## Function `is_possible_bbn_tx`
+
+Check if the transaction is a possible Babylon transaction
+If the transaction contains an OP_RETURN output with the correct tag, it is considered a possible Babylon transaction
+
+
+
public fun is_possible_bbn_tx(txid: address): bool
+

+
+
+
+
+
+## Function `process_bbn_tx_entry`
+
+
+
+
public entry fun process_bbn_tx_entry(txid: address)
+

+
+
+
+
+
+## Function `is_expired`
+
+
+
+
public fun is_expired(stake: &bbn::BBNStakeSeal): bool
+

diff --git a/frameworks/bitcoin-move/doc/bitcoin.md b/frameworks/bitcoin-move/doc/bitcoin.md
index 613f081fb2..d240e2663f 100644
--- a/frameworks/bitcoin-move/doc/bitcoin.md
+++ b/frameworks/bitcoin-move/doc/bitcoin.md
@@ -35,6 +35,7 @@
 use 0x3::address_mapping;
 use 0x3::bitcoin_address;
 use 0x3::chain_id;
+use 0x4::bbn;
 use 0x4::inscription_updater;
 use 0x4::network;
 use 0x4::pending_block;
diff --git a/frameworks/bitcoin-move/sources/bbn.move b/frameworks/bitcoin-move/sources/bbn.move
index f8d02bc5eb..343c3f283e 100644
--- a/frameworks/bitcoin-move/sources/bbn.move
+++ b/frameworks/bitcoin-move/sources/bbn.move
@@ -141,6 +141,11 @@ module bitcoin_move::bbn {
         error: String,
     }
 
+    const BBN_V1_ACTIVATION_HEIGHT: u64 = 864790;
+    const BBN_V1_CAP_HEIGHT: u64 = 864799;
+    const BBN_V2_ACTIVATION_HEIGHT: u64 = 874088;
+    const BBN_V2_CAP_HEIGHT: u64 = 875087;
+
     //https://github.com/babylonlabs-io/networks/blob/main/bbn-1/parameters/global-params.json
     // {
     //     "versions": [
@@ -193,6 +198,31 @@ module bitcoin_move::bbn {
     //             "max_staking_time": 64000,
     //             "min_staking_time": 64000,
     //             "confirmation_depth": 10
+    //         },
+    //         {
+    //             "version": 2,
+    //             "activation_height": 874088,
+    //             "cap_height": 875087,
+    //             "tag": "62626e31",
+    //             "covenant_pks": [
+    //                 "03d45c70d28f169e1f0c7f4a78e2bc73497afe585b70aa897955989068f3350aaa",
+    //                 "034b15848e495a3a62283daaadb3f458a00859fe48e321f0121ebabbdd6698f9fa",
+    //                 "0223b29f89b45f4af41588dcaf0ca572ada32872a88224f311373917f1b37d08d1",
+    //                 "02d3c79b99ac4d265c2f97ac11e3232c07a598b020cf56c6f055472c893c0967ae",
+    //                 "038242640732773249312c47ca7bdb50ca79f15f2ecc32b9c83ceebba44fb74df7",
+    //                 "03e36200aaa8dce9453567bba108bdc51f7f1174b97a65e4dc4402fc5de779d41c",
+    //                 "03cbdd028cfe32c1c1f2d84bfec71e19f92df509bba7b8ad31ca6c1a134fe09204",
+    //                 "03f178fcce82f95c524b53b077e6180bd2d779a9057fdff4255a0af95af918cee0",
+    //                 "03de13fc96ea6899acbdc5db3afaa683f62fe35b60ff6eb723dad28a11d2b12f8c"
+    //             ],
+    //             "covenant_quorum": 6,
+    //             "unbonding_time": 1008,
+    //             "unbonding_fee": 32000,
+    //             "max_staking_amount": 500000000000,
+    //             "min_staking_amount": 500000,
+    //             "max_staking_time": 64000,
+    //             "min_staking_time": 64000,
+    //             "confirmation_depth": 10
     //         }
     //     ]
     // }
@@ -253,6 +283,7 @@ module bitcoin_move::bbn {
             max_staking_time: 64000,
             confirmation_depth: 10
         };
+        
         let obj =
             object::new_named_object(BBNGlobalParams {
                 max_version: 1,
@@ -260,6 +291,7 @@ module bitcoin_move::bbn {
         object::add_field(&mut obj, 0, bbn_global_param_0);
         object::add_field(&mut obj, 1, bbn_global_params_1);
         object::to_shared(obj);
+        init_bbn_global_param_v2();
     }
 
     public fun init_for_upgrade(){
@@ -268,6 +300,45 @@ module bitcoin_move::bbn {
         genesis_init()
     }
 
+    /// BBN global param version 2 initialization
+    entry fun init_bbn_global_param_v2(){
+        let version = 2;
+        let object_id = object::named_object_id();
+        let param_obj = object::borrow_mut_object_extend(object_id);
+        assert!(!object::contains_field(param_obj, version), ErrorAlreadyInit);
+
+        // bb-1 version 2
+        let bbn_global_params_2 = BBNGlobalParamV1 {
+            version: 2,
+            activation_height: 874088,
+            cap_height: 875087,
+            //bbn1
+            tag: x"62626e31",
+            //we keep the x-only pubkey in the vector
+            covenant_pks: vector[
+                x"d45c70d28f169e1f0c7f4a78e2bc73497afe585b70aa897955989068f3350aaa",
+                x"4b15848e495a3a62283daaadb3f458a00859fe48e321f0121ebabbdd6698f9fa",
+                x"23b29f89b45f4af41588dcaf0ca572ada32872a88224f311373917f1b37d08d1",
+                x"d3c79b99ac4d265c2f97ac11e3232c07a598b020cf56c6f055472c893c0967ae",
+                x"8242640732773249312c47ca7bdb50ca79f15f2ecc32b9c83ceebba44fb74df7",
+                x"e36200aaa8dce9453567bba108bdc51f7f1174b97a65e4dc4402fc5de779d41c",
+                x"cbdd028cfe32c1c1f2d84bfec71e19f92df509bba7b8ad31ca6c1a134fe09204",
+                x"f178fcce82f95c524b53b077e6180bd2d779a9057fdff4255a0af95af918cee0",
+                x"de13fc96ea6899acbdc5db3afaa683f62fe35b60ff6eb723dad28a11d2b12f8c"
+            ],
+            covenant_quorum: 6,
+            unbonding_time: 1008,
+            unbonding_fee: 32000,
+            max_staking_amount: 500000000000,
+            min_staking_amount: 500000,
+            min_staking_time: 64000,
+            max_staking_time: 64000,
+            confirmation_depth: 10
+        };
+        object::add_field(param_obj, version, bbn_global_params_2);
+        object::borrow_mut(param_obj).max_version = version;
+    }
+
     fun new_bbn_stake_seal(
         block_height: u64, txid: address, staking_output_index: u32, tag: vector, staker_pub_key: vector,
         finality_provider_pub_key: vector, staking_time: u16, staking_value: u64
@@ -284,10 +355,22 @@ module bitcoin_move::bbn {
         })
     }
 
-    fun get_bbn_param_v1(): &BBNGlobalParamV1 {
+    fun get_bbn_param_version(height: u64): Option {
+        if(height < BBN_V1_ACTIVATION_HEIGHT){
+            none()
+        } else if (height <= BBN_V1_CAP_HEIGHT){
+            some(1)
+        } else if (height >= BBN_V2_ACTIVATION_HEIGHT && height <= BBN_V2_CAP_HEIGHT){
+            some(2)
+        }else{
+            none()
+        }
+    }
+
+    fun get_bbn_param(version: u64): &BBNGlobalParamV1 {
         let object_id = object::named_object_id();
         let param_obj = object::borrow_object(object_id);
-        object::borrow_field(param_obj, 1)
+        object::borrow_field(param_obj, version)
     }
 
     fun try_get_bbn_op_return_ouput(tx_output: &vector): Option {
@@ -359,13 +442,12 @@ module bitcoin_move::bbn {
     /// Check if the transaction is a possible Babylon transaction
     /// If the transaction contains an OP_RETURN output with the correct tag, it is considered a possible Babylon transaction
     public fun is_possible_bbn_transaction(block_height: u64, tx: &Transaction): bool {
-        let param = get_bbn_param_v1();
-        if (block_height < param.activation_height) {
-            return false
-        };
-        if (block_height > param.cap_height) {
+        let version_opt = get_bbn_param_version(block_height);
+        if (is_none(&version_opt)) {
             return false
         };
+        let version = option::destroy_some(version_opt);
+        let param = get_bbn_param(version);
         let output_opt = try_get_bbn_op_return_ouput(types::tx_output(tx));
         if (is_none(&output_opt)) {
             return false
@@ -398,7 +480,12 @@ module bitcoin_move::bbn {
     }
 
     public(friend) fun process_bbn_transaction(block_height: u64, tx: &Transaction) {
-        let param = get_bbn_param_v1();
+        let version_opt = get_bbn_param_version(block_height);
+        if (is_none(&version_opt)) {
+            return
+        };
+        let version = option::destroy_some(version_opt);
+        let param = get_bbn_param(version);
         assert!(block_height >= param.activation_height && block_height <= param.cap_height, ErrorOutBlockRange);
         let tx_output = types::tx_output(tx);
 
@@ -776,7 +863,8 @@ module bitcoin_move::bbn {
         let bbn_opreturn_data_opt = parse_bbn_op_return_data(&script_buf);
         let bbn_opreturn_data = option::destroy_some(bbn_opreturn_data_opt);
         let BBNV0OpReturnData{tag:_, version:_, staker_pub_key, finality_provider_pub_key, staking_time} = bbn_opreturn_data;
-        let param = get_bbn_param_v1();
+        let param_version = 1;
+        let param = get_bbn_param(param_version);
         let sb = build_staking_tx_output_script_pubkey(
             staker_pub_key,
             vector::singleton(finality_provider_pub_key),