protocol

Nov 14, 2023

Changes in this version

+ var ErrExpected130Bytes = errors.New("invalid data: expected 130 bytes")

+ var ErrInvalidShard = errors.New("invalid shard")

+ var ErrInvalidShardCount = errors.New("invalid shard count")

+ var ErrNotShardPubsubTopic = errors.New("not a shard pubsub topic")

+ var ErrNotWakuPubsubTopic = errors.New("not a waku pubsub topic")

+ var ErrTooManyShards = errors.New("too many shards")

+ func ContentFilterToPubSubTopicMap(contentFilter ContentFilter) (map[PubsubTopicStr][]ContentTopicStr, error)

+ func GeneratePubsubToContentTopicMap(pubsubTopic string, contentTopics []string) (map[string][]string, error)

type ContentFilter

+ func (cf ContentFilter) Equals(cf1 ContentFilter) bool

type ContentTopicSet

+ func (cf ContentTopicSet) ToList() []string

+ type ContentTopicStr = string

type DefaultPubsubTopic

+ func (DefaultPubsubTopic) String() string

+ type PubsubTopicStr = string

type RelayShards

+ ClusterID uint16

+ ShardIDs []uint16

+ func FromShardList(buf []byte) (RelayShards, error)

+ func (rs RelayShards) ContainsShardPubsubTopic(topic WakuPubSubTopic) bool

+ func (rs RelayShards) ShardList() ([]byte, error)

type StaticShardingPubsubTopic

+ func ToShardPubsubTopic(topic WakuPubSubTopic) (StaticShardingPubsubTopic, error)

+ type WakuPubSubTopic interface

+ String func() string

+ func ToWakuPubsubTopic(topic string) (WakuPubSubTopic, error)

Oct 7, 2023

Changes in this version

+ const GossipSubOptimalFullMeshSize

+ func GetPubSubTopicFromContentTopic(cTopicString string) (string, error)

+ type ContentFilter struct

+ ContentTopics ContentTopicSet

+ PubsubTopic string

+ func NewContentFilter(pubsubTopic string, contentTopics ...string) ContentFilter

+ func (cf ContentFilter) ContentTopicsList() []string

+ type ContentTopicSet map[string]struct

+ func NewContentTopicSet(contentTopics ...string) ContentTopicSet

Sep 17, 2023

Changes in this version

+ const ClusterIndex

+ const DefaultContentTopic

+ const GenerationZeroShardsCount

+ var ErrAlreadyStarted = errors.New("already started")

+ var ErrInvalidGeneration = errors.New("generation should be a number")

+ var ErrMissingGeneration = errors.New("missing part: generation")

+ var ErrNotStarted = errors.New("not started")

+ func GenerateRequestID() []byte

+ type CommonService struct

+ func NewCommonService() *CommonService

+ func (sp *CommonService) Context() context.Context

+ func (sp *CommonService) ErrOnNotRunning() error

+ func (sp *CommonService) Start(ctx context.Context, fn func() error) error

+ func (sp *CommonService) Stop(fn func())

+ func (sp *CommonService) WaitGroup() *sync.WaitGroup

+ type ContentTopicOption func(*ContentTopicParams)

+ func DefaultOptions() []ContentTopicOption

+ func WithGeneration(generation int) ContentTopicOption

+ type ContentTopicParams struct

+ Generation int

+ func (ctp ContentTopicParams) Equal(ctp2 ContentTopicParams) bool

type StaticShardingPubsubTopic

+ func GetShardFromContentTopic(topic ContentTopic, shardCount int) StaticShardingPubsubTopic

Jun 26, 2023

Changes in this version

type RelayShards

+ func TopicsToRelayShards(topic ...string) ([]RelayShards, error)

May 12, 2023

Changes in this version

+ const MaxShardIndex

+ type NamespacedPubsubTopic interface

+ Equal func(NamespacedPubsubTopic) bool

+ Kind func() NamespacedPubsubTopicKind

+ String func() string

+ type RelayShards struct

+ Cluster uint16

+ Indices []uint16

+ func FromBitVector(buf []byte) (RelayShards, error)

+ func FromIndicesList(buf []byte) (RelayShards, error)

+ func NewRelayShards(cluster uint16, indices ...uint16) (RelayShards, error)

