Skip to content

Commit 96458a3

Browse files
avilagaston9JuArce
andauthored
fix(docs): update operators guide (#1691)
Co-authored-by: Julian Arce <[email protected]>
1 parent 9b165b6 commit 96458a3

File tree

2 files changed

+65
-2
lines changed

2 files changed

+65
-2
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Common variables for all the services
2+
# 'production' only prints info and above. 'development' also prints debug
3+
environment: 'production'
4+
aligned_layer_deployment_config_file_path: './contracts/script/output/holesky/alignedlayer_deployment_output.json'
5+
eigen_layer_deployment_config_file_path: './contracts/script/output/holesky/eigenlayer_deployment_output.json'
6+
eth_rpc_url: 'https://ethereum-holesky-rpc.publicnode.com' # DO NOT USE PUBLIC NODE IN PRODUCTION
7+
eth_rpc_url_fallback: 'https://ethereum-holesky-rpc.publicnode.com'
8+
eth_ws_url: 'wss://ethereum-holesky-rpc.publicnode.com' # DO NOT USE PUBLIC NODE IN PRODUCTION
9+
eth_ws_url_fallback: 'wss://ethereum-holesky-rpc.publicnode.com'
10+
eigen_metrics_ip_port_address: 'localhost:9090'
11+
12+
## ECDSA Configurations
13+
ecdsa:
14+
private_key_store_path: '<ecdsa_key_store_location_path>'
15+
private_key_store_password: '<ecdsa_key_store_password>'
16+
17+
## BLS Configurations
18+
bls:
19+
private_key_store_path: '<bls_key_store_location_path>'
20+
private_key_store_password: '<bls_key_store_password>'
21+
22+
## Operator Configurations
23+
operator:
24+
aggregator_rpc_server_ip_port_address: holesky.aggregator.alignedlayer.com:8090
25+
operator_tracker_ip_port_address: https://holesky.telemetry.alignedlayer.com
26+
address: '<operator_address>'
27+
earnings_receiver_address: '<earnings_receiver_address>' #Can be the same as the operator.
28+
delegation_approver_address: '0x0000000000000000000000000000000000000000'
29+
staker_opt_out_window_blocks: 0
30+
metadata_url: <metadata_url>
31+
enable_metrics: true
32+
metrics_ip_port_address: localhost:9092
33+
max_batch_size: 268435456 # 256 MiB
34+
last_processed_batch_filepath: 'config-files/operator.last_processed_batch.json'

docs/operator_guides/0_running_an_operator.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,12 @@ This will display the current version of the operator binary.
8484

8585
## Step 3 - Update the configuration for your specific Operator
8686

87-
Update the following placeholders in `./config-files/config-operator-mainnet.yaml`:
87+
Locate the appropiate `operator_config_file`:
88+
89+
- Mainnet: `./config-files/config-operator-mainnet.yaml`.
90+
- Holesky: `./config-files/config-operator-holesky.yaml`.
91+
92+
Update the following placeholders:
8893

8994
- `"<operator_address>"`
9095
- `"<earnings_receiver_address>"`
@@ -133,21 +138,37 @@ eth_ws_url_fallback: "wss://<RPC_2>"
133138
134139
Then you must register as an Operator on AlignedLayer. To do this, you must run:
135140
141+
- Mainnet:
142+
136143
```bash
137144
make operator_register_with_aligned_layer CONFIG_FILE=./config-files/config-operator-mainnet.yaml
138145
```
139146

147+
- Holesky:
148+
149+
```bash
150+
make operator_register_with_aligned_layer CONFIG_FILE=./config-files/config-operator-holesky.yaml
151+
```
152+
140153
{% hint style="danger" %}
141154
If you are going to run the server in this machine,
142155
delete the operator key
143156
{% endhint %}
144157

145158
## Step 5 - Start the operator
146159

160+
- Mainnet:
161+
147162
```bash
148163
./operator/build/aligned-operator start --config ./config-files/config-operator-mainnet.yaml
149164
```
150165

166+
- Holesky:
167+
168+
```bash
169+
./operator/build/aligned-operator start --config ./config-files/config-operator-holesky.yaml
170+
```
171+
151172
### Run Operator using Systemd
152173

153174
To manage the Operator process on Linux systems, we recommend use systemd with the following configuration:
@@ -164,7 +185,7 @@ After=network.target
164185
[Service]
165186
Type=simple
166187
User=aligned
167-
ExecStart=<path_to_aligned_layer_repository>/operator/build/aligned-operator start --config <path_to_operator_config>
188+
ExecStart=<path_to_aligned_layer_repository>/operator/build/aligned-operator start --config <path_to_operator_config_file>
168189
Restart=always
169190
RestartSec=1
170191
StartLimitBurst=100
@@ -212,6 +233,14 @@ journalctl -xfeu aligned-operator.service
212233

213234
To unregister the Aligned operator, run:
214235

236+
- Mainnet:
237+
238+
```bash
239+
cast send --rpc-url https://ethereum-rpc.publicnode.com --private-key <private_key> 0xA8CC0749b4409c3c47012323E625aEcBA92f64b9 'deregisterOperator(bytes)' 0x00
240+
```
241+
242+
- Holesky:
243+
215244
```bash
216245
cast send --rpc-url https://ethereum-holesky-rpc.publicnode.com --private-key <private_key> 0x3aD77134c986193c9ef98e55e800B71e72835b62 'deregisterOperator(bytes)' 0x00
217246
```

0 commit comments

Comments
 (0)