mirror/erigon-pulse
1
0
Fork 0
mirror of https://gitlab.com/pulsechaincom/erigon-pulse.git synced 2024-12-22 03:30:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Customizable networking for Erigon Lightclient (#6032)

Browse Source
This commit is contained in:
Giulio rebuffo 2022-11-11 23:22:47 +01:00 committed by GitHub
parent 5b3f2b8c5f
commit ae01026ca9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 91 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -552,6 +552,15 @@ Typically, a sentry process will run one eth/xx protocol (e.g. eth/66) and will
Port
9091 is for internal gRCP connections (e.g erigon -> sentry).
#### `sentinel` ports
| Port | Protocol | Purpose | Expose |
|:-----:|:---------:|:----------------:|:-------:|
| 4000 | UDP | Peering | Public |
| 4001 | TCP | Peering | Public |
| 7777 | TCP | gRPC Connections | Private |
#### Other ports
| Port | Protocol | Purpose | Expose |

2
cmd/lightclient/main.go
View File

@ -57,7 +57,7 @@ func runLightClientNode(cliCtx *cli.Context) {
NetworkConfig: lcCfg.NetworkCfg,
BeaconConfig: lcCfg.BeaconCfg,
NoDiscovery: lcCfg.NoDiscovery,
}, &service.ServerConfig{Network: lcCfg.ServerProtocol, Addr: lcCfg.ServerAddr})
}, &service.ServerConfig{Network: lcCfg.ServerProtocol, Addr: lcCfg.ServerAddr}, nil)
if err != nil {
log.Error("Could not start sentinel", "err", err)
}

2
cmd/sentinel/main.go
View File

