Runtime gas meter

.changelog/unreleased/improvements/2838-runtime-gas-meter.md

@@ -0,0 +1,2 @@
+- Improved the gas metering system to track gas at runtime in wasm.
+  ([\#2838](https://github.com/anoma/namada/pull/2838))

Cargo.toml

@@ -176,6 +176,10 @@ tracing-appender = "0.2.2"
 tracing-log = "0.1.2"
 tracing-subscriber = {version = "0.3.7", default-features = false, features = ["env-filter", "fmt"]}
 wasmparser = "0.107.0"
+wasm-instrument = {version = "0.4.0", features = ["sign_ext"]}
+wasmer = {git = "https://github.com/heliaxdev/wasmer", rev = "255054f7f58b7b4a525f2fee6b9b86422d1ca15b"}
+wasmer-compiler-singlepass = { git = "https://github.com/heliaxdev/wasmer", rev = "255054f7f58b7b4a525f2fee6b9b86422d1ca15b" }
+wasmer-engine-universal = { git = "https://github.com/heliaxdev/wasmer", rev = "255054f7f58b7b4a525f2fee6b9b86422d1ca15b" }
 winapi = "0.3.9"
 yansi = "0.5.1"
 zeroize = { version = "1.5.5", features = ["zeroize_derive"] }

Makefile

@@ -108,8 +108,10 @@ check-crates:
 
 clippy-wasm = $(cargo) +$(nightly) clippy --manifest-path $(wasm)/Cargo.toml --all-targets -- -D warnings
 
+# Need a separate command for benchmarks to prevent the "testing" feature flag from being activated
 clippy:
-	$(cargo) +$(nightly) clippy $(jobs) --all-targets -- -D warnings && \
+	$(cargo) +$(nightly) clippy $(jobs) --all-targets --workspace --exclude namada_benchmarks -- -D warnings && \
+	$(cargo) +$(nightly) clippy $(jobs) --all-targets --package namada_benchmarks -- -D warnings && \
 	make -C $(wasms) clippy && \
 	make -C $(wasms_for_tests) clippy && \
 	$(foreach wasm,$(wasm_templates),$(clippy-wasm) && ) true
@@ -261,7 +263,7 @@ clean:
 	$(cargo) clean
 
 bench:
-	$(cargo) bench --package namada_benchmarks 
+	$(cargo) bench --package namada_benchmarks
 
 build-doc:
 	$(cargo) doc --no-deps

crates/apps/Cargo.toml

@@ -56,7 +56,7 @@ mainnet = [
 ]
 # for integration tests and test utilities
 testing = ["namada_test_utils"]
-benches = ["testing", "namada_test_utils"]
+benches = ["namada_test_utils"]
 integration = []
 jemalloc = ["rocksdb/jemalloc"]
 

crates/apps/src/lib/bench_utils.rs

@@ -61,6 +61,7 @@
 use namada::ibc::primitives::proto::{Any, Protobuf};
 use namada::ibc::primitives::{Msg, Timestamp as IbcTimestamp};
 use namada::ibc::storage::port_key;
+use namada::ibc::{IbcShieldedTransfer, MsgShieldedTransfer};
 use namada::io::StdIo;
 use namada::ledger::dry_run_tx;
 use namada::ledger::gas::TxGasMeter;
@@ -329,7 +330,7 @@
         tx
     }
 
-    pub fn generate_ibc_tx(&self, wasm_code_path: &str, msg: impl Msg) -> Tx {
+    pub fn generate_ibc_tx(&self, wasm_code_path: &str, msg: Vec<u8>) -> Tx {
         // This function avoid serializaing the tx data with Borsh
         let mut tx = Tx::from_type(namada::tx::data::TxType::Decrypted(
             namada::tx::data::DecryptedTx::Decrypted,
@@ -341,10 +342,7 @@
             code_hash,
             Some(wasm_code_path.to_string()),
         ));
-
-        let mut data = vec![];
-        prost::Message::encode(&msg.to_any(), &mut data).unwrap();
-        tx.set_data(Data::new(data));
+        tx.set_data(Data::new(msg));
 
         // NOTE: the Ibc VP doesn't actually check the signature
         tx
@@ -384,7 +382,10 @@
             timeout_timestamp_on_b: timeout_timestamp,
         };
 
-        self.generate_ibc_tx(TX_IBC_WASM, msg)
+        let mut data = vec![];
+        prost::Message::encode(&msg.to_any(), &mut data).unwrap();
+
+        self.generate_ibc_tx(TX_IBC_WASM, data)
     }
 
     pub fn execute_tx(&mut self, tx: &Tx) {
@@ -560,6 +561,11 @@
             .unwrap();
 
         self.inner.commit();
+        self.inner
+            .state
+            .in_mem_mut()
+            .set_header(get_dummy_header())
+            .unwrap();
     }
 
     // Commit a masp transaction and cache the tx and the changed keys for
@@ -1070,4 +1076,70 @@
         };
         (ctx, tx)
     }
