[ci]: Add genesis check and update documentation.

Signed-off-by: Aleksandr Petrosyan <a-p-petrosyan@yandex.ru>

.github/workflows/iroha2-dev-pr-static.yml

@@ -32,9 +32,3 @@ jobs:
       - name: Verify iroha_data_model still supports no_std
         run: cargo nono check --package iroha_data_model --no-default-features
         if: always()
-
-      - name: Documentation check
-        run: |
-          cargo doc --no-deps --quiet
-          ./scripts/check_docs.sh
-        if: always()

.github/workflows/iroha2-dev-pr.yml

@@ -39,6 +39,15 @@ jobs:
         working-directory: wasm
         env:
           RUSTC_BOOTSTRAP: 1
+      - name: Documentation check
+        run: |
+          cargo doc --no-deps --quiet
+          ./scripts/check.sh docs
+        if: always()
+      - name: Check genesis
+        run: |
+           ./scripts/check.sh genesis
+        if: always()
 
   # Coverage is both in PR and in push pipelines so that:
   # 1. PR can get coverage report from bot.

configs/peer/genesis.json

@@ -11,6 +11,7 @@
                     "id": {
                       "name": "wonderland"
                     },
+                    "logo": null,
                     "metadata": {}
                   }
                 }
@@ -53,8 +54,8 @@
                       }
                     },
                     "value_type": "Quantity",
-                    "metadata": {},
-                    "mintable": "Infinitely"
+                    "mintable": "Infinitely",
+                    "metadata": {}
                   }
                 }
               }

core/src/genesis.rs

@@ -1,4 +1,5 @@
-//! This module contains execution Genesis Block logic, and `GenesisBlock` definition.
+//! Genesis-related logic and constructs. Contains the `GenesisBlock`,
+//! `RawGenesisBlock` and the `RawGenesisBlockBuilder` structures.
 #![allow(clippy::module_name_repetitions)]
 #![allow(clippy::new_without_default)]
 
@@ -50,18 +51,20 @@ pub trait GenesisNetworkTrait:
         transaction_limits: &TransactionLimits,
     ) -> Result<Option<Self>>;
 
-    /// Waits for a minimum number of [`Peer`]s needed for consensus to be online.
-    /// Returns initialized network [`Topology`] with the set A consisting of online peers.
+    /// Waits for a minimum number of [`Peer`]s needed for consensus
+    /// to be online.  Returns initialized network [`Topology`] with
+    /// the set A consisting of online peers.
     async fn wait_for_peers(
         &self,
         this_peer_id: PeerId,
         network_topology: Topology,
         network: Addr<IrohaNetwork>,
     ) -> Result<Topology>;
 
-    // FIXME: Having `ctx` reference and `sumaregi` reference here is not ideal.
-    // The way it is currently designed, this function is called from sumeragi and then calls sumeragi, while being in an unrelated module.
-    // This needs to be restructured.
+    // FIXME: Having `ctx` reference and `sumaregi` reference here is
+    // not ideal.  The way it is currently designed, this function is
+    // called from sumeragi and then calls sumeragi, while being in an
+    // unrelated module.  This needs to be restructured.
 
     /// Submits genesis transactions.
     ///
