Skip to content

Commit 7225559

Browse files
committed
Document more runtime config modules
1 parent 666352e commit 7225559

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/lib/runtime_config/runtime_config.ml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -833,6 +833,8 @@ module Accounts = struct
833833
Result.bind ~f:of_json_layout (Json_layout.Accounts.of_yojson json)
834834
end
835835

836+
(** Parameters for protocol constants that specify the genesis ledger used by
837+
the network *)
836838
module Ledger = struct
837839
type base =
838840
| Named of string (** One of the named ledgers in [Genesis_ledger] *)
@@ -1186,6 +1188,8 @@ module Proof_keys = struct
11861188
}
11871189
end
11881190

1191+
(** Parameters for protocol constants that specify slot spans, and relate slot
1192+
spans to system times *)
11891193
module Genesis = struct
11901194
type t = Json_layout.Genesis.t =
11911195
{ k : int option (* the depth of finality constant (in slots) *)
@@ -1349,6 +1353,8 @@ module Daemon = struct
13491353
}
13501354
end
13511355

1356+
(** Parameters for protocol constants that specify the genesis epoch ledger
1357+
snapshots used by the network *)
13521358
module Epoch_data = struct
13531359
module Data = struct
13541360
type t = { ledger : Ledger.t; seed : string }

0 commit comments

Comments
 (0)