Class AddressBook

Hierarchy

Index

References

Constructors

Properties

Methods

References

Address

Re-exports Address

CertifiedRecord

Re-exports CertifiedRecord

Entry

Re-exports Entry

Multiaddr

Re-exports Multiaddr

PeerStore

Re-exports PeerStore

PeerStore

Re-exports PeerStore

Constructors

constructor

Properties

_ps

_ps: PeerStore

Private _toAddresses

_toAddresses: any

Transforms received multiaddrs into Address.

param
param
returns

data

data: Map<string, any[] | any>

Map known peers to their data.

eventName

eventName: string

eventProperty

eventProperty: string

eventTransformer

eventTransformer: (data: any) => any[]

Type declaration

    • (data: any): any[]

    • Parameters

      • data: any

      Returns any[]

Methods

Protected _emit

  • _emit(peerId: PeerId, data?: any): void

  • Emit data.

    Parameters

    • peerId: PeerId
    • Optional data: any

    Returns void

Protected _setData

  • _setData(peerId: PeerId, data: any, __namedParameters?: { emit: undefined | false | true }): void

  • Set data into the datastructure, persistence and emit it using the provided transformers.

    Parameters

    • peerId: PeerId

      peerId of the data to store

    • data: any

      data to store.

    • Optional __namedParameters: { emit: undefined | false | true }
      • emit: undefined | false | true

    Returns void

add

  • Add known addresses of a provided peer. If the peer is not known, it is set with the given addresses.

    Parameters

    Returns AddressBook

consumePeerRecord

  • consumePeerRecord(envelope: Envelope): boolean

  • ConsumePeerRecord adds addresses from a signed peer record contained in a record envelope. This will return a boolean that indicates if the record was successfully processed and added into the AddressBook.

    Parameters

    Returns boolean

delete

  • delete(peerId: PeerId): boolean

  • Deletes the provided peer from the book.

    Parameters

    Returns boolean

get

  • get(peerId: PeerId): any[] | any | undefined

  • Get the known data of a provided peer. Returns undefined if there is no available data for the given peer.

    Parameters

    Returns any[] | any | undefined

getMultiaddrsForPeer

  • Get the known multiaddrs for a given peer. All returned multiaddrs will include the encapsulated PeerId of the peer. Returns undefined if there are no known multiaddrs for the given peer.

    Parameters

    Returns Multiaddr[] | undefined

getPeerRecord

  • Get an Envelope containing a PeerRecord for the given peer. Returns undefined if no record exists.

    Parameters

    Returns Promise<Envelope | void> | undefined

getRawEnvelope

  • getRawEnvelope(peerId: PeerId): Uint8Array | undefined

  • Get the raw Envelope for a peer. Returns undefined if no Envelope is found.

    Parameters

    Returns Uint8Array | undefined

set

  • set(peerId: PeerId, data: any[] | any): void

  • Set known data of a provided peer.

    Parameters

    • peerId: PeerId
    • data: any[] | any

    Returns void