Interface IRelay

Hierarchy

  • GossipSub
    • IRelay

Properties

#private addObserver control direct fanout getMeshPeers globalSignaturePolicy gossip gossipTracer mesh multicodecs opts peers score send streamsInbound streamsOutbound topicValidators

Accessors

started

Methods

acceptFrom addEventListener dispatchEvent dumpPeerScoreStats getPeers getScore getSubscribers getTopics handleReceivedRpc heartbeat isStarted listenerCount piggybackControl publish removeEventListener reportMessageValidationResult start stop subscribe unsubscribe

Properties

Private #private

#private: any

addObserver

addObserver: (<T>(decoder: IDecoder<T>, callback: Callback<T>) => (() => void))

Type declaration

Readonly control

control: Map<string, IControlMessage>

Map of control messages peer id => control message

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

getMeshPeers

getMeshPeers: (() => string[])

Type declaration

    • (): string[]

    • Returns string[]

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[]

Readonly opts

opts: Required<GossipOptions>

Readonly peers

peers: Set<string>

Readonly score

score: PeerScore

Peer score tracking

send

send: ((encoder: IEncoder, message: IMessage) => Promise<SendResult>)

Type declaration

Readonly streamsInbound

streamsInbound: Map<string, InboundStream>

Readonly streamsOutbound

streamsOutbound: Map<string, OutboundStream>

Readonly topicValidators

topicValidators: Map<string, TopicValidatorFn>

Custom validator function per topic. Must return or resolve quickly (< 100ms) to prevent causing penalties for late messages. If you need to apply validation that may require longer times use asyncValidation option and callback the validation result through Gossipsub.reportValidationResult

Accessors

started

  • get started(): boolean

  • Returns boolean

Methods

acceptFrom

  • Whether to accept a message from a peer

    Parameters

    • id: string

    Returns boolean

addEventListener

  • Type Parameters

    • K extends keyof GossipsubEvents

    Parameters

    • type: K
    • listener: null | EventHandler<GossipsubEvents[K]>
    • Optional options: boolean | AddEventListenerOptions

    Returns void

dispatchEvent

  • Parameters

    • event: Event

    Returns boolean

dumpPeerScoreStats

  • FOR DEBUG ONLY - Dump peer stats for all peers. Data is cloned, safe to mutate

    Returns PeerScoreStatsDump

getPeers

  • Returns PeerId[]

getScore

  • Return score of a peer.

    Parameters

    • peerId: string

    Returns number

getSubscribers

  • Get a list of the peer-ids that are subscribed to one topic.

    Parameters

    • topic: string

    Returns PeerId[]

getTopics

  • Get the list of topics which the peer is subscribed to.

    Returns string[]

handleReceivedRpc

  • Handles an rpc request from a peer

    Parameters

    • from: PeerId
    • rpc: IRPC

    Returns Promise<void>

heartbeat

  • Maintains the mesh and fanout maps in gossipsub.

    Returns Promise<void>

isStarted

  • Returns boolean

listenerCount

  • Parameters

    • type: string

    Returns number

piggybackControl

  • Mutates outRpc adding graft and prune control messages

    Parameters

    • id: string
    • outRpc: IRPC
    • ctrl: IControlMessage

    Returns void

publish

  • 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>

removeEventListener

  • Type Parameters

    • K extends keyof GossipsubEvents

    Parameters

    • type: K
    • Optional listener: null | EventHandler<GossipsubEvents[K]>
    • Optional options: boolean | EventListenerOptions

    Returns void

reportMessageValidationResult

  • 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: TopicValidatorResult

    Returns void

start

  • Mounts the gossipsub protocol onto the libp2p node and sends our our subscriptions to every peer connected

    Returns Promise<void>

stop

  • Unmounts the gossipsub protocol and shuts down every connection

    Returns Promise<void>

subscribe

  • Subscribes to a topic

    Parameters

    • topic: string

    Returns void

unsubscribe

  • Unsubscribe to a topic

    Parameters

    • topic: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc