feat(simulacrum): add simulacrum server (#9737)

# Description of change

This PR add a simulacrum binary, that hosts a gRPC interface to interact
with the fullnode API, and a REST API to control the simulacrum. This is
useful to run simulacrum in the CI in non-rust projects.

## Links to any relevant issues

fixes #7844

## How the change has been tested

- [x] Basic tests (linting, compilation, formatting, unit/integration
tests)
- [ ] Patch-specific tests (correctness, functionality coverage)
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have checked that new and existing unit tests pass locally with
my changes

### Release Notes

- [ ] Protocol:
- [x] Nodes (Validators and Full nodes): Add simulacrum-server binary to
simulate an IOTA blockchain
- [ ] Indexer:
- [ ] JSON-RPC:
- [ ] GraphQL:
- [ ] CLI:
- [ ] Rust SDK:
- [ ] REST API:

---------

Co-authored-by: jkrvivian <jkrvivian@gmail.com>

Author: muXxer

.github/CODEOWNERS

@@ -92,7 +92,8 @@
 /crates/iota-upgrade-compatibility-transactional-tests/ @iotaledger/vm-language
 /crates/iota-verifier-transactional-tests/ @iotaledger/vm-language
 /crates/prometheus-closure-metric/ @iotaledger/node
-/crates/simulacrum/ @iotaledger/vm-language
+/crates/simulacrum/ @iotaledger/node @iotaledger/vm-language
+/crates/simulacrum-server/ @iotaledger/node
 /crates/starfish/ @iotaledger/consensus
 /crates/telemetry-subscribers/ @iotaledger/core-protocol
 /crates/transaction-fuzzer/ @iotaledger/node @iotaledger/vm-language

.github/crates-filters.yml

@@ -188,6 +188,8 @@ prometheus-closure-metric:
   - "crates/prometheus-closure-metric/**"
 simulacrum:
   - "crates/simulacrum/**"
+simulacrum-server:
+  - "crates/simulacrum-server/**"
 telemetry-subscribers:
   - "crates/telemetry-subscribers/**"
 test-cluster:

Cargo.lock

@@ -160,6 +160,7 @@ members = [
   "crates/iota-verifier-transactional-tests",
   "crates/prometheus-closure-metric",
   "crates/simulacrum",
+  "crates/simulacrum-server",
   "crates/starfish/config",
   "crates/starfish/core",
   "crates/starfish/simtests",
@@ -321,13 +322,15 @@ parking_lot = { version = "0.12.3", features = ["arc_lock"] }
 passkey-authenticator = "0.4.0"
 passkey-client = "0.4.0"
 passkey-types = "0.4.0"
+petgraph = { version = ">=0.6, <=0.7", default-features = false }
 pin-project-lite = "0.2.15"
 pretty_assertions = "1.3.0"
 proc-macro2 = "1.0.95"
 prometheus = "0.14.0"
 proptest = "1.6.0"
 proptest-derive = "0.5.1"
 prost = "0.14"
+prost-types = "0.14"
 quinn-proto = "0.11.7"
 quote = "1.0.23"
 rand = "0.8.5"
@@ -371,7 +374,6 @@ tonic = { version = "0.14", features = ["zstd", "transport"] }
 tonic-build = "0.14"
 tonic-health = "0.14"
 tonic-prost = "0.14"
-tonic-prost-build = "0.14"
 tonic-rustls = "0.3.0"
 tower = { version = "0.4.12", features = ["util", "timeout", "load-shed", "limit"] }
 tower-http = { version = "0.5", features = ["cors", "timeout", "trace", "set-header", "propagate-header"] }
@@ -498,6 +500,7 @@ move-vm-profiler = { path = "external-crates/move/crates/move-vm-profiler" }
 move-vm-test-utils = { path = "external-crates/move/crates/move-vm-test-utils/", features = ["tiered-gas"] }
 prometheus-closure-metric = { path = "crates/prometheus-closure-metric" }
 simulacrum = { path = "crates/simulacrum" }
+simulacrum-server = { path = "crates/simulacrum-server" }
 starfish-config = { path = "crates/starfish/config" }
 starfish-core = { path = "crates/starfish/core" }
 starfish-simtests = { path = "crates/starfish/simtests" }

Cargo.toml

@@ -212,7 +212,7 @@ mod tests {
 
     #[tokio::test]
     pub async fn test_transaction_handler() -> anyhow::Result<()> {
-        let mut sim = Simulacrum::new();
+        let sim = Simulacrum::new();
 
         // Execute a simple transaction.
         let transfer_recipient = IotaAddress::random_for_testing_only();

crates/iota-analytics-indexer/src/handlers/transaction_handler.rs

@@ -82,7 +82,7 @@ mod tests {
     async fn prep_executor_cluster() -> (ConnectionConfig, ExecutorCluster) {
         let rng = StdRng::from_seed([12; 32]);
         let data_ingestion_path = tempdir().unwrap().keep();
-        let mut sim = Simulacrum::new_with_rng(rng);
+        let sim = Simulacrum::new_with_rng(rng);
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 
         sim.create_checkpoint();
@@ -152,17 +152,15 @@ mod tests {
     #[serial]
     async fn test_simple_client_simulator_cluster() {
         let rng = StdRng::from_seed([12; 32]);
-        let mut sim = Simulacrum::new_with_rng(rng);
+        let sim = Simulacrum::new_with_rng(rng);
         let data_ingestion_path = tempdir().unwrap().keep();
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 
         sim.create_checkpoint();
         sim.create_checkpoint();
 
         let genesis_checkpoint_digest1 = *sim
-            .store()
-            .get_checkpoint_by_sequence_number(0)
-            .unwrap()
+            .with_store(|store| store.get_checkpoint_by_sequence_number(0).cloned().unwrap())
             .digest();
 
         let chain_id_actual = format!("{}", ChainIdentifier::from(genesis_checkpoint_digest1));

crates/iota-graphql-rpc/tests/e2e_tests.rs

@@ -144,7 +144,7 @@ mod tests {
     async fn good_examples_within_limits() {
         let rng = StdRng::from_seed([12; 32]);
         let data_ingestion_path = tempdir().unwrap().keep();
-        let mut sim = Simulacrum::new_with_rng(rng);
+        let sim = Simulacrum::new_with_rng(rng);
         let (mut max_nodes, mut max_output_nodes, mut max_depth, mut max_payload) = (0, 0, 0, 0);
 
         sim.set_data_ingestion_path(data_ingestion_path.clone());
@@ -211,7 +211,7 @@ mod tests {
     async fn bad_examples_fail() {
         let rng = StdRng::from_seed([12; 32]);
         let data_ingestion_path = tempdir().unwrap().keep();
-        let mut sim = Simulacrum::new_with_rng(rng);
+        let sim = Simulacrum::new_with_rng(rng);
         let (mut max_nodes, mut max_output_nodes, mut max_depth, mut max_payload) = (0, 0, 0, 0);
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 

crates/iota-graphql-rpc/tests/examples_validation_tests.rs

@@ -302,10 +302,9 @@ pub fn estimate_gas_budget_from_gas_cost(
     // Round up to the nearest gas rounding step (in gas units)
     let rounded_gas_loading_cost_units =
         if let Some(step) = protocol_config.gas_rounding_step_as_option() {
-            match gas_loading_cost_units.checked_next_multiple_of(step) {
-                Some(rounded) => rounded,
-                None => u64::MAX,
-            }
+            gas_loading_cost_units
+                .checked_next_multiple_of(step)
+                .unwrap_or(u64::MAX)
         } else {
             gas_loading_cost_units
         };

crates/iota-grpc-server/src/transaction_execution_service/simulate.rs

@@ -56,7 +56,7 @@ mod ingestion_tests {
     #[tokio::test]
     pub async fn checkpoint_objects_ingestion() -> Result<(), IndexerError> {
         let tempdir = tempdir().unwrap();
-        let mut sim = Simulacrum::new();
+        let sim = Simulacrum::new();
         let data_ingestion_path = tempdir.path().to_path_buf();
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 
@@ -80,7 +80,7 @@ mod ingestion_tests {
 
     #[tokio::test]
     pub async fn transaction_table() -> Result<(), IndexerError> {
-        let mut sim = Simulacrum::new();
+        let sim = Simulacrum::new();
         let data_ingestion_path = tempdir().unwrap().keep();
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 
@@ -131,7 +131,7 @@ mod ingestion_tests {
 
     #[tokio::test]
     pub async fn object_type() -> Result<(), IndexerError> {
-        let mut sim = Simulacrum::new();
+        let sim = Simulacrum::new();
         let data_ingestion_path = tempdir().unwrap().keep();
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 
@@ -184,7 +184,7 @@ mod ingestion_tests {
     #[tokio::test]
     pub async fn objects_snapshot() -> Result<(), IndexerError> {
         let tempdir = tempdir().unwrap();
-        let mut sim = Simulacrum::new();
+        let sim = Simulacrum::new();
         let data_ingestion_path = tempdir.path().to_path_buf();
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 
@@ -260,7 +260,7 @@ mod ingestion_tests {
 
     #[tokio::test]
     pub async fn tx_global_order_table() -> Result<(), IndexerError> {
-        let mut sim = Simulacrum::new();
+        let sim = Simulacrum::new();
         let data_ingestion_path = tempdir().unwrap().keep();
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 
@@ -316,7 +316,7 @@ mod ingestion_tests {
 
     #[tokio::test]
     pub async fn tx_global_order_table_on_conflict_do_nothing() -> Result<(), IndexerError> {
-        let mut sim = Simulacrum::new();
+        let sim = Simulacrum::new();
         let data_ingestion_path = tempdir().unwrap().keep();
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 
@@ -390,7 +390,7 @@ mod ingestion_tests {
     #[tokio::test]
     pub async fn test_insert_large_batch_tx_indices() -> Result<(), IndexerError> {
         let tempdir = tempdir().unwrap();
-        let mut sim = Simulacrum::new();
+        let sim = Simulacrum::new();
         let data_ingestion_path = tempdir.path().to_path_buf();
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 
@@ -427,7 +427,7 @@ mod ingestion_tests {
     #[tokio::test]
     pub async fn test_insert_large_batch_event_indices() -> Result<(), IndexerError> {
         let tempdir = tempdir().unwrap();
-        let mut sim = Simulacrum::new();
+        let sim = Simulacrum::new();
         let data_ingestion_path = tempdir.path().to_path_buf();
         sim.set_data_ingestion_path(data_ingestion_path.clone());
 
@@ -457,7 +457,7 @@ mod ingestion_tests {
     #[tokio::test]
     pub async fn test_epoch_boundary() -> Result<(), IndexerError> {
         let tempdir = tempdir().unwrap();
-        let mut sim = Simulacrum::new();
+        let sim = Simulacrum::new();
         let data_ingestion_path = tempdir.path().to_path_buf();
         sim.set_data_ingestion_path(data_ingestion_path.clone());