Skip to content

Commit 574cf42

Browse files
committed
docs: update default values
Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
1 parent 03d35cd commit 574cf42

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

docs/simulator/configuration.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
# Configuration
22

3-
There are 3 configuration sets:
43
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.
6-
1. [SimulatorStartupDataConfig](#simulatorstartupdataconfig): contains the configuration for the Block Stream Simulator startup data.
7-
1. [UnorderedStreamConfig](#unorderedstreamconfig): contains the configuration for the Unordered Stream Simulator logic.
8-
1. [ConsumerConfig](#consumerconfig): contains the configuration for the Consumer Simulator logic.
9-
1. [GrpcConfig](#grpcconfig): contains the configuration for the gRPC communication with the Block-Node.
10-
1. [PrometheusConfig](#prometheusconfig): contains the configuration for the Prometheus agent.
4+
2. [BlockGeneratorConfig](#blockgeneratorconfig): contains the configuration for the Block Stream Simulator generation module.
5+
3. [SimulatorStartupDataConfig](#simulatorstartupdataconfig): contains the configuration for the Block Stream Simulator startup data.
6+
4. [UnorderedStreamConfig](#unorderedstreamconfig): contains the configuration for the Unordered Stream Simulator logic.
7+
5. [ConsumerConfig](#consumerconfig): contains the configuration for the Consumer Simulator logic.
8+
6. [GrpcConfig](#grpcconfig): contains the configuration for the gRPC communication with the Block-Node.
9+
7. [PrometheusConfig](#prometheusconfig): contains the configuration for the Prometheus agent.
1110

1211
## BlockStreamConfig
1312

1413
Uses the prefix `blockStream` so all properties should start with `blockStream.`
1514

1615
| Key | Description | Default Value |
1716
|:----------------------------|:------------------------------------------------------------------------------------------------------------------------------------|-------------------:|
18-
| `simulatorMode` | The desired simulator mode to use, it can be either `PUBLISHER` or `CONSUMER`. | `PUBLISHER` |
17+
| `simulatorMode` | The desired simulator mode to use, it can be either `PUBLISHER_SERVER` or `CONSUMER`. | `PUBLISHER_SERVER` |
1918
| `lastKnownStatusesCapacity` | The store capacity for the last known statuses. | `10` |
2019
| `delayBetweenBlockItems` | The delay between each block item in nanoseconds, only applicable when streamingMode is `CONSTANT_RATE` | `1_500_000` |
2120
| `maxBlockItemsToStream` | The maximum number of block items to stream before stopping | `100_000` |
@@ -31,7 +30,7 @@ Uses the prefix `generator` so all properties should start with `generator.`
3130

3231
| Key | Description | Default Value |
3332
|:--------------------------|:------------------------------------------------------------------------------------------------------------|--------------------------------:|
34-
| `generationMode` | The desired generation Mode to use, it can only be `DIR` or `CRAFT` | `DIR` |
33+
| `generationMode` | The desired generation Mode to use, it can only be `DIR` or `CRAFT` | `CRAFT` |
3534
| `minEventsPerBlock` | The minimum number of events per block | `1` |
3635
| `maxEventsPerBlock` | The maximum number of events per block | `10` |
3736
| `minTransactionsPerEvent` | The minimum number of transactions per event | `1` |

0 commit comments

Comments
 (0)