feat(node): consistent genesis

Cargo.toml

@@ -144,6 +144,7 @@ serde_yaml = { version = "0.9" }
 serde_tuple = "0.5"
 serde_with = "2.3"
 serial_test = "3.0"
+snap = "1.1.0"
 strum = { version = "0.26.1", features = ["derive"] }
 tempfile = "3.7"
 thiserror = "1"

fendermint/app/options/src/genesis.rs

@@ -133,6 +133,9 @@ pub struct GenesisAddValidatorArgs {
 
 #[derive(Args, Debug)]
 pub struct GenesisIntoTendermintArgs {
+    /// The initial app bytes path for cometbft
+    #[arg(long, short)]
+    pub app_state: Option<PathBuf>,
     /// Output file name for the Tendermint genesis JSON file.
     #[arg(long, short)]
     pub out: PathBuf,
@@ -147,6 +150,28 @@ pub enum GenesisIpcCommands {
     Gateway(GenesisIpcGatewayArgs),
     /// Fetch the genesis parameters of a subnet from the parent.
     FromParent(Box<GenesisFromParentArgs>),
+    /// Seal the genesis state from the genesis parameter file
+    SealGenesis(SealGenesisArgs),
+}
+
+#[derive(Args, Debug, Clone)]
+pub struct SealGenesisArgs {
+    /// The built in actors bundle path
+    #[arg(long, short)]
+    pub builtin_actors_path: PathBuf,
+
+    /// The custom actors bundle path
+    #[arg(long, short)]
+    pub custom_actors_path: PathBuf,
+
+    /// The solidity artifacts output path. If you are using ipc-monorepo, it should be the `out` folder
+    /// of `make build`
+    #[arg(long, short)]
+    pub artifacts_path: Option<PathBuf>,
+
+    /// The sealed genesis state output path, i.e. finalized genesis state CAR file dump path
+    #[arg(long, short)]
+    pub output_path: PathBuf,
 }
 
 #[derive(Args, Debug, Clone)]

fendermint/app/settings/src/lib.rs

@@ -263,10 +263,6 @@ pub struct Settings {
     snapshots_dir: PathBuf,
     /// Solidity contracts.
     contracts_dir: PathBuf,
-    /// Builtin-actors CAR file.
-    builtin_actors_bundle: PathBuf,
-    /// Custom actors CAR file.
-    custom_actors_bundle: PathBuf,
 
     /// Where to reach CometBFT for queries or broadcasting transactions.
     tendermint_rpc_url: Url,
@@ -291,13 +287,7 @@ pub struct Settings {
 }
 
 impl Settings {
-    home_relative!(
-        data_dir,
-        snapshots_dir,
-        contracts_dir,
-        builtin_actors_bundle,
-        custom_actors_bundle
-    );
+    home_relative!(data_dir, snapshots_dir, contracts_dir);
 
     /// Load the default configuration from a directory,
     /// then potential overrides specific to the run mode,

fendermint/app/src/app.rs

@@ -1,7 +1,6 @@
 // Copyright 2022-2024 Protocol Labs
 // SPDX-License-Identifier: Apache-2.0, MIT
 use std::future::Future;
-use std::path::PathBuf;
 use std::sync::Arc;
 
 use anyhow::{anyhow, Context, Result};
@@ -19,14 +18,15 @@ use fendermint_vm_interpreter::bytes::{
 };
 use fendermint_vm_interpreter::chain::{ChainEnv, ChainMessageApplyRet, IllegalMessage};
 use fendermint_vm_interpreter::fvm::state::{
-    empty_state_tree, CheckStateRef, FvmExecState, FvmGenesisState, FvmQueryState, FvmStateParams,
+    empty_state_tree, CheckStateRef, FvmExecState, FvmQueryState, FvmStateParams,
     FvmUpdatableParams,
 };
 use fendermint_vm_interpreter::fvm::store::ReadOnlyBlockstore;
-use fendermint_vm_interpreter::fvm::{FvmApplyRet, FvmGenesisOutput, PowerUpdates};
+use fendermint_vm_interpreter::fvm::{FvmApplyRet, PowerUpdates};
+use fendermint_vm_interpreter::genesis::{read_genesis_car, GenesisAppState};
 use fendermint_vm_interpreter::signed::InvalidSignature;
 use fendermint_vm_interpreter::{
-    CheckInterpreter, ExecInterpreter, GenesisInterpreter, ProposalInterpreter, QueryInterpreter,
+    CheckInterpreter, ExecInterpreter, ProposalInterpreter, QueryInterpreter,
 };
 use fendermint_vm_message::query::FvmQueryHeight;
 use fendermint_vm_snapshot::{SnapshotClient, SnapshotError};
@@ -109,12 +109,6 @@ pub struct AppConfig<S: KVStore> {
     pub state_hist_namespace: S::Namespace,
     /// Size of state history to keep; 0 means unlimited.
     pub state_hist_size: u64,
-    /// Path to the Wasm bundle.
-    ///
-    /// Only loaded once during genesis; later comes from the [`StateTree`].
-    pub builtin_actors_bundle: PathBuf,
-    /// Path to the custom actor WASM bundle.
-    pub custom_actors_bundle: PathBuf,
     /// Block height where we should gracefully stop the node
     pub halt_height: i64,
 }
@@ -136,12 +130,6 @@ where
     state_store: Arc<SS>,
     /// Wasm engine cache.
     multi_engine: Arc<MultiEngine>,
-    /// Path to the Wasm bundle.
-    ///
-    /// Only loaded once during genesis; later comes from the [`StateTree`].
-    builtin_actors_bundle: PathBuf,
-    /// Path to the custom actor WASM bundle.
-    custom_actors_bundle: PathBuf,
     /// Block height where we should gracefully stop the node
     halt_height: i64,
     /// Namespace to store app state.
@@ -195,8 +183,6 @@ where
             db: Arc::new(db),
             state_store: Arc::new(state_store),
             multi_engine: Arc::new(MultiEngine::new(1)),
-            builtin_actors_bundle: config.builtin_actors_bundle,
-            custom_actors_bundle: config.custom_actors_bundle,
             halt_height: config.halt_height,
             namespace: config.app_namespace,
             state_hist: KVCollection::new(config.state_hist_namespace),
@@ -390,6 +376,14 @@ where
         // It's really the empty state tree that would be the best indicator.
         !(height == 0 && params.timestamp.0 == 0 && params.network_version == NetworkVersion::V0)
     }
+
+    fn parse_genesis_app_bytes(bytes: &[u8]) -> Result<Vec<u8>> {
+        // cometbft serves data in json format, convert from json string
+        match serde_json::from_slice(bytes)? {
+            serde_json::Value::String(s) => Ok(GenesisAppState::decode_and_decompress(&s)?),
+            _ => Err(anyhow!("invalid app state json")),
+        }
+    }
 }
 
 // NOTE: The `Application` interface doesn't allow failures at the moment. The protobuf
@@ -408,11 +402,6 @@ where
     S::Namespace: Sync + Send,
     DB: KVWritable<S> + KVReadable<S> + Clone + Send + Sync + 'static,
     SS: Blockstore + Clone + Send + Sync + 'static,
-    I: GenesisInterpreter<
-        State = FvmGenesisState<SS>,
-        Genesis = Vec<u8>,
-        Output = FvmGenesisOutput,
-    >,
     I: ProposalInterpreter<State = ChainEnv, Message = Vec<u8>>,
     I: ExecInterpreter<
         State = (ChainEnv, FvmExecState<SS>),
@@ -450,45 +439,18 @@ where
 
     /// Called once upon genesis.
     async fn init_chain(&self, request: request::InitChain) -> AbciResult<response::InitChain> {
-        let bundle = &self.builtin_actors_bundle;
-        let bundle = std::fs::read(bundle)
-            .map_err(|e| anyhow!("failed to load builtin bundle CAR from {bundle:?}: {e}"))?;
-
-        let custom_actors_bundle = &self.custom_actors_bundle;
-        let custom_actors_bundle = std::fs::read(custom_actors_bundle).map_err(|e| {
-            anyhow!("failed to load custom actor bundle CAR from {custom_actors_bundle:?}: {e}")
-        })?;
-
-        let state = FvmGenesisState::new(
-            self.state_store_clone(),
-            self.multi_engine.clone(),
-            &bundle,
-            &custom_actors_bundle,
-        )
-        .await
-        .context("failed to create genesis state")?;
-
-        tracing::info!(
-            manifest_root = format!("{}", state.manifest_data_cid),
-            "pre-genesis state created"
-        );
-
-        let genesis_bytes = request.app_state_bytes.to_vec();
+        let genesis_bytes = Self::parse_genesis_app_bytes(&request.app_state_bytes)?;
         let genesis_hash =
             fendermint_vm_message::cid(&genesis_bytes).context("failed to compute genesis CID")?;
 
         // Make it easy to spot any discrepancies between nodes.
         tracing::info!(genesis_hash = genesis_hash.to_string(), "genesis");
 
-        let (state, out) = self
-            .interpreter
-            .init(state, genesis_bytes)
-            .await
-            .context("failed to init from genesis")?;
-
-        let state_root = state.commit().context("failed to commit genesis state")?;
+        let (validators, state_params) = read_genesis_car(genesis_bytes, &self.state_store).await?;
         let validators =
-            to_validator_updates(out.validators).context("failed to convert validators")?;
+            to_validator_updates(validators).context("failed to convert validators")?;
+
+        tracing::info!(state_params = serde_json::to_string(&state_params)?);
 
         // Let's pretend that the genesis state is that of a fictive block at height 0.
         // The record will be stored under height 1, and the record after the application
@@ -505,16 +467,7 @@ where
         let app_state = AppState {
             block_height: height,
             oldest_state_height: height,
-            state_params: FvmStateParams {
-                state_root,
-                timestamp: out.timestamp,
-                network_version: out.network_version,
-                base_fee: out.base_fee,
-                circ_supply: out.circ_supply,
-                chain_id: out.chain_id.into(),
-                power_scale: out.power_scale,
-                app_version: 0,
-            },
+            state_params,
         };
 
         let response = response::InitChain {

fendermint/app/src/cmd/genesis.rs

@@ -14,6 +14,7 @@ use fendermint_vm_genesis::{
     ipc, Account, Actor, ActorMeta, Collateral, Genesis, Multisig, PermissionMode, SignerAddr,
     Validator, ValidatorKey,
 };
+use fendermint_vm_interpreter::genesis::{GenesisAppState, GenesisBuilder};
 
 use crate::cmd;
 use crate::options::genesis::*;
@@ -94,6 +95,8 @@ cmd! {
             set_ipc_gateway(&genesis_file, args),
         GenesisIpcCommands::FromParent(args) =>
             new_genesis_from_parent(&genesis_file, args).await,
+        GenesisIpcCommands::SealGenesis(args) =>
+            seal_genesis(&genesis_file, args).await,
     }
   }
 }
@@ -213,7 +216,12 @@ fn set_eam_permissions(
 
 fn into_tendermint(genesis_file: &PathBuf, args: &GenesisIntoTendermintArgs) -> anyhow::Result<()> {
     let genesis = read_genesis(genesis_file)?;
-    let genesis_json = serde_json::to_value(&genesis)?;
+    let app_state: Option<String> = match args.app_state {
+        Some(ref path) if path.exists() => {
+            Some(GenesisAppState::v1(std::fs::read(path)?).compress_and_encode()?)
+        }
+        _ => None,
+    };
 
     let chain_id: u64 = chainid::from_str_hashed(&genesis.chain_name)?.into();
     let chain_id = chain_id.to_string();
@@ -248,7 +256,8 @@ fn into_tendermint(genesis_file: &PathBuf, args: &GenesisIntoTendermintArgs) ->
         // Hopefully leaving this empty will skip validation,
         // otherwise we have to run the genesis in memory here and now.
         app_hash: tendermint::AppHash::default(),
-        app_state: genesis_json,
+        // cometbft serves data in json format, convert to string to be specific
+        app_state,
     };
     let tmg_json = serde_json::to_string_pretty(&tmg)?;
     std::fs::write(&args.out, tmg_json)?;
@@ -280,6 +289,22 @@ fn set_ipc_gateway(genesis_file: &PathBuf, args: &GenesisIpcGatewayArgs) -> anyh
     })
 }
 
