protocol

Documentation

Index

• func NewProtocolID(chainContext string, protocolID string, version version.Version) protocol.ID
• func NewRuntimeProtocolID(chainContext string, runtimeID common.Namespace, protocolID string, ...) protocol.ID
• func NewTopicIDForRuntime(chainContext string, runtimeID common.Namespace, kind api.TopicKind, ...) string
• func NewTopicKindCommitteeID(chainContext string, runtimeID common.Namespace) string
• func NewTopicKindTxID(chainContext string, runtimeID common.Namespace) string
• func ValidateProtocolID(p core.ProtocolID)
• func ValidateTopicID(topic string)

Functions

func NewProtocolID

func NewProtocolID(chainContext string, protocolID string, version version.Version) protocol.ID

NewProtocolID generates a protocol identifier for a consensus P2P protocol.

func NewRuntimeProtocolID

func NewRuntimeProtocolID(chainContext string, runtimeID common.Namespace, protocolID string, version version.Version) protocol.ID

NewRuntimeProtocolID generates a protocol identifier for a protocol supported for a specific runtime. This makes it so that one doesn't need additional checks to ensure that a peer supports the given protocol for the given runtime.

func NewTopicIDForRuntime

func NewTopicIDForRuntime(chainContext string, runtimeID common.Namespace, kind api.TopicKind, version version.Version) string

NewTopicIDForRuntime constructs topic id from the given parameters.

func NewTopicKindCommitteeID

func NewTopicKindCommitteeID(chainContext string, runtimeID common.Namespace) string

NewTopicKindCommitteeID constructs topic id from the given parameters.

func NewTopicKindTxID

func NewTopicKindTxID(chainContext string, runtimeID common.Namespace) string

NewTopicKindTxID constructs topic id from the given parameters.

func ValidateProtocolID

func ValidateProtocolID(p core.ProtocolID)

ValidateProtocolID panics if the protocol id is not unique.

func ValidateTopicID

func ValidateTopicID(topic string)

ValidateTopicID panics if the topic id is not unique.