chore(test-suite): gateway-stress updates for v0.10

Author: eudelins-zama

test-suite/gateway-stress/Cargo.lock

@@ -1,13 +1,13 @@
 [package]
 name = "gateway-stress"
-version = "0.9.0"
+version = "0.10.0"
 edition = "2024"
 
 [dependencies]
-fhevm_gateway_bindings = { git = "https://github.com/zama-ai/fhevm.git", tag = "v0.9.11", default-features = false }
-gateway-sdk = { git = "https://github.com/zama-ai/fhevm.git", tag = "v0.9.11", default-features = false }
+fhevm_gateway_bindings = { git = "https://github.com/zama-ai/fhevm.git", tag = "v0.10.0-4", default-features = false }
+gateway-sdk = { git = "https://github.com/zama-ai/fhevm.git", tag = "v0.10.0-4", default-features = false }
 
-alloy = { version = "1.0", default-features = false, features = [
+alloy = { version = "1.0.38", default-features = false, features = [
     "essentials",
     "json-rpc",
     "reqwest-rustls-tls",
@@ -54,7 +54,7 @@ tokio = { version = "1.47.0", default-features = false, features = [
 ] }
 tokio-util = "0.7.15"
 tracing = "0.1.41"
-tracing-subscriber = { version = "0.3.19", default-features = true, features = [
+tracing-subscriber = { version = "0.3.20", default-features = true, features = [
     "env-filter",
 ] }
 rand = "0.9.2"

test-suite/gateway-stress/Cargo.toml

@@ -13,6 +13,7 @@ decrypts at the time of writing), at a given frequency and for a specified durat
   - [Stress testing](#stress-testing)
   - [Benchmarking](#benchmarking)
 - [Tracing](#tracing)
+- [Local e2e setup](#local-e2e-setup)
 - [Bonus: Generating handles via coprocessor stress-test-generator](#bonus-generating-handles-via-coprocessor-stress-test-generator)
 
 ## Build
@@ -119,6 +120,20 @@ RUST_LOG="gateway_stress=debug,alloy=debug" ./gateway-stress -c config/config.to
 RUST_LOG="debug" ./gateway-stress -c config/config.toml gw -t public
 ```
 
+## Local e2e setup
+
+To play with the tool in a local e2e setup, follow these steps:
+- from the root of the `fehvm` repo: `cd test-suite/fhevm`
+- deploy the e2e setup using the `./fhevm-cli deploy` command
+- if using `fhevm` version > 0.10.0, fund the account the tool is using with ERC20 token (use the same private key as in [gateway-stress config](../gateway-stress/config/config.toml)):
+  - `docker run --env-file env/staging/.env.gateway-mocked-payment.local -e TX_SENDER_PRIVATE_KEY="0x24af7cb5f6cd0f29df22c6f3e2f18ee5b3949f5a489a14b0674bef8fd89bfe91" -it --rm --network fhevm_default ghcr.io/zama-ai/fhevm/gateway-contracts:v0.10.0-4 "npx hardhat task:setTxSenderMockedPayment"`
+- generate ciphertext handles
+  - `cd ../../coprocessor/fhevm-engine/stress-test-generator; rm -f data/handles_for*; EVGEN_SCENARIO=data/minitest_003_generate_handles_for_decryption.csv make run; cd -` (see [this section](#bonus-generating-handles-via-coprocessor-stress-test-generator) for more details)
+- update the `[[public_ct]]` and `[[user_ct]]` sections of the [gateway-stress config](../gateway-stress/config/config.toml) with one of the value of the `../../coprocessor/fhevm-engine/stress-test-generator/data/handles_for_pub_decryption` and `../../coprocessor/fhevm-engine/stress-test-generator/data/handles_for_usr_decryption` files
+- run the tool. Ex:
+  - `cd ../gateway_stress`
+  - `cargo run -- -c config/config.toml -p 1 -d "1s" gw -t user`
+
 ## Bonus: Generating handles via coprocessor stress-test-generator
 
 To use this tool, you would need already existing handles to decrypt. You could use coprocessor's

test-suite/gateway-stress/README.md

@@ -16,18 +16,18 @@ parallel_requests = 1
 # # Defaults to false, if set to true, then `tests_interval` is ignored
 # sequential = false
 
-# The ciphertexts to use for user decryptions
-[[user_ct]]
+# The ciphertexts to use for public decryptions
+[[public_ct]]
 # The handle used of the ciphertext
-handle = "0xc07ece86473ba540de4dbef63889f0233f5481dd7dff00000000000030390500"
-# The digest of the ciphertext
+handle = "0x1f9b79819b2581535a80f267862540c5eac12ee504ff00000000000030390500"
+# The digest of the ciphertext. Used only for DB tests, it can be a dummy value otherwise
 digest = "0x134b4f97e70be0e71a26e38304e096fd370188b5c11b89feb8a61176b73d1b5a"
 
-# The ciphertexts to use for public decryptions
-[[public_ct]]
+# The ciphertexts to use for user decryptions
+[[user_ct]]
 # The handle used of the ciphertext
-handle = "0x57539e394a6ae1dc4b4f1b00248777ce265eb6d08bff00000000000030390500"
-# The digest of the ciphertext
+handle = "0x1d01f83fd1b14d84e9b8680790d993d6848aeb6462ff00000000000030390500"
+# The digest of the ciphertext. Used only for DB tests, it can be a dummy value otherwise
 digest = "0x134b4f97e70be0e71a26e38304e096fd370188b5c11b89feb8a61176b73d1b5a"
 
 # Configuration section for stress test using the Gateway chain
@@ -42,7 +42,7 @@ host_chain_id = 12345
 gateway_chain_id = 54321
 
 # Address of the Decryption contract (required)
-decryption_address = "0xF0bFB159C7381F7CB332586004d8247252C5b816"
+decryption_address = "0x35760912360E875DA50D40a74305575c23D55783"
 
 # Wallet's private key as a hex string
 private_key = "24af7cb5f6cd0f29df22c6f3e2f18ee5b3949f5a489a14b0674bef8fd89bfe91"

test-suite/gateway-stress/config/config.toml

@@ -210,9 +210,11 @@ impl GatewayTestManager {
                 for result in results.iter() {
                     w.serialize(result)?;
                 }
+                w.flush()?;
             }
             let bench_result = BenchAverageResult::new(bench_record, results);
             average_results_writer.serialize(bench_result)?;
+            average_results_writer.flush()?;
         }
 
         Ok(())

test-suite/gateway-stress/src/blockchain/manager.rs

@@ -8,7 +8,7 @@ use async_trait::async_trait;
 use futures::lock::{Mutex, MutexGuard};
 use std::collections::{BTreeSet, HashMap, hash_map::Entry};
 use std::sync::Arc;
-use tracing::debug;
+use tracing::trace;
 
 /// A robust, in-memory nonce manager for a scalable transaction engine.
 #[derive(Clone, Debug, Default)]
@@ -52,12 +52,12 @@ impl ZamaNonceManager {
         let nonce_to_use =
             if let Some(available_nonce) = account.available_nonces.iter().next().copied() {
                 account.available_nonces.remove(&available_nonce);
-                debug!(%address, nonce = available_nonce, "Reusing available nonce");
+                trace!(%address, nonce = available_nonce, "Reusing available nonce");
                 available_nonce
             } else {
                 let next = account.next_nonce;
                 account.next_nonce += 1;
-                debug!(%address, nonce = next, "Using next sequential nonce");
+                trace!(%address, nonce = next, "Using next sequential nonce");
                 next
             };
 

test-suite/gateway-stress/src/blockchain/nonce_manager.rs

@@ -107,7 +107,7 @@ impl DbConnector {
 
         for reqs in requests.chunks(self.insertion_chunk_size) {
             let mut query_builder = QueryBuilder::new(
-                "INSERT INTO public_decryption_requests(decryption_id, sns_ct_materials, extra_data) ",
+                "INSERT INTO public_decryption_requests(decryption_id, sns_ct_materials, extra_data, otlp_context) ",
             );
             query_builder.push_values(reqs, |mut bind, req| {
                 bind.push_bind(req.decryptionId.to_le_bytes_vec())
@@ -117,7 +117,8 @@ impl DbConnector {
                             .map(SnsCiphertextMaterialDbItem::from)
                             .collect::<Vec<_>>(),
                     )
-                    .push_bind(req.extraData.to_vec());
+                    .push_bind(req.extraData.to_vec())
+                    .push_bind(alloy::hex::decode(EMPTY_OTLP_CONTEXT_SERIALIZED_HEX).unwrap());
             });
             query_builder.push(" RETURNING decryption_id, created_at");
 
@@ -141,7 +142,7 @@ impl DbConnector {
 
         for reqs in requests.chunks(self.insertion_chunk_size) {
             let mut query_builder = QueryBuilder::new("
-                INSERT INTO user_decryption_requests(decryption_id, sns_ct_materials, user_address, public_key, extra_data)
+                INSERT INTO user_decryption_requests(decryption_id, sns_ct_materials, user_address, public_key, extra_data, otlp_context)
             ");
             query_builder.push_values(reqs, |mut bind, req| {
                 bind.push_bind(req.decryptionId.to_le_bytes_vec())
@@ -153,7 +154,8 @@ impl DbConnector {
                     )
                     .push_bind(req.userAddress.to_vec())
                     .push_bind(req.publicKey.to_vec())
-                    .push_bind(req.extraData.to_vec());
+                    .push_bind(req.extraData.to_vec())
+                    .push_bind(alloy::hex::decode(EMPTY_OTLP_CONTEXT_SERIALIZED_HEX).unwrap());
             });
             query_builder.push(" RETURNING decryption_id, created_at");
 
@@ -175,3 +177,5 @@ impl Display for DbConnector {
         write!(f, "DbConnector {}", self.name)
     }
 }
+
+const EMPTY_OTLP_CONTEXT_SERIALIZED_HEX: &str = "0000000000000000";

test-suite/gateway-stress/src/db/connector.rs

@@ -175,9 +175,11 @@ impl DatabaseTestManager {
                 for result in results.iter() {
                     w.serialize(result)?;
                 }
+                w.flush()?;
             }
             let bench_result = BenchAverageResult::new(bench_record, results);
             average_results_writer.serialize(bench_result)?;
+            average_results_writer.flush()?;
         }
 
         if !args.skip_clear_db {

test-suite/gateway-stress/src/db/manager.rs

@@ -5,6 +5,7 @@ pub mod user;
 pub use public::{init_public_decryption_response_listener, public_decryption_burst};
 pub use user::{init_user_decryption_response_listener, user_decryption_burst};
 
+use crate::blockchain::manager::AppProvider;
 use alloy::{
     primitives::{B256, LogData, U256},
     providers::Provider,
@@ -15,8 +16,7 @@ use std::time::Duration;
 use tokio::sync::mpsc::UnboundedSender;
 use tracing::{debug, trace, warn};
 
-use crate::blockchain::manager::AppProvider;
-
+pub const BURST_WAIT_TIMEOUT: Duration = Duration::from_mins(5);
 pub const EVENT_LISTENER_POLLING: Duration = Duration::from_millis(500);
 
 fn extract_id_from_receipt<F>(

test-suite/gateway-stress/src/decryption/mod.rs

@@ -2,7 +2,8 @@ use crate::{
     blockchain::manager::AppProvider,
     config::Config,
     decryption::{
-        BurstResult, EVENT_LISTENER_POLLING, extract_id_from_receipt, send_tx_with_retries,
+        BURST_WAIT_TIMEOUT, BurstResult, EVENT_LISTENER_POLLING, extract_id_from_receipt,
+        send_tx_with_retries,
     },
 };
 use alloy::{
@@ -27,7 +28,7 @@ use tokio::{
         mpsc::{self, UnboundedReceiver, UnboundedSender},
     },
     task::JoinSet,
-    time::Instant,
+    time::{Instant, timeout},
 };
 use tracing::{Instrument, debug, error, trace};
 
@@ -55,12 +56,15 @@ where
     debug!("Start of the burst...");
     let (id_sender, id_receiver) = mpsc::unbounded_channel();
     let wait_response_task = tokio::spawn(
-        wait_for_burst_responses(
-            burst_index,
-            response_listener,
-            id_receiver,
-            config.clone(),
-            responses_pb,
+        timeout(
+            BURST_WAIT_TIMEOUT,
+            wait_for_burst_responses(
+                burst_index,
+                response_listener,
+                id_receiver,
+                config.clone(),
+                responses_pb,
+            ),
         )
         .in_current_span(),
     );
@@ -88,8 +92,9 @@ where
     drop(id_sender); // Dropping last sender so `wait_for_responses` can exit properly
     let res = wait_response_task
         .await
-        .inspect_err(|e| error!("{e}"))?
-        .inspect_err(|e| error!("{e}"))?;
+        .inspect_err(|e| error!("Burst wait task panic: {e}"))?
+        .inspect_err(|_| error!("Bust wait timed out"))?
+        .inspect_err(|e| error!("Burst wait error: {e}"))?;
     debug!("Successfully received all responses of the burst!");
     Ok(res)
 }