fix: restore RawGenesisTransaction schema (#4765)

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

configs/swarm/genesis.json

@@ -1,4 +1,6 @@
 {
+  "chain": "00000000-0000-0000-0000-000000000000",
+  "executor": "./executor.wasm",
   "instructions": [
     {
       "Register": {
@@ -185,7 +187,5 @@
       }
     }
   ],
-  "executor": "./executor.wasm",
-  "chain": "00000000-0000-0000-0000-000000000000",
   "topology": []
 }

data_model/src/block.rs

@@ -129,7 +129,6 @@ mod model {
         /// Signatures of peers which approved this block.
         pub(super) signatures: Vec<BlockSignature>,
         /// Block payload
-        #[serde(flatten)]
         pub(super) payload: BlockPayload,
     }
 }
@@ -333,7 +332,6 @@ mod candidate {
     #[derive(Decode, Deserialize)]
     struct SignedBlockCandidate {
         signatures: Vec<BlockSignature>,
-        #[serde(flatten)]
         payload: BlockPayload,
     }
 

data_model/src/query/mod.rs

@@ -1317,7 +1317,6 @@ pub mod http {
         #[derive(Decode, Deserialize)]
         struct SignedQueryCandidate {
             signature: QuerySignature,
-            #[serde(flatten)]
             payload: ClientQueryPayload,
         }
 

data_model/src/transaction.rs

@@ -177,7 +177,6 @@ mod model {
         /// Signature of [`Self::payload`].
         pub(super) signature: TransactionSignature,
         /// Payload of the transaction.
-        #[serde(flatten)]
         pub(super) payload: TransactionPayload,
     }
 
@@ -361,7 +360,6 @@ mod candidate {
     #[derive(Decode, Deserialize)]
     struct SignedTransactionCandidate {
         signature: TransactionSignature,
-        #[serde(flatten)]
         payload: TransactionPayload,
     }
 

docs/source/references/schema.json

@@ -3043,6 +3043,26 @@
     ]
   },
   "QuerySignature": "SignatureOf<ClientQueryPayload>",
+  "RawGenesisTransaction": {
+    "Struct": [
+      {
+        "name": "chain",
+        "type": "ChainId"
+      },
+      {
+        "name": "executor",
+        "type": "String"
+      },
+      {
+        "name": "instructions",
+        "type": "Vec<InstructionBox>"
+      },
+      {
+        "name": "topology",
+        "type": "Vec<PeerId>"
+      }
+    ]
+  },
   "Register<Account>": {
     "Struct": [
       {

genesis/Cargo.toml

@@ -12,6 +12,7 @@ workspace = true
 
 [dependencies]
 iroha_crypto = { workspace = true }
+iroha_schema = { workspace = true }
 iroha_data_model = { workspace = true, features = ["http"] }
 
 derive_more = { workspace = true, features = ["deref"] }

genesis/src/lib.rs

@@ -11,6 +11,7 @@ use std::{
 use eyre::{eyre, Result, WrapErr};
 use iroha_crypto::{KeyPair, PublicKey};
 use iroha_data_model::{block::SignedBlock, prelude::*};
+use iroha_schema::IntoSchema;
 use once_cell::sync::Lazy;
 use serde::{Deserialize, Serialize};
 
@@ -34,17 +35,22 @@ pub struct GenesisBlock(pub SignedBlock);
 /// It should be signed, converted to [`GenesisBlock`],
 /// and serialized in SCALE format before supplying to Iroha peer.
 /// See `kagami genesis sign`.
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, IntoSchema)]
 pub struct RawGenesisTransaction {
-    instructions: Vec<InstructionBox>,
-    /// Path to the [`Executor`] file
-    executor: PathBuf,
     /// Unique id of blockchain
     chain: ChainId,
+    /// Path to the [`Executor`] file
+    executor: ExecutorPath,
+    instructions: Vec<InstructionBox>,
     /// Initial topology
     topology: Vec<PeerId>,
 }
 
+/// Path to [`Executor`] file
+#[derive(Debug, Clone, Deserialize, Serialize, IntoSchema)]
+#[schema(transparent = "String")]
+pub struct ExecutorPath(PathBuf);
+
 impl RawGenesisTransaction {
     const WARN_ON_GENESIS_GTE: u64 = 1024 * 1024 * 1024; // 1Gb
 
@@ -70,11 +76,12 @@ impl RawGenesisTransaction {
                 path.as_ref().display()
             )
         })?;
-        value.executor = path
-            .as_ref()
-            .parent()
-            .expect("genesis must be a file in some directory")
-            .join(value.executor);
+        value.executor = ExecutorPath(
+            path.as_ref()
+                .parent()
+                .expect("genesis must be a file in some directory")
+                .join(value.executor.0),
+        );
         Ok(value)
     }
 
@@ -95,7 +102,7 @@ impl RawGenesisTransaction {
     /// # Errors
     /// If executor couldn't be read from provided path
     pub fn build_and_sign(self, genesis_key_pair: &KeyPair) -> Result<GenesisBlock> {
-        let executor = get_executor(&self.executor)?;
+        let executor = get_executor(&self.executor.0)?;
         let genesis = build_and_sign_genesis(
             self.instructions,
             executor,
@@ -212,13 +219,13 @@ impl GenesisBuilder {
     /// Finish building and produce a [`RawGenesisTransaction`].
     pub fn build_raw(
         self,
-        executor_file: PathBuf,
         chain_id: ChainId,
+        executor_file: PathBuf,
         topology: Vec<PeerId>,
     ) -> RawGenesisTransaction {
         RawGenesisTransaction {
             instructions: self.instructions,
-            executor: executor_file,
+            executor: ExecutorPath(executor_file),
             chain: chain_id,
             topology,
         }

schema/gen/src/lib.rs

@@ -54,6 +54,10 @@ pub fn build_schemas() -> MetaMap {
 
         // Never referenced, but present in type signature. Like `PhantomData<X>`
         MerkleTree<SignedTransaction>,
+
+        // Genesis file - used by SDKs to generate the genesis block
+        // TODO: IMO it could/should be removed from the schema
+        iroha_genesis::RawGenesisTransaction,
     }
 }
 

tools/kagami/src/genesis/generate.rs

@@ -220,7 +220,7 @@ pub fn generate_default(
     // Will be replaced with actual topology either in scripts/test_env.py or in iroha_swarm
     let topology = vec![];
     let chain_id = ChainId::from("00000000-0000-0000-0000-000000000000");
-    let genesis = builder.build_raw(executor_path, chain_id, topology);
+    let genesis = builder.build_raw(chain_id, executor_path, topology);
     Ok(genesis)
 }