+ func (rs RelayShards) BitVector() []byte

+ func (rs RelayShards) Contains(cluster uint16, index uint16) bool

+ func (rs RelayShards) ContainsNamespacedTopic(topic NamespacedPubsubTopic) bool

+ func (rs RelayShards) ContainsTopic(topic string) bool

+ func (rs RelayShards) IndicesList() ([]byte, error)

+ func (rs RelayShards) Topics() []NamespacedPubsubTopic

Mar 14, 2023

Changes in this version

+ const StaticShardingPubsubTopicPrefix

+ const Waku2PubsubTopicPrefix

+ var ErrInvalidNumberFormat = errors.New("only 2^16 numbers are allowed")

+ var ErrInvalidShardedTopicPrefix = errors.New("must start with " + StaticShardingPubsubTopicPrefix)

+ var ErrInvalidStructure = errors.New("invalid topic structure")

+ var ErrInvalidTopicPrefix = errors.New("must start with " + Waku2PubsubTopicPrefix)

+ var ErrMissingClusterIndex = errors.New("missing shard_cluster_index")

+ var ErrMissingShardNumber = errors.New("missing shard_number")

+ var ErrMissingTopicName = errors.New("missing topic-name")

+ type NamedShardingPubsubTopic struct

+ func (n NamedShardingPubsubTopic) Kind() NamespacedPubsubTopicKind

+ func (n NamedShardingPubsubTopic) Name() string

+ func (n NamedShardingPubsubTopic) String() string

+ func (s *NamedShardingPubsubTopic) Parse(topic string) error

+ func (s NamedShardingPubsubTopic) Equal(t2 ShardedPubsubTopic) bool

+ type NamespacedPubsubTopicKind int

+ const NamedSharding

+ const StaticSharding

+ type ShardedPubsubTopic interface

+ Equal func(ShardedPubsubTopic) bool

+ Kind func() NamespacedPubsubTopicKind

+ String func() string

+ func NewNamedShardingPubsubTopic(name string) ShardedPubsubTopic

+ func NewStaticShardingPubsubTopic(cluster uint16, shard uint16) ShardedPubsubTopic

+ func ToShardedPubsubTopic(topic string) (ShardedPubsubTopic, error)

+ type StaticShardingPubsubTopic struct

+ func (n StaticShardingPubsubTopic) Cluster() uint16

+ func (n StaticShardingPubsubTopic) Kind() NamespacedPubsubTopicKind

+ func (n StaticShardingPubsubTopic) Shard() uint16

+ func (n StaticShardingPubsubTopic) String() string

+ func (s *StaticShardingPubsubTopic) Parse(topic string) error

+ func (s StaticShardingPubsubTopic) Equal(t2 ShardedPubsubTopic) bool

Dec 21, 2022

Changes in this version

+ var ErrInvalidFormat = errors.New("invalid format")

+ func FulltextMatch(expectedProtocol string) func(string) bool

+ func GenerateRequestId() []byte

+ func PrefixTextMatch(prefix string) func(string) bool

+ type ContentTopic struct

+ ApplicationName string

+ ApplicationVersion uint

+ ContentTopicName string

+ Encoding string

+ func NewContentTopic(applicationName string, applicationVersion uint, contentTopicName string, ...) ContentTopic

+ func StringToContentTopic(s string) (ContentTopic, error)

+ func (ct ContentTopic) Equal(ct2 ContentTopic) bool

+ func (ct ContentTopic) String() string

+ type Envelope struct

+ func NewEnvelope(msg *pb.WakuMessage, receiverTime int64, pubSubTopic string) *Envelope

+ func (e *Envelope) Hash() []byte

+ func (e *Envelope) Message() *pb.WakuMessage

+ func (e *Envelope) PubsubTopic() string

+ func (e *Envelope) Size() int

+ func (env *Envelope) Index() *pb.Index

+ type PubsubTopic struct

+ Encoding string

+ Name string

+ func DefaultPubsubTopic() PubsubTopic

+ func NewPubsubTopic(name string, encoding string) PubsubTopic

+ func StringToPubsubTopic(s string) (PubsubTopic, error)

+ func (t PubsubTopic) Equal(t2 PubsubTopic) bool

+ func (t PubsubTopic) String() string