Class WakuRelay

Implements the Waku v2 Relay protocol. Must be passed as a pubsub module to a Libp2p instance.

Implements

Hierarchy

GossipSub
- WakuRelay

Constructors

constructor

new WakuRelay(options?: Partial<waku_relay.CreateOptions>): WakuRelay
Parameters
- Optional options: Partial<waku_relay.CreateOptions>
Returns WakuRelay
Overrides GossipSub.constructor
- Defined in src/lib/waku_relay/index.ts:62

Properties

`Private` #private

#private: any

`Readonly` control

control: Map<string, IControlMessage>

Map of control messages peer id => control message

decryptionKeys

decryptionKeys: Map<Uint8Array, { contentTopics?: string[]; method?: DecryptionMethod }>

`Readonly` direct

direct: Set<string>

Direct peers

`Readonly` fanout

fanout: Map<string, Set<string>>

Map of topics to set of peers. These mesh peers are the ones to which we are publishing without a topic membership topic => peer id set

`Readonly` globalSignaturePolicy

globalSignaturePolicy: "StrictSign" | "StrictNoSign"

The signature policy to follow by default

`Readonly` gossip

gossip: Map<string, IControlIHave[]>

Map of pending messages to gossip peer id => control messages

`Readonly` gossipTracer

gossipTracer: IWantTracer

Tracks IHAVE/IWANT promises broken by peers

`Readonly` mesh

mesh: Map<string, Set<string>>

Map of topic meshes topic => peer id set

multicodecs

multicodecs: string[]

observers

observers: { [contentTopic: string]: Set<((message: waku_message.WakuMessage) => void)> }

observers called when receiving new message. Observers under key "" are always called.

Type declaration

[contentTopic: string]: Set<((message: waku_message.WakuMessage) => void)>

`Readonly` opts

opts: Required<GossipOptions>

`Readonly` peers

peers: Set<string>

pubSubTopic

pubSubTopic: string

`Readonly` score

score: PeerScore

Peer score tracking

`Readonly` streamsInbound

streamsInbound: Map<string, InboundStream>

`Readonly` streamsOutbound

streamsOutbound: Map<string, OutboundStream>

`Readonly` topicValidators

topicValidators: Map<string, TopicValidatorFn>

`Static` multicodec

multicodec: string = ...

Accessors

started

get started(): boolean
Returns boolean
Inherited from GossipSub.started
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:238

Methods

acceptFrom

acceptFrom(id: string): boolean
Whether to accept a message from a peer
Parameters
- id: string
Returns boolean
Inherited from GossipSub.acceptFrom
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:288

addDecryptionKey

addDecryptionKey(key: string | Uint8Array, options?: { contentTopics?: string[]; method?: DecryptionMethod }): void
Register a decryption key to attempt decryption of received messages. This can either be a private key for asymmetric encryption or a symmetric key. WakuRelay will attempt to decrypt messages using both methods.

Strings must be in hex format.
Parameters
- key: string | Uint8Array
- Optional options: { contentTopics?: string[]; method?: DecryptionMethod }
  - Optional contentTopics?: string[]
  - Optional method?: DecryptionMethod
Returns void
- Defined in src/lib/waku_relay/index.ts:111

addEventListener

