Skip to content

Commit 3100ba1

Browse files
Update .vscode/README.md to enhance the documentation for custom Assertoor configurations. Added an example YAML configuration and detailed notes on the configuration process, including how to set up nodes, enable additional services, and customize parameters for testing environments. This improves clarity and usability for users creating personalized configurations.
1 parent 6fc8f1b commit 3100ba1

File tree

1 file changed

+31
-45
lines changed

1 file changed

+31
-45
lines changed

.vscode/README.md

Lines changed: 31 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -109,22 +109,41 @@ You can create a custom devnet configuration to customize the testing environmen
109109
2. Add your desired configuration to this file
110110
3. The devnet setup will automatically use your custom configuration if it exists
111111

112-
## Custom Assertoor Configuration
112+
### Example Configuration
113113

114-
You can create a personalized Assertoor configuration that overrides or extends the automatically generated settings.
114+
Here's an example of a custom configuration:
115115

116-
### How the configuration system works
116+
```yaml
117+
participants:
118+
- el_type: erigon
119+
el_image: test/erigon:current
120+
cl_type: prysm
121+
count: 2
122+
additional_services:
123+
- assertoor
124+
- dora
125+
assertoor_params:
126+
run_stability_check: false
127+
run_block_proposal_check: true
128+
```
117129
118-
When you run the devnet setup (`.hack/devnet/run.sh`), the following process occurs:
130+
This configuration:
131+
132+
- Sets up 2 nodes with Erigon (execution layer) and Prysm (consensus layer)
133+
- Enables additional services (Assertoor and Dora)
134+
- Configures Assertoor with specific parameters and test playbooks
135+
- Uses custom Docker images for testing
136+
137+
### Notes
119138
120-
1. **Kurtosis generates a base config** from the ethereum-package, including endpoints and global variables
121-
2. **The script looks for a custom file**:
122-
- First searches for `custom-assertoor.devnet.config.yaml`
123-
- If not found, uses `assertoor.devnet.config.yaml`
124-
3. **Applies environment variables** to the custom file using `envsubst`
125-
4. **Merges the configurations** using `yq eval-all` which combines:
126-
- The config generated by Kurtosis (with endpoints, database, etc.)
127-
- Your custom config that overrides/adds settings
139+
- Make sure all requirements are installed before launching the debugger
140+
- The `devnet-setup` task may take a few minutes the first time
141+
- You can set breakpoints in the Go code before starting the debug session
142+
- Custom configurations allow you to test different network setups and scenarios
143+
144+
## Custom Assertoor Configuration
145+
146+
You can create a personalized Assertoor configuration that overrides or extends the automatically generated settings.
128147

129148
### Creating your custom Assertoor configuration
130149

@@ -179,7 +198,6 @@ database:
179198

180199
- **Change web port**: Modify `web.server.port`
181200
- **Add custom tests**: Use `externalTests` to include your test playbooks
182-
- **Custom global variables**: Use `globalVars` for test parameters
183201
- **Custom logging**: Configure log level and format
184202
- **Different database**: Switch from PostgreSQL to SQLite or customize connection settings
185203

@@ -189,35 +207,3 @@ database:
189207
- The generated config is recreated each time you run the devnet setup
190208
- Environment variables in your config (like `${DEVNET_DIR}`) are automatically substituted
191209
- Your custom settings will override any conflicting settings from the generated config
192-
193-
### Example Configuration
194-
195-
Here's an example of a custom configuration:
196-
197-
```yaml
198-
participants:
199-
- el_type: erigon
200-
el_image: test/erigon:current
201-
cl_type: prysm
202-
count: 2
203-
additional_services:
204-
- assertoor
205-
- dora
206-
assertoor_params:
207-
run_stability_check: false
208-
run_block_proposal_check: true
209-
```
210-
211-
This configuration:
212-
213-
- Sets up 2 nodes with Erigon (execution layer) and Prysm (consensus layer)
214-
- Enables additional services (Assertoor and Dora)
215-
- Configures Assertoor with specific parameters and test playbooks
216-
- Uses custom Docker images for testing
217-
218-
### Notes
219-
220-
- Make sure all requirements are installed before launching the debugger
221-
- The `devnet-setup` task may take a few minutes the first time
222-
- You can set breakpoints in the Go code before starting the debug session
223-
- Custom configurations allow you to test different network setups and scenarios

0 commit comments

Comments
 (0)