config

Documentation

Index

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

Types

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
	ResourceLimiter                 ResourceLimiterConfig
}

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 ResourceLimiterConfig

type ResourceLimiterConfig struct {
	Type                   string
	ManualSystemMemoryInMB int64
	ManualMaximumFD        int
}

ResourceLimiterConfig specifies the resource limiter configuration

type ShardingConfig

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

ShardingConfig will hold the network sharding config settings

type TCPProtocolConfig

type TCPProtocolConfig struct {
	ListenAddress    string
	PreventPortReuse bool
}

TCPProtocolConfig specifies the TCP protocol config

type TransportConfig

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

TransportConfig specifies the supported protocols by the node