+
+    pub fn generate_shielded_action(
+        self,
+        amount: Amount,
+        source: TransferSource,
+        target: TransferTarget,
+    ) -> (Self, Tx) {
+        let (ctx, tx) = self.generate_masp_tx(
+            amount,
+            source.clone(),
+            TransferTarget::Address(Address::Internal(InternalAddress::Ibc)),
+        );
+
+        let token = PrefixedCoin {
+            denom: address::testing::nam().to_string().parse().unwrap(),
+            amount: amount
+                .to_string_native()
+                .split('.')
+                .next()
+                .unwrap()
+                .to_string()
+                .parse()
+                .unwrap(),
+        };
+        let timeout_height = TimeoutHeight::At(IbcHeight::new(0, 100).unwrap());
+
+        let now: namada::tendermint::Time =
+            DateTimeUtc::now().try_into().unwrap();
+        let now: IbcTimestamp = now.into();
+        let timeout_timestamp =
+            (now + std::time::Duration::new(3600, 0)).unwrap();
+        let msg = MsgTransfer {
+            port_id_on_a: PortId::transfer(),
+            chan_id_on_a: ChannelId::new(5),
+            packet_data: PacketData {
+                token,
+                sender: source.effective_address().to_string().into(),
+                receiver: target.effective_address().to_string().into(),
+                memo: "".parse().unwrap(),
+            },
+            timeout_height_on_b: timeout_height,
+            timeout_timestamp_on_b: timeout_timestamp,
+        };
+
+        let transfer =
+            Transfer::deserialize(&mut tx.data().unwrap().as_slice()).unwrap();
+        let masp_tx = tx
+            .get_section(&transfer.shielded.unwrap())
+            .unwrap()
+            .masp_tx()
+            .unwrap();
+        let msg = MsgShieldedTransfer {
+            message: msg,
+            shielded_transfer: IbcShieldedTransfer {
+                transfer,
+                masp_tx: masp_tx.clone(),
+            },
+        };
+
+        let mut ibc_tx = ctx
+            .shell
+            .generate_ibc_tx(TX_IBC_WASM, msg.serialize_to_vec());
+        ibc_tx.add_masp_tx_section(masp_tx);
+
+        (ctx, ibc_tx)
+    }
 }

crates/apps/src/lib/mod.rs

@@ -5,7 +5,7 @@
 #![deny(rustdoc::broken_intra_doc_links)]
 #![deny(rustdoc::private_intra_doc_links)]
 
-#[cfg(feature = "testing")]
+#[cfg(feature = "benches")]
 pub mod bench_utils;
 pub mod cli;
 pub mod client;

crates/apps/src/lib/node/ledger/mod.rs

@@ -99,7 +99,11 @@
                 tracing::debug!("Request InitChain");
                 self.init_chain(
                     init,
-                    #[cfg(any(test, feature = "testing"))]
+                    #[cfg(any(
+                        test,
+                        feature = "testing",
+                        feature = "benches"
+                    ))]
                     1,
                 )
                 .map(Response::InitChain)

crates/apps/src/lib/node/ledger/shell/finalize_block.rs

@@ -800,7 +800,8 @@ mod test_finalize_block {
         FinalizeBlock, ProcessedTx,
     };
 
-    const GAS_LIMIT_MULTIPLIER: u64 = 100_000_000;
+    const GAS_LIMIT: u64 = 10_000_000_000;
+    const WRAPPER_GAS_LIMIT: u64 = 20_000;
 
     /// Make a wrapper tx and a processed tx from the wrapped tx that can be
     /// added to `FinalizeBlock` request.
@@ -816,7 +817,7 @@ mod test_finalize_block {
                 },
                 keypair.ref_to(),
                 Epoch(0),
-                GAS_LIMIT_MULTIPLIER.into(),
+                WRAPPER_GAS_LIMIT.into(),
                 None,
             ))));
         wrapper_tx.header.chain_id = shell.chain_id.clone();
@@ -857,7 +858,7 @@ mod test_finalize_block {
                 },
                 keypair.ref_to(),
                 Epoch(0),
-                GAS_LIMIT_MULTIPLIER.into(),
+                WRAPPER_GAS_LIMIT.into(),
                 None,
             ))));
         outer_tx.header.chain_id = shell.chain_id.clone();
@@ -973,7 +974,7 @@ mod test_finalize_block {
                 },
                 keypair.ref_to(),
                 Epoch(0),
-                GAS_LIMIT_MULTIPLIER.into(),
+                WRAPPER_GAS_LIMIT.into(),
                 None,
             ))));
         outer_tx.header.chain_id = shell.chain_id.clone();
@@ -1027,7 +1028,7 @@ mod test_finalize_block {
             },
             keypair.ref_to(),
             Epoch(0),
