Class PubSubBaseProtocol<Events>`Abstract`

PubSubBaseProtocol handles the peers and connections logic for pubsub routers and specifies the API that pubsub routers should have.

Type Parameters

Events extends Record<string, any> = PubSubEvents

Hierarchy

EventEmitter<Events>
- PubSubBaseProtocol

Implements

PubSub<Events>

Constructors

constructor

new PubSubBaseProtocol<Events>(components: PubSubComponents, props: PubSubInit): PubSubBaseProtocol<Events>
Type Parameters
- Events extends Record<string, any> = PubSubEvents
Parameters
- components: PubSubComponents
- props: PubSubInit
Returns PubSubBaseProtocol<Events>
Overrides EventEmitter<Events>.constructor
- Defined in index.ts:74

Properties

`Private` _registrarTopologyIds

_registrarTopologyIds: undefined | string[]

canRelayMessage

canRelayMessage: boolean

If router can relay received messages, even if not subscribed

components

components: PubSubComponents

emitSelf

emitSelf: boolean

if publish should emit to self, if subscribed

`Protected` enabled

enabled: boolean

globalSignaturePolicy

globalSignaturePolicy: "StrictSign" | "StrictNoSign"

The signature policy to follow by default

`Private` `Readonly` maxInboundStreams

maxInboundStreams: number

`Private` `Readonly` maxOutboundStreams

maxOutboundStreams: number

multicodecs

multicodecs: string[]

peers

peers: PeerMap<PeerStreams>

Map of peer streams

queue

queue: default<default, QueueAddOptions>

started

started: boolean

subscriptions

subscriptions: Set<string>

List of our subscriptions

topicValidators

topicValidators: Map<string, TopicValidatorFn>

Topic validator map

Keyed by topic Topic validators are functions with the following input:

topics

topics: Map<string, PeerSet>

Map of topics to which peers are subscribed to

Methods

`Protected` _onIncomingStream

_onIncomingStream(data: IncomingStreamData): void
On an inbound stream opened
Parameters
- data: IncomingStreamData
Returns void
- Defined in index.ts:180

`Protected` _onPeerConnected

_onPeerConnected(peerId: PeerId, conn: Connection): void
Registrar notifies an established connection with pubsub protocol
Parameters
- peerId: PeerId
- conn: Connection
Returns void
- Defined in index.ts:199

`Protected` _onPeerDisconnected

_onPeerDisconnected(peerId: PeerId, conn?: Connection): void
Registrar notifies a closing connection with pubsub protocol
Parameters
- peerId: PeerId
- Optional conn: Connection
Returns void
- Defined in index.ts:228

`Protected` _removePeer

_removePeer(peerId: PeerId): undefined | PeerStreams
Notifies the router that a peer has been disconnected
Parameters
- peerId: PeerId
Returns undefined | PeerStreams
- Defined in index.ts:265

acceptFrom

acceptFrom(id: PeerId): boolean
Whether to accept a message from a peer Override to create a graylist
Parameters
- id: PeerId
Returns boolean
- Defined in index.ts:477

addPeer

addPeer(peerId: PeerId, protocol: string): PeerStreams
Notifies the router that a peer has been connected
Parameters
- peerId: PeerId
- protocol: string
Returns PeerStreams
- Defined in index.ts:238

buildMessage

buildMessage(message: {
    data: Uint8Array;
    from: PeerId;
    sequenceNumber: bigint;
    topic: string;
}): Promise<Message>
Normalizes the message and signs it, if signing is enabled. Should be used by the routers to create the message to send.
Parameters
- message: {
      data: Uint8Array;
      from: PeerId;
      sequenceNumber: bigint;
      topic: string;
  }
  - data: Uint8Array
  - from: PeerId
  - sequenceNumber: bigint
  - topic: string
Returns Promise<Message>
- Defined in index.ts:588

`Abstract` decodeRpc

