Skip to content

Commit a0c10c1

Browse files
committed
docs: refactor
Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
1 parent dd5de75 commit a0c10c1

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/simulator/configuration.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22

33
There are 3 configuration sets:
44
1. [BlockStreamConfig](#blockstreamconfig): contains the configuration for the Block Stream Simulator logic.
5-
1. [BlockGeneratorConfig](#blockGeneratorConfig): contains the configuration for the Block Stream Simulator generation module.
5+
1. [BlockGeneratorConfig](#blockgeneratorconfig): contains the configuration for the Block Stream Simulator generation module.
66
1. [SimulatorStartupDataConfig](#simulatorstartupdataconfig): contains the configuration for the Block Stream Simulator startup data.
77
1. [UnorderedStreamConfig](#unorderedstreamconfig): contains the configuration for the Unordered Stream Simulator logic.
8-
1. [ConsumerConfig](#consumerConfig): contains the configuration for the Consumer Simulator logic.
8+
1. [ConsumerConfig](#consumerconfig): contains the configuration for the Consumer Simulator logic.
99
1. [GrpcConfig](#grpcconfig): contains the configuration for the gRPC communication with the Block-Node.
1010
1. [PrometheusConfig](#prometheusconfig): contains the configuration for the Prometheus.
1111

1212
## BlockStreamConfig
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` | `MILLIS_PER_BLOCK` |
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

0 commit comments

Comments
 (0)