Merge branch 'origin/grarco/masp-fee-payment' (#3393)

* origin/grarco/masp-fee-payment:
  Removes fallback logic when failed fee payment
  Renames misleading gas limit variable
  Removes useless write-log commit in fee payment
  Fixes typo
  Fixes masp amounts conversion
  Fixes broken docs
  Reuses token transfer
  Fixes typo
  Panics in fee payment if balance read fails
  Changelog #3393
  Adds missing gas spending key arg to ibc tx
  Masp fee payment for shielded actions
  Fixes masp tx generation and integration tests
  Updates shielded wasm code to handle fee unshielding
  Removes unused denominate function
  Adds support for masp fee payment in sdk
  Refactors the write log api
  Different gas cost for storage deletes
  Removes write log precommit and leverages the batch log
  Adds integration tests for masp fee payment
  Refactors batch execution in case of masp fee payment
  Skips the execution of the first inner tx when masp fee payment
  Renames fee payment gas limit parameter
  Returns `BatchedTxResult` from masp fee payment
  `check_fees` drop the storage changes in case of failure
  `check_fees` checks masp fee payment
  Reworks masp fee payment to correctly handle errors. Misc refactors
  Passes the correct tx index to masp fee payment check
  Introduces masp fee payment

.changelog/unreleased/features/3393-masp-fee-payment.md

@@ -0,0 +1,2 @@
+- Added support for fee payment directly from the MASP pool.
+  ([\#3393](https://github.com/anoma/namada/pull/3393))

crates/apps_lib/src/cli.rs

@@ -3249,6 +3249,8 @@ pub mod args {
         "gas-limit",
         DefaultFn(|| GasLimit::from(DEFAULT_GAS_LIMIT)),
     );
+    pub const GAS_SPENDING_KEY: ArgOpt<WalletSpendingKey> =
+        arg_opt("gas-spending-key");
     pub const FEE_TOKEN: ArgDefaultFromCtx<WalletAddrOrNativeToken> =
         arg_default_from_ctx("gas-token", DefaultFn(|| "".parse().unwrap()));
     pub const FEE_PAYER: Arg<WalletAddress> = arg("fee-payer");
@@ -4443,9 +4445,16 @@ pub mod args {
                 });
             }
 
+            let gas_spending_keys = self
+                .gas_spending_keys
+                .iter()
+                .map(|key| chain_ctx.get_cached(key))
+                .collect();
+
             Ok(TxShieldedTransfer::<SdkTypes> {
                 tx,
                 data,
+                gas_spending_keys,
                 tx_code_path: self.tx_code_path.to_path_buf(),
             })
         }
@@ -4465,10 +4474,15 @@ pub mod args {
                 token,
                 amount,
             }];
+            let mut gas_spending_keys = vec![];
+            if let Some(key) = GAS_SPENDING_KEY.parse(matches) {
+                gas_spending_keys.push(key);
+            }
 
             Self {
                 tx,
                 data,
+                gas_spending_keys,
                 tx_code_path,
             }
         }
@@ -4491,6 +4505,10 @@ pub mod args {
                         .def()
                         .help(wrap!("The amount to transfer in decimal.")),
                 )
+                .arg(GAS_SPENDING_KEY.def().help(wrap!(
+                    "The optional spending key that will be used in addition \
+                     to the source for gas payment."
+                )))
         }
     }
 
@@ -4584,10 +4602,16 @@ pub mod args {
                     amount: transfer_data.amount,
                 });
             }
+            let gas_spending_keys = self
+                .gas_spending_keys
+                .iter()
+                .map(|key| chain_ctx.get_cached(key))
+                .collect();
 
             Ok(TxUnshieldingTransfer::<SdkTypes> {
                 tx,
                 data,
+                gas_spending_keys,
                 source: chain_ctx.get_cached(&self.source),
                 tx_code_path: self.tx_code_path.to_path_buf(),
             })
@@ -4607,11 +4631,16 @@ pub mod args {
                 token,
                 amount,
             }];
+            let mut gas_spending_keys = vec![];
+            if let Some(key) = GAS_SPENDING_KEY.parse(matches) {
+                gas_spending_keys.push(key);
+            }
 
             Self {
                 tx,
                 source,
                 data,
+                gas_spending_keys,
                 tx_code_path,
             }
         }
@@ -4634,6 +4663,10 @@ pub mod args {
                         .def()
                         .help(wrap!("The amount to transfer in decimal.")),
                 )
+                .arg(GAS_SPENDING_KEY.def().help(wrap!(
+                    "The optional spending key that will be used in addition \
+                     to the source for gas payment."
+                )))
         }
     }
 
@@ -4646,6 +4679,11 @@ pub mod args {
         ) -> Result<TxIbcTransfer<SdkTypes>, Self::Error> {
             let tx = self.tx.to_sdk(ctx)?;
             let chain_ctx = ctx.borrow_mut_chain_or_exit();
+            let gas_spending_keys = self
+                .gas_spending_keys
+                .iter()
+                .map(|key| chain_ctx.get_cached(key))
+                .collect();
 
             Ok(TxIbcTransfer::<SdkTypes> {
                 tx,
@@ -4659,6 +4697,7 @@ pub mod args {
                 timeout_sec_offset: self.timeout_sec_offset,
                 refund_target: chain_ctx.get_opt(&self.refund_target),
                 memo: self.memo,
+                gas_spending_keys,
                 tx_code_path: self.tx_code_path.to_path_buf(),
             })
         }
@@ -4680,6 +4719,10 @@ pub mod args {
                 std::fs::read_to_string(path)
                     .expect("Expected a file at given path")
             });
