Documentation
¶
Index ¶
- Constants
- Variables
- func BlockSigningHash(cfg *rollup.Config, payloadBytes []byte) common.Hash
- func BuildBlocksValidator(log log.Logger, cfg *rollup.Config) pubsub.ValidatorEx
- func BuildGlobalGossipParams(cfg *rollup.Config) pubsub.GossipSubParams
- func BuildMsgIdFn(cfg *rollup.Config) pubsub.MsgIdFunction
- func BuildSubscriptionFilter(cfg *rollup.Config) pubsub.SubscriptionFilter
- func DefaultConnGater(conf *Config) (connmgr.ConnectionGater, error)
- func DefaultConnManager(conf *Config) (connmgr.ConnManager, error)
- func FilterEnodes(log log.Logger, cfg *rollup.Config) func(node *enode.Node) bool
- func FindActiveTCPPort(h host.Host) (uint16, error)
- func LogTopicEvents(ctx context.Context, log log.Logger, evHandler *pubsub.TopicEventHandler)
- func NewGossipSub(p2pCtx context.Context, h host.Host, cfg *rollup.Config) (*pubsub.PubSub, error)
- func NewNetworkNotifier(log log.Logger) network.Notifiee
- func SigningHash(domain [32]byte, chainID *big.Int, payloadBytes []byte) common.Hash
- type API
- type APIBackend
- func (s *APIBackend) BlockAddr(_ context.Context, ip net.IP) error
- func (s *APIBackend) BlockPeer(_ context.Context, p peer.ID) error
- func (s *APIBackend) BlockSubnet(_ context.Context, ipnet *net.IPNet) error
- func (s *APIBackend) ConnectPeer(ctx context.Context, addr string) error
- func (s *APIBackend) DisconnectPeer(_ context.Context, id peer.ID) error
- func (s *APIBackend) DiscoveryTable(_ context.Context) ([]*enode.Node, error)
- func (s *APIBackend) ListBlockedAddrs(_ context.Context) ([]net.IP, error)
- func (s *APIBackend) ListBlockedPeers(_ context.Context) ([]peer.ID, error)
- func (s *APIBackend) ListBlockedSubnets(_ context.Context) ([]*net.IPNet, error)
- func (s *APIBackend) PeerStats(_ context.Context) (*PeerStats, error)
- func (s *APIBackend) Peers(ctx context.Context, connected bool) (*PeerDump, error)
- func (s *APIBackend) ProtectPeer(_ context.Context, p peer.ID) error
- func (s *APIBackend) Self(ctx context.Context) (*PeerInfo, error)
- func (s *APIBackend) UnblockAddr(_ context.Context, ip net.IP) error
- func (s *APIBackend) UnblockPeer(_ context.Context, p peer.ID) error
- func (s *APIBackend) UnblockSubnet(_ context.Context, ipnet *net.IPNet) error
- func (s *APIBackend) UnprotectPeer(_ context.Context, p peer.ID) error
- type Client
- func (c *Client) BlockAddr(ctx context.Context, ip net.IP) error
- func (c *Client) BlockPeer(ctx context.Context, p peer.ID) error
- func (c *Client) BlockSubnet(ctx context.Context, ipnet *net.IPNet) error
- func (c *Client) ConnectPeer(ctx context.Context, addr string) error
- func (c *Client) DisconnectPeer(ctx context.Context, id peer.ID) error
- func (c *Client) DiscoveryTable(ctx context.Context) ([]*enode.Node, error)
- func (c *Client) ListBlockedAddrs(ctx context.Context) ([]net.IP, error)
- func (c *Client) ListBlockedPeers(ctx context.Context) ([]peer.ID, error)
- func (c *Client) ListBlockedSubnets(ctx context.Context) ([]*net.IPNet, error)
- func (c *Client) PeerStats(ctx context.Context) (*PeerStats, error)
- func (c *Client) Peers(ctx context.Context, connected bool) (*PeerDump, error)
- func (c *Client) ProtectPeer(ctx context.Context, p peer.ID) error
- func (c *Client) Self(ctx context.Context) (*PeerInfo, error)
- func (c *Client) UnblockAddr(ctx context.Context, ip net.IP) error
- func (c *Client) UnblockPeer(ctx context.Context, p peer.ID) error
- func (c *Client) UnblockSubnet(ctx context.Context, ipnet *net.IPNet) error
- func (c *Client) UnprotectPeer(ctx context.Context, p peer.ID) error
- type Config
- type ConnectionGater
- type ExtraHostFeatures
- type GossipIn
- type GossipOut
- type GossipTopicInfo
- type LocalSigner
- type MessageHandler
- type Node
- type NodeP2P
- func (n *NodeP2P) Close() error
- func (n *NodeP2P) ConnectionGater() ConnectionGater
- func (n *NodeP2P) ConnectionManager() connmgr.ConnManager
- func (n *NodeP2P) DiscoveryProcess(ctx context.Context, log log.Logger, cfg *rollup.Config, connectGoal uint)
- func (n *NodeP2P) Dv5Local() *enode.LocalNode
- func (n *NodeP2P) Dv5Udp() *discover.UDPv5
- func (n *NodeP2P) GossipOut() GossipOut
- func (n *NodeP2P) GossipSub() *pubsub.PubSub
- func (n *NodeP2P) Host() host.Host
- type OptimismENRData
- type PeerDump
- type PeerInfo
- type PeerStats
- type Prepared
- type PreparedSigner
- type Secp256k1
- type SetupP2P
- type Signer
- type SignerSetup
- type TopicSubscriber
Constants ¶
const MaxGossipSize = 1 << 20
Variables ¶
var ( DisabledDiscovery = errors.New("discovery disabled") NoConnectionManager = errors.New("no connection manager") NoConnectionGater = errors.New("no connection gater") )
var MessageDomainInvalidSnappy = [4]byte{0, 0, 0, 0}
var MessageDomainValidSnappy = [4]byte{1, 0, 0, 0}
var NamespaceRPC = "opp2p"
var SigningDomainBlocksV1 = [32]byte{}
Functions ¶
func BuildBlocksValidator ¶
func BuildGlobalGossipParams ¶
func BuildGlobalGossipParams(cfg *rollup.Config) pubsub.GossipSubParams
func BuildMsgIdFn ¶
func BuildMsgIdFn(cfg *rollup.Config) pubsub.MsgIdFunction
BuildMsgIdFn builds a generic message ID function for gossipsub that can handle compressed payloads, mirroring the eth2 p2p gossip spec.
func BuildSubscriptionFilter ¶
func BuildSubscriptionFilter(cfg *rollup.Config) pubsub.SubscriptionFilter
BuildSubscriptionFilter builds a simple subscription filter, to help protect against peers spamming useless subscriptions.
func DefaultConnGater ¶
func DefaultConnGater(conf *Config) (connmgr.ConnectionGater, error)
func DefaultConnManager ¶
func DefaultConnManager(conf *Config) (connmgr.ConnManager, error)
func FilterEnodes ¶
func LogTopicEvents ¶
func NewGossipSub ¶
Types ¶
type API ¶
type API interface {
Self(ctx context.Context) (*PeerInfo, error)
Peers(ctx context.Context, connected bool) (*PeerDump, error)
PeerStats(ctx context.Context) (*PeerStats, error)
DiscoveryTable(ctx context.Context) ([]*enode.Node, error)
BlockPeer(ctx context.Context, p peer.ID) error
UnblockPeer(ctx context.Context, p peer.ID) error
ListBlockedPeers(ctx context.Context) ([]peer.ID, error)
BlockAddr(ctx context.Context, ip net.IP) error
UnblockAddr(ctx context.Context, ip net.IP) error
ListBlockedAddrs(ctx context.Context) ([]net.IP, error)
BlockSubnet(ctx context.Context, ipnet *net.IPNet) error
UnblockSubnet(ctx context.Context, ipnet *net.IPNet) error
ListBlockedSubnets(ctx context.Context) ([]*net.IPNet, error)
ProtectPeer(ctx context.Context, p peer.ID) error
UnprotectPeer(ctx context.Context, p peer.ID) error
ConnectPeer(ctx context.Context, addr string) error
DisconnectPeer(ctx context.Context, id peer.ID) error
}
type APIBackend ¶
type APIBackend struct {
// contains filtered or unexported fields
}
func NewP2PAPIBackend ¶
func (*APIBackend) BlockAddr ¶
BlockAddr adds an IP address to the set of blocked addresses. Note: active connections to the IP address are not automatically closed.
func (*APIBackend) BlockSubnet ¶
BlockSubnet adds an IP subnet to the set of blocked addresses. Note: active connections to the IP subnet are not automatically closed.
func (*APIBackend) ConnectPeer ¶
func (s *APIBackend) ConnectPeer(ctx context.Context, addr string) error
ConnectPeer connects to a given peer address, and wait for protocol negotiation & identification of the peer
func (*APIBackend) DisconnectPeer ¶
func (*APIBackend) DiscoveryTable ¶
func (*APIBackend) ListBlockedAddrs ¶
func (*APIBackend) ListBlockedPeers ¶
func (*APIBackend) ListBlockedSubnets ¶
func (*APIBackend) PeerStats ¶
func (s *APIBackend) PeerStats(_ context.Context) (*PeerStats, error)
func (*APIBackend) Peers ¶
Peers lists information of peers. Optionally filter to only retrieve connected peers.
func (*APIBackend) ProtectPeer ¶
func (*APIBackend) UnblockAddr ¶
func (*APIBackend) UnblockPeer ¶
func (*APIBackend) UnblockSubnet ¶
func (*APIBackend) UnprotectPeer ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) BlockSubnet ¶
func (*Client) DisconnectPeer ¶
func (*Client) DiscoveryTable ¶
func (*Client) ListBlockedAddrs ¶
func (*Client) ListBlockedPeers ¶
func (*Client) ListBlockedSubnets ¶
func (*Client) UnblockSubnet ¶
type Config ¶
type Config struct {
Priv *crypto.Secp256k1PrivateKey
DisableP2P bool
NoDiscovery bool
ListenIP net.IP
ListenTCPPort uint16
// Port to bind discv5 to
ListenUDPPort uint16
AdvertiseIP net.IP
AdvertiseTCPPort uint16
AdvertiseUDPPort uint16
Bootnodes []*enode.Node
DiscoveryDB *enode.DB
StaticPeers []core.Multiaddr
HostMux []lconf.MsMuxC
HostSecurity []lconf.MsSecC
NoTransportSecurity bool
PeersLo uint
PeersHi uint
PeersGrace time.Duration
// If true a NAT manager will host a NAT port mapping that is updated with PMP and UPNP by libp2p/go-nat
NAT bool
UserAgent string
TimeoutNegotiation time.Duration
TimeoutAccept time.Duration
TimeoutDial time.Duration
// Underlying store that hosts connection-gater and peerstore data.
Store ds.Batching
ConnGater func(conf *Config) (connmgr.ConnectionGater, error)
ConnMngr func(conf *Config) (connmgr.ConnManager, error)
// nil to disable bandwidth metrics
BandwidthMetrics metrics.Reporter
}
Config sets up a p2p host and discv5 service from configuration. This implements SetupP2P.
func (*Config) TargetPeers ¶
type ConnectionGater ¶
type ConnectionGater interface {
connmgr.ConnectionGater
// BlockPeer adds a peer to the set of blocked peers.
// Note: active connections to the peer are not automatically closed.
BlockPeer(p peer.ID) error
UnblockPeer(p peer.ID) error
ListBlockedPeers() []peer.ID
// BlockAddr adds an IP address to the set of blocked addresses.
// Note: active connections to the IP address are not automatically closed.
BlockAddr(ip net.IP) error
UnblockAddr(ip net.IP) error
ListBlockedAddrs() []net.IP
// BlockSubnet adds an IP subnet to the set of blocked addresses.
// Note: active connections to the IP subnet are not automatically closed.
BlockSubnet(ipnet *net.IPNet) error
UnblockSubnet(ipnet *net.IPNet) error
ListBlockedSubnets() []*net.IPNet
}
type ExtraHostFeatures ¶
type ExtraHostFeatures interface {
host.Host
ConnectionGater() ConnectionGater
ConnectionManager() connmgr.ConnManager
}
type GossipOut ¶
type GossipOut interface {
GossipTopicInfo
PublishL2Payload(ctx context.Context, msg *eth.ExecutionPayload, signer Signer) error
Close() error
}
type GossipTopicInfo ¶
type LocalSigner ¶
type LocalSigner struct {
// contains filtered or unexported fields
}
LocalSigner is suitable for testing
func NewLocalSigner ¶
func NewLocalSigner(priv *ecdsa.PrivateKey) *LocalSigner
func (*LocalSigner) Close ¶
func (s *LocalSigner) Close() error
type MessageHandler ¶
func BlocksHandler ¶
func BlocksHandler(onBlock func(ctx context.Context, from peer.ID, msg *eth.ExecutionPayload) error) MessageHandler
type Node ¶
type Node interface {
// Host returns the libp2p host
Host() host.Host
// Dv5Local returns the control over the Discv5 data of the local node, nil if disabled
Dv5Local() *enode.LocalNode
// Dv5Udp returns the control over the Discv5 network, nil if disabled
Dv5Udp() *discover.UDPv5
// GossipSub returns the gossip router
GossipSub() *pubsub.PubSub
// GossipOut returns the gossip output/info control
GossipOut() GossipOut
// ConnectionGater returns the connection gater, to ban/unban peers with, may be nil
ConnectionGater() ConnectionGater
// ConnectionManager returns the connection manager, to protect peers with, may be nil
ConnectionManager() connmgr.ConnManager
}
type NodeP2P ¶
type NodeP2P struct {
// contains filtered or unexported fields
}
func NewNodeP2P ¶
func (*NodeP2P) ConnectionGater ¶
func (n *NodeP2P) ConnectionGater() ConnectionGater
func (*NodeP2P) ConnectionManager ¶
func (n *NodeP2P) ConnectionManager() connmgr.ConnManager
func (*NodeP2P) DiscoveryProcess ¶
func (n *NodeP2P) DiscoveryProcess(ctx context.Context, log log.Logger, cfg *rollup.Config, connectGoal uint)
DiscoveryProcess runs a discovery process that randomly walks the DHT to fill the peerstore, and connects to nodes in the peerstore that we are not already connected to. Nodes from the peerstore will be shuffled, unsuccessful connection attempts will cause peers to be avoided, and only nodes with addresses (under TTL) will be connected to.
type OptimismENRData ¶
type OptimismENRData struct {
// contains filtered or unexported fields
}
The discovery ENRs are just key-value lists, and we filter them by records tagged with the "optimism" key, and then check the chain ID and version.
func (*OptimismENRData) ENRKey ¶
func (o *OptimismENRData) ENRKey() string
type PeerInfo ¶
type PeerInfo struct {
PeerID peer.ID `json:"peerID"`
NodeID enode.ID `json:"nodeID"`
UserAgent string `json:"userAgent"`
ProtocolVersion string `json:"protocolVersion"`
ENR string `json:"ENR"` // might not always be known, e.g. if the peer connected us instead of us discovering them
Addresses []string `json:"addresses"` // multi-addresses. may be mix of LAN / docker / external IPs. All of them are communicated.
Protocols []string `json:"protocols"` // negotiated protocols list
//GossipScore float64
//PeerScore float64
Connectedness network.Connectedness `json:"connectedness"` // "NotConnected", "Connected", "CanConnect" (gracefully disconnected), or "CannotConnect" (tried but failed)
Direction network.Direction `json:"direction"` // "Unknown", "Inbound" (if the peer contacted us), "Outbound" (if we connected to them)
Protected bool `json:"protected"` // Protected peers do not get
ChainID uint64 `json:"chainID"` // some peers might try to connect, but we figure out they are on a different chain later. This may be 0 if the peer is not an optimism node at all.
Latency time.Duration `json:"latency"`
GossipBlocks bool `json:"gossipBlocks"` // if the peer is in our gossip topic
}
type Prepared ¶
Prepared provides a p2p host and discv5 service that is already set up. This implements SetupP2P.
func (*Prepared) Discovery ¶
func (p *Prepared) Discovery(log log.Logger, rollupCfg *rollup.Config, tcpPort uint16) (*enode.LocalNode, *discover.UDPv5, error)
Discovery creates a disc-v5 service. Returns nil, nil, nil if discovery is disabled.
func (*Prepared) TargetPeers ¶
type PreparedSigner ¶
type PreparedSigner struct {
Signer
}
func (*PreparedSigner) SetupSigner ¶
func (p *PreparedSigner) SetupSigner(ctx context.Context) (Signer, error)
type Secp256k1 ¶
type Secp256k1 crypto.Secp256k1PublicKey
Secp256k1 is like the geth Secp256k1 enr entry type, but using the libp2p pubkey representation instead
type SetupP2P ¶
type SetupP2P interface {
Check() error
// Host creates a libp2p host service. Returns nil, nil if p2p is disabled.
Host(log log.Logger) (host.Host, error)
// Discovery creates a disc-v5 service. Returns nil, nil, nil if discovery is disabled.
Discovery(log log.Logger, rollupCfg *rollup.Config, tcpPort uint16) (*enode.LocalNode, *discover.UDPv5, error)
TargetPeers() uint
}
SetupP2P provides a host and discovery service for usage in the rollup node.
type SignerSetup ¶
func LoadSignerSetup ¶
func LoadSignerSetup(ctx *cli.Context) (SignerSetup, error)
LoadSignerSetup loads a configuration for a Signer to be set up later
type TopicSubscriber ¶
type TopicSubscriber func(ctx context.Context, sub *pubsub.Subscription)
func MakeSubscriber ¶
func MakeSubscriber(log log.Logger, msgHandler MessageHandler) TopicSubscriber