Handle IBC deposits/withdraws to/from payment addresses

.changelog/unreleased/improvements/4939-znam-ibc-shielding.md

@@ -0,0 +1,4 @@
+- Allow IBC deposits into payment addresses (without generating MASP
+  transactions), and IBC withdraws from payment addresses (to automatically
+  get refunded, if an IBC unshielding transfer fails on the counter-party).
+  ([\#4939](https://github.com/namada-net/namada/pull/4939))

.github/workflows/scripts/e2e.json

@@ -1,5 +1,6 @@
 {
     "e2e::eth_bridge_tests::everything": 4,
+    "e2e::ibc_tests::ibc_to_and_from_payment_addrs": 350,
     "e2e::ibc_tests::frontend_sus_fee": 350,
     "e2e::ibc_tests::ibc_transfers": 414,
     "e2e::ibc_tests::ibc_nft_transfers": 224,

crates/apps_lib/src/cli.rs

@@ -3623,7 +3623,6 @@ pub mod args {
         arg_opt("output-folder-path");
     pub const OSMOSIS_POOL_HOP: ArgMulti<OsmosisPoolHop, GlobStar> =
         arg_multi("pool-hop");
-    pub const OVERFLOW_OPT: ArgOpt<WalletAddress> = arg_opt("overflow-addr");
     pub const OWNER: Arg<WalletAddress> = arg("owner");
     pub const OWNER_OPT: ArgOpt<WalletAddress> = OWNER.opt();
     pub const PATH: Arg<PathBuf> = arg("path");
@@ -5311,18 +5310,15 @@ pub mod args {
                 Either::Left(r) => Either::Left(chain_ctx.get(&r)),
                 Either::Right(r) => Either::Right(chain_ctx.get(&r)),
             };
-            let overflow = self.overflow.map(|r| chain_ctx.get(&r));
             Ok(TxOsmosisSwap {
                 transfer: self.transfer.to_sdk(ctx)?,
                 output_denom: self.output_denom,
                 recipient,
-                overflow,
                 slippage: self.slippage,
                 local_recovery_addr: self.local_recovery_addr,
                 route: self.route,
                 osmosis_lcd_rpc: self.osmosis_lcd_rpc,
                 osmosis_sqs_rpc: self.osmosis_sqs_rpc,
-                frontend_sus_fee: None,
             })
         }
     }
@@ -5336,7 +5332,6 @@ pub mod args {
             let maybe_trans_recipient = TARGET_OPT.parse(matches);
             let maybe_shielded_recipient =
                 PAYMENT_ADDRESS_TARGET_OPT.parse(matches);
-            let maybe_overflow = OVERFLOW_OPT.parse(matches);
             let slippage_percent = SLIPPAGE.parse(matches);
             if slippage_percent.is_some_and(|percent| {
                 let zero = Dec::zero();
@@ -5369,13 +5364,11 @@ pub mod args {
                 } else {
                     Either::Right(maybe_shielded_recipient.unwrap())
                 },
-                overflow: maybe_overflow,
                 slippage,
                 local_recovery_addr,
                 route,
                 osmosis_lcd_rpc,
                 osmosis_sqs_rpc,
-                frontend_sus_fee: None,
             }
         }
 
@@ -5409,7 +5402,6 @@ pub mod args {
                 .arg(
                     TARGET_OPT
                         .def()
-                        .conflicts_with(OVERFLOW_OPT.name)
                         .conflicts_with(PAYMENT_ADDRESS_TARGET_OPT.name)
                         .help(wrap!(
                             "Transparent Namada address that shall receive \
@@ -5425,15 +5417,6 @@ pub mod args {
                              minimum amount of tokens swapped on Osmosis."
                         )),
                 )
-                .arg(OVERFLOW_OPT.def().help(wrap!(
-                    "Transparent address that receives the amount of target \
-                     asset exceeding the minimum trade amount. Only \
-                     applicable when shielding assets that have been swapped \
-                     on Osmosis. This address should not be linkable to any \
-                     of the user's personal accounts, to maximize the privacy \
-                     of the trade. If unspecified, a disposable address is \
-                     generated."
-                )))
                 .arg(SLIPPAGE.def().help(wrap!(
                     "Slippage percentage, as a number between 0 and 100. \
                      Represents the maximum acceptable deviation from the \

crates/benches/native_vps.rs

@@ -41,12 +41,12 @@ use namada_apps_lib::masp_primitives::merkle_tree::CommitmentTree;
 use namada_apps_lib::masp_primitives::transaction::Transaction;
 use namada_apps_lib::masp_proofs::sapling::SaplingVerificationContextInner;
 use namada_apps_lib::proof_of_stake::KeySeg;
-use namada_apps_lib::state::{Epoch, StorageRead, StorageWrite, TxIndex};
+use namada_apps_lib::state::{Epoch, StorageRead, StorageWrite};
 use namada_apps_lib::token::masp::{
     PVKs, partial_deauthorize, preload_verifying_keys,
 };
 use namada_apps_lib::token::{Amount, Transfer};
-use namada_apps_lib::tx::{BatchedTx, Code, Section, Tx};
+use namada_apps_lib::tx::{BatchedTx, Code, IndexedTx, Section, Tx};
 use namada_apps_lib::validation::{
     EthBridgeNutVp, EthBridgePoolVp, EthBridgeVp, GovernanceVp, IbcVp,
     IbcVpContext, MaspVp, MultitokenVp, ParametersVp, PgfVp, PosVp,
@@ -222,12 +222,13 @@ fn governance(c: &mut Criterion) {
         let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
             &TxGasMeter::new(u64::MAX, 1),
         ));
+        let indexed_tx = IndexedTx::default();
         let ctx = Ctx::new(
             &Address::Internal(InternalAddress::Governance),
             &shell.state,
             &signed_tx.tx,
             &signed_tx.cmt,
-            &TxIndex(0),
+            &indexed_tx,
             &gas_meter,
             &keys_changed,
             &verifiers,
@@ -294,13 +295,14 @@ fn governance(c: &mut Criterion) {
 //              .write_log
 //              .verifiers_and_changed_keys(&verifiers_from_tx);
 
+//          let indexed_tx = IndexedTx::default();
 //          let slash_fund = SlashFundVp {
 //              ctx: Ctx::new(
 //                  &Address::Internal(InternalAddress::SlashFund),
 //                  &shell.state.storage,
 //                  &shell.state.write_log,
 //                  &tx,
-//                  &TxIndex(0),
+//                  &indexed_tx,
 //
 // VpGasMeter::new_from_tx_meter(&TxGasMeter::new(
 // u64::MAX.into(),                  )),
@@ -451,12 +453,13 @@ fn ibc(c: &mut Criterion) {
             &TxGasMeter::new(u64::MAX, 1),
         ));
         let shell_read = shielded_ctx.shell.read();
+        let indexed_tx = IndexedTx::default();
         let ibc = IbcVp::new(Ctx::new(
             &Address::Internal(InternalAddress::Ibc),
             &shell_read.state,
             &signed_tx.tx,
             &signed_tx.cmt,
-            &TxIndex(0),
+            &indexed_tx,
             &gas_meter,
             &keys_changed,
             &verifiers,
@@ -519,12 +522,13 @@ fn vp_multitoken(c: &mut Criterion) {
         let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
             &TxGasMeter::new(u64::MAX, 1),
         ));
+        let indexed_tx = IndexedTx::default();
         let ctx = Ctx::new(
             &Address::Internal(InternalAddress::Multitoken),
             &shell.state,
             &signed_tx.tx,
             &signed_tx.cmt,
-            &TxIndex(0),
+            &indexed_tx,
             &gas_meter,
             &keys_changed,
             &verifiers,
@@ -644,12 +648,13 @@ fn masp(c: &mut Criterion) {
             let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
                 &TxGasMeter::new(u64::MAX, 1),
             ));
+            let indexed_tx = IndexedTx::default();
             let ctx = Ctx::new(
                 &Address::Internal(InternalAddress::Masp),
                 &shell_read.state,
                 &signed_tx.tx,
                 &signed_tx.cmt,
-                &TxIndex(0),
+                &indexed_tx,
                 &gas_meter,
                 &keys_changed,
                 &verifiers,
@@ -1271,12 +1276,13 @@ fn pgf(c: &mut Criterion) {
         let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
             &TxGasMeter::new(u64::MAX, 1),
         ));
+        let indexed_tx = IndexedTx::default();
         let ctx = Ctx::new(
             &Address::Internal(InternalAddress::Pgf),
             &shell.state,
             &signed_tx.tx,
             &signed_tx.cmt,
-            &TxIndex(0),
+            &indexed_tx,
             &gas_meter,
             &keys_changed,
             &verifiers,
@@ -1349,12 +1355,13 @@ fn eth_bridge_nut(c: &mut Criterion) {
     let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
         &TxGasMeter::new(u64::MAX, 1),
     ));
+    let indexed_tx = IndexedTx::default();
     let ctx = Ctx::new(
         &vp_address,
         &shell.state,
         &signed_tx.tx,
         &signed_tx.cmt,
-        &TxIndex(0),
+        &indexed_tx,
         &gas_meter,
         &keys_changed,
         &verifiers,
@@ -1423,12 +1430,13 @@ fn eth_bridge(c: &mut Criterion) {
     let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
         &TxGasMeter::new(u64::MAX, 1),
     ));
+    let indexed_tx = IndexedTx::default();
     let ctx = Ctx::new(
         &vp_address,
         &shell.state,
         &signed_tx.tx,
         &signed_tx.cmt,
-        &TxIndex(0),
+        &indexed_tx,
         &gas_meter,
         &keys_changed,
         &verifiers,
@@ -1522,12 +1530,13 @@ fn eth_bridge_pool(c: &mut Criterion) {
     let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
         &TxGasMeter::new(u64::MAX, 1),
     ));
+    let indexed_tx = IndexedTx::default();
     let ctx = Ctx::new(
         &vp_address,
         &shell.state,
         &signed_tx.tx,
         &signed_tx.cmt,
-        &TxIndex(0),
+        &indexed_tx,
         &gas_meter,
         &keys_changed,
         &verifiers,
@@ -1596,12 +1605,13 @@ fn parameters(c: &mut Criterion) {
         let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
             &TxGasMeter::new(u64::MAX, 1),
         ));
+        let indexed_tx = IndexedTx::default();
         let ctx = Ctx::new(
             &vp_address,
             &shell.state,
             &signed_tx.tx,
             &signed_tx.cmt,
-            &TxIndex(0),
+            &indexed_tx,
             &gas_meter,
             &keys_changed,
             &verifiers,
@@ -1673,12 +1683,13 @@ fn pos(c: &mut Criterion) {
         let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
             &TxGasMeter::new(u64::MAX, 1),
         ));
+        let indexed_tx = IndexedTx::default();
         let ctx = Ctx::new(
             &vp_address,
             &shell.state,
             &signed_tx.tx,
             &signed_tx.cmt,
-            &TxIndex(0),
+            &indexed_tx,
             &gas_meter,
             &keys_changed,
             &verifiers,
@@ -1727,12 +1738,13 @@ fn ibc_vp_validate_action(c: &mut Criterion) {
         let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
             &TxGasMeter::new(u64::MAX, 1),
         ));
+        let indexed_tx = IndexedTx::default();
         let ibc = IbcVp::new(Ctx::new(
             &Address::Internal(InternalAddress::Ibc),
             &shell_read.state,
             &signed_tx.tx,
             &signed_tx.cmt,
-            &TxIndex(0),
+            &indexed_tx,
             &gas_meter,
             &keys_changed,
             &verifiers,
@@ -1745,17 +1757,20 @@ fn ibc_vp_validate_action(c: &mut Criterion) {
 
         let exec_ctx = IbcVpContext::new(ibc.ctx.pre());
         let ctx = Rc::new(RefCell::new(exec_ctx));
-        let mut actions =
-            IbcActions::<_, parameters::Store<_>, token::Store<()>>::new(
-                ctx.clone(),
-                verifiers.clone(),
-            );
+        let mut actions = IbcActions::<
+            _,
+            parameters::Store<_>,
+            token::Store<_>,
+            token::ShieldedStore<_>,
+        >::new(ctx.clone(), verifiers.clone());
         actions.set_validation_params(ibc.validation_params().unwrap());
 
-        let module = create_transfer_middlewares::<_, parameters::Store<_>>(
-            ctx.clone(),
-            verifiers,
-        );
+        let module = create_transfer_middlewares::<
+            _,
+            parameters::Store<_>,
+            token::Store<_>,
+            token::ShieldedStore<_>,
+        >(ctx.clone(), verifiers);
         actions.add_transfer_module(module);
         let module = NftTransferModule::<_, token::Store<()>>::new(ctx);
         actions.add_transfer_module(module);
@@ -1791,12 +1806,13 @@ fn ibc_vp_execute_action(c: &mut Criterion) {
         let gas_meter = RefCell::new(VpGasMeter::new_from_tx_meter(
             &TxGasMeter::new(u64::MAX, 1),
         ));
+        let indexed_tx = IndexedTx::default();
         let ibc = IbcVp::new(Ctx::new(
             &Address::Internal(InternalAddress::Ibc),
             &shell_read.state,
             &signed_tx.tx,
             &signed_tx.cmt,
-            &TxIndex(0),
+            &indexed_tx,
             &gas_meter,
             &keys_changed,
             &verifiers,
@@ -1810,17 +1826,20 @@ fn ibc_vp_execute_action(c: &mut Criterion) {
         let exec_ctx = IbcVpContext::new(ibc.ctx.pre());
         let ctx = Rc::new(RefCell::new(exec_ctx));
 
-        let mut actions =
-            IbcActions::<_, parameters::Store<_>, token::Store<()>>::new(
-                ctx.clone(),
-                verifiers.clone(),
-            );
+        let mut actions = IbcActions::<
+            _,
+            parameters::Store<_>,
+            token::Store<_>,
+            token::ShieldedStore<_>,
+        >::new(ctx.clone(), verifiers.clone());
         actions.set_validation_params(ibc.validation_params().unwrap());
 
-        let module = create_transfer_middlewares::<_, parameters::Store<_>>(
-            ctx.clone(),
-            verifiers,
-        );
+        let module = create_transfer_middlewares::<
+            _,
+            parameters::Store<_>,
+            token::Store<_>,
+            token::ShieldedStore<_>,
+        >(ctx.clone(), verifiers);
         actions.add_transfer_module(module);
         let module = NftTransferModule::<_, token::Store<()>>::new(ctx);
         actions.add_transfer_module(module);

crates/benches/process_wrapper.rs

@@ -1,6 +1,5 @@
 use criterion::{Criterion, criterion_group, criterion_main};
 use namada_apps_lib::key::RefTo;
-use namada_apps_lib::state::TxIndex;
 use namada_apps_lib::time::DateTimeUtc;
 use namada_apps_lib::token::{Amount, DenominatedAmount, Transfer};
 use namada_apps_lib::tx::Authorization;
@@ -90,7 +89,7 @@ fn process_tx(c: &mut Criterion) {
                     shell
                         .check_proposal_tx(
                             &wrapper,
-                            &TxIndex::default(),
+                            Default::default(),
                             validation_meta,
                             temp_state,
                             datetime,

crates/core/Cargo.toml

@@ -46,6 +46,7 @@ ed25519-consensus.workspace = true
 ethabi.workspace = true
 ethbridge-structs.workspace = true
 eyre.workspace = true
+group.workspace = true
 ibc.workspace = true
 ics23.workspace = true
 impl-num-traits.workspace = true