Module libp2p

Index

Classes

Type aliases

Variables

Type aliases

Connection

Connection: Connection

CreateOptions

CreateOptions: { peerId: PeerId }

Type declaration

Crypto

Crypto: Crypto

Libp2pConfig

Libp2pConfig: { dht?: any; peerDiscovery?: PeerDiscoveryOptions | undefined; pubsub?: PubsubBaseProtocol | undefined; relay?: RelayOptions | undefined; transport?: Record<string, any> | undefined }

Type declaration

  • Optional dht?: any

    dht module options

  • Optional peerDiscovery?: PeerDiscoveryOptions | undefined
  • Optional pubsub?: PubsubBaseProtocol | undefined

    pubsub module options

  • Optional relay?: RelayOptions | undefined
  • Optional transport?: Record<string, any> | undefined

    transport options indexed by transport key

Libp2pModules

Libp2pModules: { connEncryption: Crypto[]; streamMuxer: MuxerFactory[]; transport: TransportFactory<any, any>[] }

Type declaration

  • connEncryption: Crypto[]
  • streamMuxer: MuxerFactory[]
  • transport: TransportFactory<any, any>[]

Libp2pOptions

Libp2pOptions: { addresses?: { announce?: string[] | undefined; listen?: string[] | undefined } | undefined; config?: Libp2pConfig | undefined; connectionManager?: { autoDial?: boolean | undefined; autoDialInterval?: number | undefined; defaultPeerValue?: number | undefined; maxConnections?: number | undefined; maxData?: number | undefined; maxEventLoopDelay?: number | undefined; maxReceivedData?: number | undefined; maxSentData?: number | undefined; minConnections?: number | undefined; movingAverageInterval?: number | undefined; pollInterval?: number | undefined } | undefined; dialer?: { addressSorter?: ((addresses: Address[]) => Address[]) | undefined; concurrency?: number | undefined; perPeerLimit?: number | undefined; resolvers?: Record<string, (addr: Multiaddr) => Promise<string[]>> | undefined; timeout?: number | undefined } | undefined; keychain?: any; metrics?: { computeThrottleMaxQueueSize?: number | undefined; computeThrottleTimeout?: number | undefined; maxOldPeersRetention?: number | undefined; movingAverageIntervals?: number[] | undefined } | undefined; modules: Libp2pModules; peerId: PeerId; peerStore?: (PeerStoreOptions & { threshold?: number | undefined }) | undefined; transportManager?: { faultTolerance?: number | undefined } | undefined }

Type declaration

  • Optional addresses?: { announce?: string[] | undefined; listen?: string[] | undefined } | undefined
  • Optional config?: Libp2pConfig | undefined
  • Optional connectionManager?: { autoDial?: boolean | undefined; autoDialInterval?: number | undefined; defaultPeerValue?: number | undefined; maxConnections?: number | undefined; maxData?: number | undefined; maxEventLoopDelay?: number | undefined; maxReceivedData?: number | undefined; maxSentData?: number | undefined; minConnections?: number | undefined; movingAverageInterval?: number | undefined; pollInterval?: number | undefined } | undefined
  • Optional dialer?: { addressSorter?: ((addresses: Address[]) => Address[]) | undefined; concurrency?: number | undefined; perPeerLimit?: number | undefined; resolvers?: Record<string, (addr: Multiaddr) => Promise<string[]>> | undefined; timeout?: number | undefined } | undefined
  • Optional keychain?: any
  • Optional metrics?: { computeThrottleMaxQueueSize?: number | undefined; computeThrottleTimeout?: number | undefined; maxOldPeersRetention?: number | undefined; movingAverageIntervals?: number[] | undefined } | undefined
  • modules: Libp2pModules

    libp2p modules to use

  • peerId: PeerId
  • Optional peerStore?: (PeerStoreOptions & { threshold?: number | undefined }) | undefined
  • Optional transportManager?: { faultTolerance?: number | undefined } | undefined

Multiaddr

Multiaddr: Multiaddr

MuxedStream

MuxedStream: MuxedStream

MuxerFactory

MuxerFactory: MuxerFactory

PeerDiscoveryOptions

PeerDiscoveryOptions: { autoDial: boolean }

Type declaration

  • autoDial: boolean

PeerStoreOptions

PeerStoreOptions: { persistence: boolean }

Type declaration

  • persistence: boolean

Pubsub

Pubsub: PubsubBaseProtocol

RelayOptions

RelayOptions: { advertise: { bootDelay?: number | undefined; enabled?: boolean | undefined; ttl?: number | undefined }; autoRelay: { enabled?: boolean | undefined; maxListeners?: number | undefined }; enabled: boolean; hop: { active?: boolean | undefined; enabled?: boolean | undefined } }

Type declaration

  • advertise: { bootDelay?: number | undefined; enabled?: boolean | undefined; ttl?: number | undefined }
    • Optional bootDelay?: number | undefined
    • Optional enabled?: boolean | undefined
    • Optional ttl?: number | undefined
  • autoRelay: { enabled?: boolean | undefined; maxListeners?: number | undefined }
    • Optional enabled?: boolean | undefined
    • Optional maxListeners?: number | undefined
      • maximum number of relays to listen.
  • enabled: boolean
  • hop: { active?: boolean | undefined; enabled?: boolean | undefined }
    • Optional active?: boolean | undefined
    • Optional enabled?: boolean | undefined

TransportFactory

TransportFactory: TransportFactory<any, any>

Variables

Const Libp2p_base

Libp2p_base: EventEmitter