decodeRpc(bytes: Uint8ArrayList | Uint8Array): PubSubRPC
Decode Uint8Array into an RPC object. This can be override to use a custom router protobuf.
Parameters
- bytes: Uint8ArrayList | Uint8Array
Returns PubSubRPC
- Defined in index.ts:485

`Abstract` encodeMessage

encodeMessage(rpc: PubSubRPCMessage): Uint8Array
Encode RPC object into a Uint8Array. This can be override to use a custom router protobuf.
Parameters
- rpc: PubSubRPCMessage
Returns Uint8Array
- Defined in index.ts:497

`Abstract` encodeRpc

encodeRpc(rpc: PubSubRPC): Uint8Array
Encode RPC object into a Uint8Array. This can be override to use a custom router protobuf.
Parameters
- rpc: PubSubRPC
Returns Uint8Array
- Defined in index.ts:491

getMsgId

getMsgId(msg: Message): Uint8Array | Promise<Uint8Array>
The default msgID implementation Child class can override this.
Parameters
- msg: Message
Returns Uint8Array | Promise<Uint8Array>
- Defined in index.ts:449

getPeers

getPeers(): PeerId[]
Returns PeerId[]
Implementation of PubSub.getPeers
- Defined in index.ts:728

getSubscribers

getSubscribers(topic: string): PeerId[]
Get a list of the peer-ids that are subscribed to one topic.
Parameters
- topic: string
Returns PeerId[]
Implementation of PubSub.getSubscribers
- Defined in index.ts:608

getTopics

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

Returns string[]
Implementation of PubSub.getTopics
- Defined in index.ts:720

isStarted

isStarted(): boolean
Returns boolean
- Defined in index.ts:173

processMessage

processMessage(from: PeerId, msg: Message): Promise<void>
Handles a message from a peer
Parameters
- from: PeerId
- msg: Message
Returns Promise<void>
- Defined in index.ts:419

processMessages

processMessages(peerId: PeerId, stream: AsyncIterable<Uint8ArrayList>, peerStreams: PeerStreams): Promise<void>
Responsible for processing each RPC message received by other peers.
Parameters
- peerId: PeerId
- stream: AsyncIterable<Uint8ArrayList>
- peerStreams: PeerStreams
Returns Promise<void>
- Defined in index.ts:291

processRpc

processRpc(from: PeerId, peerStreams: PeerStreams, rpc: PubSubRPC): Promise<boolean>
Handles an rpc request from a peer
Parameters
- from: PeerId
- peerStreams: PeerStreams
- rpc: PubSubRPC
Returns Promise<boolean>
- Defined in index.ts:339

processRpcSubOpt

processRpcSubOpt(id: PeerId, subOpt: PubSubRPCSubscription): void
Handles a subscription change from a peer
Parameters
- id: PeerId
- subOpt: PubSubRPCSubscription
Returns void
- Defined in index.ts:394

publish

publish(topic: string, data?: Uint8Array): Promise<PublishResult>
Publishes messages to all subscribed peers
Parameters
- topic: string
- Optional data: Uint8Array
Returns Promise<PublishResult>
Implementation of PubSub.publish
- Defined in index.ts:629

`Abstract` publishMessage

publishMessage(sender: PeerId, message: Message): Promise<PublishResult>
Overriding the implementation of publish should handle the appropriate algorithms for the publish/subscriber implementation. For example, a Floodsub implementation might simply publish each message to each topic for every peer.

sender might be this peer, or we might be forwarding a message on behalf of another peer, in which case sender is the peer we received the message from, which may not be the peer the message was created by.
Parameters
- sender: PeerId
- message: Message
Returns Promise<PublishResult>
- Defined in index.ts:673

send

send(peer: PeerId, data: {
    messages?: Message[];
    subscribe?: boolean;
    subscriptions?: string[];
}): void
Send an rpc object to a peer
Parameters
- peer: PeerId
- data: {
      messages?: Message[];
      subscribe?: boolean;
      subscriptions?: string[];
  }
  - Optional messages?: Message[]
  - Optional subscribe?: boolean
  - Optional subscriptions?: string[]