@@ -502,7 +505,7 @@ mod tests {
             let domain_id: DomainId = "wonderland".parse().unwrap();
             assert_eq!(
                 finished_genesis_block.transactions[0].isi[0],
-                RegisterBox::new(domain_id.clone()).into()
+                Instruction::from(RegisterBox::new(NewDomain::new(domain_id.clone())))
             );
             assert_eq!(
                 finished_genesis_block.transactions[0].isi[1],
@@ -518,7 +521,7 @@ mod tests {
             let domain_id: DomainId = "tulgey_wood".parse().unwrap();
             assert_eq!(
                 finished_genesis_block.transactions[0].isi[3],
-                RegisterBox::new(domain_id.clone()).into()
+                Instruction::from(RegisterBox::new(NewDomain::new(domain_id.clone())))
             );
             assert_eq!(
                 finished_genesis_block.transactions[0].isi[4],
@@ -529,7 +532,7 @@ mod tests {
             let domain_id: DomainId = "meadow".parse().unwrap();
             assert_eq!(
                 finished_genesis_block.transactions[0].isi[5],
-                RegisterBox::new(domain_id.clone()).into()
+                Instruction::from(RegisterBox::new(NewDomain::new(domain_id.clone())))
             );
             assert_eq!(
                 finished_genesis_block.transactions[0].isi[6],

data_model/src/domain.rs

@@ -1,4 +1,9 @@
-//! This module contains [`Domain`](`crate::domain::Domain`) structure and related implementations and trait implementations.
+//! This module contains [`Domain`](`crate::domain::Domain`) structure
+//! and related implementations and trait implementations.
+//!
+//! Note that the Genesis domain and account have a temporary
+//! privileged position, and permission validation is turned off for
+//! the Genesis block.
 
 #[cfg(not(feature = "std"))]
 use alloc::{format, string::String, vec::Vec};
@@ -18,7 +23,9 @@ use crate::{
     Identifiable, Name, ParseError,
 };
 
-/// Genesis domain name. Genesis domain should contain only genesis account.
+/// The domain name of the genesis domain.
+///
+/// The genesis domain should only contain the genesis account.
 pub const GENESIS_DOMAIN_NAME: &str = "genesis";
 
 /// Genesis domain. It will contain only one `genesis` account.
@@ -62,8 +69,11 @@ impl From<GenesisDomain> for Domain {
 /// Builder which can be submitted in a transaction to create a new [`Domain`]
 #[derive(Debug, Clone, PartialEq, Eq, Decode, Encode, Deserialize, Serialize, IntoSchema)]
 pub struct NewDomain {
+    /// The identification associated to the domain builder.
     id: <Domain as Identifiable>::Id,
+    /// The (IPFS) link to the logo of this domain.
     logo: Option<IpfsPath>,
+    /// metadata associated to the domain builder.
     pub metadata: Metadata,
 }
 
@@ -82,6 +92,7 @@ impl Ord for NewDomain {
 }
 
 impl NewDomain {
+    /// Create a [`NewDomain`], reserved for internal use.
     #[must_use]
     pub fn new(id: <Domain as Identifiable>::Id) -> Self {
         Self {
@@ -251,8 +262,8 @@ impl Domain {
         self.asset_definitions.get_mut(asset_definition_id)
     }
 
-    /// Add asset definition into the [`Domain`] returning previous asset definition stored under
-    /// the same id
+    /// Add asset definition into the [`Domain`] returning previous
+    /// asset definition stored under the same id
     #[inline]
     pub fn add_asset_definition(
         &mut self,
@@ -284,9 +295,8 @@ impl FromIterator<Domain> for crate::Value {
     }
 }
 
-/// Represents path in IPFS. Performs some checks to ensure path validity.
-///
-/// Should be constructed with `from_str()` method.
+/// Represents path in IPFS. Performs checks to ensure path validity.
+/// Construct using [`FromStr::from_str`] method.
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Encode, Serialize, IntoSchema)]
 pub struct IpfsPath(String);
 

hooks/pre-commit.sample

@@ -1,4 +1,4 @@
 #!/bin/sh
 set -e
-cargo run --bin iroha_docs >docs/source/references/config.md
+cargo run --bin iroha_gen -- --docs >docs/source/references/config.md
 git add docs/source/references/config.md

scripts/check.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+set -e
+
+TMPFILE=$(mktemp)
+
+case $1 in
+    "docs")
+        cargo run --bin iroha_gen -- --docs >"$TMPFILE"
+        diff "$TMPFILE" docs/source/references/config.md || {
+            echo 'Please re-generate docs with git hook in ./hooks directory'
+            exit 1
+        };;
+    "genesis")
+        cargo run --bin iroha_gen -- --genesis >"$TMPFILE"
+        diff "$TMPFILE" configs/peer/genesis.json || {
+            echo 'Please re-generate the genesis with `cargo run --bin iroha_gen -- --genesis`'
+            exit 1
+        };;
+esac