docs(test-suite): update README

Author: eudelins-zama

test-suite/gateway-stress/README.md

@@ -1,8 +1,28 @@
 # Gateway Stress-Test Tool
 
+## Introduction
+
 A simple tool to send a configurable number of parallel decryption requests (public or user
 decrypts at the time of writing), at a given frequency and for a specified duration.
 
+## Table of Contents
+- [Introduction](#introduction)
+- [Build](#build)
+- [Configuration](#configuration)
+- [Run](#run)
+  - [Stress testing](#stress-testing)
+  - [Benchmarking](#benchmarking)
+- [Tracing](#tracing)
+- [Bonus: Generating handles via coprocessor stress-test-generator](#bonus-generating-handles-via-coprocessor-stress-test-generator)
+
+## Build
+
+You can build the tool by running the `cargo build --release` command in the
+`test-suite/gateway-stress` directory.
+
+Alternatively, you can run the manual `gateway-stress-tool-docker-build` workflow to trigger the
+build of the Docker images for the tool.
+
 ## Configuration
 
 To configure the tool, you can use either a configuration file (TOML format) or environment
@@ -13,16 +33,10 @@ along with its associated environment variable.
 
 Configuration fields defined via environment variables override those in the configuration file.
 
-## Build
-
-You can build the tool by running the `cargo build --release` command in the
-`test-suite/gateway-stress` directory.
-
-Alternatively, you can run the manual `gateway-stress-tool-docker-build` workflow to trigger the
-build of the Docker images for the tool.
-
 ## Run
 
+### Stress testing
+
 Once the `gateway-stress` binary has been built, you can run the following commands:
 
 ```bash
@@ -48,6 +62,28 @@ cargo run -- -c config/config.toml user
 
 Note that the `mixed` command of the CLI is not implemented yet.
 
+### Benchmarking
+
+The `benchmark` command take a CSV file in input (and the global config file as well).
+Each line of this CSV represent a burst of decryption to benchmark, which is composed of:
+- The number of parallel requests in the burst (1st column)
+- The number of time we must measure this burst (2nd column)
+- The type of decryption in the burst (`public` or `user`)
+
+See the [templates](./templates) folder for examples.
+
+It will then run the benchmark and stores the results (average and standard deviation of latency
+and throughput) for each burst in a CSV file.
+
+```bash
+# Run a benchmarking session using `templates/small_bench.csv` as input and store the global
+# results in `/tmp/bench.csv`
+./gateway-stress -c config/config.toml benchmark -i templates/small_bench.csv -o /tmp/bench.csv
+
+# Same, but also store each burst result in `tmp/full.csv`
+./gateway-stress -c config/config.toml benchmark -i templates/small_bench.csv -o /tmp/bench.csv -r /tmp/full.csv
+```
+
 ## Tracing
 
 This tool aims to output only essential information regarding the status of the test. The main
@@ -67,17 +103,23 @@ RUST_LOG="gateway_stress=debug,alloy=debug" ./gateway-stress -c config/config.to
 RUST_LOG="debug" ./gateway-stress -c config/config.toml public
 ```
 
-## Bonus: Generating handles via coprocessor-stress-test-generator
+## 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
+`stress-test-generator` tool to generate these handles.
 
-First clone the repo. Then, look at the `README.md` and gather all the environment variable values
-needed (default values work only for e2e setup).
+The tool is located at `coprocessor/fhevm-engine/stress-test-generator` in the `fhevm` repo.
+Then, look at the `README.md` and gather all the environment variable values needed (default
+values work only for e2e setup).
 
 ```bash
-git checkout simon/chore/fhevm-0.8.3
 export EVGEN_DB_URL="TODO"
 export ACL_CONTRACT_ADDRESS="TODO"
 # ...
 EVGEN_SCENARIO=data/minitest_003_generate_handles_for_decryption.csv make run
 ```
 
 This will generate the `data/handles_for_pub_decryption` and `handles_for_usr_decryption` files.
+
+Make sure that the 6th column of the `EVGEN_SCENARIO` file match the `allowed_contract` value of
+this tool's configuration, and that the 7th column match the wallet address used by the tool.