Skip to content

Commit dd5de75

Browse files
mustafauzunnmustafauzunn
committed
style: formatting
Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
1 parent fcd0665 commit dd5de75

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

‎docs/simulator/configuration.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -13,46 +13,46 @@ There are 3 configuration sets:
1313

1414
Uses the prefix `blockStream` so all properties should start with `blockStream.`
1515

16-
| Key | Description | Default Value |
17-
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------|----------------:|
18-
| `simulatorMode` | The desired simulator mode to use, it can be either `PUBLISHER` or `CONSUMER`. | `PUBLISHER` |
19-
| `lastKnownStatusesCapacity` | The store capacity for the last known statuses. | `10` |
20-
| `delayBetweenBlockItems` | The delay between each block item in nanoseconds, only applicable when streamingMode=CONSTANT_RATE | `1_500_000` |
21-
| `maxBlockItemsToStream` | The maximum number of block items to stream before stopping | `100_000` |
22-
| `streamingMode` | Can either be `CONSTANT_RATE` or `MILLIS_PER_BLOCK` | `CONSTANT_RATE` |
23-
| `millisecondsPerBlock` | If streamingMode is `MILLIS_PER_BLOCK` this will be the time to wait between blocks in milliseconds | `1_000` |
24-
| `blockItemsBatchSize` | The number of block items to send in a single batch, however if a block has less block items, it will send all the items in a block | `1_000` |
25-
| `midBlockFailType` | The type of failure to occur while streaming. It can be `NONE`, `ABRUPT` or `EOS` | `NONE` |
26-
| `midBlockFailOffset` | The index where the failure will occur, only applicable if midBlockFailType is not `NONE` | `0` |
16+
| Key | Description | Default Value |
17+
|:----------------------------|:------------------------------------------------------------------------------------------------------------------------------------|----------------:|
18+
| `simulatorMode` | The desired simulator mode to use, it can be either `PUBLISHER` or `CONSUMER`. | `PUBLISHER` |
19+
| `lastKnownStatusesCapacity` | The store capacity for the last known statuses. | `10` |
20+
| `delayBetweenBlockItems` | The delay between each block item in nanoseconds, only applicable when streamingMode=CONSTANT_RATE | `1_500_000` |
21+
| `maxBlockItemsToStream` | The maximum number of block items to stream before stopping | `100_000` |
22+
| `streamingMode` | Can either be `CONSTANT_RATE` or `MILLIS_PER_BLOCK` | `CONSTANT_RATE` |
23+
| `millisecondsPerBlock` | If streamingMode is `MILLIS_PER_BLOCK` this will be the time to wait between blocks in milliseconds | `1_000` |
24+
| `blockItemsBatchSize` | The number of block items to send in a single batch, however if a block has less block items, it will send all the items in a block | `1_000` |
25+
| `midBlockFailType` | The type of failure to occur while streaming. It can be `NONE`, `ABRUPT` or `EOS` | `NONE` |
26+
| `midBlockFailOffset` | The index where the failure will occur, only applicable if midBlockFailType is not `NONE` | `0` |
2727

2828
## BlockGeneratorConfig
2929

3030
Uses the prefix `generator` so all properties should start with `generator.`
3131

