Merge pull request #4412 from stacks-network/feat/stacking-burnops-include-signer-key

Update StackStxOp to include signer key

Author: 8marz8

.github/workflows/bitcoin-tests.yml

@@ -59,6 +59,7 @@ jobs:
           - tests::neon_integrations::size_overflow_unconfirmed_stream_microblocks_integration_test
           - tests::neon_integrations::stx_delegate_btc_integration_test
           - tests::neon_integrations::stx_transfer_btc_integration_test
+          - tests::neon_integrations::stack_stx_burn_op_test
           - tests::neon_integrations::test_chainwork_first_intervals
           - tests::neon_integrations::test_chainwork_partial_interval
           - tests::neon_integrations::test_flash_block_skip_tenure
@@ -83,6 +84,7 @@ jobs:
           - tests::signer::stackerdb_block_proposal
           - tests::signer::stackerdb_filter_bad_transactions
           - tests::signer::stackerdb_mine_2_nakamoto_reward_cycles
+          - tests::nakamoto_integrations::stack_stx_burn_op_integration_test
     steps:
       ## Setup test environment
       - name: Setup Test Environment

stackslib/src/chainstate/burn/db/sortdb.rs

@@ -319,6 +319,19 @@ impl FromRow<StackStxOp> for StackStxOp {
         let stacked_ustx = u128::from_str_radix(&stacked_ustx_str, 10)
             .expect("CORRUPTION: bad u128 written to sortdb");
         let num_cycles = row.get_unwrap("num_cycles");
+        let signing_key_str_opt: Option<String> = row.get("signer_key")?;
+        let signer_key = match signing_key_str_opt {
+            Some(key_str) => serde_json::from_str(&key_str).ok(),
+            None => None,
+        };
+        let max_amount_str_opt: Option<String> = row.get("max_amount")?;
+        let max_amount = match max_amount_str_opt {
+            Some(max_amount_str) => u128::from_str_radix(&max_amount_str, 10)
+                .map_err(|_| db_error::ParseError)
+                .ok(),
+            None => None,
+        };
+        let auth_id = row.get("auth_id")?;
 
         Ok(StackStxOp {
             txid,
@@ -329,6 +342,9 @@ impl FromRow<StackStxOp> for StackStxOp {
             reward_addr,
             stacked_ustx,
             num_cycles,
+            signer_key,
+            max_amount,
+            auth_id,
         })
     }
 }
@@ -702,6 +718,9 @@ const SORTITION_DB_SCHEMA_8: &'static [&'static str] = &[
         block_hash TEXT NOT NULL,
         block_height INTEGER NOT NULL
     );"#,
+    r#"ALTER TABLE stack_stx ADD signer_key TEXT DEFAULT NULL;"#,
+    r#"ALTER TABLE stack_stx ADD max_amount TEXT DEFAULT NULL;"#,
+    r#"ALTER TABLE stack_stx ADD auth_id INTEGER DEFAULT NULL;"#,
     r#"
     -- table definition for `vote-for-aggregate-key` burn op
     CREATE TABLE vote_for_aggregate_key (
@@ -5372,9 +5391,12 @@ impl<'a> SortitionHandleTx<'a> {
             &op.reward_addr.to_db_string(),
             &op.stacked_ustx.to_string(),
             &op.num_cycles,
+            &serde_json::to_string(&op.signer_key).unwrap(),
+            &serde_json::to_string(&op.max_amount).unwrap(),
+            &op.auth_id,
         ];
 
-        self.execute("REPLACE INTO stack_stx (txid, vtxindex, block_height, burn_header_hash, sender_addr, reward_addr, stacked_ustx, num_cycles) VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8)", args)?;
+        self.execute("REPLACE INTO stack_stx (txid, vtxindex, block_height, burn_header_hash, sender_addr, reward_addr, stacked_ustx, num_cycles, signer_key, max_amount, auth_id) VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11)", args)?;
 
         Ok(())
     }
@@ -10085,6 +10107,9 @@ pub mod tests {
                 reward_addr: PoxAddress::Standard(StacksAddress::new(4, Hash160([4u8; 20])), None),
                 stacked_ustx: 456,
                 num_cycles: 6,
+                signer_key: Some(StacksPublicKeyBuffer([0x02; 33])),
+                max_amount: Some(u128::MAX),
+                auth_id: Some(0u32),
 
                 txid: Txid([0x02; 32]),
                 vtxindex: 2,
@@ -10177,6 +10202,9 @@ pub mod tests {
                 reward_addr: PoxAddress::Standard(StacksAddress::new(4, Hash160([4u8; 20])), None),
                 stacked_ustx: 456,
                 num_cycles: 6,
+                signer_key: None,
+                max_amount: None,
+                auth_id: None,
 
                 txid: Txid([0x02; 32]),
                 vtxindex: 2,

stackslib/src/chainstate/burn/operations/mod.rs

@@ -82,6 +82,7 @@ pub enum Error {
     // stack stx related errors
     StackStxMustBePositive,
     StackStxInvalidCycles,
+    StackStxInvalidKey,
 
     // errors associated with delegate stx
     DelegateStxMustBePositive,
@@ -142,6 +143,7 @@ impl fmt::Display for Error {
                 f,
                 "Stack STX must set num cycles between 1 and max num cycles"
             ),
+            Error::StackStxInvalidKey => write!(f, "Signer key is invalid"),
             Error::DelegateStxMustBePositive => write!(f, "Delegate STX must be positive amount"),
             Error::VoteForAggregateKeyInvalidKey => {
                 write!(f, "Aggregate key is invalid")
@@ -190,6 +192,9 @@ pub struct StackStxOp {
     /// how many ustx this transaction locks
     pub stacked_ustx: u128,
     pub num_cycles: u8,
+    pub signer_key: Option<StacksPublicKeyBuffer>,
+    pub max_amount: Option<u128>,
+    pub auth_id: Option<u32>,
 
     // common to all transactions
     pub txid: Txid,                            // transaction ID
@@ -478,6 +483,9 @@ impl BlockstackOperationType {
                 "stacked_ustx": op.stacked_ustx,
                 "burn_txid": op.txid,
                 "vtxindex": op.vtxindex,
+                "signer_key": op.signer_key.as_ref().map(|k| serde_json::Value::String(k.to_hex())).unwrap_or(serde_json::Value::Null),
+                "max_amount": op.max_amount.map_or(serde_json::Value::Null, |amount| serde_json::Value::Number(serde_json::Number::from(amount))),
+                "auth_id": op.auth_id.map_or(serde_json::Value::Null, |id| serde_json::Value::Number(serde_json::Number::from(id))),
             }
         })
     }