GenesisConfig in WASM Runtime: A Step Towards a Non-Native Future

michal · May 17, 2023, 2:22pm

At present, the GenesisConfig is not compatible with WASM environments. My current mission is to rectify this and fully incorporate GenesisConfig functionality into the WASM runtime. This is an important step for the progression towards a non-native runtime environment.

The primary problem we’re addressing and proposed high-level plan are thoroughly detailed in this issue: `GenesisConfig` in a native runtime free world · Issue #13334 · paritytech/substrate · GitHub

This post aims to shed further light on the issue, outline our strategy, and share the progress we have made so far.

Here’s an overview of our planned modifications:

We intend to enable serialization support in substrate primitives by introducing a serde feature, regardless of std.
We are proposing to integrate the serde crate (featuring Serialize/Deserialize traits) into the WASM runtime by default, without the need for a gate feature.
GenesisConfig-related code will always be compiled for WASM, without the necessity to introduce serde or genesis-config features into pallets (this includes Default implementation for GenesisConfig).
At the runtime level, we’re suggesting a genesis-config feature. We expect that disabling this feature will restrict linking any serde or GenesisConfig related functionality from pallets and the runtime into the WASM blob.
To enhance interaction with GenesisConfig for the runtime, we’ve proposed a new runtime API called GenesisBuilder. This API simplifies the instantiation of a default GenesisConfig, its serialization to a JSON blob, deserialization from a given JSON blob, and storage of the GenesisConfig.

Several pull requests have already been initiated in this regard:

serde support in primitives: https://github.com/paritytech/substrate/pull/13027
GenesisBuilder API proposal: `GenesisBuilder` Runtime API: preliminary proposal by michalkucharczyk · Pull Request #14131 · paritytech/substrate · GitHub
Enabling GenesisConfig in frame for no_std: frame: Enable GenesisConfig in no_std by michalkucharczyk · Pull Request #14108 · paritytech/substrate · GitHub
Activating GenesisBuild::build for no_std: frame: GenesisBuild::build allowed in no_std by michalkucharczyk · Pull Request #14107 · paritytech/substrate · GitHub

For a practical demonstration of the new API’s usage and implementation on runtime side, check out our draft/proof of concept here:

github.com

paritytech/substrate/blob/55318dbd974942dc99f1592d56f84b487820163e/test-utils/runtime/src/lib.rs#L1310-L1342


      
          	fn default_config_as_json_works() {
          		sp_tracing::try_init_simple();
          		let mut t = BasicExternalities::new_empty();
          		let r = executor_call(&mut t, "GenesisBuilder_default_genesis_config_as_json", &vec![])
          			.0
          			.unwrap();
          		let r = Vec::<u8>::decode(&mut &r[..]).unwrap();
          		let json = String::from_utf8(r.into()).expect("returned value is json. qed.");
          
          
		let expected = r#"{"system":{"code":"0x"},"babe":{"authorities":[],"epochConfig":null},"substrateTest":{"authorities":[]},"balances":{"balances":[]}}"#;
          		assert_eq!(expected.to_string(), json);
          	}
          
          
	#[test]
          	fn build_genesis_config_from_json_works() {
          		sp_tracing::try_init_simple();
          		let j = include_str!("test_json/default_genesis_config.json");
          
          
		let mut t = BasicExternalities::new_empty();
          		executor_call(&mut t, "GenesisBuilder_build_genesis_config_from_json", &j.encode())

This file has been truncated. show original

github.com

paritytech/substrate/blob/55318dbd974942dc99f1592d56f84b487820163e/test-utils/runtime/src/lib.rs#L717-L726


      
          	impl sc_genesis_builder::api::GenesisBuilder<Block> for Runtime {
          		fn default_genesis_config_as_json() -> Vec<u8> {
          			sc_genesis_builder::helper::GenesisBuilder::<Runtime, GenesisConfig>::default_genesis_config_as_json()
          		}
          
          
		fn build_genesis_config_from_json(json: sp_std::vec::Vec<u8>) {
          			log::trace!("build_genesis_config_from_json: {:?}", json);
          			sc_genesis_builder::helper::GenesisBuilder::<Runtime, GenesisConfig>::build_genesis_config_from_json(json)
          		}
          	}

Topic		Replies	Views
We should create an RFC with the Bytecode Alliance to add no_std support Tech Talk wasm	0	328	September 15, 2022
New Tool for Runtime Developers: Try Runtime Github Action Tech Talk	0	157	March 18, 2024
WrappedEVM Eth RPC compatibility layer Tech Talk frame , smart-contracts , frontier , ethereum	5	999	July 6, 2023
Representing pallet's origins as System-like origins Tech Talk frame	4	371	October 18, 2023
Deterministic PVF executor Tech Talk	15	632	October 13, 2023

GenesisConfig in WASM Runtime: A Step Towards a Non-Native Future

Related Topics