relay

Documentation

Index

• Constants
• Variables
• func NewBroadcaster(bufLen int) *broadcaster
• func SignMessage(privKey *ecdsa.PrivateKey, msg *pb.WakuMessage, pubsubTopic string) error
• type Broadcaster
• type EvtPeerTopic
• type EvtRelaySubscribed
• type EvtRelayUnsubscribed
• type Metrics
• type PeerTopicState
• type Subscription
  • func ArraySubscription(msgs []*protocol.Envelope) Subscription
  • func NoopSubscription() Subscription
• type WakuRelay
  • func NewWakuRelay(bcaster Broadcaster, minPeersToPublish int, timesource timesource.Timesource, ...) *WakuRelay
  • func (w *WakuRelay) AddSignedTopicValidator(topic string, publicKey *ecdsa.PublicKey) error
  • func (w *WakuRelay) EnoughPeersToPublish() bool
  • func (w *WakuRelay) EnoughPeersToPublishToTopic(topic string) bool
  • func (w *WakuRelay) Events() event.Bus
  • func (w *WakuRelay) IsSubscribed(topic string) bool
  • func (w *WakuRelay) Params() pubsub.GossipSubParams
  • func (w *WakuRelay) PubSub() *pubsub.PubSub
  • func (w *WakuRelay) Publish(ctx context.Context, message *pb.WakuMessage) ([]byte, error)
  • func (w *WakuRelay) PublishToTopic(ctx context.Context, message *pb.WakuMessage, topic string) ([]byte, error)
  • func (w *WakuRelay) RegisterDefaultValidator(fn validatorFn)
  • func (w *WakuRelay) RegisterTopicValidator(topic string, fn validatorFn)
  • func (w *WakuRelay) RemoveTopicValidator(topic string)
  • func (w *WakuRelay) SetHost(h host.Host)
  • func (w *WakuRelay) SetPubSub(pubSub *pubsub.PubSub)
  • func (w *WakuRelay) Start(ctx context.Context) error
  • func (w *WakuRelay) Stop()
  • func (w *WakuRelay) Subscribe(ctx context.Context) (*Subscription, error)
  • func (w *WakuRelay) SubscribeToTopic(ctx context.Context, topic string) (*Subscription, error)
  • func (w *WakuRelay) Topics() []string
  • func (w *WakuRelay) Unsubscribe(ctx context.Context, topic string) error

Constants

const (
	PEER_JOINED = iota
	PEER_LEFT
)

const WakuRelayID_v200 = protocol.ID("/vac/waku/relay/2.0.0")

WakuRelayID_v200 is the current protocol ID used for WakuRelay

Variables

var DefaultWakuTopic string = waku_proto.DefaultPubsubTopic().String()

DefaultWakuTopic is the default pubsub topic used across all Waku protocols

Functions

func NewBroadcaster

func NewBroadcaster(bufLen int) *broadcaster

NewBroadcaster creates a new instance of a broadcaster

func SignMessage

func SignMessage(privKey *ecdsa.PrivateKey, msg *pb.WakuMessage, pubsubTopic string) error

SignMessage adds an ECDSA signature to a WakuMessage as an opt-in mechanism for DoS prevention

Types

type Broadcaster

type Broadcaster interface {
	Start(ctx context.Context) error
	Stop()
	Register(topic string, chLen ...int) Subscription
	RegisterForAll(chLen ...int) Subscription
	Submit(*protocol.Envelope)
}

Broadcaster is used to create a fanout for an envelope that will be received by any subscriber interested in the topic of the message

type EvtPeerTopic

type EvtPeerTopic struct {
	PubsubTopic string
	PeerID      peer.ID
	State       PeerTopicState
}

type EvtRelaySubscribed

type EvtRelaySubscribed struct {
	Topic     string
	TopicInst *pubsub.Topic
}

EvtRelaySubscribed is an event emitted when a new subscription to a pubsub topic is created

type EvtRelayUnsubscribed

type EvtRelayUnsubscribed struct {
	Topic string
}

EvtRelayUnsubscribed is an event emitted when a subscription to a pubsub topic is closed

type Metrics

type Metrics interface {
	RecordMessage(envelope *waku_proto.Envelope)
}

Metrics exposes the functions required to update prometheus metrics for relay protocol

type PeerTopicState

type PeerTopicState int

type Subscription

type Subscription struct {
	Unsubscribe func()
	Ch          <-chan *protocol.Envelope
}

