You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-4Lines changed: 22 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,31 @@
3
3
This project contains all the software required for creating or participating in a distributed validator cluster for Ethereum using the [SSV project](https://github.com/bloxapp/ssv).
4
4
It currently supports mainnet, holesky and hoodi - though holesky no longer supports the full validator registration lifecycle since got rekt.
5
5
6
-
## cli
6
+
## Development
7
+
8
+
### Prerequisites
9
+
- go 19 or newer
10
+
11
+
### Building
12
+
13
+
To build the sidecar from source run:
14
+
```go
15
+
go build -o ssv-sidecar ./sidecar/cmd/main.go
16
+
```
17
+
18
+
To build the user CLI from source run:
19
+
```go
20
+
go build -o ssv-dkg ./cli/cmd/main.go
21
+
```
22
+
23
+
## Usage
24
+
### cli
7
25
For users with ETH to stake who wish to create a validator cluster, [read the CLI readme](./cli/README.md)
8
26
9
-
## sidecar
27
+
###sidecar
10
28
For SSV node operators who wish to opt into distributed key generation opportunities, [read the sidecar readme](./sidecar/README.md)
11
29
12
-
## tools
30
+
###tools
13
31
The tools module contains useful applications for interacting with other parts of the project.
14
32
15
-
[./tools/key_verifier](./tools/key_verifier) is a tool used by the GitHub actions for verifying the keys of operators added to the [operators list](./nodes/operators.json).
33
+
[./tools/key_verifier](./tools/key_verifier) is a tool used by the GitHub actions for verifying the keys of operators added to the [operators list](./nodes/operators.json).
0 commit comments