+async fn seal_genesis(genesis_file: &PathBuf, args: &SealGenesisArgs) -> anyhow::Result<()> {
+    let genesis_params = read_genesis(genesis_file)?;
+
+    let mut builder = GenesisBuilder::new(
+        args.builtin_actors_path.clone(),
+        args.custom_actors_path.clone(),
+        genesis_params,
+    );
+
+    if let Some(ref ipc_system_artifacts) = args.artifacts_path {
+        builder = builder.with_ipc_system_contracts(ipc_system_artifacts.clone());
+    }
+
+    builder.write_to(args.output_path.clone()).await
+}
+
 async fn new_genesis_from_parent(
     genesis_file: &PathBuf,
     args: &GenesisFromParentArgs,

fendermint/app/src/cmd/run.rs

@@ -137,7 +137,6 @@ async fn run(settings: Settings) -> anyhow::Result<()> {
     let interpreter = FvmMessageInterpreter::<NamespaceBlockstore, _>::new(
         tendermint_client.clone(),
         validator_ctx,
-        settings.contracts_dir(),
         settings.fvm.gas_overestimation_rate,
         settings.fvm.gas_search_step,
         settings.fvm.exec_in_check,
@@ -300,8 +299,6 @@ async fn run(settings: Settings) -> anyhow::Result<()> {
             app_namespace: ns.app,
             state_hist_namespace: ns.state_hist,
             state_hist_size: settings.db.state_hist_size,
-            builtin_actors_bundle: settings.builtin_actors_bundle(),
-            custom_actors_bundle: settings.custom_actors_bundle(),
             halt_height: settings.halt_height,
         },
         db,

fendermint/app/src/lib.rs

@@ -1,3 +1,5 @@
+extern crate core;
+
 // Copyright 2022-2024 Protocol Labs
 // SPDX-License-Identifier: Apache-2.0, MIT
 mod app;

fendermint/testing/contract-test/Cargo.toml

@@ -31,7 +31,7 @@ fendermint_vm_core = { path = "../../vm/core" }
 fendermint_vm_genesis = { path = "../../vm/genesis" }
 fendermint_vm_message = { path = "../../vm/message" }
 fendermint_vm_interpreter = { path = "../../vm/interpreter", features = [
-    "bundle",
+    "bundle", "test-util"
 ] }
 
 [dev-dependencies]