Usage:"Sets the peer scoring strategy for the P2P stack. Can be one of: none or light.",
Required:false,
Value:"light",
EnvVars:p2pEnv("PEER_SCORING"),
}
PeerScoring=&cli.StringFlag{
Name:"p2p.scoring.peers",
Usage:fmt.Sprintf("Deprecated: Use %v instead",Scoring.Name),
Required:false,
Hidden:true,
}
PeerScoreBands=&cli.StringFlag{
Name:"p2p.score.bands",
Usage:"Deprecated. This option is ignored and is only present for backwards compatibility.",
Required:false,
Value:"",
Hidden:true,
}
// Banning Flag - whether or not we want to act on the scoring
Banning=&cli.BoolFlag{
Name:"p2p.ban.peers",
Usage:"Enables peer banning.",
Value:true,
Required:false,
EnvVars:p2pEnv("PEER_BANNING"),
}
BanningThreshold=&cli.Float64Flag{
Name:"p2p.ban.threshold",
Usage:"The minimum score below which peers are disconnected and banned.",
Required:false,
Value:-100,
EnvVars:p2pEnv("PEER_BANNING_THRESHOLD"),
}
BanningDuration=&cli.DurationFlag{
Name:"p2p.ban.duration",
Usage:"The duration that peers are banned for.",
Required:false,
Value:1*time.Hour,
EnvVars:p2pEnv("PEER_BANNING_DURATION"),
}
TopicScoring=&cli.StringFlag{
Name:"p2p.scoring.topics",
Usage:fmt.Sprintf("Deprecated: Use %v instead",Scoring.Name),
Required:false,
Hidden:true,
}
P2PPrivPath=&cli.StringFlag{
Name:"p2p.priv.path",
Usage:"Read the hex-encoded 32-byte private key for the peer ID from this txt file. Created if not already exists."+
"Important to persist to keep the same network identity after restarting, maintaining the previous advertised identity.",
Required:false,
Value:"opnode_p2p_priv.txt",
EnvVars:p2pEnv("PRIV_PATH"),
TakesFile:true,
}
P2PPrivRaw=&cli.StringFlag{
// sometimes it may be ok to not persist the peer priv key as file, and instead pass it directly.
Name:"p2p.priv.raw",
Usage:"The hex-encoded 32-byte private key for the peer ID",
Required:false,
Hidden:true,
Value:"",
EnvVars:p2pEnv("PRIV_RAW"),
}
ListenIP=&cli.StringFlag{
Name:"p2p.listen.ip",
Usage:"IP to bind LibP2P and Discv5 to",
Required:false,
Value:"0.0.0.0",
EnvVars:p2pEnv("LISTEN_IP"),
}
ListenTCPPort=&cli.UintFlag{
Name:"p2p.listen.tcp",
Usage:"TCP port to bind LibP2P to. Any available system port if set to 0.",
Required:false,
Value:9222,
EnvVars:p2pEnv("LISTEN_TCP_PORT"),
}
ListenUDPPort=&cli.UintFlag{
Name:"p2p.listen.udp",
Usage:"UDP port to bind Discv5 to. Same as TCP port if left 0.",
Required:false,
Value:0,// can simply match the TCP libp2p port
EnvVars:p2pEnv("LISTEN_UDP_PORT"),
}
AdvertiseIP=&cli.StringFlag{
Name:"p2p.advertise.ip",
Usage:"The IP address to advertise in Discv5, put into the ENR of the node. This may also be a hostname / domain name to resolve to an IP.",
Required:false,
// Ignored by default, nodes can discover their own external IP in the happy case,
// by communicating with bootnodes. Fixed IP is recommended for faster bootstrap though.
Value:"",
EnvVars:p2pEnv("ADVERTISE_IP"),
}
AdvertiseTCPPort=&cli.UintFlag{
Name:"p2p.advertise.tcp",
Usage:"The TCP port to advertise in Discv5, put into the ENR of the node. Set to p2p.listen.tcp value if 0.",
Required:false,
Value:0,
EnvVars:p2pEnv("ADVERTISE_TCP"),
}
AdvertiseUDPPort=&cli.UintFlag{
Name:"p2p.advertise.udp",
Usage:"The UDP port to advertise in Discv5 as fallback if not determined by Discv5, put into the ENR of the node. Set to p2p.listen.udp value if 0.",
Required:false,
Value:0,
EnvVars:p2pEnv("ADVERTISE_UDP"),
}
Bootnodes=&cli.StringFlag{
Name:"p2p.bootnodes",
Usage:"Comma-separated base64-format ENR list. Bootnodes to start discovering other node records from.",
Required:false,
Value:"",
EnvVars:p2pEnv("BOOTNODES"),
}
StaticPeers=&cli.StringFlag{
Name:"p2p.static",
Usage:"Comma-separated multiaddr-format peer list. Static connections to make and maintain, these peers will be regarded as trusted.",
Required:false,
Value:"",
EnvVars:p2pEnv("STATIC"),
}
NetRestrict=&cli.StringFlag{
Name:"p2p.netrestrict",
Usage:"Comma-separated list of CIDR masks. P2P will only try to connect on these networks",
Required:false,
EnvVars:p2pEnv("NETRESTRICT"),
}
HostMux=&cli.StringFlag{
Name:"p2p.mux",
Usage:"Comma-separated list of multiplexing protocols in order of preference. At least 1 required. Options: 'yamux','mplex'.",
Hidden:true,
Required:false,
Value:"yamux,mplex",
EnvVars:p2pEnv("MUX"),
}
HostSecurity=&cli.StringFlag{
Name:"p2p.security",
Usage:"Comma-separated list of transport security protocols in order of preference. At least 1 required. Options: 'noise','tls'. Set to 'none' to disable.",
Hidden:true,
Required:false,
Value:"noise",
EnvVars:p2pEnv("SECURITY"),
}
PeersLo=&cli.UintFlag{
Name:"p2p.peers.lo",
Usage:"Low-tide peer count. The node actively searches for new peer connections if below this amount.",
Required:false,
Value:20,
EnvVars:p2pEnv("PEERS_LO"),
}
PeersHi=&cli.UintFlag{
Name:"p2p.peers.hi",
Usage:"High-tide peer count. The node starts pruning peer connections slowly after reaching this number.",
Required:false,
Value:30,
EnvVars:p2pEnv("PEERS_HI"),
}
PeersGrace=&cli.DurationFlag{
Name:"p2p.peers.grace",
Usage:"Grace period to keep a newly connected peer around, if it is not misbehaving.",
Required:false,
Value:30*time.Second,
EnvVars:p2pEnv("PEERS_GRACE"),
}
NAT=&cli.BoolFlag{
Name:"p2p.nat",
Usage:"Enable NAT traversal with PMP/UPNP devices to learn external IP.",
Required:false,
EnvVars:p2pEnv("NAT"),
}
UserAgent=&cli.StringFlag{
Name:"p2p.useragent",
Usage:"User-agent string to share via LibP2P identify. If empty it defaults to 'optimism'.",
Hidden:true,
Required:false,
Value:"optimism",
EnvVars:p2pEnv("AGENT"),
}
TimeoutNegotiation=&cli.DurationFlag{
Name:"p2p.timeout.negotiation",
Usage:"Negotiation timeout, time for new peer connections to share their their supported p2p protocols",
Hidden:true,
Required:false,
Value:10*time.Second,
EnvVars:p2pEnv("TIMEOUT_NEGOTIATION"),
}
TimeoutAccept=&cli.DurationFlag{
Name:"p2p.timeout.accept",
Usage:"Accept timeout, time for connection to be accepted.",
Hidden:true,
Required:false,
Value:10*time.Second,
EnvVars:p2pEnv("TIMEOUT_ACCEPT"),
}
TimeoutDial=&cli.DurationFlag{
Name:"p2p.timeout.dial",
Usage:"Dial timeout for outgoing connection requests",
Hidden:true,
Required:false,
Value:10*time.Second,
EnvVars:p2pEnv("TIMEOUT_DIAL"),
}
PeerstorePath=&cli.StringFlag{
Name:"p2p.peerstore.path",
Usage:"Peerstore database location. Persisted peerstores help recover peers after restarts. "+
"Set to 'memory' to never persist the peerstore. Peerstore records will be pruned / expire as necessary. "+
"Warning: a copy of the priv network key of the local peer will be persisted here.",// TODO: bad design of libp2p, maybe we can avoid this from happening
Required:false,
TakesFile:true,
Value:"opnode_peerstore_db",
EnvVars:p2pEnv("PEERSTORE_PATH"),
}
DiscoveryPath=&cli.StringFlag{
Name:"p2p.discovery.path",
Usage:"Discovered ENRs are persisted in a database to recover from a restart without having to bootstrap the discovery process again. Set to 'memory' to never persist the peerstore.",
Required:false,
TakesFile:true,
Value:"opnode_discovery_db",
EnvVars:p2pEnv("DISCOVERY_PATH"),
}
SequencerP2PKeyFlag=&cli.StringFlag{
Name:"p2p.sequencer.key",
Usage:"Hex-encoded private key for signing off on p2p application messages as sequencer.",
Required:false,
Value:"",
EnvVars:p2pEnv("SEQUENCER_KEY"),
}
GossipMeshDFlag=&cli.UintFlag{
Name:"p2p.gossip.mesh.d",
Usage:"Configure GossipSub topic stable mesh target count, a.k.a. desired outbound degree, number of peers to gossip to",
Usage:fmt.Sprintf("Deprecated: Use %v instead",ScoringName),
Required:false,
Hidden:true,
},
&cli.StringFlag{
Name:P2PPrivPathName,
Usage:"Read the hex-encoded 32-byte private key for the peer ID from this txt file. Created if not already exists."+
"Important to persist to keep the same network identity after restarting, maintaining the previous advertised identity.",
Required:false,
Value:"opnode_p2p_priv.txt",
EnvVars:p2pEnv(envPrefix,"PRIV_PATH"),
TakesFile:true,
},
&cli.StringFlag{
// sometimes it may be ok to not persist the peer priv key as file, and instead pass it directly.
Name:P2PPrivRawName,
Usage:"The hex-encoded 32-byte private key for the peer ID",
Required:false,
Hidden:true,
Value:"",
EnvVars:p2pEnv(envPrefix,"PRIV_RAW"),
},
&cli.StringFlag{
Name:ListenIPName,
Usage:"IP to bind LibP2P and Discv5 to",
Required:false,
Value:"0.0.0.0",
EnvVars:p2pEnv(envPrefix,"LISTEN_IP"),
},
&cli.UintFlag{
Name:ListenTCPPortName,
Usage:"TCP port to bind LibP2P to. Any available system port if set to 0.",
Required:false,
Value:9222,
EnvVars:p2pEnv(envPrefix,"LISTEN_TCP_PORT"),
},
&cli.UintFlag{
Name:ListenUDPPortName,
Usage:"UDP port to bind Discv5 to. Same as TCP port if left 0.",
Required:false,
Value:0,// can simply match the TCP libp2p port
EnvVars:p2pEnv(envPrefix,"LISTEN_UDP_PORT"),
},
&cli.StringFlag{
Name:AdvertiseIPName,
Usage:"The IP address to advertise in Discv5, put into the ENR of the node. This may also be a hostname / domain name to resolve to an IP.",
Required:false,
// Ignored by default, nodes can discover their own external IP in the happy case,
// by communicating with bootnodes. Fixed IP is recommended for faster bootstrap though.
Value:"",
EnvVars:p2pEnv(envPrefix,"ADVERTISE_IP"),
},
&cli.UintFlag{
Name:AdvertiseTCPPortName,
Usage:"The TCP port to advertise in Discv5, put into the ENR of the node. Set to p2p.listen.tcp value if 0.",
Required:false,
Value:0,
EnvVars:p2pEnv(envPrefix,"ADVERTISE_TCP"),
},
&cli.UintFlag{
Name:AdvertiseUDPPortName,
Usage:"The UDP port to advertise in Discv5 as fallback if not determined by Discv5, put into the ENR of the node. Set to p2p.listen.udp value if 0.",
Required:false,
Value:0,
EnvVars:p2pEnv(envPrefix,"ADVERTISE_UDP"),
},
&cli.StringFlag{
Name:BootnodesName,
Usage:"Comma-separated base64-format ENR list. Bootnodes to start discovering other node records from.",
Required:false,
Value:"",
EnvVars:p2pEnv(envPrefix,"BOOTNODES"),
},
&cli.StringFlag{
Name:StaticPeersName,
Usage:"Comma-separated multiaddr-format peer list. Static connections to make and maintain, these peers will be regarded as trusted.",
Required:false,
Value:"",
EnvVars:p2pEnv(envPrefix,"STATIC"),
},
&cli.StringFlag{
Name:NetRestrictName,
Usage:"Comma-separated list of CIDR masks. P2P will only try to connect on these networks",
Required:false,
EnvVars:p2pEnv(envPrefix,"NETRESTRICT"),
},
&cli.StringFlag{
Name:HostMuxName,
Usage:"Comma-separated list of multiplexing protocols in order of preference. At least 1 required. Options: 'yamux','mplex'.",
Hidden:true,
Required:false,
Value:"yamux,mplex",
EnvVars:p2pEnv(envPrefix,"MUX"),
},
&cli.StringFlag{
Name:HostSecurityName,
Usage:"Comma-separated list of transport security protocols in order of preference. At least 1 required. Options: 'noise','tls'. Set to 'none' to disable.",
Hidden:true,
Required:false,
Value:"noise",
EnvVars:p2pEnv(envPrefix,"SECURITY"),
},
&cli.UintFlag{
Name:PeersLoName,
Usage:"Low-tide peer count. The node actively searches for new peer connections if below this amount.",
Required:false,
Value:20,
EnvVars:p2pEnv(envPrefix,"PEERS_LO"),
},
&cli.UintFlag{
Name:PeersHiName,
Usage:"High-tide peer count. The node starts pruning peer connections slowly after reaching this number.",
Required:false,
Value:30,
EnvVars:p2pEnv(envPrefix,"PEERS_HI"),
},
&cli.DurationFlag{
Name:PeersGraceName,
Usage:"Grace period to keep a newly connected peer around, if it is not misbehaving.",
Required:false,
Value:30*time.Second,
EnvVars:p2pEnv(envPrefix,"PEERS_GRACE"),
},
&cli.BoolFlag{
Name:NATName,
Usage:"Enable NAT traversal with PMP/UPNP devices to learn external IP.",
Required:false,
EnvVars:p2pEnv(envPrefix,"NAT"),
},
&cli.StringFlag{
Name:UserAgentName,
Usage:"User-agent string to share via LibP2P identify. If empty it defaults to 'optimism'.",
Hidden:true,
Required:false,
Value:"optimism",
EnvVars:p2pEnv(envPrefix,"AGENT"),
},
&cli.DurationFlag{
Name:TimeoutNegotiationName,
Usage:"Negotiation timeout, time for new peer connections to share their their supported p2p protocols",
Hidden:true,
Required:false,
Value:10*time.Second,
EnvVars:p2pEnv(envPrefix,"TIMEOUT_NEGOTIATION"),
},
&cli.DurationFlag{
Name:TimeoutAcceptName,
Usage:"Accept timeout, time for connection to be accepted.",
Hidden:true,
Required:false,
Value:10*time.Second,
EnvVars:p2pEnv(envPrefix,"TIMEOUT_ACCEPT"),
},
&cli.DurationFlag{
Name:TimeoutDialName,
Usage:"Dial timeout for outgoing connection requests",
Hidden:true,
Required:false,
Value:10*time.Second,
EnvVars:p2pEnv(envPrefix,"TIMEOUT_DIAL"),
},
&cli.StringFlag{
Name:PeerstorePathName,
Usage:"Peerstore database location. Persisted peerstores help recover peers after restarts. "+
"Set to 'memory' to never persist the peerstore. Peerstore records will be pruned / expire as necessary. "+
"Warning: a copy of the priv network key of the local peer will be persisted here.",// TODO: bad design of libp2p, maybe we can avoid this from happening
Required:false,
TakesFile:true,
Value:"opnode_peerstore_db",
EnvVars:p2pEnv(envPrefix,"PEERSTORE_PATH"),
},
&cli.StringFlag{
Name:DiscoveryPathName,
Usage:"Discovered ENRs are persisted in a database to recover from a restart without having to bootstrap the discovery process again. Set to 'memory' to never persist the peerstore.",
Required:false,
TakesFile:true,
Value:"opnode_discovery_db",
EnvVars:p2pEnv(envPrefix,"DISCOVERY_PATH"),
},
&cli.StringFlag{
Name:SequencerP2PKeyName,
Usage:"Hex-encoded private key for signing off on p2p application messages as sequencer.",
Required:false,
Value:"",
EnvVars:p2pEnv(envPrefix,"SEQUENCER_KEY"),
},
&cli.UintFlag{
Name:GossipMeshDName,
Usage:"Configure GossipSub topic stable mesh target count, a.k.a. desired outbound degree, number of peers to gossip to",
