feat: introduce clean flag for speeding up the development

Author: fabianbormann

cardano/gateway/.env.example

@@ -14,6 +14,8 @@ CARDANO_CHAIN_PORT=3001
 CARDANO_NETWORK_MAGIC=42
 CARDANO_EPOCH_NONCE_GENESIS="5569014c252a963bad2efaa35e0db74c9581db3d107cb817810916b1463e7550"
 
+HANDLER_JSON_PATH=../deployment/offchain/handler.json
+
 MITHRIL_ENDPOINT=http://127.0.0.1:8080/aggregator
 MITHRIL_GENESIS_VERIFICATION_KEY=5b33322c3235332c3138362c3230312c3137372c31312c3131372c3133352c3138372c3136372c3138312c3138382c32322c35392c3230362c3130352c3233312c3135302c3231352c33302c37382c3231322c37362c31362c3235322c3138302c37322c3133342c3133372c3234372c3136312c36385d
 # MITHRIL_ENDPOINT=https://aggregator.testing-preview.api.mithril.network/aggregator

cardano/gateway/docker-compose.yml

@@ -1,12 +1,11 @@
 services:
   app:
-    build: 
+    build:
       context: ../..
       dockerfile: cardano/gateway/Dockerfile
-    network_mode: "host"
+    network_mode: 'host'
     volumes:
       - ../../chains/mithrils/data/aggregator/stores:/usr/chains/mithrils/data/aggregator/stores
+      - ../offchain/deployments:/usr/src/app/cardano/offchain/deployments
     env_file:
       - .env
-
-

cardano/gateway/src/app.module.ts

@@ -19,7 +19,7 @@ import { MithrilModule } from './shared/modules/mithril/mithril.module';
       load: [
         configuration,
         () => ({
-          deployment: require('./deployment/handler.json'),
+          deployment: require(process.env.HANDLER_JSON_PATH || '../deployment/offchain/handler.json'),
         }),
       ],
       isGlobal: true,

cardano/gateway/tsconfig.json

@@ -26,7 +26,7 @@
       "@config/*": ["src/config/*"]
     }
   },
-  "include": ["src/**/*", "handler.json", "src/deployment/handler.json"],
+  "include": ["src/**/*"],
   "exclude": ["*.test.ts", "*.spec.ts"],
   "rootDirs": ["src", "../../proto-types"]
 }

caribic/src/main.rs

@@ -78,6 +78,9 @@ enum Commands {
     Start {
         #[arg(value_enum, default_value_t = StartTarget::All)]
         target: StartTarget,
+        /// Cleans up the local environment before starting the services
+        #[arg(long, default_value_t = false)]
+        clean: bool,
     },
     /// Stops a specific bridge component. The component can be either the network, bridge, demo or all. Default is all
     Stop {
@@ -276,10 +279,12 @@ async fn main() {
                 );
             }
         }