@ -87,7 +87,7 @@ func runSentinelNode(cliCtx *cli.Context) {
NetworkConfig: lcCfg.NetworkCfg,
BeaconConfig: lcCfg.BeaconCfg,
NoDiscovery: lcCfg.NoDiscovery,
}, &service.ServerConfig{Network: lcCfg.ServerProtocol, Addr: lcCfg.ServerAddr})
}, &service.ServerConfig{Network: lcCfg.ServerProtocol, Addr: lcCfg.ServerAddr}, nil)
if err != nil {
log.Error("Could not start sentinel", "err", err)
return

16
cmd/sentinel/sentinel/service/start.go
View File

@ -10,6 +10,7 @@ import (
"github.com/ledgerwatch/erigon/cmd/sentinel/sentinel"
"github.com/ledgerwatch/log/v3"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
)
@ -18,7 +19,7 @@ type ServerConfig struct {
Addr string
}
func StartSentinelService(cfg *sentinel.SentinelConfig, srvCfg *ServerConfig) (consensusrpc.SentinelClient, error) {
func StartSentinelService(cfg *sentinel.SentinelConfig, srvCfg *ServerConfig, creds credentials.TransportCredentials) (consensusrpc.SentinelClient, error) {
ctx := context.Background()
sent, err := sentinel.New(context.Background(), cfg)
if err != nil {
@ -51,7 +52,11 @@ func StartSentinelService(cfg *sentinel.SentinelConfig, srvCfg *ServerConfig) (c
log.Info("Sentinel started", "enr", sent.String())
server := NewSentinelServer(ctx, sent)
go StartServe(server, srvCfg)
if creds == nil {
creds = insecure.NewCredentials()
}
go StartServe(server, srvCfg, creds)
timeOutTimer := time.NewTimer(5 * time.Second)
WaitingLoop:
for {
@ -64,7 +69,8 @@ WaitingLoop:
}
}
}
conn, err := grpc.DialContext(ctx, srvCfg.Addr, grpc.WithTransportCredentials(insecure.NewCredentials()))
conn, err := grpc.DialContext(ctx, srvCfg.Addr, grpc.WithTransportCredentials(creds))
if err != nil {
return nil, err
}
@ -72,13 +78,13 @@ WaitingLoop:
return consensusrpc.NewSentinelClient(conn), nil
}
func StartServe(server *SentinelServer, srvCfg *ServerConfig) {
func StartServe(server *SentinelServer, srvCfg *ServerConfig, creds credentials.TransportCredentials) {
lis, err := net.Listen(srvCfg.Network, srvCfg.Addr)
if err != nil {
log.Warn("[Sentinel] could not serve service", "reason", err)
}
// Create a gRPC server
gRPCserver := grpc.NewServer()
gRPCserver := grpc.NewServer(grpc.Creds(creds))
go server.ListenToGossip()
// Regiser our server as a gRPC server
consensusrpc.RegisterSentinelServer(gRPCserver, server)

31
cmd/utils/flags.go
View File

@ -726,6 +726,31 @@ var (
Usage: "Sets erigon flags from YAML/TOML file",
Value: "",
}
LightClientDiscoveryAddrFlag = cli.StringFlag{
Name: "lightclient.discovery.addr",
Usage: "Address for lightclient DISCV5 protocol",
Value: "127.0.0.1",
}
LightClientDiscoveryPortFlag = cli.Uint64Flag{
Name: "lightclient.discovery.port",
Usage: "Port for lightclient DISCV5 protocol",
Value: 4000,
}
LightClientDiscoveryTCPPortFlag = cli.Uint64Flag{
Name: "lightclient.discovery.tcpport",
Usage: "TCP Port for lightclient DISCV5 protocol",
Value: 4001,
}
SentinelAddrFlag = cli.StringFlag{
Name: "sentinel.addr",
Usage: "Address for sentinel",
Value: "localhost",
}
SentinelPortFlag = cli.Uint64Flag{
Name: "sentinel.port",
Usage: "Port for sentinel",
Value: 7777,
}
)
var MetricFlags = []cli.Flag{MetricsEnabledFlag, MetricsEnabledExpensiveFlag, MetricsHTTPFlag, MetricsPortFlag}
@ -1428,6 +1453,12 @@ func CheckExclusive(ctx *cli.Context, args ...interface{}) {
// SetEthConfig applies eth-related command line flags to the config.
func SetEthConfig(ctx *cli.Context, nodeConfig *nodecfg.Config, cfg *ethconfig.Config) {
cfg.CL = ctx.GlobalBool(ExternalConsensusFlag.Name)
cfg.LightClientDiscoveryAddr = ctx.GlobalString(LightClientDiscoveryAddrFlag.Name)
cfg.LightClientDiscoveryPort = ctx.GlobalUint64(LightClientDiscoveryPortFlag.Name)
cfg.LightClientDiscoveryTCPPort = ctx.GlobalUint64(LightClientDiscoveryTCPPortFlag.Name)
cfg.SentinelAddr = ctx.GlobalString(SentinelAddrFlag.Name)
cfg.SentinelPort = ctx.GlobalUint64(SentinelPortFlag.Name)
cfg.Sync.UseSnapshots = ctx.GlobalBoolT(SnapshotFlag.Name)
cfg.Dirs = nodeConfig.Dirs
cfg.Snapshot.KeepBlocks = ctx.GlobalBool(SnapKeepBlocksFlag.Name)

52
eth/backend.go
View File

@ -453,6 +453,28 @@ func New(stack *node.Node, config *ethconfig.Config, logger log.Logger) (*Ethere
blockReader, chainConfig, assembleBlockPOS, backend.sentriesClient.Hd, config.Miner.EnabledPOS)
miningRPC = privateapi.NewMiningServer(ctx, backend, ethashApi)
var creds credentials.TransportCredentials
if stack.Config().PrivateApiAddr != "" {
if stack.Config().TLSConnection {
creds, err = grpcutil.TLS(stack.Config().TLSCACert, stack.Config().TLSCertFile, stack.Config().TLSKeyFile)
if err != nil {
return nil, err
}
}
backend.privateAPI, err = privateapi.StartGrpc(
kvRPC,
ethBackendRPC,
backend.txPool2GrpcServer,
miningRPC,
stack.Config().PrivateApiAddr,
stack.Config().PrivateApiRateLimit,
creds,
stack.Config().HealthCheck)
if err != nil {
return nil, fmt.Errorf("private api: %w", err)
}
}
// If we choose not to run a consensus layer, run our embedded.
if !config.CL && clparams.Supported(config.NetworkID) {
genesisCfg, networkCfg, beaconCfg := clparams.GetConfigsByNetwork(clparams.NetworkType(config.NetworkID))
@ -460,13 +482,13 @@ func New(stack *node.Node, config *ethconfig.Config, logger log.Logger) (*Ethere
return nil, err
}
client, err := service.StartSentinelService(&sentinel.SentinelConfig{
IpAddr: "127.0.0.1",
Port: 4000,
TCPPort: 4001,
IpAddr: config.LightClientDiscoveryAddr,
Port: int(config.LightClientDiscoveryPort),
TCPPort: uint(config.LightClientDiscoveryTCPPort),
GenesisConfig: genesisCfg,
NetworkConfig: networkCfg,
BeaconConfig: beaconCfg,
}, &service.ServerConfig{Network: "tcp", Addr: "localhost:7777"})
}, &service.ServerConfig{Network: "tcp", Addr: fmt.Sprintf("%s:%d", config.SentinelAddr, config.SentinelPort)}, creds)
if err != nil {
return nil, err
}
@ -489,28 +511,6 @@ func New(stack *node.Node, config *ethconfig.Config, logger log.Logger) (*Ethere
go lc.Start()
}
if stack.Config().PrivateApiAddr != "" {
var creds credentials.TransportCredentials
if stack.Config().TLSConnection {
creds, err = grpcutil.TLS(stack.Config().TLSCACert, stack.Config().TLSCertFile, stack.Config().TLSKeyFile)
if err != nil {
return nil, err
}
}
backend.privateAPI, err = privateapi.StartGrpc(
kvRPC,
ethBackendRPC,
backend.txPool2GrpcServer,
miningRPC,
stack.Config().PrivateApiAddr,
stack.Config().PrivateApiRateLimit,
creds,
stack.Config().HealthCheck)
if err != nil {
return nil, fmt.Errorf("private api: %w", err)
}
}
if currentBlock == nil {
currentBlock = genesis
}

7
eth/ethconfig/config.go
View File

@ -236,7 +236,12 @@ type Config struct {
// Ethstats service
Ethstats string
// ConsenSUS layer
CL bool
CL bool
LightClientDiscoveryAddr string
LightClientDiscoveryPort uint64
LightClientDiscoveryTCPPort uint64
SentinelAddr string
SentinelPort uint64
// FORK_NEXT_VALUE (see EIP-3675) block override
OverrideMergeNetsplitBlock *big.Int `toml:",omitempty"`

6
turbo/cli/default_flags.go
View File

@ -148,4 +148,10 @@ var DefaultFlags = []cli.Flag{
logging.LogConsoleJsonFlag,
logging.LogJsonFlag,
logging.LogDirJsonFlag,
utils.LightClientDiscoveryAddrFlag,
utils.LightClientDiscoveryPortFlag,
utils.LightClientDiscoveryTCPPortFlag,
utils.SentinelAddrFlag,
utils.SentinelPortFlag,
}