+            let mut gas_spending_keys = vec![];
+            if let Some(key) = GAS_SPENDING_KEY.parse(matches) {
+                gas_spending_keys.push(key);
+            }
             let tx_code_path = PathBuf::from(TX_IBC_WASM);
             Self {
                 tx,
@@ -4693,6 +4736,7 @@ pub mod args {
                 timeout_sec_offset,
                 refund_target,
                 memo,
+                gas_spending_keys,
                 tx_code_path,
             }
         }
@@ -4729,6 +4773,11 @@ pub mod args {
                 .arg(IBC_TRANSFER_MEMO_PATH.def().help(wrap!(
                     "The path for the memo field of ICS20 transfer."
                 )))
+                .arg(GAS_SPENDING_KEY.def().help(wrap!(
+                    "The optional spending key that will be used in addition \
+                     to the source for gas payment (if this is a shielded \
+                     action)."
+                )))
         }
     }
 

crates/apps_lib/src/client/rpc.rs

@@ -649,16 +649,16 @@ pub async fn query_protocol_parameters(
         .expect("Parameter should be defined.");
     display_line!(context.io(), "{:4}Max block gas: {:?}", "", max_block_gas);
 
-    let key = param_storage::get_fee_unshielding_gas_limit_key();
-    let fee_unshielding_gas_limit: u64 =
+    let key = param_storage::get_masp_fee_payment_gas_limit_key();
+    let masp_fee_payment_gas_limit: u64 =
         query_storage_value(context.client(), &key)
             .await
             .expect("Parameter should be defined.");
     display_line!(
         context.io(),
-        "{:4}Fee unshielding gas limit: {:?}",
+        "{:4}Masp fee payment gas limit: {:?}",
         "",
-        fee_unshielding_gas_limit
+        masp_fee_payment_gas_limit
     );
 
     let key = param_storage::get_gas_cost_key();

crates/apps_lib/src/config/genesis.rs

@@ -309,8 +309,8 @@ pub struct Parameters {
     pub epochs_per_year: u64,
     /// How many epochs it takes to transition to the next masp epoch
     pub masp_epoch_multiplier: u64,
-    /// Fee unshielding gas limit
-    pub fee_unshielding_gas_limit: u64,
+    /// The gas limit for a masp transaction paying fees
+    pub masp_fee_payment_gas_limit: u64,
     /// Gas scale
     pub gas_scale: u64,
     /// Map of the cost per gas unit for every token allowed for fee payment

crates/apps_lib/src/config/genesis/chain.rs

@@ -302,7 +302,7 @@ impl Finalized {
             implicit_vp,
             epochs_per_year,
             masp_epoch_multiplier,
-            fee_unshielding_gas_limit,
+            masp_fee_payment_gas_limit,
             gas_scale,
             max_block_gas,
             minimum_gas_price,
@@ -344,7 +344,7 @@ impl Finalized {
             epochs_per_year,
             masp_epoch_multiplier,
             max_proposal_bytes,
-            fee_unshielding_gas_limit,
+            masp_fee_payment_gas_limit,
             gas_scale,
             max_block_gas,
             minimum_gas_price: minimum_gas_price

crates/apps_lib/src/config/genesis/templates.rs

@@ -294,8 +294,8 @@ pub struct ChainParams<T: TemplateValidation> {
     pub masp_epoch_multiplier: u64,
     /// Max gas for block
     pub max_block_gas: u64,
-    /// Fee unshielding gas limit
-    pub fee_unshielding_gas_limit: u64,
+    /// Gas limit of a masp transaction paying fees
+    pub masp_fee_payment_gas_limit: u64,
     /// Gas scale
     pub gas_scale: u64,
     /// Map of the cost per gas unit for every token allowed for fee payment
@@ -319,7 +319,7 @@ impl ChainParams<Unvalidated> {
             epochs_per_year,
             masp_epoch_multiplier,
             max_block_gas,
-            fee_unshielding_gas_limit,
+            masp_fee_payment_gas_limit,
             gas_scale,
             minimum_gas_price,
         } = self;
@@ -364,7 +364,7 @@ impl ChainParams<Unvalidated> {
             epochs_per_year,
             masp_epoch_multiplier,
             max_block_gas,
-            fee_unshielding_gas_limit,
+            masp_fee_payment_gas_limit,
             gas_scale,
             minimum_gas_price: min_gas_prices,
         })

crates/benches/process_wrapper.rs

@@ -3,6 +3,7 @@ use namada::core::address;
 use namada::core::key::RefTo;
 use namada::core::storage::BlockHeight;
 use namada::core::time::DateTimeUtc;
+use namada::state::TxIndex;
 use namada::token::{
     Amount, DenominatedAmount, TransparentTransfer, TransparentTransferData,
 };
@@ -80,6 +81,7 @@ fn process_tx(c: &mut Criterion) {
                     shell
                         .check_proposal_tx(
                             &wrapper,
+                            &TxIndex::default(),
                             validation_meta,
                             temp_state,
                             datetime,

crates/core/src/masp.rs

@@ -370,7 +370,15 @@ impl<'de> serde::Deserialize<'de> for PaymentAddress {
 
 /// Wrapper for masp_primitive's ExtendedSpendingKey
 #[derive(
-    Clone, Debug, Copy, BorshSerialize, BorshDeserialize, BorshDeserializer,
+    Clone,
+    Debug,
+    Copy,
+    BorshSerialize,
+    BorshDeserialize,
+    BorshDeserializer,
+    Hash,
+    Eq,
+    PartialEq,
 )]
 pub struct ExtendedSpendingKey(masp_primitives::zip32::ExtendedSpendingKey);
 
@@ -435,7 +443,7 @@ impl<'de> serde::Deserialize<'de> for ExtendedSpendingKey {
 }
 
 /// Represents a source of funds for a transfer
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, Hash, Eq, PartialEq)]
 pub enum TransferSource {
     /// A transfer coming from a transparent address
     Address(Address),
@@ -543,7 +551,16 @@ pub fn addr_taddr(addr: Address) -> TransparentAddress {
 }
 
 /// Represents a target for the funds of a transfer
-#[derive(Debug, Clone, BorshDeserialize, BorshSerialize, BorshDeserializer)]
+#[derive(
+    Debug,
+    Clone,
+    BorshDeserialize,
+    BorshSerialize,
+    BorshDeserializer,
+    Hash,
+    Eq,
+    PartialEq,
+)]
 pub enum TransferTarget {
     /// A transfer going to a transparent address
     Address(Address),

crates/core/src/parameters.rs

@@ -47,8 +47,8 @@ pub struct Parameters {
     /// The multiplier for masp epochs (it requires this amount of epochs to
     /// transition to the next masp epoch)
     pub masp_epoch_multiplier: u64,
-    /// Fee unshielding gas limit
-    pub fee_unshielding_gas_limit: u64,
+    /// The gas limit for a masp transaction paying fees
+    pub masp_fee_payment_gas_limit: u64,
     /// Gas scale
     pub gas_scale: u64,
     /// Map of the cost per gas unit for every token allowed for fee payment

crates/core/src/token.rs

@@ -231,13 +231,16 @@ impl Amount {
         Self { raw: Uint(raw) }
     }
 
-    /// Given a u128 and [`MaspDigitPos`], construct the corresponding
+    /// Given a i128 and [`MaspDigitPos`], construct the corresponding
     /// amount.
-    pub fn from_masp_denominated_u128(
-        val: u128,
+    pub fn from_masp_denominated_i128(
+        val: i128,
         denom: MaspDigitPos,
     ) -> Option<Self> {
-        let lo = u64::try_from(val).ok()?;
+        #[allow(clippy::cast_sign_loss)]
+        #[allow(clippy::cast_possible_truncation)]
+        let lo = val as u64;
+        #[allow(clippy::cast_sign_loss)]
         let hi = (val >> 64) as u64;
         let lo_pos = denom as usize;
         let hi_pos = lo_pos.checked_add(1)?;
@@ -922,18 +925,6 @@ impl MaspDigitPos {
         let amount = amount.into();
         amount.raw.0[*self as usize]
     }
-
-    /// Get the corresponding u64 word from the input uint256.
-    pub fn denominate_i128(&self, amount: &Change) -> i128 {
-        let val = i128::from(amount.abs().0[*self as usize]);
-        if Change::is_negative(amount) {
-            // Cannot panic as the value is limited to `u64` range
-            #[allow(clippy::arithmetic_side_effects)]
-            -val
-        } else {
-            val
-        }
-    }
 }
 
 impl From<Amount> for IbcAmount {

crates/gas/src/lib.rs

@@ -74,6 +74,9 @@ pub const STORAGE_ACCESS_GAS_PER_BYTE: u64 =
 /// The cost of writing data to storage, per byte
 pub const STORAGE_WRITE_GAS_PER_BYTE: u64 =
     MEMORY_ACCESS_GAS_PER_BYTE + 69_634 + STORAGE_OCCUPATION_GAS_PER_BYTE;
+/// The cost of removing data from storage, per byte
+pub const STORAGE_DELETE_GAS_PER_BYTE: u64 =
+    MEMORY_ACCESS_GAS_PER_BYTE + 69_634 + PHYSICAL_STORAGE_LATENCY_PER_BYTE;
 /// The cost of verifying a single signature of a transaction
 pub const VERIFY_TX_SIG_GAS: u64 = 594_290;
 /// The cost for requesting one more page in wasm (64KiB)

crates/ibc/src/actions.rs

@@ -212,6 +212,7 @@ where
     let data = MsgTransfer {
         message,
         transfer: None,
+        fee_unshield: None,
     }
     .serialize_to_vec();