Documentation
¶
Index ¶
Constants ¶
View Source
const ( // ChainAliasPrefix denotes a prefix for an alias that belongs to a blockchain ID. ChainAliasPrefix string = "bc" // VMAliasPrefix denotes a prefix for an alias that belongs to a VM ID. VMAliasPrefix string = "vm" )
View Source
const ( // PlatformName exports the name of the platform PlatformName = "metal" // AppName exports the name of the avalanche application AppName = "metalgo" )
Const variables to be exported
View Source
const ( MainnetID uint32 = 1 TahoeID uint32 = 5 UnitTestID uint32 = 10 LocalID uint32 = 12345 MainnetName = "mainnet" TahoeName = "tahoe" UnitTestName = "testing" LocalName = "local" MainnetHRP = "metal" TahoeHRP = "tahoe" UnitTestHRP = "testing" LocalHRP = "local" FallbackHRP = "custom" )
Const variables to be exported
View Source
const ( // Request ID used when sending a Put message to gossip an accepted container // (ie not sent in response to a Get) GossipMsgRequestID uint32 = math.MaxUint32 // The network must be "tcp", "tcp4", "tcp6", "unix" or "unixpacket". NetworkType = "tcp" DefaultMaxMessageSize = 2 * units.MiB DefaultPingPongTimeout = 30 * time.Second DefaultPingFrequency = 3 * DefaultPingPongTimeout / 4 DefaultByteSliceCap = 128 MaxContainersLen = int(4 * DefaultMaxMessageSize / 5) DefaultNetworkPeerListNumValidatorIPs = 15 DefaultNetworkPeerListValidatorGossipSize = 20 DefaultNetworkPeerListNonValidatorGossipSize = 0 DefaultNetworkPeerListPeersGossipSize = 10 DefaultNetworkPeerListGossipFreq = time.Minute // Inbound Connection Throttling DefaultInboundConnUpgradeThrottlerCooldown = 10 * time.Second DefaultInboundThrottlerMaxConnsPerSec = 256 // Outbound Connection Throttling DefaultOutboundConnectionThrottlingRps = 50 DefaultOutboundConnectionTimeout = 30 * time.Second // Timeouts DefaultNetworkInitialTimeout = 5 * time.Second DefaultNetworkMinimumTimeout = 2 * time.Second DefaultNetworkMaximumTimeout = 10 * time.Second DefaultNetworkMaximumInboundTimeout = 10 * time.Second DefaultNetworkTimeoutHalflife = 5 * time.Minute DefaultNetworkTimeoutCoefficient = 2 DefaultNetworkReadHandshakeTimeout = 15 * time.Second DefaultNetworkCompressionType = compression.TypeZstd DefaultNetworkMaxClockDifference = time.Minute DefaultNetworkRequireValidatorToConnect = false DefaultNetworkPeerReadBufferSize = 8 * units.KiB DefaultNetworkPeerWriteBufferSize = 8 * units.KiB DefaultNetworkTCPProxyEnabled = false // The PROXY protocol specification recommends setting this value to be at // least 3 seconds to cover a TCP retransmit. // Ref: https://www.haproxy.org/download/2.3/doc/proxy-protocol.txt // Specifying a timeout of 0 will actually result in a timeout of 200ms, but // a timeout of 0 should generally not be provided. DefaultNetworkTCPProxyReadTimeout = 3 * time.Second // Benchlist DefaultBenchlistFailThreshold = 10 DefaultBenchlistDuration = 15 * time.Minute DefaultBenchlistMinFailingDuration = 2*time.Minute + 30*time.Second // Router DefaultConsensusAppConcurrency = 2 DefaultConsensusShutdownTimeout = time.Minute DefaultFrontierPollFrequency = 100 * time.Millisecond DefaultConsensusGossipAcceptedFrontierValidatorSize = 0 DefaultConsensusGossipAcceptedFrontierNonValidatorSize = 0 DefaultConsensusGossipAcceptedFrontierPeerSize = 1 DefaultConsensusGossipOnAcceptValidatorSize = 0 DefaultConsensusGossipOnAcceptNonValidatorSize = 0 DefaultConsensusGossipOnAcceptPeerSize = 10 DefaultAppGossipValidatorSize = 10 DefaultAppGossipNonValidatorSize = 0 DefaultAppGossipPeerSize = 0 // Inbound Throttling DefaultInboundThrottlerAtLargeAllocSize = 6 * units.MiB DefaultInboundThrottlerVdrAllocSize = 32 * units.MiB DefaultInboundThrottlerNodeMaxAtLargeBytes = DefaultMaxMessageSize DefaultInboundThrottlerMaxProcessingMsgsPerNode = 1024 DefaultInboundThrottlerBandwidthRefillRate = 512 * units.KiB DefaultInboundThrottlerBandwidthMaxBurstSize = DefaultMaxMessageSize DefaultInboundThrottlerCPUMaxRecheckDelay = 5 * time.Second DefaultInboundThrottlerDiskMaxRecheckDelay = 5 * time.Second MinInboundThrottlerMaxRecheckDelay = time.Millisecond // Outbound Throttling DefaultOutboundThrottlerAtLargeAllocSize = 32 * units.MiB DefaultOutboundThrottlerVdrAllocSize = 32 * units.MiB DefaultOutboundThrottlerNodeMaxAtLargeBytes = DefaultMaxMessageSize // Network Health DefaultHealthCheckAveragerHalflife = 10 * time.Second DefaultNetworkHealthMaxTimeSinceMsgSent = time.Minute DefaultNetworkHealthMaxTimeSinceMsgReceived = time.Minute DefaultNetworkHealthMaxPortionSendQueueFill = 0.9 DefaultNetworkHealthMinPeers = 1 DefaultNetworkHealthMaxSendFailRate = .9 // Metrics DefaultUptimeMetricFreq = 30 * time.Second // Delays DefaultNetworkInitialReconnectDelay = time.Second DefaultNetworkMaxReconnectDelay = time.Minute )
Const variables to be exported
View Source
const PointerOverhead = 8
PointerOverhead is used to approximate the memory footprint from allocating a pointer.
Variables ¶
View Source
var ( PrimaryNetworkID = ids.Empty PlatformChainID = ids.Empty NetworkIDToNetworkName = map[uint32]string{ MainnetID: MainnetName, TahoeID: TahoeName, UnitTestID: UnitTestName, LocalID: LocalName, } NetworkNameToNetworkID = map[string]uint32{ MainnetName: MainnetID, TahoeName: TahoeID, UnitTestName: UnitTestID, LocalName: LocalID, } NetworkIDToHRP = map[uint32]string{ MainnetID: MainnetHRP, TahoeID: TahoeHRP, UnitTestID: UnitTestHRP, LocalID: LocalHRP, } NetworkHRPToNetworkID = map[string]uint32{ MainnetHRP: MainnetID, TahoeHRP: TahoeID, UnitTestHRP: UnitTestID, LocalHRP: LocalID, } ProductionNetworkIDs = set.Of(MainnetID, TahoeID) ValidNetworkPrefix = "network-" ErrParseNetworkName = errors.New("failed to parse network name") )
Variables to be exported
Functions ¶
func NetworkName ¶
NetworkName returns a human readable name for the network with ID [networkID]
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.