32-
| Key | Description | Default Value |
33-
|:--------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------:|
34-
| `generationMode` | The desired generation Mode to use, it can only be `DIR` or `CRAFT` | `DIR` |
35-
| `minEventsPerBlock` | The minimum number of events per block | `1` |
36-
| `maxEventsPerBlock` | The maximum number of events per block | `10` |
37-
| `minTransactionsPerEvent` | The minimum number of transactions per event | `1` |
38-
| `maxTransactionsPerEvent` | The maximum number of transactions per event | `10` |
39-
| `folderRootPath` | If the generationMode is `DIR` this will be used as the source of the recording to stream to the Block-Node | `` |
40-
| `managerImplementation` | The desired implementation of the BlockStreamManager to use, it can only be `BlockAsDirBlockStreamManager`, `BlockAsFileBlockStreamManager` or `BlockAsFileLargeDataSets` | `BlockAsFileBlockStreamManager` |
41-
| `paddedLength` | On the `BlockAsFileLargeDataSets` implementation, the length of the padded left zeroes `000001.blk.gz` | `36` |
42-
| `fileExtension` | On the `BlockAsFileLargeDataSets` implementation, the extension of the files to be streamed | `.blk.gz` |
43-
| `startBlockNumber` | The block number to start streaming from | `0` |
44-
| `endBlockNumber` | The block number to stop streaming at | `-1` |
45-
| `invalidBlockHash` | If set to true, will send invalid block root hash | `false` |
32+
| Key | Description | Default Value |
33+
|:--------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------:|
34+
| `generationMode` | The desired generation Mode to use, it can only be `DIR` or `CRAFT` | `DIR` |
35+
| `minEventsPerBlock` | The minimum number of events per block | `1` |
36+
| `maxEventsPerBlock` | The maximum number of events per block | `10` |
37+
| `minTransactionsPerEvent` | The minimum number of transactions per event | `1` |
38+
| `maxTransactionsPerEvent` | The maximum number of transactions per event | `10` |
39+
| `folderRootPath` | If the generationMode is `DIR` this will be used as the source of the recording to stream to the Block-Node | `` |
40+
| `managerImplementation` | The desired implementation of the BlockStreamManager to use, it can only be `BlockAsDirBlockStreamManager`, `BlockAsFileBlockStreamManager` or `BlockAsFileLargeDataSets` | `BlockAsFileBlockStreamManager` |
41+
| `paddedLength` | On the `BlockAsFileLargeDataSets` implementation, the length of the padded left zeroes `000001.blk.gz` | `36` |
42+
| `fileExtension` | On the `BlockAsFileLargeDataSets` implementation, the extension of the files to be streamed | `.blk.gz` |
43+
| `startBlockNumber` | The block number to start streaming from | `0` |
44+
| `endBlockNumber` | The block number to stop streaming at | `-1` |
45+
| `invalidBlockHash` | If set to true, will send invalid block root hash | `false` |
4646

4747
## SimulatorStartupDataConfig
4848

4949
Uses the prefix `simulator.startup.data` so all properties should start with `simulator.startup.data.`
5050

51-
| Key | Description | Default Value |
52-
|:---------------------------|:-----------------------------------------------------------------|--------------------------------------------:|
53-
| `enabled` | Whether the startup data functionality is enabled | `false` |
54-
| `latestAckBlockNumberPath` | Path to the file containing the latest acknowledged block number | `/opt/simulator/data/latestAckBlockNumber` |
55-
| `latestAckBlockHashPath` | Path to the file containing the latest acknowledged block hash | `/opt/simulator/data/latestAckBlockHash` |
51+
| Key | Description | Default Value |
52+
|:---------------------------|:-----------------------------------------------------------------|-------------------------------------------:|
53+
| `enabled` | Whether the startup data functionality is enabled | `false` |
54+
| `latestAckBlockNumberPath` | Path to the file containing the latest acknowledged block number | `/opt/simulator/data/latestAckBlockNumber` |
55+
| `latestAckBlockHashPath` | Path to the file containing the latest acknowledged block hash | `/opt/simulator/data/latestAckBlockHash` |
5656

5757
## UnorderedStreamConfig
5858

@@ -69,13 +69,13 @@ Uses the prefix `unorderedStream` so all properties should start with `unordered
6969

7070
Uses the prefix `consumer` so all properties should start with `consumer.`
7171

72-
| Key | Description | Default Value |
73-
|:------------------------|:--------------------------------------------------------------------------------------------------------|----------------:|
74-
| `startBlockNumber` | The block number from which to start consuming | `-1` |
75-
| `endBlockNumber` | The block number at which to stop consuming | `-1` |
76-
| `slowDownType` | The type of slow down to apply while consuming, it can be `NONE`, `FIXED`, `RANDOM`, `RANDOM_WITH_WAIT` | `NONE` |
77-
| `slowDownMilliseconds` | The slowdown in milliseconds | `2` |
78-
| `slowDownForBlockRange` | The range of blocks to apply the slowdown | `10-30` |
72+
| Key | Description | Default Value |
73+
|:------------------------|:--------------------------------------------------------------------------------------------------------|--------------:|
74+
| `startBlockNumber` | The block number from which to start consuming | `-1` |
75+
| `endBlockNumber` | The block number at which to stop consuming | `-1` |
76+
| `slowDownType` | The type of slow down to apply while consuming, it can be `NONE`, `FIXED`, `RANDOM`, `RANDOM_WITH_WAIT` | `NONE` |
77+
| `slowDownMilliseconds` | The slowdown in milliseconds | `2` |
78+
| `slowDownForBlockRange` | The range of blocks to apply the slowdown | `10-30` |
7979

8080
## GrpcConfig
8181

0 commit comments

Comments
 (0)