-        Commands::Start { target } => {
+        Commands::Start { target, clean } => {
             let project_config = config::get_config();
             let project_root_path = Path::new(&project_config.project_root);
 
+            let mut cardano_current_epoch = 0;
+
             if target == StartTarget::Network || target == StartTarget::All {
                 // Start the local Cardano network and its services
                 match start_local_cardano_network(&project_root_path).await {
@@ -289,26 +294,26 @@ async fn main() {
                         error
                     )),
                 }
-
-                let mut cardano_current_epoch = 0;
                 // Start Mithril if needed
-                match start_mithril(&project_root_path).await {
-                    Ok(current_epoch) => {
-                        cardano_current_epoch = current_epoch;
-                        logger::log("✅ Mithril up and running")
-                    }
-                    Err(error) => {
-                        network_down_with_error(&format!("❌ Failed to start Mithril: {}", error))
+                if target == StartTarget::All {
+                    match start_mithril(&project_root_path).await {
+                        Ok(current_epoch) => {
+                            cardano_current_epoch = current_epoch;
+                            logger::log("✅ Mithril up and running")
+                        }
+                        Err(error) => network_down_with_error(&format!(
+                            "❌ Failed to start Mithril: {}",
+                            error
+                        )),
                     }
+                } else {
+                    // Wait for Mithril to start reading the immutable cardano node files
+                    match wait_and_start_mithril_genesis(&project_root_path, cardano_current_epoch) {
+                        Ok(_) => logger::log("✅ Immutable Cardano node files have been created, and Mithril is working as expected"),
+                        Err(error) => {
+                            network_down_with_error(&format!("❌ Mithril failed to read the immutable cardano node files: {}", error))
+                    }}
                 }
-
-                // Wait for Mithril to start reading the immutable cardano node files
-                match wait_and_start_mithril_genesis(&project_root_path, cardano_current_epoch) {
-                    Ok(_) => logger::log("✅ Immutable Cardano node files have been created, and Mithril is working as expected"),
-                    Err(error) => {
-                        network_down_with_error(&format!("❌ Mithril failed to read the immutable cardano node files: {}", error))
-                }}
-
                 logger::log("\n✅ Cardano Network started successfully");
             }
 
@@ -323,7 +328,7 @@ async fn main() {
                 ));
 
                 // Deploy Contracts
-                match deploy_contracts(&project_root_path).await {
+                match deploy_contracts(&project_root_path, clean).await {
                     Ok(_) => logger::log("✅ Cardano Scripts correcty deployed"),
                     Err(error) => bridge_down_with_error(&format!(
                         "❌ Failed to deploy Cardano Scripts: {}",
@@ -341,7 +346,7 @@ async fn main() {
                 ));
 
                 // Start gateway
-                match start_gateway(project_root_path.join("cardano/gateway").as_path()) {
+                match start_gateway(project_root_path.join("cardano/gateway").as_path(), clean) {
                     Ok(_) => logger::log("✅ Gateway started successfully"),
                     Err(error) => {
                         bridge_down_with_error(&format!("❌ Failed to start gateway: {}", error))
@@ -353,6 +358,14 @@ async fn main() {
                     "addr_test1vz8nzrmel9mmmu97lm06uvm55cj7vny6dxjqc0y0efs8mtqsd8r5m",
                 );
                 logger::log(&format!("Final balance {}", &balance.to_string().as_str()));
+                if target == StartTarget::All {
+                    match wait_and_start_mithril_genesis(&project_root_path, cardano_current_epoch) {
+                    Ok(_) => logger::log("✅ Immutable Cardano node files have been created, and Mithril is working as expected"),
+                    Err(error) => {
+                        network_down_with_error(&format!("❌ Mithril failed to read the immutable cardano node files: {}", error))
+                        }
+                    }
+                }
             }
         }
     }

caribic/src/setup.rs

@@ -457,7 +457,13 @@ fn get_genesis_hash(era: String, script_dir: &Path) -> Result<String, Box<dyn st
             genesis_file.as_str(),
         ];
     } else {
-        cli_args = vec!["conway", "genesis", "hash", "--genesis", genesis_file.as_str()];
+        cli_args = vec![
+            "conway",
+            "genesis",
+            "hash",
+            "--genesis",
+            genesis_file.as_str(),
+        ];
     }
 
     let genesis_hash = Command::new("docker")

caribic/src/start.rs

@@ -216,25 +216,54 @@ pub async fn start_local_cardano_network(
     Ok(())
 }
 
-pub async fn deploy_contracts(project_root_path: &Path) -> Result<(), Box<dyn std::error::Error>> {
+pub async fn deploy_contracts(
+    project_root_path: &Path,
+    clean: bool,
+) -> Result<(), Box<dyn std::error::Error>> {
     let optional_progress_bar = match logger::get_verbosity() {
         logger::Verbosity::Verbose => None,
         _ => Some(ProgressBar::new_spinner()),
     };
 
-    log_or_show_progress(
-        &format!(
-            "{} 🛠️ Building Aiken validators",
-            style("Step 4/5").bold().dim()
-        ),
-        &optional_progress_bar,
-    );
-    execute_script(
-        project_root_path.join("cardano").join("onchain").as_path(),
-        "aiken",
-        Vec::from(["build", "--trace-filter", "all", "--trace-level", "verbose"]),
-        None,
-    )?;
+    let is_verbose = logger::get_verbosity() == logger::Verbosity::Verbose;
+
+    if !project_root_path
+        .join("cardano")
+        .join("plutus.json")
+        .as_path()
+        .exists()
+        || clean
+        || is_verbose
+    {
+        log_or_show_progress(
+            &format!(
+                "{} 🛠️ Building Aiken validators",
+                style("Step 4/5").bold().dim()
+            ),
+            &optional_progress_bar,
+        );
+
+        let build_args = if is_verbose {
+            vec!["build", "--trace-filter", "all", "--trace-level", "verbose"]
+        } else {
+            vec!["build"]
+        };
+
+        execute_script(
+            project_root_path.join("cardano").join("onchain").as_path(),
+            "aiken",
+            build_args,
+            None,
+        )?;
+    } else {
+        log_or_show_progress(
+            &format!(
+                "{} 🛠️ Aiken validators already built",
+                style("Step 4/5").bold().dim()
+            ),
+            &optional_progress_bar,
+        );
+    }
 
     log_or_show_progress(
         &format!(

chains/cardano/docker-compose.yaml

@@ -1,6 +1,6 @@
 services:
   cardano-node:
-    image: ghcr.io/blinklabs-io/cardano-node:10.1.4-1
+    image: ghcr.io/blinklabs-io/cardano-node:10.1.4-3
     container_name: cardano-node
     volumes:
       - ./devnet:/devnet