@@ -106,7 +106,7 @@ public-key = ""
106106api-address = " localhost:8080"
107107```
108108
109- ## Parameters
109+ ## Base Options
110110
111111### ` public-key `
112112
@@ -132,7 +132,7 @@ Private key of this peer
132132private-key = { digest = " " , payload = " " }
133133```
134134
135- ### Genesis
135+ ## Genesis Options
136136
137137Explain the purpose of this block. Maybe explain both keys in a single
138138section?
@@ -169,11 +169,11 @@ The warning will be printed if
169169
170170:::
171171
172- ### Network
172+ ## Network Options
173173
174174Explain network module
175175
176- #### ` network.address `
176+ ### ` network.address `
177177
178178- ** Type:** String, [ Socket-Address] ( #type-socket-address )
179179- ** Required**
@@ -188,18 +188,18 @@ This address is what other peers should specify in their
188188
189189:::
190190
191- #### ` network.actor-channel-capacity `
191+ ### ` network.actor-channel-capacity `
192192
193193- ** Type:** Number
194194- ** Default:** 100
195195
196196See: [ Actor Channel Capacity] ( #actor-channel-capacity )
197197
198- ### Sumeragi
198+ ## Sumeragi Options
199199
200200Explain sumeragi module
201201
202- #### ` sumeragi.trusted-peers `
202+ ### ` sumeragi.trusted-peers `
203203
204204- ** Type:** Array of Peer Ids
205205
@@ -241,48 +241,48 @@ trusted-peers = [
241241]
242242```
243243
244- #### ` sumeragi.block-time `
244+ ### ` sumeragi.block-time `
245245
246246- ** Type:** String or Number, [ Duration] ( #type-duration )
247247- ** Default:** 2 seconds
248248
249249The period of time a peer waits for the ` CreatedBlock ` message after
250250getting a ` TransactionReceipt `
251251
252- #### ` sumeragi.commit-time-limit `
252+ ### ` sumeragi.commit-time-limit `
253253
254254- ** Type:** String or Number, [ Duration] ( #type-duration )
255255- ** Default:** 4 seconds
256256
257257The period of time a peer waits for ` CommitMessage ` from the proxy tail.
258258
259- #### ` sumeragi.gossip-period `
259+ ### ` sumeragi.gossip-period `
260260
261261- ** Type:** String or Number, [ Duration] ( #type-duration )
262262- ** Default:** 1 second
263263
264264Period in milliseconds for pending transaction gossiping between peers.
265265
266- #### ` sumeragi.gossip-batch-size `
266+ ### ` sumeragi.gossip-batch-size `
267267
268268- ** Type:** Number
269269- ** Default:** 500
270270
271271max number of transactions in tx gossip batch message. While configuring
272272this, pay attention to ` p2p ` max message size.
273273
274- #### ` sumeragi.max-transactions-in-block `
274+ ### ` sumeragi.max-transactions-in-block `
275275
276276- ** Type:** u32
277277- ** Default:** 2_u32.pow(9)
278278
279279The upper limit of the number of transactions per block.
280280
281- ### Torii
281+ ## Torii Options
282282
283283Explain Torii module
284284
285- #### ` torii.api-address `
285+ ### ` torii.api-address `
286286
287287- ** ENV:** ` API_ENDPOINT `
288288- ** Type:** String, [ Socket-Address] ( #type-socket-address )
@@ -295,7 +295,7 @@ Address for client API.
295295api-address = " localhost:8080"
296296```
297297
298- #### ` torii.telemetry-address `
298+ ### ` torii.telemetry-address `
299299
300300- ** Type:** String, [ Socket-Address] ( #type-socket-address )
301301- ** Optional**
@@ -310,22 +310,22 @@ about "active" outbound telemetry, actively produced by Iroha.
310310
311311:::
312312
313- #### ` torii.max-transaction-size `
313+ ### ` torii.max-transaction-size `
314314
315315- ** Type:** String or Number, [ Byte Size] ( #type-byte-size )
316316- ** Default:** 2 pow 15 (todo mathjax?) ` 32_768 ` (2 \*\* 15)
317317
318318Maximum number of bytes in raw transaction. Used to prevent from DOS
319319attacks.
320320
321- #### ` torii.max-content-len `
321+ ### ` torii.max-content-len `
322322
323323- ** Type:** String or Number, [ Byte Size] ( #type-byte-size )
324324- ** Default:** ` 2 ** 12 * 4000 `
325325
326326Maximum number of bytes in raw message. Used to prevent from DOS attacks.
327327
328- #### ` torii.fetch-size `
328+ ### ` torii.fetch-size `
329329
330330TODO: use "amount" instead of size. Usually "size" means bytes in this
331331document
@@ -335,53 +335,53 @@ document
335335
336336How many query results are returned in one batch
337337
338- #### ` torii.query-idle-time `
338+ ### ` torii.query-idle-time `
339339
340340- ** Type:** String or Number, [ Duration] ( #type-duration )
341341- ** Default:** ` 30_000 `
342342
343343Time query can remain in the store if unaccessed
344344
345- ### Queue
345+ ## Queue Options
346346
347347Explain Queue module
348348
349- #### ` queue.max-transactions-in-queue `
349+ ### ` queue.max-transactions-in-queue `
350350
351351- ** Type:** u32
352352- ** Default:** ` 2 ** 16 `
353353
354354The upper limit of the number of transactions waiting in the queue.
355355
356- #### ` queue.max-transactions-in-queue-per-user `
356+ ### ` queue.max-transactions-in-queue-per-user `
357357
358358- ** Type:** u32
359359- ** Default:** 2 \*\* 16
360360
361361The upper limit of the number of transactions waiting in the queue for
362362single user. Use this option to apply throttling.
363363
364- #### ` queue.transaction-time-to-live `
364+ ### ` queue.transaction-time-to-live `
365365
366366- ** Type:** String or Number, [ Duration] ( #type-duration )
367367- ** Default:** 24 hours
368368
369369The transaction will be dropped after this time if it is still in the
370370queue.
371371
372- #### ` queue.future-threshold `
372+ ### ` queue.future-threshold `
373373
374374- ** Type:** String or Number, [ Duration] ( #type-duration )
375375- ** Default:** 1 second
376376
377377The threshold to determine if a transaction has been tampered to have a
378378future timestamp.
379379
380- ### Kura
380+ ## Kura Options
381381
382382Explain Kura module
383383
384- #### ` kura.init-mode `
384+ ### ` kura.init-mode `
385385
386386- ** Type:** String
387387- ** Possible Values:** ` strict ` or ` fast `
@@ -390,7 +390,7 @@ Explain Kura module
390390` strict ` - Strict validation of all blocks. ` fast ` - Fast initialization
391391with basic checks.
392392
393- #### ` kura.block-store-path `
393+ ### ` kura.block-store-path `
394394
395395- ** Type:** String
396396- ** Default:** ` ./storage `
@@ -405,25 +405,25 @@ with a snippet pointing to the configuration
405405
406406:::
407407
408- #### ` kura.blocks-per-storage-file `
408+ ### ` kura.blocks-per-storage-file `
409409
410410- ** Type:** non zero u64
411411- ** Default:** 1000
412412
413413Maximum number of blocks to write into a single storage file.
414414
415- #### ` kura.actor-channel-capacity `
415+ ### ` kura.actor-channel-capacity `
416416
417417- ** Type:** Number
418418- ** Default:** 100
419419
420420See: [ Actor Channel Capacity] ( #actor-channel-capacity )
421421
422- ### Logger
422+ ## Logger Options
423423
424424Explain module
425425
426- #### ` logger.level `
426+ ### ` logger.level `
427427
428428- ** ENV:** ` LOG ` , ` LOG_LEVEL ` , ` IROHA_LOG_LEVEL `
429429- ** Type:** String
@@ -433,14 +433,14 @@ Explain module
433433
434434Maximum log level
435435
436- #### ` logger.compact-mode `
436+ ### ` logger.compact-mode `
437437
438438- ** Type:** Boolean
439439- ** Default:** ` false `
440440
441441Compact mode (no spans from telemetry)
442442
443- #### ` logger.log-file-path `
443+ ### ` logger.log-file-path `
444444
445445- ** Type:** String
446446- ** Optional**
@@ -450,7 +450,7 @@ TODO: Find a standard name for log file path? (i.e. posix)
450450If provided, logs will be copied to said file in the format readable by
451451[ bunyan] ( https://lib.rs/crates/bunyan )
452452
453- #### ` logger.terminal-colors `
453+ ### ` logger.terminal-colors `
454454
455455- ** Type:** Boolean
456456- ** Default:** depends on ` logger.compact-mode ` . If compact mode is
@@ -470,11 +470,11 @@ colorize-output = true # INVALID: should be `false` or omitted
470470
471471:::
472472
473- ### Block Sync
473+ ## Block Sync Options
474474
475475Explain module
476476
477- #### ` block-sync.actor-channel-capacity `
477+ ### ` block-sync.actor-channel-capacity `
478478
479479- ** Type:** Number
480480- ** Default:** 100
@@ -488,7 +488,7 @@ Buffer capacity of actor's MPSC channel
488488actor-channel-capacity = 100
489489```
490490
491- #### ` block-sync.block-batch-size `
491+ ### ` block-sync.block-batch-size `
492492
493493- ** Type:** Number
494494- ** Default:** 4
@@ -500,7 +500,7 @@ The number of blocks that can be sent in one message.
500500block-batch-size = 4
501501```
502502
503- #### ` block-sync.gossip-period `
503+ ### ` block-sync.gossip-period `
504504
505505- ** Type:** String or Number, [ Duration] ( #type-duration )
506506- ** Default:** 10 seconds
@@ -512,11 +512,11 @@ The period of time to wait between sending requests for the latest block.
512512gossip-period = " 5 secs"
513513```
514514
515- ### World State View
515+ ## World State View Options
516516
517517Explain module
518518
519- #### ` wsv.asset-metadata-limits `
519+ ### ` wsv.asset-metadata-limits `
520520
521521- ** Type:** Table, [ Metadata Limits] ( #type-metadata-limits )
522522- ** Default:** [ Default Metadata Limits] ( #default-metadata-limits )
@@ -529,31 +529,31 @@ max-len = 30
529529max-entry-byte-size = " 2mb"
530530```
531531
532- #### ` wsv.asset-definition-metadata-limits `
532+ ### ` wsv.asset-definition-metadata-limits `
533533
534534TODO
535535
536- #### ` wsv.account-metadata-limits `
536+ ### ` wsv.account-metadata-limits `
537537
538538TODO
539539
540- #### ` wsv.domain-metadata-limits `
540+ ### ` wsv.domain-metadata-limits `
541541
542542TODO
543543
544- #### ` wsv.ident-length-limits `
544+ ### ` wsv.ident-length-limits `
545545
546546Limits for the number of characters in identifiers that can be stored in
547547the WSV.
548548
549549FIXME: rename ` ident ` to something more readable?
550550
551- #### ` wsv.transaction-limits `
551+ ### ` wsv.transaction-limits `
552552
553553Limits that all transactions need to obey, in terms of size of WASM blob
554554and number of instructions.
555555
556- #### ` wsv.wasm-runtime.fuel-limit `
556+ ### ` wsv.wasm-runtime.fuel-limit `
557557
558558The fuel limit determines the maximum number of instructions that can be
559559executed within a smart contract. Every WASM instruction costs
@@ -572,7 +572,7 @@ Example:
572572fuel-limit = 40_000_000
573573```
574574
575- #### ` wsv.wasm-runtime.max-memory `
575+ ### ` wsv.wasm-runtime.max-memory `
576576
577577Maximum amount of linear memory a given smart contract can allocate.
578578
@@ -588,11 +588,11 @@ Example:
588588max-memory = " 1gb"
589589```
590590
591- ## Telemetry
591+ ## Telemetry Options
592592
593593Two Telemetries are supported: Substrate-based and File-based.
594594
595- #### ` telemetry.substrate `
595+ ### ` telemetry.substrate `
596596
597597Enable Substrate active outbound telemetry.
598598
@@ -621,7 +621,7 @@ name = "iroha"
621621url = " ws://127.0.0.1:8001/submit"
622622```
623623
624- #### ` telemetry.file-output `
624+ ### ` telemetry.file-output `
625625
626626Enable file-based active outbound telemetry.
627627
0 commit comments