package
0.38.0-preview.0
Repository: https://github.com/onflow/flow-go.git
Documentation: pkg.go.dev

# Functions

ChannelExists returns true if the channel exists.
No description provided by the author
Channels returns all channels that nodes of any role have subscribed to (except cluster-based channels).
ChannelsByRole returns a list of all channels the role subscribes to (except cluster-based channels and public channels).
ClusterChannelPrefix returns the cluster channel prefix and true if clusterChannel exists inclusterChannelPrefixRoleMap.
ClusterChannelRoles returns the list of roles that are involved in the given cluster-based channel.
ConsensusCluster returns a dynamic cluster consensus channel based on the chain ID of the cluster in question.
IsClusterChannel returns true if channel is cluster-based.
IsInvalidTopicErr returns true if an error is InvalidTopicErr.
IsPublicChannel returns true if channel is in the public channels list.
IsUnknownClusterIDErr returns true if an error is UnknownClusterIDErr.
IsValidFlowChannel ensures the channel is a valid Flow network channel.
IsValidFlowClusterTopic ensures the topic is a valid Flow network topic and ensures the cluster ID part of the Topic is equal to one of the provided active cluster IDs.
IsValidNonClusterFlowTopic ensures the topic is a valid Flow network topic and ensures the sporkID part of the Topic is equal to the current network sporkID.
NewInvalidTopicErr returns a new ErrMalformedTopic.
NewUnknownClusterIdErr returns a new UnknownClusterIDErr.
PublicChannels returns all channels that are used on the public network.
RolesByChannel returns list of flow roles involved in the channel.
SyncCluster returns a dynamic cluster sync channel based on the chain ID of the cluster in question.
TopicFromChannel returns the unique LibP2P topic form the channel.
TopicsFromChannels returns the unique LibP2P topics form the channels.
UniqueChannels returns list of non-cluster channels with a unique RoleList accompanied with the list of all cluster channels.

# Constants

dynamic channel, use ConsensusCluster function.
Channels for consensus protocols.
Channels for dkg communication.
Execution data service.
channels.
channels.
channels.
channels.
channels.
Public network channels.
channels.
channels.
channels.
channels.
channels.
channels.
Channels for actively pushing entities to subscribers.
channels.
channels.
channels.
channels.
Channel aliases to make the code more readable / more robust to errors.
channels.
channels.
Channels for actively requesting missing entities.
channels.
dynamic channel, use SyncCluster function.
Channels for protocols actively synchronizing state across nodes.
channels.
Channels used for testing.

# Structs

InvalidTopicErr error wrapper that indicates an error when checking if a Topic is a valid Flow Topic.
UnknownClusterIDErr error wrapper that indicates an invalid topic with an unknown cluster ID prefix.

# Type aliases

Channel specifies a virtual and isolated communication medium.
No description provided by the author
Topic is the internal type of Libp2p which corresponds to the Channel in the network level.