config

Documentation

Index

• type AdditionalConnectionsConfig
• type KadDhtPeerDiscoveryConfig
• type NodeConfig
• type P2PConfig
• type ShardingConfig
• type TCPProtocolConfig
• type TransportConfig

Types

type AdditionalConnectionsConfig

type AdditionalConnectionsConfig struct {
	MaxFullHistoryObservers uint32
}

AdditionalConnectionsConfig will hold the additional connections that will be open when certain conditions are met All these values should be added to the maximum target peer count value

type KadDhtPeerDiscoveryConfig

type KadDhtPeerDiscoveryConfig struct {
	Enabled                          bool
	Type                             string
	RefreshIntervalInSec             uint32
	ProtocolID                       string
	InitialPeerList                  []string
	BucketSize                       uint32
	RoutingTableRefreshIntervalInSec uint32
}

KadDhtPeerDiscoveryConfig will hold the kad-dht discovery config settings

type NodeConfig

type NodeConfig struct {
	Port                            string
	MaximumExpectedPeerCount        uint64
	ThresholdMinConnectedPeers      uint32
	MinNumPeersToWaitForOnBootstrap uint32
	Transports                      TransportConfig
}

NodeConfig will hold basic p2p settings

type P2PConfig

type P2PConfig struct {
	Node                NodeConfig
	KadDhtPeerDiscovery KadDhtPeerDiscoveryConfig
	Sharding            ShardingConfig
}

P2PConfig will hold all the P2P settings

type ShardingConfig

type ShardingConfig struct {
	TargetPeerCount         uint32
	MaxIntraShardValidators uint32
	MaxCrossShardValidators uint32
	MaxIntraShardObservers  uint32
	MaxCrossShardObservers  uint32
	MaxSeeders              uint32
	Type                    string
	AdditionalConnections   AdditionalConnectionsConfig
}

ShardingConfig will hold the network sharding config settings

type TCPProtocolConfig

type TCPProtocolConfig struct {
	ListenAddress    string
	PreventPortReuse bool
}

TCPProtocolConfig specify the TCP protocol config

type TransportConfig

type TransportConfig struct {
	TCP                 TCPProtocolConfig
	QUICAddress         string
	WebSocketAddress    string
	WebTransportAddress string
}

TransportConfig specify the supported protocols by the node