Skip to content

Commit ec33164

Browse files
authored
feat: vouch docs (Commit-Boost#132)
1 parent 5718c4b commit ec33164

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/docs/get_started/configuration.md

+32
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,35 @@ A few things to note:
6969
- There is now a `[[modules]]` section which at a minimum needs to specify the module `id`, `type` and `docker_image`. Additional parameters needed for the business logic of the module will also be here,
7070

7171
To learn more about developing modules, check out [here](/category/developing).
72+
73+
## Vouch
74+
[Vouch](https://github.com/attestantio/vouch) is a multi-node validator client built by [Attestant](https://www.attestant.io/). Vouch is particular in that it also integrates a MEV-Boost client to interact with relays. The Commit-Boost PBS module is compatible with the Vouch `blockrelay` since it implements the Builder-API, just like relays do. For example, depending on your setup and preference, you may want to fetch headers from a given relay using Commit-Boost vs using the built-in Vouch `blockrelay`.
75+
76+
### Configuration
77+
Get familiar on how to set up Vouch [here](https://github.com/attestantio/vouch/blob/master/docs/getting_started.md).
78+
79+
You can setup Commit-Boost with Vouch in two ways.
80+
For simplicity, assume that in Vouch `blockrelay.listen-address: 127.0.0.0:19550` and in Commit-Boost `pbs.port = 18550`.
81+
82+
#### Beacon Node to Vouch
83+
In this setup, the BN Builder-API endpoint will be pointing to the Vouch `blockrelay` (e.g. for Lighthouse you will need the flag `--builder=http://127.0.0.0:19550`).
84+
85+
Modify the `blockrelay.config` file to add Commit-Boost:
86+
```json
87+
"relays": {
88+
"http://127.0.0.0:18550": {}
89+
}
90+
```
91+
92+
#### Beacon Node to Commit Boost
93+
In this setup, the BN Builder-API endpoint will be pointing to the PBS module (e.g. for Lighthouse you will need the flag `--builder=http://127.0.0.0:18550`).
94+
95+
This will bypass the `blockrelay` entirely so make sure all relays are properly configured in the `[[relays]]` section.
96+
97+
**Note**: this approach could also work if you have a multi-beacon-node setup, where some BNs fetch directly via Commit-Boost while others go through the `blockrelay`.
98+
99+
### Notes
100+
- It's up to you to decide which relays will be connected via Commit-Boost (`[[relays]]` section in the `toml` config) and which via Vouch (additional entries in the `relays` field). Remember that any rate-limit will be shared across the two sidecars, if running on the same machine.
101+
- You may occasionally see a `timeout` error during registrations, especially if you're running a large number of validators in the same instance. This can resolve itself as registrations will be cleared later in the epoch when relays are less busy processing other registrations. Alternatively you can also adjust the `builderclient.timeout` option in `.vouch.yml`.
102+
103+

0 commit comments

Comments
 (0)