Returns void
- Defined in index.ts:502

sendRpc

sendRpc(peer: PeerId, rpc: PubSubRPC): void
Send an rpc object to a peer
Parameters
- peer: PeerId
- rpc: PubSubRPC
Returns void
- Defined in index.ts:514

start

start(): Promise<void>
Register the pubsub protocol onto the libp2p node.

Returns Promise<void>
- Defined in index.ts:112

stop

stop(): Promise<void>
Unregister the pubsub protocol and the streams with other peers will be closed.

Returns Promise<void>
- Defined in index.ts:144

subscribe(topic: string): void
Subscribes to a given topic.
Parameters
- topic: string
Returns void
Implementation of PubSub.subscribe
- Defined in index.ts:678

unsubscribe

unsubscribe(topic: string): void
Unsubscribe from the given topic
Parameters
- topic: string
Returns void
Implementation of PubSub.unsubscribe
- Defined in index.ts:697

validate

validate(from: PeerId, message: Message): Promise<void>
Validates the given message. The signature will be checked for authenticity. Throws an error on invalid messages
Parameters
- from: PeerId
- message: Message
Returns Promise<void>
- Defined in index.ts:530

Class PubSubBaseProtocol<Events>Abstract

Type Parameters

Events extends Record<string, any> = PubSubEvents

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Events extends Record<string, any> = PubSubEvents

Parameters

components: PubSubComponents

props: PubSubInit

Returns PubSubBaseProtocol<Events>

Properties

Private _registrarTopologyIds

canRelayMessage

components

emitSelf

Protected enabled

globalSignaturePolicy

Private Readonly maxInboundStreams

Private Readonly maxOutboundStreams

multicodecs

peers

queue

started

subscriptions

topicValidators

topics

Methods

Protected _onIncomingStream

Parameters

data: IncomingStreamData

Returns void

Protected _onPeerConnected

Parameters

peerId: PeerId

conn: Connection

Returns void

Protected _onPeerDisconnected

Parameters

peerId: PeerId

Optional conn: Connection

Returns void

Protected _removePeer

Parameters

peerId: PeerId

Returns undefined | PeerStreams

acceptFrom

Parameters

id: PeerId

Returns boolean

addPeer

Parameters

peerId: PeerId

protocol: string

Returns PeerStreams

buildMessage

Parameters

message: { data: Uint8Array; from: PeerId; sequenceNumber: bigint; topic: string; }

data: Uint8Array

from: PeerId

sequenceNumber: bigint

topic: string

Returns Promise<Message>

Abstract decodeRpc

Parameters

bytes: Uint8ArrayList | Uint8Array

Returns PubSubRPC

Abstract encodeMessage

Parameters

rpc: PubSubRPCMessage

Returns Uint8Array

Abstract encodeRpc

Parameters

rpc: PubSubRPC

Class PubSubBaseProtocol<Events>`Abstract`

`Private` _registrarTopologyIds

`Protected` enabled

`Private` `Readonly` maxInboundStreams

`Private` `Readonly` maxOutboundStreams

`Protected` _onIncomingStream

`Protected` _onPeerConnected

`Protected` _onPeerDisconnected

`Optional` conn: Connection

`Protected` _removePeer

message: {
data: Uint8Array;
from: PeerId;
sequenceNumber: bigint;
topic: string;
}

`Abstract` decodeRpc

`Abstract` encodeMessage

`Abstract` encodeRpc

`Optional` data: Uint8Array

`Abstract` publishMessage

data: {
messages?: Message[];
subscribe?: boolean;
subscriptions?: string[];
}

`Optional` messages?: Message[]

`Optional` subscribe?: boolean

`Optional` subscriptions?: string[]