Subscription handles the details of a particular Topic subscription. There may be many subscriptions for a given topic.

func ArraySubscription

func ArraySubscription(msgs []*protocol.Envelope) Subscription

ArraySubscription creates a subscription for a list of envelopes

func NoopSubscription

func NoopSubscription() Subscription

NoopSubscription creates a noop subscription that will not receive any envelope

type WakuRelay

type WakuRelay struct {
	*waku_proto.CommonService
	// contains filtered or unexported fields
}

WakuRelay is the implementation of the Waku Relay protocol

func NewWakuRelay

func NewWakuRelay(bcaster Broadcaster, minPeersToPublish int, timesource timesource.Timesource, reg prometheus.Registerer, log *zap.Logger, opts ...pubsub.Option) *WakuRelay

NewWakuRelay returns a new instance of a WakuRelay struct

func (*WakuRelay) AddSignedTopicValidator

func (w *WakuRelay) AddSignedTopicValidator(topic string, publicKey *ecdsa.PublicKey) error

AddSignedTopicValidator registers a gossipsub validator for a topic which will check that messages Meta field contains a valid ECDSA signature for the specified pubsub topic. This is used as a DoS prevention mechanism

func (*WakuRelay) EnoughPeersToPublish

func (w *WakuRelay) EnoughPeersToPublish() bool

EnoughPeersToPublish returns whether there are enough peers connected in the default waku pubsub topic

func (*WakuRelay) EnoughPeersToPublishToTopic

func (w *WakuRelay) EnoughPeersToPublishToTopic(topic string) bool

EnoughPeersToPublish returns whether there are enough peers connected in a pubsub topic

func (*WakuRelay) Events

func (w *WakuRelay) Events() event.Bus

Events returns the event bus on which WakuRelay events will be emitted

func (*WakuRelay) IsSubscribed

func (w *WakuRelay) IsSubscribed(topic string) bool

IsSubscribed indicates whether the node is subscribed to a pubsub topic or not

func (*WakuRelay) Params

func (w *WakuRelay) Params() pubsub.GossipSubParams

Params returns the gossipsub configuration parameters used by WakuRelay

func (*WakuRelay) PubSub

func (w *WakuRelay) PubSub() *pubsub.PubSub

PubSub returns the implementation of the pubsub system

func (*WakuRelay) Publish

func (w *WakuRelay) Publish(ctx context.Context, message *pb.WakuMessage) ([]byte, error)

Publish is used to broadcast a WakuMessage to the default waku pubsub topic

func (*WakuRelay) PublishToTopic

func (w *WakuRelay) PublishToTopic(ctx context.Context, message *pb.WakuMessage, topic string) ([]byte, error)

PublishToTopic is used to broadcast a WakuMessage to a pubsub topic

func (*WakuRelay) RegisterDefaultValidator

func (w *WakuRelay) RegisterDefaultValidator(fn validatorFn)

func (*WakuRelay) RegisterTopicValidator

func (w *WakuRelay) RegisterTopicValidator(topic string, fn validatorFn)

func (*WakuRelay) RemoveTopicValidator

func (w *WakuRelay) RemoveTopicValidator(topic string)

func (*WakuRelay) SetHost

func (w *WakuRelay) SetHost(h host.Host)

SetHost sets the host to be able to mount or consume a protocol

func (*WakuRelay) SetPubSub

func (w *WakuRelay) SetPubSub(pubSub *pubsub.PubSub)

SetPubSub is used to set an implementation of the pubsub system

func (*WakuRelay) Start

func (w *WakuRelay) Start(ctx context.Context) error

Start initiates the WakuRelay protocol

func (*WakuRelay) Stop

func (w *WakuRelay) Stop()

Stop unmounts the relay protocol and stops all subscriptions

func (*WakuRelay) Subscribe

func (w *WakuRelay) Subscribe(ctx context.Context) (*Subscription, error)

Subscribe returns a Subscription to receive messages from the default waku pubsub topic

func (*WakuRelay) SubscribeToTopic

func (w *WakuRelay) SubscribeToTopic(ctx context.Context, topic string) (*Subscription, error)

SubscribeToTopic returns a Subscription to receive messages from a pubsub topic

func (*WakuRelay) Topics

func (w *WakuRelay) Topics() []string

Topics returns a list of all the pubsub topics currently subscribed to

func (*WakuRelay) Unsubscribe

func (w *WakuRelay) Unsubscribe(ctx context.Context, topic string) error

Unsubscribe closes a subscription to a pubsub topic