More cleanup and TODOs for runtime (#49)

* WIP

* Removed export-genesis-state / export-genesis-wasm

* Update more TODOs

* Update more TODOs

* More TODOs to check

Author: bkontur

README.md

@@ -1,4 +1,4 @@
-## Polkadot Bulletin chain
+# Polkadot Bulletin chain
 
 The Bulletin chain consists of a customized node implementation and a single runtime.
 
@@ -29,7 +29,6 @@ The core functionality of the bulletin chain is in the transaction-storage palle
 
 Data is added via the `transactionStorage.store` extrinsic, provided the storage of the data is authorized by root call. Authorization is granted either for a specific account via authorize_account or for data with a specific preimage via authorize_preimage. Once data is stored, it can be retrieved from IPFS with the Blake2B hash of the data.
 
-
 #### Bridge to PeopleChain
 For Rococo, we have a PeopleRococo → BridgeHubRococo → Bulletin connection.
 
@@ -49,40 +48,14 @@ Controls the validator set. Currently set in genesis and validators can be added
 ####  polkadot-bulletin-chain/pallets/transaction-storage
 Stores arbitrary data on IPFS via the `store` extrinsic, provided that either the signer or the preimage of the data are pre-authorized. Stored data can be retrieved from IPFS or directly from the node via the transaction index or hash.
 
-## Polkadot Bulletin production/live runtime
-
-### Initial genesis chain spec
-
-[bulletin-polkadot-genesis.json](./node/chain-specs/bulletin-polkadot.json)
-
-```
-cargo build --release -p polkadot-bulletin-chain
-
-./target/release/polkadot-bulletin-chain build-spec --chain bulletin-polkadot
-or
-./target/release/polkadot-bulletin-chain build-spec --chain bulletin-polkadot --raw
-```
+# Polkadot Bulletin production/live runtime
 
-### Run local chain
-```
-cargo build --release -p polkadot-bulletin-chain
-
-POLKADOT_BULLETIN_BINARY_PATH=./target/release/polkadot-bulletin-chain zombienet -p native spawn ./zombienet/bulletin-polkadot-local.toml
-```
-
-### Run a production chain (but only with Alice validator)
-You can override the Alice validator keys here: [adjust\_bp\_spec.sh](./zombienet/adjust_bp_spec.sh) (you should see finalized blocks in the logs).
-
-```
-cargo build --release -p polkadot-bulletin-chain
-
-POLKADOT_BULLETIN_BINARY_PATH=./target/release/polkadot-bulletin-chain ENV_PATH=<path-to-zombienet-dir-in-bulletin-repo> zombienet -p native spawn ./zombienet/bulletin-polkadot.toml
-```
-
-### Run a production chain
+## Prepare for a production
 
 ### Prepare keys for a production chain
 
+This chapter provides a one-time example setup. For more details about running a validator and key management, see: [https://docs.polkadot.com/infrastructure/running-a-validator/#running-a-validator.”](https://docs.polkadot.com/infrastructure/running-a-validator/#running-a-validator.”).
+
 **Prerequisites:**
 ```
 # Build the node
@@ -92,7 +65,7 @@ cargo build --release -p polkadot-bulletin-chain
 mkdir /tmp/bulletin
 ```
 
-**Generate a validator account**
+#### Generate a validator account
 ```
 ./target/release/polkadot-bulletin-chain key generate --scheme sr25519 --output-type json
 {
@@ -106,7 +79,7 @@ mkdir /tmp/bulletin
 }
 ```
 
-**Generate node-key (used for networking and peerId)**
+#### Generate node-key (used for networking and peerId)
 ```
 ./target/release/polkadot-bulletin-chain key generate-node-key --chain bulletin-polkadot --base-path /tmp/bulletin
 (example output)
@@ -118,7 +91,7 @@ Generating key in "/tmp/bulletin/chains/bulletin-polkadot/network/secret_ed25519
 (should print the same public key as above)
 ```
 
-**Generate initial session keys for genesis chain spec**
+#### Generate initial session keys for genesis chain spec
 ```
 # Babe (suri is `secretSeed`)
 ./target/release/polkadot-bulletin-chain key insert --chain bulletin-polkadot --base-path /tmp/bulletin --scheme sr25519 --key-type babe --suri 0x749a0904471df8d128b49dfeedf4081af0846b839c6eb69c536cf500e3886646
@@ -174,7 +147,10 @@ Secret Key URI `0x749a0904471df8d128b49dfeedf4081af0846b839c6eb69c536cf500e38866
   SS58 Address:      5H5jr87N42Bpt36LKZxZcWS7P1ppgH5Yyf31C4LGb6PFFz9w
 ```
 
-**Update genesis chain spec script**
+#### Update genesis chain spec script
+
+_Note: This is relevant only for the initial launch; after that, we expect Polkadot OpenGov to manage the validator set._
+
 * File `./scripts/create_bulletin_polkadot_spec.sh`
 * Update `.genesis.runtimeGenesis.patch.validatorSet.initialValidators` with a validator account public key (example above: `5DWpUqkKHHCaRHVqgocGMnJhuvNtCfm7xvqtSd23Mu6kEVQ9`)
 * Update `genesis.runtimeGenesis.patch.session.keys` (and new element)
@@ -199,7 +175,43 @@ Secret Key URI `0x749a0904471df8d128b49dfeedf4081af0846b839c6eb69c536cf500e38866
 * **You should see finalized blocks in the logs.**
 * **!!! Push changes `./scripts/create_bulletin_polkadot_spec.sh` !!!**
 
-### Fresh benchmarks
+## Run node
+
+### Run production chain
+```
+# You can omit `--validator` if you are not part of the active validator set.
+./target/release/polkadot-bulletin-chain --validator --chain bulletin-polkadot <other-relevant-params: ./target/release/polkadot-bulletin-chain --help>
+```
+
+### Run local chain
+```
+cargo build --release -p polkadot-bulletin-chain
+
+POLKADOT_BULLETIN_BINARY_PATH=./target/release/polkadot-bulletin-chain zombienet -p native spawn ./zombienet/bulletin-polkadot-local.toml
+```
+
+### Run a production chain (but only with Alice validator)
+You can override the Alice validator keys here: [adjust\_bp\_spec.sh](./zombienet/adjust_bp_spec.sh) (you should see finalized blocks in the logs).
+
+```
+cargo build --release -p polkadot-bulletin-chain
+
+POLKADOT_BULLETIN_BINARY_PATH=./target/release/polkadot-bulletin-chain ENV_PATH=<path-to-zombienet-dir-in-bulletin-repo> zombienet -p native spawn ./zombienet/bulletin-polkadot.toml
+```
+
+## Initial genesis chain spec
+
+[bulletin-polkadot-genesis.json](./node/chain-specs/bulletin-polkadot.json)
+
+```
+cargo build --release -p polkadot-bulletin-chain
+
+./target/release/polkadot-bulletin-chain build-spec --chain bulletin-polkadot
+or
+./target/release/polkadot-bulletin-chain build-spec --chain bulletin-polkadot --raw
+```
+
+## Fresh benchmarks
 
 Run on the dedicated machine from the root directory:
 ```

node/src/command.rs

@@ -46,6 +46,7 @@ impl SubstrateCli for Cli {
 
 	fn load_spec(&self, id: &str) -> Result<Box<dyn sc_service::ChainSpec>, String> {
 		Ok(match id {
+			// TODO: put behind feature and remove dependencies
 			"dev" | "rococo-dev" => Box::new(chain_spec::rococo_development_config()?),
 			"local" | "rococo-local" => Box::new(chain_spec::rococo_local_testnet_config()?),
 			"polkadot-dev" | "bulletin-polkadot-dev" => Box::new(chain_spec::bulletin_polkadot_development_config()?),

runtimes/bulletin-polkadot/src/polkadot_bridge_config.rs

@@ -206,7 +206,7 @@ impl pallet_bridge_parachains::Config<WithPolkadotBridgeParachainsInstance> for
 
 const LOG_TARGET_BRIDGE_DISPATCH: &str = "runtime::bridge-dispatch";
 
-/// Message dispatch result type for single message.
+/// Message dispatch result type for a single message.
 #[derive(
 	CloneNoBound,
 	EqNoBound,
@@ -218,11 +218,11 @@ const LOG_TARGET_BRIDGE_DISPATCH: &str = "runtime::bridge-dispatch";
 	TypeInfo,
 )]
 pub enum XcmBlobMessageDispatchResult {
-	/// We've been unable to decode message payload.
+	/// We've been unable to decode the message payload.
 	InvalidPayload,
 	/// Message has been dispatched.
 	Dispatched,
-	/// Message has **NOT** been dispatched because of given error.
+	/// Message has **NOT** been dispatched because of a given error.
 	NotDispatched(#[codec(skip)] Option<DispatchBlobError>),
 }
 
@@ -432,7 +432,8 @@ pub mod benchmarking {
 			pallet_bridge_messages::LaneIdOf<Runtime, WithPeoplePolkadotMessagesInstance>,
 		>;
 }
-//
+
+// TODO: enable tests as much as possible
 // #[cfg(test)]
 // pub(crate) mod tests {
 // 	use super::*;

runtimes/bulletin-polkadot/src/xcm_config.rs

@@ -99,7 +99,7 @@ impl WeightTrader for NoopTrader {
 /// Allows execution from `origin` if it is contained in `AllowedOrigin`
 /// and if it is just a straight `Transact` which contains any call.
 ///
-/// That's a 1:1 copy of corresponding Cumulus structure.
+/// That's a 1:1 copy of the corresponding Cumulus structure.
 pub struct AllowUnpaidTransactsFrom<RuntimeCall, AllowedOrigin>(
 	sp_std::marker::PhantomData<(RuntimeCall, AllowedOrigin)>,
 );
@@ -119,6 +119,8 @@ impl<RuntimeCall: Decode, AllowedOrigin: Contains<Location>> ShouldExecute
 		{:?}", 			origin, instructions, max_weight, _properties,
 		);
 
+		// TODO: check if this is enough, because we don't filter `Transact` at all,
+		// but instead we allow all XCM instruction processing.
 		// we only allow from configured origins
 		ensure!(AllowedOrigin::contains(origin), ProcessMessageError::Unsupported);
 
@@ -138,7 +140,8 @@ pub type XcmRouter = LocalExporter<ToBridgeHaulBlobExporter, UniversalLocation>;
 /// The barriers one of which must be passed for an XCM message to be executed.
 pub type Barrier = TrailingSetTopicAsId<
 	WithComputedOrigin<
-		// We only allow unpaid execution from the PeoplePolkadot parachain.
+		// TODO: check if this is working, I think we executed `Trap` in zombienet with
+		// `DescendOrigin`. We only allow unpaid execution from the PeoplePolkadot parachain.
 		AllowUnpaidTransactsFrom<RuntimeCall, OnlyPeoplePolkadotLocation>,
 		UniversalLocation,
 		ConstU32<2>,
@@ -170,6 +173,7 @@ impl xcm_executor::Config for XcmConfig {
 	type PalletInstancesInfo = AllPalletsWithSystem;
 	type MaxAssetsIntoHolding = ConstU32<0>;
 	type FeeManager = ();
+	// TODO: Why? This could allow processing of `ExportMessage` from People?
 	type MessageExporter = ToBridgeHaulBlobExporter;
 	type UniversalAliases = UniversalAliases;
 	type CallDispatcher = WithOriginFilter<Everything>;
@@ -180,10 +184,11 @@ impl xcm_executor::Config for XcmConfig {
 	type HrmpChannelAcceptedHandler = ();
 	type HrmpChannelClosingHandler = ();
 	type XcmRecorder = ();
-	// TODO: add here some impl?
+	// TODO: maybe add here some emitter?
 	type XcmEventEmitter = ();
 }
 
+// TODO: setup pallet-message-queue and dispatch with MessageQueue, so we don't need this.
 /// XCM blob dispatcher that executes XCM message at this chain.
 ///
 /// That's a copy of `xcm_builder::BridgeBlobDispatcher` struct. The only difference is
@@ -225,6 +230,8 @@ impl DispatchBlob for ImmediateXcmDispatcher {
 		// execute the XCM program
 		let mut message_hash = message.using_encoded(blake2_256);
 		XcmExecutor::<XcmConfig>::prepare_and_execute(
+			// TODO: double-check if this, maybe should be just `Here`, I think we executed `Trap`
+			// in zombienet with `DescendOrigin`.
 			PeoplePolkadotLocation::get(),
 			message,
 			&mut message_hash,
@@ -246,6 +253,7 @@ impl DispatchBlob for ImmediateXcmDispatcher {
 	}
 }
 
+// TODO: check - remove and use BridgeMessage
 /// Decode inbound `BridgeMessage` from PeoplePolkadot parachain.
 pub(crate) fn decode_bridge_message(
 	blob: &XcmAsPlainPayload,

scripts/create_bulletin_polkadot_spec.sh

@@ -79,8 +79,3 @@ $binary build-spec --chain edited-chain-spec-plain.json --raw > chain-spec-raw.j
 cp edited-chain-spec-plain.json ./node/chain-specs/bulletin-polkadot-plain.json
 cp chain-spec-raw.json ./node/chain-specs/bulletin-polkadot.json
 
-# build genesis data
-$binary export-genesis-state --chain chain-spec-raw.json > bulletin-polkadot-genesis-head-data
-
-# build genesis wasm
-$binary export-genesis-wasm --chain chain-spec-raw.json > bulletin-polkadot-wasm