-            GAS_LIMIT_MULTIPLIER.into(),
+            WRAPPER_GAS_LIMIT.into(),
             None,
         ))));
         let processed_tx = ProcessedTx {
@@ -2758,7 +2759,7 @@ mod test_finalize_block {
                 },
                 keypair.ref_to(),
                 Epoch(0),
-                GAS_LIMIT_MULTIPLIER.into(),
+                WRAPPER_GAS_LIMIT.into(),
                 None,
             ))));
         wrapper.header.chain_id = shell.chain_id.clone();
@@ -2775,7 +2776,7 @@ mod test_finalize_block {
             },
             keypair_2.ref_to(),
             Epoch(0),
-            GAS_LIMIT_MULTIPLIER.into(),
+            WRAPPER_GAS_LIMIT.into(),
             None,
         ))));
         new_wrapper.add_section(Section::Signature(Signature::new(
@@ -2816,8 +2817,8 @@ mod test_finalize_block {
             })
         }
 
-        shell.enqueue_tx(wrapper.clone(), GAS_LIMIT_MULTIPLIER.into());
-        shell.enqueue_tx(new_wrapper.clone(), GAS_LIMIT_MULTIPLIER.into());
+        shell.enqueue_tx(wrapper.clone(), GAS_LIMIT.into());
+        shell.enqueue_tx(new_wrapper.clone(), GAS_LIMIT.into());
         // merkle tree root before finalize_block
         let root_pre = shell.shell.state.in_mem().block.tree.root();
 
@@ -2884,7 +2885,7 @@ mod test_finalize_block {
                 },
                 keypair.ref_to(),
                 Epoch(0),
-                GAS_LIMIT_MULTIPLIER.into(),
+                WRAPPER_GAS_LIMIT.into(),
                 None,
             ))));
         unsigned_wrapper.header.chain_id = shell.chain_id.clone();
@@ -2965,16 +2966,10 @@ mod test_finalize_block {
         }
 
         shell.enqueue_tx(out_of_gas_wrapper.clone(), Gas::default());
-        shell.enqueue_tx(
-            undecryptable_wrapper.clone(),
-            GAS_LIMIT_MULTIPLIER.into(),
-        );
+        shell.enqueue_tx(undecryptable_wrapper.clone(), GAS_LIMIT.into());
         shell.enqueue_tx(unsigned_wrapper.clone(), u64::MAX.into()); // Prevent out of gas which would still make the test pass
-        shell.enqueue_tx(
-            wrong_commitment_wrapper.clone(),
-            GAS_LIMIT_MULTIPLIER.into(),
-        );
-        shell.enqueue_tx(failing_wrapper.clone(), GAS_LIMIT_MULTIPLIER.into());
+        shell.enqueue_tx(wrong_commitment_wrapper.clone(), GAS_LIMIT.into());
+        shell.enqueue_tx(failing_wrapper.clone(), GAS_LIMIT.into());
         // merkle tree root before finalize_block
         let root_pre = shell.shell.state.in_mem().block.tree.root();
 
@@ -3138,7 +3133,7 @@ mod test_finalize_block {
                 },
                 keypair.ref_to(),
                 Epoch(0),
-                GAS_LIMIT_MULTIPLIER.into(),
+                WRAPPER_GAS_LIMIT.into(),
                 None,
             ))));
         wrapper.header.chain_id = shell.chain_id.clone();

crates/apps/src/lib/node/ledger/shell/init_chain.rs

@@ -84,7 +84,8 @@ where
     pub fn init_chain(
         &mut self,
         init: request::InitChain,
-        #[cfg(any(test, feature = "testing"))] _num_validators: u64,
+        #[cfg(any(test, feature = "testing", feature = "benches"))]
+        _num_validators: u64,
     ) -> Result<response::InitChain> {
         let mut response = response::InitChain::default();
         let chain_id = self.state.in_mem().chain_id.as_str();

crates/benches/Cargo.toml

@@ -37,16 +37,28 @@ name = "host_env"
 harness = false
 path = "host_env.rs"
 
+[[bench]]
+name = "wasm_opcodes"
+harness = false
+path = "wasm_opcodes.rs"
+
 [dependencies]
 
+# NOTE: this crate MUST NOT import any dependency with testing features to prevent benchmarking non-production code
 [dev-dependencies]
-namada = { path = "../namada", features = ["rand", "testing"] }
+namada = { path = "../namada", features = ["rand", "benches"] }
 namada_apps = { path = "../apps", features = ["benches"] }
 masp_primitives.workspace = true
 borsh.workspace = true
 borsh-ext.workspace = true
 criterion = { version = "0.5", features = ["html_reports"] }
+lazy_static.workspace= true
+prost.workspace = true
 rand_core.workspace = true
 rand.workspace = true
 tempfile.workspace = true
 sha2.workspace = true
+wasm-instrument.workspace = true
+wasmer-compiler-singlepass.workspace = true
+wasmer-engine-universal.workspace = true
+wasmer.workspace = true