addEventListener<K>(type: K, listener: null | EventHandler<GossipsubEvents[K]>, options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends keyof GossipsubEvents
Parameters
- type: K
- listener: null | EventHandler<GossipsubEvents[K]>
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from GossipSub.addEventListener
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:21

addObserver

addObserver(callback: ((message: waku_message.WakuMessage) => void), contentTopics?: string[]): void
Register an observer of new messages received via waku relay

Returns
Parameters
- callback: ((message: waku_message.WakuMessage) => void)
  
  called when a new message is received via waku relay
  - - (message: waku_message.WakuMessage): void
    - Parameters
      
      message: waku_message.WakuMessage
      
      Returns void
- contentTopics: string[] = []
  
  Content Topics for which the callback with be called, all of them if undefined, [] or ["",..] is passed.
Returns void
- Defined in src/lib/waku_relay/index.ts:136

deleteDecryptionKey

deleteDecryptionKey(key: string | Uint8Array): void
Delete a decryption key that was used to attempt decryption of received messages.

Strings must be in hex format.
Parameters
- key: string | Uint8Array
Returns void
- Defined in src/lib/waku_relay/index.ts:124

deleteObserver

deleteObserver(callback: ((message: waku_message.WakuMessage) => void), contentTopics?: string[]): void
Remove an observer of new messages received via waku relay. Useful to ensure the same observer is not registered several time (e.g when loading React components)
Parameters
- callback: ((message: waku_message.WakuMessage) => void)
  - - (message: waku_message.WakuMessage): void
    - Parameters
      
      message: waku_message.WakuMessage
      
      Returns void
- contentTopics: string[] = []
Returns void
- Defined in src/lib/waku_relay/index.ts:160

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean
Inherited from GossipSub.dispatchEvent
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:23

dumpPeerScoreStats

dumpPeerScoreStats(): PeerScoreStatsDump
FOR DEBUG ONLY - Dump peer stats for all peers. Data is cloned, safe to mutate

Returns PeerScoreStatsDump
Inherited from GossipSub.dumpPeerScoreStats
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:215

getMeshPeers

getMeshPeers(topic?: string): string[]
Parameters
- Optional topic: string
Returns string[]
Overrides GossipSub.getMeshPeers
- Defined in src/lib/waku_relay/index.ts:228

getPeers

getPeers(): PeerId[]
Returns PeerId[]
Inherited from GossipSub.getPeers
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:199

getScore

getScore(peerId: string): number
Return score of a peer.
Parameters
- peerId: string
Returns number
Inherited from GossipSub.getScore
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:276

getSubscribers

getSubscribers(topic: string): PeerId[]
Get a list of the peer-ids that are subscribed to one topic.
Parameters
- topic: string
Returns PeerId[]
Inherited from GossipSub.getSubscribers
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:246

getTopics

getTopics(): string[]
Get the list of topics which the peer is subscribed to.

Returns string[]
Inherited from GossipSub.getTopics
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:250

handleReceivedRpc

handleReceivedRpc(from: PeerId, rpc: IRPC): Promise<void>
Handles an rpc request from a peer
Parameters
- from: PeerId
- rpc: IRPC
Returns Promise<void>
Inherited from GossipSub.handleReceivedRpc
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:258

heartbeat

heartbeat(): Promise<void>
Maintains the mesh and fanout maps in gossipsub.

Returns Promise<void>
Inherited from GossipSub.heartbeat
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:441

init

init(components: Components): Promise<void>
Pass libp2p components to interested system components
Parameters
- components: Components
Returns Promise<void>
Inherited from GossipSub.init
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:204

isStarted

isStarted(): boolean
Returns boolean
Inherited from GossipSub.isStarted
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:200

listenerCount

listenerCount(type: string): number
Parameters
- type: string
Returns number
Inherited from GossipSub.listenerCount
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:20

piggybackControl

piggybackControl(id: string, outRpc: IRPC, ctrl: IControlMessage): void
Parameters
- id: string
- outRpc: IRPC
- ctrl: IControlMessage
Returns void
Inherited from GossipSub.piggybackControl
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:403

publish

publish(topic: string, data: Uint8Array): Promise<PublishResult>
App layer publishes a message to peers, return number of peers this message is published to Note: async due to crypto only if StrictSign, otherwise it's a sync fn.

For messages not from us, this class uses forwardMessage.
Parameters
- topic: string
- data: Uint8Array
Returns Promise<PublishResult>
Inherited from GossipSub.publish
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:368

removeEventListener

removeEventListener<K>(type: K, listener?: null | EventHandler<GossipsubEvents[K]>, options?: boolean | EventListenerOptions): void
Type Parameters
- K extends keyof GossipsubEvents
Parameters
- type: K
- Optional listener: null | EventHandler<GossipsubEvents[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from GossipSub.removeEventListener
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:22

reportMessageValidationResult

reportMessageValidationResult(msgId: string, propagationSource: PeerId, acceptance: MessageAcceptance): void
This function should be called when asyncValidation is true after the message got validated by the caller. Messages are stored in the mcache and validation is expected to be fast enough that the messages should still exist in the cache. There are three possible validation outcomes and the outcome is given in acceptance.

If acceptance = MessageAcceptance.Accept the message will get propagated to the network. The propagation_source parameter indicates who the message was received by and will not be forwarded back to that peer.

If acceptance = MessageAcceptance.Reject the message will be deleted from the memcache and the P₄ penalty will be applied to the propagationSource.

If acceptance = MessageAcceptance.Ignore the message will be deleted from the memcache but no P₄ penalty will be applied.

This function will return true if the message was found in the cache and false if was not in the cache anymore.

This should only be called once per message.
Parameters
- msgId: string
- propagationSource: PeerId
- acceptance: MessageAcceptance
Returns void
Inherited from GossipSub.reportMessageValidationResult
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:390

send

send(message: waku_message.WakuMessage): Promise<void>
Send Waku message.

Returns
Parameters
- message: waku_message.WakuMessage
Returns Promise<void>
- Defined in src/lib/waku_relay/index.ts:99

start

start(): Promise<void>
Mounts the gossipsub protocol onto the libp2p node and subscribes to the default topic.

Returns

Returns Promise<void>
Overrides GossipSub.start
- Defined in src/lib/waku_relay/index.ts:88

stop

stop(): Promise<void>
Unmounts the gossipsub protocol and shuts down every connection

Returns Promise<void>
Inherited from GossipSub.stop
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:213

subscribe(pubSubTopic: string): void
Subscribe to a pubsub topic and start emitting Waku messages to observers.
Parameters
- pubSubTopic: string
Returns void
Overrides GossipSub.subscribe
- Defined in src/lib/waku_relay/index.ts:182

unsubscribe

unsubscribe(topic: string): void
Unsubscribe to a topic
Parameters
- topic: string
Returns void
Inherited from GossipSub.unsubscribe
- Defined in node_modules/@chainsafe/libp2p-gossipsub/dist/src/index.d.ts:345

Class WakuRelay

Implements

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: Partial<waku_relay.CreateOptions>

Returns WakuRelay

Properties

Private #private

Readonly control

decryptionKeys

Readonly direct

Readonly fanout

Readonly globalSignaturePolicy

Readonly gossip

Readonly gossipTracer

Readonly mesh

multicodecs

observers

Type declaration

[contentTopic: string]: Set<((message: waku_message.WakuMessage) => void)>

Readonly opts

Readonly peers

pubSubTopic

Readonly score

Readonly streamsInbound

Readonly streamsOutbound

Readonly topicValidators

Static multicodec

Accessors

started

Returns boolean

Methods

acceptFrom

Parameters

id: string

Returns boolean

addDecryptionKey

Parameters

key: string | Uint8Array

Optional options: { contentTopics?: string[]; method?: DecryptionMethod }

Optional contentTopics?: string[]

Optional method?: DecryptionMethod

Returns void

addEventListener

Type Parameters

K extends keyof GossipsubEvents

Parameters

type: K

listener: null | EventHandler<GossipsubEvents[K]>

Optional options: boolean | AddEventListenerOptions

Returns void

addObserver

Returns

Parameters

callback: ((message: waku_message.WakuMessage) => void)

Parameters

message: waku_message.WakuMessage

Returns void

contentTopics: string[] = []

Returns void

deleteDecryptionKey

Parameters

key: string | Uint8Array

Returns void

deleteObserver

Parameters

callback: ((message: waku_message.WakuMessage) => void)

Parameters

message: waku_message.WakuMessage

Returns void

contentTopics: string[] = []

Returns void

dispatchEvent

`Optional` options: Partial<waku_relay.CreateOptions>

`Private` #private

`Readonly` control

`Readonly` direct

`Readonly` fanout

`Readonly` globalSignaturePolicy

`Readonly` gossip

`Readonly` gossipTracer

`Readonly` mesh

`Readonly` opts

`Readonly` peers

`Readonly` score

`Readonly` streamsInbound

`Readonly` streamsOutbound

`Readonly` topicValidators

`Static` multicodec

`Optional` options: { contentTopics?: string[]; method?: DecryptionMethod }

`Optional` contentTopics?: string[]

`Optional` method?: DecryptionMethod

`Optional` options: boolean | AddEventListenerOptions

`Optional` topic: string

`Optional` listener: null | EventHandler<GossipsubEvents[K]>

`Optional` options: boolean | EventListenerOptions