sim-rs: document ib-shards

Author: SupernaviX

data/simulation/config.d.ts

@@ -45,6 +45,8 @@ export interface Config {
   // Input Block Configuration
   "ib-generation-probability": number;
   "ib-generation-cpu-time-ms": number;
+  /** Only supported by Rust simulation. */
+  "ib-shards": number;
   /** Only supported by Haskell simulation. */
   "ib-head-size-bytes": bigint;
   "ib-head-validation-cpu-time-ms": number;

data/simulation/config.default.yaml

@@ -58,6 +58,7 @@ rb-body-legacy-praos-payload-avg-size-bytes: 0
 
 ib-generation-probability: 5.0
 ib-generation-cpu-time-ms: 300.0
+ib-shards: 1
 ib-head-size-bytes: 32
 ib-head-validation-cpu-time-ms: 1.0
 ib-body-validation-cpu-time-ms-constant: 50.0

data/simulation/config.schema.json

@@ -206,6 +206,10 @@
     "ib-head-validation-cpu-time-ms": {
       "type": "number"
     },
+    "ib-shards": {
+      "description": "Only supported by Rust simulation.",
+      "type": "number"
+    },
     "leios-stage-active-voting-slots": {
       "additionalProperties": false,
       "properties": {},

sim-rs/sim-core/src/config.rs

@@ -5,7 +5,6 @@ use std::{
 };
 
 use anyhow::{anyhow, bail, Result};
-use num_traits::One as _;
 use serde::{Deserialize, Serialize};
 
 use crate::probability::FloatDistribution;
@@ -78,14 +77,13 @@ pub struct RawParameters {
     // Input block configuration
     pub ib_generation_probability: f64,
     pub ib_generation_cpu_time_ms: f64,
+    pub ib_shards: u64,
     // pub ib_head_size_bytes: u64,
     pub ib_head_validation_cpu_time_ms: f64,
     pub ib_body_validation_cpu_time_ms_constant: f64,
     pub ib_body_validation_cpu_time_ms_per_byte: f64,
     pub ib_body_max_size_bytes: u64,
     pub ib_diffusion_strategy: DiffusionStrategy,
-    #[serde(default = "u64::one")]
-    pub ib_shards: u64,
 
     // Endorsement block configuration
     pub eb_generation_probability: f64,