feat: include PC abort reason in tx receipt

Author: obycode

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to the versioning scheme outlined in the [README.md](README.md).
 
+## [Unreleased]
+
+### Added
+
+- Include a reason string in the transaction receipt when a transaction is rolled back due to a post-condition. This should help users in understanding what went wrong.
+
 ## [3.1.0.0.8]
 
 ### Added

clarity/src/vm/clarity.rs

@@ -20,7 +20,7 @@ pub enum Error {
     Interpreter(InterpreterError),
     BadTransaction(String),
     CostError(ExecutionCost, ExecutionCost),
-    AbortedByCallback(Option<Value>, AssetMap, Vec<StacksTransactionEvent>),
+    AbortedByCallback(Option<Value>, AssetMap, Vec<StacksTransactionEvent>, String),
 }
 
 impl fmt::Display for Error {
@@ -175,9 +175,9 @@ pub trait TransactionConnection: ClarityConnection {
         &mut self,
         to_do: F,
         abort_call_back: A,
-    ) -> Result<(R, AssetMap, Vec<StacksTransactionEvent>, bool), E>
+    ) -> Result<(R, AssetMap, Vec<StacksTransactionEvent>, Option<String>), E>
     where
-        A: FnOnce(&AssetMap, &mut ClarityDatabase) -> bool,
+        A: FnOnce(&AssetMap, &mut ClarityDatabase) -> Option<String>,
         F: FnOnce(&mut OwnedEnvironment) -> Result<(R, AssetMap, Vec<StacksTransactionEvent>), E>,
         E: From<InterpreterError>;
 
@@ -283,7 +283,7 @@ pub trait TransactionConnection: ClarityConnection {
                     .stx_transfer(from, to, amount, memo)
                     .map_err(Error::from)
             },
-            |_, _| false,
+            |_, _| None,
         )
         .map(|(value, assets, events, _)| (value, assets, events))
     }
@@ -305,7 +305,7 @@ pub trait TransactionConnection: ClarityConnection {
         max_execution_time: Option<std::time::Duration>,
     ) -> Result<(Value, AssetMap, Vec<StacksTransactionEvent>), Error>
     where
-        F: FnOnce(&AssetMap, &mut ClarityDatabase) -> bool,
+        F: FnOnce(&AssetMap, &mut ClarityDatabase) -> Option<String>,
     {
         let expr_args: Vec<_> = args
             .iter()
@@ -332,8 +332,13 @@ pub trait TransactionConnection: ClarityConnection {
             abort_call_back,
         )
         .and_then(|(value, assets, events, aborted)| {
-            if aborted {
-                Err(Error::AbortedByCallback(Some(value), assets, events))
+            if let Some(aborted) = aborted {
+                Err(Error::AbortedByCallback(
+                    Some(value),
+                    assets,
+                    events,
+                    aborted,
+                ))
             } else {
                 Ok((value, assets, events))
             }
@@ -357,7 +362,7 @@ pub trait TransactionConnection: ClarityConnection {
         max_execution_time: Option<std::time::Duration>,
     ) -> Result<(AssetMap, Vec<StacksTransactionEvent>), Error>
     where
-        F: FnOnce(&AssetMap, &mut ClarityDatabase) -> bool,
+        F: FnOnce(&AssetMap, &mut ClarityDatabase) -> Option<String>,
     {
         let (_, asset_map, events, aborted) = self.with_abort_callback(
             |vm_env| {
@@ -378,8 +383,8 @@ pub trait TransactionConnection: ClarityConnection {
             },
             abort_call_back,
         )?;
-        if aborted {
-            Err(Error::AbortedByCallback(None, asset_map, events))
+        if let Some(aborted) = aborted {
+            Err(Error::AbortedByCallback(None, asset_map, events, aborted))
         } else {
             Ok((asset_map, events))
         }

stackslib/src/chainstate/coordinator/tests.rs

@@ -391,7 +391,7 @@ pub fn setup_states_with_epochs(
                         Value::UInt(burnchain.pox_constants.reward_cycle_length as u128),
                         Value::UInt(burnchain.pox_constants.pox_rejection_fraction as u128),
                     ],
-                    |_, _| false,
+                    |_, _| None,
                     None,
                 )
                 .expect("Failed to set burnchain parameters in PoX contract");

stackslib/src/chainstate/nakamoto/mod.rs

@@ -4945,7 +4945,7 @@ impl NakamotoChainState {
                     &ast,
                     &contract_content,
                     None,
-                    |_, _| false,
+                    |_, _| None,
                     None,
                 )
                 .unwrap();

stackslib/src/chainstate/nakamoto/signer_set.rs

@@ -335,7 +335,7 @@ impl NakamotoSigners {
                         )
                     })
                 },
-                |_, _| false,
+                |_, _| None,
             )
             .expect("FATAL: failed to update signer stackerdb");
 

stackslib/src/chainstate/stacks/boot/contract_tests.rs

@@ -1177,7 +1177,7 @@ fn pox_2_delegate_extend_units() {
                     Value::UInt(25),
                     Value::UInt(0),
                 ],
-                |_, _| false,
+                |_, _| None,
                 None,
             )
         })
@@ -1780,15 +1780,7 @@ fn test_deploy_smart_contract(
     block.as_transaction(|tx| {
         let (ast, analysis) =
             tx.analyze_smart_contract(contract_id, version, content, ASTRules::PrecheckSize)?;
-        tx.initialize_smart_contract(
-            contract_id,
-            version,
-            &ast,
-            content,
-            None,
-            |_, _| false,
-            None,
-        )?;
+        tx.initialize_smart_contract(contract_id, version, &ast, content, None, |_, _| None, None)?;
         tx.save_analysis(contract_id, &analysis)?;
         return Ok(());
     })

stackslib/src/chainstate/stacks/boot/mod.rs

@@ -562,7 +562,7 @@ impl StacksChainState {
                             )
                         })
                     },
-                    |_, _| false,
+                    |_, _| None,
                 )
                 .expect("FATAL: failed to handle PoX unlock");
 

stackslib/src/chainstate/stacks/db/blocks.rs

@@ -4175,7 +4175,7 @@ impl StacksChainState {
                     &boot_code_id(active_pox_contract, mainnet),
                     "stack-stx",
                     &args,
-                    |_, _| false,
+                    |_, _| None,
                     None,
                 )
             });
@@ -4384,7 +4384,7 @@ impl StacksChainState {
                         until_burn_height_val,
                         reward_addr_val,
                     ],
-                    |_, _| false,
+                    |_, _| None,
                     None,
                 )
             });
@@ -4491,7 +4491,7 @@ impl StacksChainState {
                         Value::UInt(round.clone().into()),
                         Value::UInt(reward_cycle.clone().into()),
                     ],
-                    |_, _| false,
+                    |_, _| None,
                     None,
                 )
             });

stackslib/src/chainstate/stacks/db/mod.rs

@@ -1624,7 +1624,7 @@ impl StacksChainState {
                     &contract,
                     "set-burnchain-parameters",
                     &params,
-                    |_, _| false,
+                    |_, _| None,
                     None,
                 )
                 .expect("Failed to set burnchain parameters in PoX contract");