/
bootnode.go
287 lines (260 loc) · 8.3 KB
/
bootnode.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
/**
* Bootnode
*
* A node which implements the DiscoveryV5 protocol for peer
* discovery. The purpose of this service is to provide a starting point for
* newly connected services to find other peers outside of their network.
*
* Usage: Run bootnode --help for flag options.
*/
package main
import (
"context"
"crypto/ecdsa"
"crypto/rand"
"encoding/hex"
"flag"
"fmt"
"io"
"net"
"net/http"
"os"
"time"
gcrypto "github.com/ethereum/go-ethereum/crypto"
gethlog "github.com/ethereum/go-ethereum/log"
"github.com/ethereum/go-ethereum/p2p/discover"
"github.com/ethereum/go-ethereum/p2p/enode"
"github.com/ethereum/go-ethereum/p2p/enr"
"github.com/libp2p/go-libp2p/core/crypto"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/prysmaticlabs/go-bitfield"
"github.com/prysmaticlabs/prysm/v4/async"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/core/signing"
"github.com/prysmaticlabs/prysm/v4/config/params"
ecdsaprysm "github.com/prysmaticlabs/prysm/v4/crypto/ecdsa"
"github.com/prysmaticlabs/prysm/v4/encoding/bytesutil"
"github.com/prysmaticlabs/prysm/v4/io/logs"
"github.com/prysmaticlabs/prysm/v4/network"
pb "github.com/prysmaticlabs/prysm/v4/proto/prysm/v1alpha1"
_ "github.com/prysmaticlabs/prysm/v4/runtime/maxprocs"
"github.com/prysmaticlabs/prysm/v4/runtime/version"
"github.com/sirupsen/logrus"
)
var (
debug = flag.Bool("debug", false, "Enable debug logging")
logFileName = flag.String("log-file", "", "Specify log filename, relative or absolute")
privateKey = flag.String("private", "", "Private key to use for peer ID")
discv5port = flag.Int("discv5-port", 4000, "Port to listen for discv5 connections")
metricsPort = flag.Int("metrics-port", 5000, "Port to listen for connections")
externalIP = flag.String("external-ip", "", "External IP for the bootnode")
forkVersion = flag.String("fork-version", "", "Fork Version that the bootnode uses")
genesisValidatorsRoot = flag.String("genesis-root", "", "Genesis Validators Root the beacon node uses")
seedNode = flag.String("seed-node", "", "External node to connect to")
log = logrus.WithField("prefix", "bootnode")
discv5PeersCount = promauto.NewGauge(prometheus.GaugeOpts{
Name: "bootstrap_node_discv5_peers",
Help: "The current number of discv5 peers of the bootstrap node",
})
)
type handler struct {
listener *discover.UDPv5
}
func main() {
flag.Parse()
if *logFileName != "" {
if err := logs.ConfigurePersistentLogging(*logFileName); err != nil {
log.WithError(err).Error("Failed to configuring logging to disk.")
}
}
fmt.Printf("Starting bootnode. Version: %s\n", version.Version())
if *debug {
logrus.SetLevel(logrus.DebugLevel)
// Geth specific logging.
glogger := gethlog.NewGlogHandler(gethlog.StreamHandler(os.Stderr, gethlog.TerminalFormat(false)))
glogger.Verbosity(gethlog.LvlTrace)
gethlog.Root().SetHandler(glogger)
log.Debug("Debug logging enabled.")
}
privKey := extractPrivateKey()
cfg := discover.Config{
PrivateKey: privKey,
}
if *seedNode != "" {
log.Debugf("Adding seed node %s", *seedNode)
node, err := enode.Parse(enode.ValidSchemes, *seedNode)
if err != nil {
log.Fatal(err)
}
cfg.Bootnodes = []*enode.Node{node}
}
ipAddr, err := network.ExternalIP()
if err != nil {
log.Fatal(err)
}
listener := createListener(ipAddr, *discv5port, cfg)
node := listener.Self()
log.Infof("Running bootnode: %s", node.String())
handler := &handler{
listener: listener,
}
mux := http.NewServeMux()
mux.HandleFunc("/p2p", handler.httpHandler)
srv := &http.Server{
Addr: fmt.Sprintf(":%d", *metricsPort),
ReadHeaderTimeout: 3 * time.Second,
Handler: mux,
}
if err := srv.ListenAndServe(); err != nil {
log.WithError(err).Fatal("Failed to start server")
}
// Update metrics once per slot.
slotDuration := time.Duration(params.BeaconConfig().SecondsPerSlot)
async.RunEvery(context.Background(), slotDuration*time.Second, func() {
updateMetrics(listener)
})
select {}
}
func createListener(ipAddr string, port int, cfg discover.Config) *discover.UDPv5 {
ip := net.ParseIP(ipAddr)
if ip.To4() == nil {
log.Fatalf("IPV4 address not provided instead %s was provided", ipAddr)
}
var bindIP net.IP
var networkVersion string
switch {
case ip.To16() != nil && ip.To4() == nil:
bindIP = net.IPv6zero
networkVersion = "udp6"
case ip.To4() != nil:
bindIP = net.IPv4zero
networkVersion = "udp4"
default:
log.Fatalf("Valid ip address not provided instead %s was provided", ipAddr)
}
udpAddr := &net.UDPAddr{
IP: bindIP,
Port: port,
}
conn, err := net.ListenUDP(networkVersion, udpAddr)
if err != nil {
log.Fatal(err)
}
localNode, err := createLocalNode(cfg.PrivateKey, ip, port)
if err != nil {
log.Fatal(err)
}
net, err := discover.ListenV5(conn, localNode, cfg)
if err != nil {
log.Fatal(err)
}
return net
}
func (h *handler) httpHandler(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusOK)
write := func(w io.Writer, b []byte) {
if _, err := w.Write(b); err != nil {
log.WithError(err).Error("Failed to write to http response")
}
}
allNodes := h.listener.AllNodes()
write(w, []byte("Nodes stored in the table:\n"))
for i, n := range allNodes {
write(w, []byte(fmt.Sprintf("Node %d\n", i)))
write(w, []byte(n.String()+"\n"))
write(w, []byte("Node ID: "+n.ID().String()+"\n"))
write(w, []byte("IP: "+n.IP().String()+"\n"))
write(w, []byte(fmt.Sprintf("UDP Port: %d", n.UDP())+"\n"))
write(w, []byte(fmt.Sprintf("TCP Port: %d", n.UDP())+"\n\n"))
}
}
func createLocalNode(privKey *ecdsa.PrivateKey, ipAddr net.IP, port int) (*enode.LocalNode, error) {
db, err := enode.OpenDB("")
if err != nil {
return nil, errors.Wrap(err, "Could not open node's peer database")
}
external := net.ParseIP(*externalIP)
if *externalIP == "" {
external = ipAddr
}
fVersion := params.BeaconConfig().GenesisForkVersion
if *forkVersion != "" {
fVersion, err = hex.DecodeString(*forkVersion)
if err != nil {
return nil, errors.Wrap(err, "Could not retrieve fork version")
}
if len(fVersion) != 4 {
return nil, errors.Errorf("Invalid fork version size expected %d but got %d", 4, len(fVersion))
}
}
genRoot := params.BeaconConfig().ZeroHash
if *genesisValidatorsRoot != "" {
retRoot, err := hex.DecodeString(*genesisValidatorsRoot)
if err != nil {
return nil, errors.Wrap(err, "Could not retrieve genesis validators root")
}
if len(retRoot) != 32 {
return nil, errors.Errorf("Invalid root size, expected 32 but got %d", len(retRoot))
}
genRoot = bytesutil.ToBytes32(retRoot)
}
digest, err := signing.ComputeForkDigest(fVersion, genRoot[:])
if err != nil {
return nil, errors.Wrap(err, "Could not compute fork digest")
}
forkID := &pb.ENRForkID{
CurrentForkDigest: digest[:],
NextForkVersion: fVersion,
NextForkEpoch: params.BeaconConfig().FarFutureEpoch,
}
forkEntry, err := forkID.MarshalSSZ()
if err != nil {
return nil, errors.Wrap(err, "Could not marshal fork id")
}
localNode := enode.NewLocalNode(db, privKey)
localNode.Set(enr.WithEntry("eth2", forkEntry))
localNode.Set(enr.WithEntry("attnets", bitfield.NewBitvector64()))
localNode.SetFallbackIP(external)
localNode.SetFallbackUDP(port)
return localNode, nil
}
func extractPrivateKey() *ecdsa.PrivateKey {
var privKey *ecdsa.PrivateKey
if *privateKey != "" {
dst, err := hex.DecodeString(*privateKey)
if err != nil {
panic(err)
}
unmarshalledKey, err := crypto.UnmarshalSecp256k1PrivateKey(dst)
if err != nil {
panic(err)
}
privKey, err = ecdsaprysm.ConvertFromInterfacePrivKey(unmarshalledKey)
if err != nil {
panic(err)
}
} else {
privInterfaceKey, _, err := crypto.GenerateSecp256k1Key(rand.Reader)
if err != nil {
panic(err)
}
privKey, err = ecdsaprysm.ConvertFromInterfacePrivKey(privInterfaceKey)
if err != nil {
panic(err)
}
log.Warning("No private key was provided. Using default/random private key")
b, err := privInterfaceKey.Raw()
if err != nil {
panic(err)
}
log.Debugf("Private key %x", b)
}
privKey.Curve = gcrypto.S256()
return privKey
}
func updateMetrics(listener *discover.UDPv5) {
if listener != nil {
discv5PeersCount.Set(float64(len(listener.AllNodes())))
}
}