+
+
+
+
+ Class AddressManager
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_circuit_auto_relay_.autorelay.html b/classes/_circuit_auto_relay_.autorelay.html
new file mode 100644
index 00000000..3e94f490
--- /dev/null
+++ b/classes/_circuit_auto_relay_.autorelay.html
@@ -0,0 +1,625 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Address
+ Re-exports AddressManagerOptions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ get
+
+
+
+ get
+
+
+
+
+ Hierarchy
+-
+
- + AddressManager + +
Index
+References
+AddressManagerOptions
+ Re-exports AddressManagerOptions
+ Multiaddr
+ Re-exports Multiaddr +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Responsible for managing the peer addresses. + Peers can specify their listen and announce addresses. + The listen addresses will be used by the libp2p transports to listen for new connections, + while the announce addresses will be used for the peer addresses' to other peers in the network.
+Parameters
+-
+
-
+
Optional __namedParameters: { announce: undefined | string[]; listen: undefined | string[] }
+-
+
-
+
announce: undefined | string[]
+
+ -
+
listen: undefined | string[]
+
+
+ -
+
Returns AddressManager
+
+ -
+
Properties
+announce
+ + +listen
+ + +Methods
+getAnnounceAddrs
+ -
+
+
-
+
-
+
+ ++++
Get peer announcing multiaddrs.
+Returns Multiaddr[]
+
+
getListenAddrs
+ -
+
+
-
+
-
+
+ ++++
Get peer listen multiaddrs.
+Returns Multiaddr[]
+
+
+
+
+
+
+ Class AutoRelay
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_circuit_circuit_stream_handler_.streamhandler.html b/classes/_circuit_circuit_stream_handler_.streamhandler.html
new file mode 100644
index 00000000..287a218b
--- /dev/null
+++ b/classes/_circuit_circuit_stream_handler_.streamhandler.html
@@ -0,0 +1,486 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Auto
+ Re-exports AutoRelayOptions
+
+
+
+ Auto
+ Re-exports AutoRelayProperties
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Private _add
+
+
+
+
+
+ _address
+
+
+
+
+
+
+ _connection
+
+
+
+
+
+
+
+
+ _listen
+
+
+
+
+
+ _peer
+
+
+
+
+
+ _peer
+
+
+
+
+
+ Private _remove
+
+
+
+
+
+ _transport
+
+
+
+
+
+ max
+
+
+
+
+
+
+
+ _listen
+
+
+
+ _on
+
+
+
+ _on
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + AutoRelay + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Address +
- Auto
Relay Options
+ - Auto
Relay Properties
+ - Connection +
Constructors
+-
+
- constructor +
Properties
+ +Methods
+ +References
+Address
+ Re-exports Address +AutoRelayOptions
+ Re-exports AutoRelayOptions
+ AutoRelayProperties
+ Re-exports AutoRelayProperties
+ Connection
+ Re-exports Connection +Constructors
+constructor
+-
+
+
Properties
+Private _addListenRelay
+
+
+
+
+
+
+
+ Attempt to listen on the given relay connection.
+_addressSorter
+
+
+
+ _connectionManager
+
+
+ _libp2p
+ + +_listenRelays
+
+
+
+
+ _peerId
+
+
+ _peerStore
+
+
+ Private _removeListenRelay
+
+
+
+
+
+
+
+ Remove listen relay.
+_transportManager
+
+
+ maxListeners
+
+
+ Methods
+_listenOnAvailableHopRelays
+ -
+
+
-
+
-
+
+ ++++
Try to listen on available hop relay connections. + The following order will happen while we do not have enough relays.
+-
+
- Check the metadata store for known relays, try to listen on the ones we are already connected. +
- Dial and try to listen on the peers we know that support hop but are not connected. +
- Search the network. +
Parameters
+-
+
-
+
Optional peersToIgnore: string[] | undefined
+
+
Returns Promise<void>
+
+
_onPeerDisconnected
+ -
+
+
-
+
-
+
+ ++++
Peer disconnects.
+Parameters
+-
+
-
+
connection: Connection
+++connection to the peer
+
+
Returns void
+
+ -
+
_onProtocolChange
+ -
+
+
-
+
-
+
+ ++++
Check if a peer supports the relay protocol. + If the protocol is not supported, check if it was supported before and remove it as a listen relay. + If the protocol is supported, check if the peer supports HOP and add it as a listener if + inside the threshold.
+Parameters
+-
+
-
+
__namedParameters: { peerId: PeerId; protocols: string[] }
+-
+
-
+
peer
+Id: PeerId
+ -
+
protocols: string[]
+
+
+ -
+
Returns Promise<void>
+
+ -
+
+
+
+
+
+ Class StreamHandler<T>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_circuit_index_.relay.html b/classes/_circuit_index_.relay.html
new file mode 100644
index 00000000..fb94b39a
--- /dev/null
+++ b/classes/_circuit_index_.relay.html
@@ -0,0 +1,479 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Muxed
+ Re-exports MuxedStream
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
T
+++++
+
Hierarchy
+-
+
- + StreamHandler + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Muxed
Stream
+
Constructors
+-
+
- constructor +
Properties
+ +Methods
+ +References
+MuxedStream
+ Re-exports MuxedStream
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Create a stream handler for connection
+Parameters
+-
+
-
+
__namedParameters: { maxLength: undefined | number; stream: MuxedStream }
+-
+
-
+
max
+Length: undefined | number
+ -
+
stream: MuxedStream
+
+
+ -
+
Returns StreamHandler
+
+ -
+
Properties
+decoder
+ + +shake
+ + +stream
+ + +Methods
+close
+-
+
+
-
+
-
+
+ ++++
Close the stream
+Returns void
+
+
end
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
msg: any
+
+
Returns void
+
+ -
+
read
+-
+
+
-
+
-
+
+ ++++ +
Read and decode message
+Returns Promise<T | undefined>
+
+
rest
+-
+
+
-
+
-
+
+ ++++
Return the handshake rest stream and invalidate handler
+Returns any
+A duplex iterable
+
+
write
+-
+
+
-
+
-
+
+ ++++
Encode and write array of buffers
+Parameters
+-
+
-
+
msg: any
+++An unencoded CircuitRelay protobuf message
+
+
Returns void
+
+ -
+
+
+
+
+
+ Class Relay
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_circuit_transport_.circuit.html b/classes/_circuit_transport_.circuit.html
new file mode 100644
index 00000000..1599a1a2
--- /dev/null
+++ b/classes/_circuit_transport_.circuit.html
@@ -0,0 +1,634 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Auto
+ Re-exports AutoRelayOptions
+
+
+
+ Hop
+ Re-exports HopOptions
+
+
+
+
+
+
+ Relay
+ Re-exports RelayAdvertiseOptions
+
+
+
+
+
+
+
+
+
+
+ _auto
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ _advertise
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + Relay + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+ +Constructors
+-
+
- constructor +
Properties
+-
+
- _auto
Relay
+ - _libp2p +
- _options +
- _timeout +
Methods
+-
+
- _advertise
Service
+ - start +
- stop +
References
+AutoRelayOptions
+ Re-exports AutoRelayOptions
+ HopOptions
+ Re-exports HopOptions
+ Libp2p
+ Re-exports Libp2p +RelayAdvertiseOptions
+ Re-exports RelayAdvertiseOptions
+ Constructors
+constructor
+-
+
+
Properties
+_autoRelay
+
+
+ _libp2p
+ + +_options
+ + +_timeout
+ + +Methods
+_advertiseService
+ -
+
+
-
+
-
+
+ ++++
Advertise hop relay service in the network.
+Returns Promise<void>
+
+
start
+-
+
+
-
+
-
+
+ ++++
Start Relay service.
+Returns void
+
+
stop
+-
+
+
-
+
-
+
+ ++++
Stop Relay service.
+Returns void
+
+
+
+
+
+
+ Class Circuit
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_connection_manager_index_.connectionmanager.html b/classes/_connection_manager_index_.connectionmanager.html
new file mode 100644
index 00000000..bc9c2bc7
--- /dev/null
+++ b/classes/_connection_manager_index_.connectionmanager.html
@@ -0,0 +1,1410 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Circuit
+ Re-exports CircuitRequest
+
+
+
+
+
+
+
+
+
+ Muxed
+ Re-exports MuxedStream
+
+
+
+
+
+
+
+
+
+
+ _connection
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ peer
+
+
+
+
+
+
+
+ [
+
+
+
+
+
+ _on
+
+
+
+ create
+
+
+
+
+
+
+
+
+
+ Static is
+
+
+
+
+
+
+ Hierarchy
+-
+
- + Circuit + +
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Circuit
Request
+ - Connection +
- Multiaddr +
- Muxed
Stream
+
Constructors
+-
+
- constructor +
Properties
+-
+
- _connection
Manager
+ - _dialer +
- _libp2p +
- _options +
- _registrar +
- _upgrader +
- handler +
- peer
Id
+
Accessors
+ +Methods
+-
+
- _on
Protocol
+ - create
Listener
+ - dial +
- filter +
- is
Transport
+
References
+CircuitRequest
+ Re-exports CircuitRequest
+ Connection
+ Re-exports Connection +Multiaddr
+ Re-exports Multiaddr +MuxedStream
+ Re-exports MuxedStream
+ Constructors
+constructor
+-
+
+
Properties
+_connectionManager
+
+
+ _dialer
+ + +_libp2p
+ + +_options
+ + +_registrar
+ + +_upgrader
+ + +handler
+ + +peerId
+
+
+ Accessors
+[Symbol.toStringTag]
+ -
+
+
-
+
-
+
+
Returns string
+
+
Methods
+_onProtocol
+ -
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
__namedParameters: { connection: Connection; stream: MuxedStream }
+-
+
-
+
connection: Connection
+
+ -
+
stream: MuxedStream
+
+
+ -
+
Returns Promise<void>
+
+ -
+
createListener
+ -
+
+
-
+
-
+
+ ++++
Create a listener
+Parameters
+-
+
-
+
options: any
+
+ -
+
handler: Function
+
+
Returns Listener
+
+ -
+
dial
+-
+
+
-
+
-
+
+ ++++
Dial a peer over a relay
+Parameters
+-
+
-
+
ma: Multiaddr
+++the multiaddr of the peer to dial
+
+ -
+
options: { signal: AbortSignal | undefined }
+++dial options
+-
+
-
+
signal: AbortSignal | undefined
+
+
+ -
+
Returns Promise<Connection>
+-
+
- the connection +
+ -
+
filter
+-
+
+
Static isTransport
+ -
+
+
-
+
-
+
+ ++++
Checks if the given value is a Transport instance.
+Parameters
+-
+
-
+
other: any
+
+
Returns other is Transport
+
+ -
+
+
+
+
+
+ Class ConnectionManager
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_connection_manager_latency_monitor_.latencymonitor.html b/classes/_connection_manager_latency_monitor_.latencymonitor.html
new file mode 100644
index 00000000..51486786
--- /dev/null
+++ b/classes/_connection_manager_latency_monitor_.latencymonitor.html
@@ -0,0 +1,1095 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Connection
+ Re-exports ConnectionManagerOptions
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Private _auto
+
+
+
+
+
+ _auto
+
+
+
+
+
+ Private _check
+
+
+
+
+
+ Private _check
+
+
+
+
+
+ _latency
+
+
+
+
+
+
+
+
+ Private _maybe
+
+
+
+
+
+ Private _on
+
+
+
+
+
+
+
+
+ _peer
+
+
+
+
+
+ _peer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Static default
+
+
+
+
+
+ Static Readonly error
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+
+
+
+ event
+
+
+
+
+
+
+ get
+
+
+
+ get
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+ on
+
+
+
+ on
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+ raw
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+ Static listener
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ EventEmitter
+
-
+
- + ConnectionManager + +
+
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Connection +
- Connection
Manager Options
+ - Libp2p +
Constructors
+-
+
- constructor +
Properties
+-
+
- _auto
Dial
+ - _auto
Dial Timeout
+ - _check
Max Limit
+ - _check
Metrics
+ - _latency
Monitor
+ - _libp2p +
- _maybe
Disconnect One
+ - _on
Latency Measure
+ - _options +
- _peer
Id
+ - _peer
Values
+ - _started +
- _timer +
- connections +
- default
Max Listeners
+ - error
Monitor
+
Accessors
+-
+
- size +
Methods
+-
+
- _close +
- add
Listener
+ - emit +
- event
Names
+ - get +
- get
All
+ - get
Max Listeners
+ - listener
Count
+ - listeners +
- off +
- on +
- on
Connect
+ - on
Disconnect
+ - once +
- prepend
Listener
+ - prepend
Once Listener
+ - raw
Listeners
+ - remove
All Listeners
+ - remove
Listener
+ - set
Max Listeners
+ - set
Peer Value
+ - start +
- stop +
- listener
Count
+
References
+Connection
+ Re-exports Connection +ConnectionManagerOptions
+ Re-exports ConnectionManagerOptions
+ Libp2p
+ Re-exports Libp2p +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Responsible for managing known connections.
+Parameters
+-
+
-
+
libp2p: Libp2p
+
+ -
+
Optional options: ConnectionManagerOptions
+++++
+
Returns ConnectionManager
+
+ -
+
Properties
+Private _autoDial
+
+
+
+
+
+
+
+ Proactively tries to connect to known peers stored in the PeerStore. + It will keep the number of connections below the upper limit and sort + the peers to connect based on wether we know their keys and protocols.
+_autoDialTimeout
+
+
+ Private _checkMaxLimit
+
+
+
+
+
+
+
+ If the value of name has exceeded its limit, maybe close a connection
Private _checkMetrics
+
+
+
+
+
+
+ Checks the libp2p metrics to determine if any values have exceeded + the configured maximums.
+_latencyMonitor
+
+
+ _libp2p
+ + +Private _maybeDisconnectOne
+
+
+
+
+
+
+ If we have more connections than our maximum, close a connection + to the lowest valued peer.
+Private _onLatencyMeasure
+
+
+
+
+
+
+
+ If the event loop is slow, maybe close a connection
+_options
+ + +_peerId
+
+
+ _peerValues
+
+
+
+
+
+
+ Map of peer identifiers to their peer value for pruning connections.
+_started
+ + +_timer
+ + +connections
+ + +
+
+
+
+ Map of connections per peer
+Static defaultMaxListeners
+
+
+ Static Readonly errorMonitor
+
+
+
+
+
+
+ This symbol shall be used to install a listener for only monitoring 'error'
+ events. Listeners installed using this symbol are called before the regular
+ 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
+ 'error' event is emitted, therefore the process will still crash if no
+ regular 'error' listener is installed.
Accessors
+size
+-
+
+
-
+
-
+
+ ++++
Get current number of open connections.
+Returns number
+
+
Methods
+_close
+-
+
+
-
+
-
+
+ ++++ +
Cleans up the connections
+Returns Promise<void>
+
+
addListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
emit
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
get
+-
+
+
-
+
-
+
+ ++++
Get a connection with a peer.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns Connection | null
+
+ -
+
getAll
+ -
+
+
-
+
-
+
+ ++++
Get all open connections with a peer.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns Connection[]
+
+ -
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
onConnect
+ -
+
+
-
+
-
+
+ ++++
Tracks the incoming connection and check the connection limit
+Parameters
+-
+
-
+
connection: Connection
+
+
Returns void
+
+ -
+
onDisconnect
+ -
+
+
-
+
-
+
+ ++++
Removes the connection from tracking
+Parameters
+-
+
-
+
connection: Connection
+
+
Returns void
+
+ -
+
once
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
setPeerValue
+ -
+
+
-
+
-
+
+ ++++
Sets the value of the given peer. Peers with lower values + will be disconnected first.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
value: number
+++A number between 0 and 1
+
+
Returns void
+
+ -
+
start
+-
+
+
-
+
-
+
+ ++++
Starts the Connection Manager. If Metrics are not enabled on libp2p + only event loop and connection limits will be monitored.
+Returns void
+
+
stop
+-
+
+
-
+
-
+
+ ++++ +
Stops the Connection Manager
+Returns Promise<void>
+
+
Static listenerCount
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
emitter: EventEmitter
+
+ -
+
event: string | symbol
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class LatencyMonitor
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_connection_manager_visibility_change_emitter_.visibilitychangeemitter.html b/classes/_connection_manager_visibility_change_emitter_.visibilitychangeemitter.html
new file mode 100644
index 00000000..6e43514e
--- /dev/null
+++ b/classes/_connection_manager_visibility_change_emitter_.visibilitychangeemitter.html
@@ -0,0 +1,999 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Latency
+ Re-exports LatencyMonitorOptions
+
+
+
+ Summary
+ Re-exports SummaryObject
+
+
+
+
+
+
+
+
+
+
+ Private _check
+
+
+
+
+
+ _check
+
+
+
+
+
+ _emit
+
+
+
+
+
+ Private _emit
+
+
+
+
+
+ _latency
+
+
+
+
+
+ Private _start
+
+
+
+
+
+ Private _stop
+
+
+
+
+
+ Static default
+
+
+
+
+
+ Static Readonly error
+
+
+
+
+
+
+
+ _init
+
+
+
+ add
+
+
+
+
+
+
+ event
+
+
+
+ get
+
+
+
+ get
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+ raw
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+ set
+
+
+
+ Static listener
+
+
+
+
+
+
+
+
+
+ A class to monitor latency of any async function which works in a browser or node. This works by periodically calling + the asyncTestFn and timing how long it takes the callback to be called. It can also periodically emit stats about this. + This can be disabled and stats can be pulled via setting dataEmitIntervalMs = 0.
+Hierarchy
+-
+
-
+ EventEmitter
+
-
+
- + LatencyMonitor + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ References
+ +Constructors
+-
+
- constructor +
Properties
+ +Methods
+-
+
- _init
Latency Data
+ - add
Listener
+ - emit +
- event
Names
+ - get
Max Listeners
+ - get
Summary
+ - listener
Count
+ - listeners +
- off +
- on +
- once +
- prepend
Listener
+ - prepend
Once Listener
+ - raw
Listeners
+ - remove
All Listeners
+ - remove
Listener
+ - set
Max Listeners
+ - listener
Count
+
References
+LatencyMonitorOptions
+ Re-exports LatencyMonitorOptions
+ SummaryObject
+ Re-exports SummaryObject
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
Optional __namedParameters: { asyncTestFn: undefined | Function; dataEmitIntervalMs: undefined | number; latencyCheckIntervalMs: undefined | number; latencyRandomPercentage: undefined | number }
+-
+
-
+
async
+Test Fn: undefined | Function
+ -
+
data
+Emit Interval Ms: undefined | number
+ -
+
latency
+Check Interval Ms: undefined | number
+ -
+
latency
+Random Percentage: undefined | number
+
+ -
+
Returns LatencyMonitor
+
+ -
+
Properties
+Private _checkLatency
+
+
+
+
+
+
+ Randomly calls an async fn every roughly latencyCheckIntervalMs (plus some randomness). If no async fn is found, + it will simply report on event loop latency.
+_checkLatencyID
+
+
+ _emitIntervalID
+
+
+ Private _emitSummary
+
+
+
+
+
+
+ Emit summary only if there were events. It might not have any events if it was forced via a page hidden/show
+_latencyData
+
+
+ Private _startTimers
+
+
+
+
+
+
+ Start internal timers
+Private _stopTimers
+
+
+
+
+
+
+ Stop internal timers
+Static defaultMaxListeners
+
+
+ Static Readonly errorMonitor
+
+
+
+
+
+
+ This symbol shall be used to install a listener for only monitoring 'error'
+ events. Listeners installed using this symbol are called before the regular
+ 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
+ 'error' event is emitted, therefore the process will still crash if no
+ regular 'error' listener is installed.
Methods
+_initLatencyData
+ -
+
+
-
+
-
+
+
Returns { events: number; maxMs: number; minMs: number; startTime: any; totalMs: number }
+-
+
-
+
events: number
+
+ -
+
max
+Ms: number
+ -
+
min
+Ms: number
+ -
+
start
+Time: any
+ -
+
total
+Ms: number
+
+ -
+
addListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
emit
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
getSummary
+ -
+
+
-
+
-
+
+ ++++
Calling this function will end the collection period. If a timing event was already fired and somewhere in the queue, + it will not count for this time period
+Returns SummaryObject
+
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
once
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
Static listenerCount
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
emitter: EventEmitter
+
+ -
+
event: string | symbol
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class VisibilityChangeEmitter
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_content_routing_.contentrouting.html b/classes/_content_routing_.contentrouting.html
new file mode 100644
index 00000000..66534d4c
--- /dev/null
+++ b/classes/_content_routing_.contentrouting.html
@@ -0,0 +1,556 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Private _add
+
+
+
+
+
+ Private _handle
+
+
+
+
+
+
+
+
+ Private _initialize
+
+
+
+
+
+ _visibility
+
+
+
+
+
+ Static default
+
+
+
+
+
+ Static Readonly error
+
+
+
+
+
+
+
+ add
+
+
+
+
+
+
+ event
+
+
+
+ get
+
+
+
+ is
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+ raw
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+ set
+
+
+
+ Static listener
+
+
+
+
+
+
+
+
+ Listen to page visibility change events (i.e. when the page is focused / blurred) by an event emitter.
+Warning: This does not work on all browsers, but should work on all modern browsers
+ +Hierarchy
+-
+
-
+ EventEmitter
+
-
+
- + VisibilityChangeEmitter + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Methods
+-
+
- add
Listener
+ - emit +
- event
Names
+ - get
Max Listeners
+ - is
Visible
+ - listener
Count
+ - listeners +
- off +
- on +
- once +
- prepend
Listener
+ - prepend
Once Listener
+ - raw
Listeners
+ - remove
All Listeners
+ - remove
Listener
+ - set
Max Listeners
+ - listener
Count
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional options: EventEmitterOptions
+
+
Returns VisibilityChangeEmitter
+
+ -
+
Properties
+Private _addVisibilityChangeListener
+
+
+
+
+
+
+ Adds an event listener on the document that listens to changes in document.visibilityChange + (or whatever name by which the visibilityChange variable is known in the browser)
+Private _handleVisibilityChange
+
+
+
+
+
+
+ The function that is called when document.visibilityChange has changed + It emits an event called visibilityChange and sends the value of document.hidden as a + parameter
+_hidden
+ + +Private _initializeVisibilityVarNames
+
+
+
+
+
+
+ document.hidden and document.visibilityChange are the two variables we need to check for; + Since these variables are named differently in different browsers, this function sets + the appropriate name based on the browser being used. Once executed, tha actual names of + document.hidden and document.visibilityChange are found in this._hidden and this._visibilityChange + respectively
+_visibilityChange
+
+
+ Static defaultMaxListeners
+
+
+ Static Readonly errorMonitor
+
+
+
+
+
+
+ This symbol shall be used to install a listener for only monitoring 'error'
+ events. Listeners installed using this symbol are called before the regular
+ 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
+ 'error' event is emitted, therefore the process will still crash if no
+ regular 'error' listener is installed.
Methods
+addListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
emit
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
isVisible
+ -
+
+
-
+
-
+
+ ++++
The function returns
+trueif the page is visible orfalseif the page is not visible and +undefinedif the page visibility API is not supported by the browser.Returns boolean | void
+whether the page is now visible or not (undefined is unknown)
+
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
once
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
Static listenerCount
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
emitter: EventEmitter
+
+ -
+
event: string | symbol
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class ContentRouting
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_dialer_dial_request_.dialrequest.html b/classes/_dialer_dial_request_.dialrequest.html
new file mode 100644
index 00000000..fc3605df
--- /dev/null
+++ b/classes/_dialer_dial_request_.dialrequest.html
@@ -0,0 +1,488 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get
+ Re-exports GetData
+
+
+
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ find
+
+
+
+
+
+
+ get
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + ContentRouting + +
Index
+References
+CID
+ Re-exports CID +GetData
+ Re-exports GetData
+ Multiaddr
+ Re-exports Multiaddr +PeerId
+ Re-exports PeerId
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
libp2p: Libp2p
+++++
+
Returns ContentRouting
+
+ -
+
Properties
+dht
+ + +libp2p
+ + +routers
+ + +Methods
+findProviders
+ -
+
+
-
+
-
+
+ ++++
Iterates over all content routers in series to find providers of the given key. + Once a content router succeeds, iteration will stop.
+Parameters
+-
+
-
+
key: CID
+++The CID key of the content to find
+
+ -
+
Optional options: { maxNumProviders?: number | undefined; timeout?: number | undefined } | undefined
+
+
Returns AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>
++
+}
+
+ -
+
get
+-
+
+
-
+
-
+
+ ++++
Get the value to the given key. + Times out after 1 minute by default.
+Parameters
+-
+
-
+
key: Uint8Array
+
+ -
+
Optional options: { timeout?: number | undefined } | undefined
+
+
Returns Promise<GetData>
+
+ -
+
getMany
+ -
+
+
-
+
-
+
+ ++++
Get the
+nvalues to the given key without sorting.Parameters
+-
+
-
+
key: Uint8Array
+
+ -
+
nVals: number
+
+ -
+
Optional options: { timeout?: number | undefined } | undefined
+
+
Returns Promise<GetData[]>
+
+ -
+
provide
+-
+
+
-
+
-
+
+ ++++
Iterates over all content routers in parallel to notify it is + a provider of the given key.
+Parameters
+-
+
-
+
key: CID
+++The CID key of the content to find
+
+
Returns Promise<void>
+
+ -
+
put
+-
+
+
-
+
-
+
+ ++++
Store the given key/value pair in the DHT.
+Parameters
+-
+
-
+
key: Uint8Array
+
+ -
+
value: Uint8Array
+
+ -
+
Optional options: { minPeers?: number | undefined } | undefined
+
+
Returns Promise<void>
+
+ -
+
+
+
+
+
+ Class DialRequest
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_dialer_index_.dialer.html b/classes/_dialer_index_.dialer.html
new file mode 100644
index 00000000..c77015d4
--- /dev/null
+++ b/classes/_dialer_index_.dialer.html
@@ -0,0 +1,814 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dial
+ Re-exports DialOptions
+
+
+
+ Dial
+ Re-exports DialRequestOptions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dial
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + DialRequest + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Connection +
- Dial
Options
+ - Dial
Request Options
+ - Dialer +
- Multiaddr +
Constructors
+-
+
- constructor +
Properties
+-
+
- addrs +
- dial
Action
+ - dialer +
Methods
+-
+
- run +
References
+Connection
+ Re-exports Connection +DialOptions
+ Re-exports DialOptions
+ DialRequestOptions
+ Re-exports DialRequestOptions
+ Dialer
+ Re-exports Dialer +Multiaddr
+ Re-exports Multiaddr +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Manages running the
+dialActionon multiple providedaddrsin parallel + up to a maximum determined by the number of tokens returned + fromdialer.getTokens. Once a DialRequest is created, it can be + started usingDialRequest.run(options). Once a single dial has succeeded, + all other dials in the request will be cancelled.Parameters
+-
+
-
+
__namedParameters: { addrs: Multiaddr[]; dialAction: (m: Multiaddr, options: DialOptions) => Promise<Connection>; dialer: Dialer }
+-
+
-
+
addrs: Multiaddr[]
+
+ -
+
dial
+Action: (m: Multiaddr, options: DialOptions) => Promise<Connection> -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
m: Multiaddr
+
+ -
+
options: DialOptions
+
+
Returns Promise<Connection>
+
+ -
+
+ -
+
+ -
+
-
+
dialer: Dialer
+
+
+ -
+
Returns DialRequest
+
+ -
+
Properties
+addrs
+ + +dialAction
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
m: Multiaddr
+
+ -
+
options: DialOptions
+
+
Returns Promise<Connection>
+
+ -
+
+ -
+
dialer
+ + +Methods
+run
+-
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
Optional options: { signal?: AbortSignal | undefined } | undefined
+
+
Returns Promise<Connection>
+
+ -
+
+
+
+
+
+ Class Dialer
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_identify_index_.identifyservice.html b/classes/_identify_index_.identifyservice.html
new file mode 100644
index 00000000..1dcaa571
--- /dev/null
+++ b/classes/_identify_index_.identifyservice.html
@@ -0,0 +1,619 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dial
+ Re-exports DialTarget
+
+
+
+ Dialer
+ Re-exports DialerOptions
+
+
+
+ Dialer
+ Re-exports DialerProperties
+
+
+
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+ Pending
+ Re-exports PendingDial
+
+
+
+
+
+
+ Transport
+ Re-exports TransportManager
+
+
+
+
+
+
+
+
+
+
+ Private _create
+
+
+
+
+
+ Private _create
+
+
+
+
+
+ _pending
+
+
+
+
+
+ address
+
+
+
+
+
+
+
+
+
+ peer
+
+
+
+
+
+ per
+
+
+
+
+
+
+
+
+
+
+
+ transport
+
+
+
+
+
+
+
+
+
+
+ _resolve
+
+
+
+ connect
+
+
+
+
+
+
+ get
+
+
+
+ release
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + Dialer + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Address +
- Connection +
- Dial
Target
+ - Dialer
Options
+ - Dialer
Properties
+ - Multiaddr +
- Peer
Id
+ - Peer
Store
+ - Pending
Dial
+ - Resolver +
- Transport
Manager
+
Constructors
+-
+
- constructor +
Properties
+-
+
- _create
Dial Target
+ - _create
Pending Dial
+ - _pending
Dials
+ - address
Sorter
+ - concurrency +
- peer
Store
+ - per
Peer Limit
+ - timeout +
- tokens +
- transport
Manager
+
Methods
+-
+
- _resolve +
- _resolve
Record
+ - connect
ToPeer
+ - destroy +
- get
Tokens
+ - release
Token
+
References
+Address
+ Re-exports Address +Connection
+ Re-exports Connection +DialTarget
+ Re-exports DialTarget
+ DialerOptions
+ Re-exports DialerOptions
+ DialerProperties
+ Re-exports DialerProperties
+ Multiaddr
+ Re-exports Multiaddr +PeerId
+ Re-exports PeerId
+ PeerStore
+ Re-exports PeerStore
+ PendingDial
+ Re-exports PendingDial
+ Resolver
+ Re-exports Resolver +TransportManager
+ Re-exports TransportManager
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
__namedParameters: { addressSorter: undefined | ((addresses: Address[]) => Address[]); concurrency: undefined | number; peerStore: PeerStore; perPeerLimit: undefined | number; resolvers: undefined | Record<string, (addr: Multiaddr) => Promise<string[]>>; timeout: undefined | number; transportManager: TransportManager }
+-
+
-
+
address
+Sorter: undefined | ((addresses: Address[]) => Address[])
+ -
+
concurrency: undefined | number
+
+ -
+
peer
+Store: PeerStore
+ -
+
per
+Peer Limit: undefined | number
+ -
+
resolvers: undefined | Record<string, (addr: Multiaddr) => Promise<string[]>>
+
+ -
+
timeout: undefined | number
+
+ -
+
transport
+Manager: TransportManager
+
+ -
+
Returns Dialer
+
+ -
+
Properties
+Private _createDialTarget
+
+
+
+
+
+
+
+ Creates a DialTarget. The DialTarget is used to create and track + the DialRequest to a given peer. + If a multiaddr is received it should be the first address attempted.
+Private _createPendingDial
+
+
+
+
+
+
+
+ Creates a PendingDial that wraps the underlying DialRequest
+_pendingDials
+
+
+ addressSorter
+
+
+
+ concurrency
+ + +peerStore
+
+
+ perPeerLimit
+
+
+ timeout
+ + +tokens
+ + +transportManager
+
+
+ Methods
+_resolve
+-
+
+
_resolveRecord
+ -
+
+
connectToPeer
+ -
+
+
-
+
-
+
+ ++++
Connects to a given
+peerby dialing all of its known addresses. + The dial to the first address that is successfully able to upgrade a connection + will be used.Parameters
+-
+
-
+
peer: PeerId | Multiaddr | string
+++The peer to dial
+
+ -
+
Optional options: { signal?: AbortSignal | undefined } | undefined
+
+
Returns Promise<Connection>
+
+ -
+
destroy
+-
+
+
-
+
-
+
+ ++++
Clears any pending dials
+Returns void
+
+
getTokens
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
num: any
+
+
Returns number[]
+
+ -
+
releaseToken
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
token: any
+
+
Returns void
+
+ -
+
+
+
+
+
+ Class IdentifyService
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_keychain_cms_.cms.html b/classes/_keychain_cms_.cms.html
new file mode 100644
index 00000000..46902ca8
--- /dev/null
+++ b/classes/_keychain_cms_.cms.html
@@ -0,0 +1,379 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Muxed
+ Re-exports MuxedStream
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Private _handle
+
+
+
+
+
+ Private _handle
+
+
+
+
+
+
+
+
+
+
+
+ connection
+
+
+
+
+
+ peer
+
+
+
+
+
+ peer
+
+
+
+
+
+
+
+ handle
+
+
+
+
+
+
+
+
+
+ push
+
+
+
+ Static get
+
+
+
+
+
+
+ Hierarchy
+-
+
- + IdentifyService + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Connection +
- Messsage +
- Muxed
Stream
+ - multicodecs +
Constructors
+-
+
- constructor +
Properties
+-
+
- _handle
Identify
+ - _handle
Push
+ - _host +
- _libp2p +
- connection
Manager
+ - peer
Id
+ - peer
Store
+
Methods
+-
+
- handle
Message
+ - identify +
- push +
- push
ToPeer Store
+ - get
Clean Multiaddr
+
References
+Connection
+ Re-exports Connection +Messsage
+ Renames and exports Message +MuxedStream
+ Re-exports MuxedStream
+ multicodecs
+ Re-exports multicodecs +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+ +Returns IdentifyService
+
+
Properties
+Private _handleIdentify
+
+
+
+
+
+
+
+ Sends the Identify response with the Signed Peer Record
+ to the requesting peer over the given connection
Private _handlePush
+
+
+
+
+
+
+
+ Reads the Identify Push message from the given connection
_host
+ + +_libp2p
+ + +connectionManager
+
+
+ peerId
+
+
+ peerStore
+
+
+ Methods
+handleMessage
+ -
+
+
-
+
-
+
+ ++++
A handler to register with Libp2p to process identify messages.
+Parameters
+-
+
-
+
__namedParameters: { connection: Connection; protocol: string; stream: MuxedStream }
+-
+
-
+
connection: Connection
+
+ -
+
protocol: string
+
+ -
+
stream: MuxedStream
+
+
+ -
+
Returns Promise<void> | undefined
+
+ -
+
identify
+-
+
+
-
+
-
+
+ ++++ +
Requests the
+Identifymessage from peer associated with the givenconnection. + If the identified peer does not match thePeerIdassociated with the connection, + an error will be thrown.Parameters
+-
+
-
+
connection: Connection
+
+
Returns Promise<void>
+
+ -
+
push
+-
+
+
-
+
-
+
+ ++++
Send an Identify Push update to the list of connections
+Parameters
+-
+
-
+
connections: Connection[]
+
+
Returns Promise<void[]>
+
+ -
+
pushToPeerStore
+ -
+
+
-
+
-
+
+ ++++
Calls
+pushfor all peers in thepeerStorethat are connectedReturns void
+
+
Static getCleanMultiaddr
+ -
+
+
-
+
-
+
+ ++++
Takes the
+addrand converts it to a Multiaddr if possibleParameters
+-
+
-
+
addr: Uint8Array | string
+
+
Returns Multiaddr | null
+
+ -
+
+
+
+
+
+ Class CMS
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_keychain_index_.keychain.html b/classes/_keychain_index_.keychain.html
new file mode 100644
index 00000000..7e626b3b
--- /dev/null
+++ b/classes/_keychain_index_.keychain.html
@@ -0,0 +1,758 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Cryptographic Message Syntax (aka PKCS #7)
+CMS describes an encapsulation syntax for data protection. It + is used to digitally sign, digest, authenticate, or encrypt + arbitrary message content.
+See RFC 5652 for all the details.
+Hierarchy
+-
+
- + CMS + +
Index
+Constructors
+constructor
+-
+
+
Properties
+keychain
+ + +Methods
+decrypt
+-
+
+
-
+
-
+
+ ++++
Reads some protected data.
+The keychain must contain one of the keys used to encrypt the data. If none of the keys + exists, an Error is returned with the property 'missingKeys'. It is array of key ids.
+Parameters
+-
+
-
+
cmsData: Uint8Array
+++The CMS encrypted data to decrypt.
+
+
Returns Promise<Uint8Array>
+
+ -
+
encrypt
+-
+
+
-
+
-
+
+ ++++
Creates some protected data.
+The output Uint8Array contains the PKCS #7 message in DER.
+Parameters
+-
+
-
+
name: string
+++The local key name.
+
+ -
+
plain: Uint8Array
+++The data to encrypt.
+
+
Returns Promise<Uint8Array>
+
+ -
+
+
+
+
+
+ Class Keychain
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_metrics_index_.metrics.html b/classes/_metrics_index_.metrics.html
new file mode 100644
index 00000000..d1d32d12
--- /dev/null
+++ b/classes/_metrics_index_.metrics.html
@@ -0,0 +1,808 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Key
+ Re-exports KeyInfo
+
+
+
+
+
+
+
+
+
+
+ Private _get
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ create
+
+
+
+ export
+
+
+
+ find
+
+
+
+ find
+
+
+
+ import
+
+
+
+ import
+
+
+
+ list
+
+
+
+ remove
+
+
+
+ rename
+
+
+
+ Static generate
+
+
+
+
+
+
+
+
+ Manages the lifecycle of a key. Keys are encrypted at rest using PKCS #8.
+A key in the store has two entries
+-
+
- '/info/key-name', contains the KeyInfo for the key +
- '/pkcs8/key-name', contains the PKCS #8 for the key +
Hierarchy
+-
+
- + Keychain + +
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Key
Info
+
Constructors
+-
+
- constructor +
Properties
+-
+
- _get
Private Key
+ - opts +
- store +
Accessors
+ +Methods
+-
+
- create
Key
+ - export
Key
+ - find
Key ById
+ - find
Key ByName
+ - import
Key
+ - import
Peer
+ - list
Keys
+ - remove
Key
+ - rename
Key
+ - generate
Options
+
References
+KeyInfo
+ Re-exports KeyInfo
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates a new instance of a key chain.
+Parameters
+-
+
-
+
store: any
+++++where the key are.
+
+ -
+
options: object
+
+
Returns Keychain
+
+ -
+
Properties
+Private _getPrivateKey
+
+
+
+
+
+
+
+ Gets the private key as PEM encoded PKCS #8 string.
+opts
+ + +store
+ + +Accessors
+cms
+-
+
+
-
+
-
+
+ ++++
Gets an object that can encrypt/decrypt protected data + using the Cryptographic Message Syntax (CMS).
+CMS describes an encapsulation syntax for data protection. It + is used to digitally sign, digest, authenticate, or encrypt + arbitrary message content.
+Returns CMS
+
+
Static options
+-
+
+
-
+
-
+
+ ++++
Gets an object that can encrypt/decrypt protected data. + The default options for a keychain.
+Returns any
+
+
Methods
+createKey
+ -
+
+
-
+
-
+
+ ++++
Create a new key.
+Parameters
+-
+
-
+
name: string
+++The local key name; cannot already exist.
+
+ -
+
type: string
+++One of the key types; 'rsa'.
+
+ -
+
Optional size: any
+
+
Returns KeyInfo
+
+ -
+
exportKey
+ -
+
+
-
+
-
+
+ ++++
Export an existing key as a PEM encrypted PKCS #8 string
+Parameters
+-
+
-
+
name: string
+++The local key name; must already exist.
+
+ -
+
password: string
+++The password
+
+
Returns string
+
+ -
+
findKeyById
+ -
+
+
-
+
-
+
+ ++++
Find a key by it's id.
+Parameters
+-
+
-
+
id: string
+++The universally unique key identifier.
+
+
Returns KeyInfo
+
+ -
+
findKeyByName
+ -
+
+
-
+
-
+
+ ++++
Find a key by it's name.
+Parameters
+-
+
-
+
name: string
+++The local key name.
+
+
Returns KeyInfo
+
+ -
+
importKey
+ -
+
+
-
+
-
+
+ ++++
Import a new key from a PEM encoded PKCS #8 string
+Parameters
+-
+
-
+
name: string
+++The local key name; must not already exist.
+
+ -
+
pem: string
+++The PEM encoded PKCS #8 string
+
+ -
+
password: string
+++The password.
+
+
Returns KeyInfo
+
+ -
+
importPeer
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
name: any
+
+ -
+
peer: any
+
+
Returns Promise<void | { id: any; name: any }>
+
+ -
+
listKeys
+ -
+
+
-
+
-
+
+ ++++
List all the keys.
+Returns KeyInfo[]
+
+
removeKey
+ -
+
+
-
+
-
+
+ ++++
Remove an existing key.
+Parameters
+-
+
-
+
name: string
+++The local key name; must already exist.
+
+
Returns KeyInfo
+
+ -
+
renameKey
+ -
+
+
-
+
-
+
+ ++++
Rename a key
+Parameters
+-
+
-
+
oldName: string
+++The old local key name; must already exist.
+
+ -
+
newName: string
+++The new local key name; must not already exist.
+
+
Returns KeyInfo
+
+ -
+
Static generateOptions
+ -
+
+
-
+
-
+
+ ++++
Generates the options for a keychain. A random salt is produced.
+Returns object
+
+
+
+
+
+
+ Class Metrics
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_metrics_stats_.stats.html b/classes/_metrics_stats_.stats.html
new file mode 100644
index 00000000..aae850bd
--- /dev/null
+++ b/classes/_metrics_stats_.stats.html
@@ -0,0 +1,1279 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Metrics
+ Re-exports MetricsOptions
+
+
+
+ Metrics
+ Re-exports MetricsProperties
+
+
+
+ Multiaddr
+ Re-exports MultiaddrConnection
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+
+
+
+
+
+
+
+ _connection
+
+
+
+
+
+ _global
+
+
+
+
+
+ _old
+
+
+
+
+
+ Private _on
+
+
+
+
+
+
+
+
+ _peer
+
+
+
+
+
+ _protocol
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ for
+
+
+
+ for
+
+
+
+ on
+
+
+
+
+
+
+
+
+
+ track
+
+
+
+ update
+
+
+
+ Static merge
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + Metrics + +
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+ +Constructors
+-
+
- constructor +
Properties
+-
+
- _connection
Manager
+ - _global
Stats
+ - _old
Peers
+ - _on
Message
+ - _options +
- _peer
Stats
+ - _protocol
Stats
+ - _running +
Accessors
+ +Methods
+-
+
- for
Peer
+ - for
Protocol
+ - on
Peer Disconnected
+ - start +
- stop +
- track
Stream
+ - update
Placeholder
+ - merge
Stats
+
References
+MetricsOptions
+ Re-exports MetricsOptions
+ MetricsProperties
+ Re-exports MetricsProperties
+ MultiaddrConnection
+ Re-exports MultiaddrConnection
+ PeerId
+ Re-exports PeerId
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
options: MetricsProperties & MetricsOptions
+++++
+
Returns Metrics
+
+ -
+
Properties
+_connectionManager
+
+
+ _globalStats
+
+
+ _oldPeers
+
+
+ Private _onMessage
+
+
+
+
+
+
+
+ Takes the metadata for a message and tracks it in the + appropriate categories. If the protocol is present, protocol + stats will also be tracked.
+_options
+ + +_peerStats
+
+
+ _protocolStats
+
+
+ _running
+ + +Accessors
+global
+-
+
+
-
+
-
+
+ ++++
Gets the global
+StatsobjectReturns Stats
+
+
peers
+-
+
+
-
+
-
+
+ ++++
Returns a list of
+PeerIdstrings currently being trackedReturns string[]
+
+
protocols
+-
+
+
-
+
-
+
+ ++++
Returns a list of all protocol strings currently being tracked.
+Returns string[]
+
+
Methods
+forPeer
+ -
+
+
forProtocol
+ -
+
+
-
+
-
+
+ ++++
Returns the
+Statsobject for the givenprotocol.Parameters
+-
+
-
+
protocol: string
+
+
Returns Stats
+
+ -
+
onPeerDisconnected
+ -
+
+
-
+
-
+
+ ++++
Should be called when all connections to a given peer + have closed. The
+Statscollection for the peer will + be stopped and moved to an LRU for temporary retention.Parameters
+-
+
-
+
peerId: PeerId
+++
+
Returns void
+
+ -
+
start
+-
+
+
-
+
-
+
+ ++++
Must be called for stats to saved. Any data pushed for tracking + will be ignored.
+Returns void
+
+
stop
+-
+
+
-
+
-
+
+ ++++
Stops all averages timers and prevents new data from being tracked. + Once
+stopis called,startmust be called to resume stats tracking.Returns void
+
+
trackStream
+ -
+
+
-
+
-
+
+ ++++
Tracks data running through a given Duplex Iterable
+stream. If + thepeerIdis not provided, a placeholder string will be created and + returned. This allows lazy tracking of a peer when the peer is not yet known. + When thePeerIdis known,Metrics.updatePlaceholdershould be called + with the placeholder string returned from here, and the knownPeerId.Parameters
+-
+
-
+
__namedParameters: { protocol: undefined | string; remotePeer: undefined | PeerId; stream: MultiaddrConnection }
+-
+
-
+
protocol: undefined | string
+
+ -
+
remote
+Peer: undefined | PeerId
+ -
+
stream: MultiaddrConnection
+
+
+ -
+
Returns MultiaddrConnection
+The peerId string or placeholder string
+
+ -
+
updatePlaceholder
+ -
+
+
Static mergeStats
+ -
+
+
+
+
+
+
+ Class Stats
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_peer_routing_.peerrouting.html b/classes/_peer_routing_.peerrouting.html
new file mode 100644
index 00000000..39ee430e
--- /dev/null
+++ b/classes/_peer_routing_.peerrouting.html
@@ -0,0 +1,516 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Private _apply
+
+
+
+
+
+ _frequency
+
+
+
+
+
+ _frequency
+
+
+
+
+
+ _moving
+
+
+
+
+
+ Private _next
+
+
+
+
+
+
+
+
+
+
+
+ Private _reset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Private _update
+
+
+
+
+
+ Private _update
+
+
+
+
+
+ Static default
+
+
+
+
+
+ Static Readonly error
+
+
+
+
+
+
+
+ moving
+
+
+
+
+
+
+
+
+ add
+
+
+
+
+
+
+ event
+
+
+
+ get
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+
+
+
+ raw
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+
+
+
+ Static listener
+
+
+
+
+ Hierarchy
+-
+
-
+ EventEmitter
+
-
+
- + Stats + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Accessors
+-
+
- moving
Averages
+ - snapshot +
Methods
+-
+
- add
Listener
+ - emit +
- event
Names
+ - get
Max Listeners
+ - listener
Count
+ - listeners +
- off +
- on +
- once +
- prepend
Listener
+ - prepend
Once Listener
+ - push +
- raw
Listeners
+ - remove
All Listeners
+ - remove
Listener
+ - set
Max Listeners
+ - start +
- stop +
- toJSON +
- listener
Count
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
A queue based manager for stat processing
+Parameters
+-
+
-
+
initialCounters: string[]
+
+ -
+
options: any
+++++
+
Returns Stats
+
+ -
+
Properties
+Private _applyOp
+
+
+
+
+
+
+
+ For the given operation, op, the stats and frequencyAccumulator
+ will be updated or initialized if they don't already exist.
_frequencyAccumulators
+
+
+
+
+ Type declaration
+-
+
_frequencyLastTime
+
+
+ _movingAverages
+
+
+
+
+ Type declaration
+-
+
Private _nextTimeout
+
+
+
+
+
+
+
+ Calculates and returns the timeout for the next update based on + the urgency of the update.
+_options
+ + +_queue
+ + +Private _resetComputeTimeout
+
+
+
+
+
+
+
+ Resets the timeout for triggering updates.
+_stats
+ + +
+
+ Type declaration
+-
+
_timeout
+ + +Private _update
+ + +
+
+
+
+ If there are items in the queue, they will will be processed and
+ the frequency for all items will be updated based on the Timestamp
+ of the last item in the queue. The update event will also be emitted
+ with the latest stats.
If there are no items in the queue, no action is taken.
+ +Private _updateFrequency
+
+
+
+
+
+
+
+ For each key in the stats, the frequency and moving averages + will be updated via Stats._updateFrequencyFor based on the time + difference between calls to this method.
+Private _updateFrequencyFor
+
+
+
+
+
+
+
+ Updates the movingAverages for the given key and also
+ resets the frequencyAccumulator for the key.
Static defaultMaxListeners
+
+
+ Static Readonly errorMonitor
+
+
+
+
+
+
+ This symbol shall be used to install a listener for only monitoring 'error'
+ events. Listeners installed using this symbol are called before the regular
+ 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
+ 'error' event is emitted, therefore the process will still crash if no
+ regular 'error' listener is installed.
Accessors
+movingAverages
+ -
+
+
-
+
-
+
+ ++++
Returns a clone of the internal movingAverages
+Returns any
+
+
snapshot
+-
+
+
-
+
-
+
+ ++++
Returns a clone of the current stats.
+Returns any
+
+
Methods
+addListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
emit
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
once
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
push
+-
+
+
-
+
-
+
+ ++++
Pushes the given operation data to the queue, along with the + current Timestamp, then resets the update timer.
+Parameters
+-
+
-
+
counter: string
+
+ -
+
inc: number
+
+
Returns void
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
start
+-
+
+
-
+
-
+
+ ++++
Initializes the internal timer if there are items in the queue. This + should only need to be called if
+Stats.stopwas previously called, as +Stats.pushwill also start the processing.Returns void
+
+
stop
+-
+
+
-
+
-
+
+ ++++
Stops processing and computing of stats by clearing the internal + timer.
+Returns void
+
+
toJSON
+-
+
+
-
+
-
+
+ ++++
Returns a plain JSON object of the stats
+Returns any
+
+
Static listenerCount
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
emitter: EventEmitter
+
+ -
+
event: string | symbol
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class PeerRouting
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_peer_store_address_book_.addressbook.html b/classes/_peer_store_address_book_.addressbook.html
new file mode 100644
index 00000000..7e0a1ae2
--- /dev/null
+++ b/classes/_peer_store_address_book_.addressbook.html
@@ -0,0 +1,823 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+
+
+
+
+
+
+
+ _peer
+
+
+
+
+
+ _peer
+
+
+
+
+
+ _refresh
+
+
+
+
+
+
+
+
+ _timeout
+
+
+
+
+
+
+
+ _find
+
+
+
+ find
+
+
+
+ get
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + PeerRouting + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+ +Constructors
+-
+
- constructor +
Properties
+-
+
- _peer
Id
+ - _peer
Store
+ - _refresh
Manager Options
+ - _routers +
- _timeout
Id
+
Methods
+-
+
- _find
Closest Peers Task
+ - find
Peer
+ - get
Closest Peers
+ - start +
- stop +
References
+Multiaddr
+ Re-exports Multiaddr +PeerId
+ Re-exports PeerId
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
libp2p: Libp2p
+++++
+
Returns PeerRouting
+
+ -
+
Properties
+_peerId
+
+
+ _peerStore
+
+
+ _refreshManagerOptions
+
+
+ _routers
+ + +_timeoutId
+
+
+ Methods
+_findClosestPeersTask
+ -
+
+
-
+
-
+
+ ++++
Recurrent task to find closest peers and add their addresses to the Address Book.
+Returns Promise<void>
+
+
findPeer
+ -
+
+
getClosestPeers
+ -
+
+
start
+-
+
+
-
+
-
+
+ ++++
Start peer routing service.
+Returns void
+
+
stop
+-
+
+
-
+
-
+
+ ++++
Stop peer routing service.
+Returns void
+
+
+
+
+
+
+ Class AddressBook
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_peer_store_book_.book.html b/classes/_peer_store_book_.book.html
new file mode 100644
index 00000000..f7da7849
--- /dev/null
+++ b/classes/_peer_store_book_.book.html
@@ -0,0 +1,586 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Certified
+ Re-exports CertifiedRecord
+
+
+
+
+
+
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Private _to
+
+
+
+
+
+
+
+
+ event
+
+
+
+
+
+ event
+
+
+
+
+
+ event
+
+
+
+
+
+
+
+
+
+
+ Protected _set
+
+
+
+
+
+
+ consume
+
+
+
+
+
+
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Book
+
-
+
- + AddressBook + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ References
+ +Constructors
+-
+
- constructor +
Properties
+-
+
- _ps +
- _to
Addresses
+ - data +
- event
Name
+ - event
Property
+ - event
Transformer
+
Methods
+-
+
- _emit +
- _set
Data
+ - add +
- consume
Peer Record
+ - delete +
- get +
- get
Multiaddrs For Peer
+ - get
Peer Record
+ - get
Raw Envelope
+ - set +
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
+-
+
+
-
+
-
+
+ ++++
The AddressBook is responsible for keeping the known multiaddrs of a peer.
+Parameters
+-
+
-
+
peerStore: PeerStore
+++++
+
Returns AddressBook
+
+ -
+
Properties
+_ps
+ + +Private _toAddresses
+
+
+
+
+
+
+
+ Transforms received multiaddrs into Address.
+data
+ + +
+
+
+
+ Map known peers to their data.
+eventName
+
+
+ eventProperty
+
+
+ eventTransformer
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns any[]
+
+ -
+
+ -
+
Methods
+Protected _emit
+-
+
+
-
+
-
+
+ ++++
Emit data.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
Optional data: any
+
+
Returns void
+
+ -
+
Protected _setData
+ -
+
+
-
+
-
+
+ ++++
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 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
+-
+
-
+
envelope: Envelope
+
+
Returns boolean
+
+ -
+
delete
+-
+
+
-
+
-
+
+ ++++
Deletes the provided peer from the book.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns boolean
+
+ -
+
get
+-
+
+
-
+
-
+
+ ++++
Get the known data of a provided peer. + Returns
+undefinedif there is no available data for the given peer.Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns any[] | any | undefined
+
+ -
+
getMultiaddrsForPeer
+ -
+
+
-
+
-
+
+ ++++
Get the known multiaddrs for a given peer. All returned multiaddrs + will include the encapsulated
+PeerIdof the peer. + Returnsundefinedif there are no known multiaddrs for the given peer.Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
Optional addressSorter: ((addresses: Address[]) => Address[]) | undefined
+
+
Returns Multiaddr[] | undefined
+
+ -
+
getPeerRecord
+ -
+
+
getRawEnvelope
+ -
+
+
-
+
-
+
+ ++++
Get the raw Envelope for a peer. Returns + undefined if no Envelope is found.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns Uint8Array | undefined
+
+ -
+
set
+-
+
+
-
+
-
+
+ ++++
Set known data of a provided peer.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
data: any[] | any
+++
+
Returns void
+
+ -
+
+
+
+
+
+ Class Book
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_peer_store_index_.peerstore.html b/classes/_peer_store_index_.peerstore.html
new file mode 100644
index 00000000..bc0ca0c5
--- /dev/null
+++ b/classes/_peer_store_index_.peerstore.html
@@ -0,0 +1,1130 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ event
+
+
+
+
+
+ event
+
+
+
+
+
+ event
+
+
+
+
+
+
+
+
+
+
+ Protected _set
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Book
+
-
+
- + AddressBook + +
- + KeyBook + +
- + MetadataBook + +
- + ProtoBook + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Peer
Store
+
Constructors
+-
+
- constructor +
Properties
+-
+
- _ps +
- data +
- event
Name
+ - event
Property
+ - event
Transformer
+
Methods
+ +References
+PeerStore
+ Re-exports PeerStore
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
The Book is the skeleton for the PeerStore books.
+Parameters
+-
+
-
+
__namedParameters: { eventName: string; eventProperty: string; eventTransformer: undefined | ((data: any) => any[]); peerStore: PeerStore }
+-
+
-
+
event
+Name: string
+ -
+
event
+Property: string
+ -
+
event
+Transformer: undefined | ((data: any) => any[])
+ -
+
peer
+Store: PeerStore
+
+ -
+
Returns Book
+
+ -
+
Properties
+_ps
+ + +data
+ + +
+
+
+
+ Map known peers to their data.
+eventName
+
+
+ eventProperty
+
+
+ eventTransformer
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns any[]
+
+ -
+
+ -
+
Methods
+Protected _emit
+-
+
+
-
+
-
+
+ ++++
Emit data.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
Optional data: any
+
+
Returns void
+
+ -
+
Protected _setData
+ -
+
+
-
+
-
+
+ ++++
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
+
+ -
+
delete
+-
+
+
-
+
-
+
+ ++++
Deletes the provided peer from the book.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns boolean
+
+ -
+
get
+-
+
+
-
+
-
+
+ ++++
Get the known data of a provided peer. + Returns
+undefinedif there is no available data for the given peer.Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns any[] | any | undefined
+
+ -
+
set
+-
+
+
-
+
-
+
+ ++++
Set known data of a provided peer.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
data: any[] | any
+++
+
Returns void
+
+ -
+
+
+
+
+
+ Class PeerStore
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_peer_store_key_book_.keybook.html b/classes/_peer_store_key_book_.keybook.html
new file mode 100644
index 00000000..5a20c2fc
--- /dev/null
+++ b/classes/_peer_store_key_book_.keybook.html
@@ -0,0 +1,601 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ _peer
+
+
+
+
+
+ address
+
+
+
+
+
+ key
+
+
+
+
+
+ metadata
+
+
+
+
+
+ proto
+
+
+
+
+
+ Static default
+
+
+
+
+
+ Static Readonly error
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ event
+
+
+
+
+
+
+ get
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+ raw
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+ Static listener
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ EventEmitter
+
-
+
- + PeerStore + +
+
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Address +
Constructors
+-
+
- constructor +
Properties
+-
+
- _peer
Id
+ - address
Book
+ - key
Book
+ - metadata
Book
+ - proto
Book
+ - default
Max Listeners
+ - error
Monitor
+
Accessors
+-
+
- peers +
Methods
+-
+
- add
Listener
+ - delete +
- emit +
- event
Names
+ - get +
- get
Max Listeners
+ - listener
Count
+ - listeners +
- off +
- on +
- once +
- prepend
Listener
+ - prepend
Once Listener
+ - raw
Listeners
+ - remove
All Listeners
+ - remove
Listener
+ - set
Max Listeners
+ - start +
- stop +
- listener
Count
+
References
+Address
+ Re-exports Address +Constructors
+constructor
+-
+
+
Properties
+_peerId
+
+
+ addressBook
+
+
+
+
+
+
+ AddressBook containing a map of peerIdStr to Address.
+keyBook
+
+
+
+
+
+
+ KeyBook containing a map of peerIdStr to their PeerId with public keys.
+metadataBook
+
+
+
+
+
+
+ MetadataBook containing a map of peerIdStr to their metadata Map.
+protoBook
+
+
+
+
+
+
+ ProtoBook containing a map of peerIdStr to supported protocols.
+Static defaultMaxListeners
+
+
+ Static Readonly errorMonitor
+
+
+
+
+
+
+ This symbol shall be used to install a listener for only monitoring 'error'
+ events. Listeners installed using this symbol are called before the regular
+ 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
+ 'error' event is emitted, therefore the process will still crash if no
+ regular 'error' listener is installed.
Accessors
+peers
+-
+
+
Methods
+addListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
delete
+-
+
+
-
+
-
+
+ ++++
Delete the information of the given peer in every book.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns boolean
+true if found and removed
+
+ -
+
emit
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
get
+-
+
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
once
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
start
+-
+
+
-
+
-
+
+ ++++
Start the PeerStore.
+Returns void
+
+
stop
+-
+
+
-
+
-
+
+ ++++
Stop the PeerStore.
+Returns void
+
+
Static listenerCount
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
emitter: EventEmitter
+
+ -
+
event: string | symbol
+
+
Returns number
+
+ -
+
+
+
+
+
+ Class KeyBook
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_peer_store_metadata_book_.metadatabook.html b/classes/_peer_store_metadata_book_.metadatabook.html
new file mode 100644
index 00000000..8375b806
--- /dev/null
+++ b/classes/_peer_store_metadata_book_.metadatabook.html
@@ -0,0 +1,707 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+ Public
+ Re-exports PublicKey
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ event
+
+
+
+
+
+ event
+
+
+
+
+
+ event
+
+
+
+
+
+
+
+
+
+
+ Protected _set
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Book
+
-
+
- + KeyBook + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ References
+ +Constructors
+-
+
- constructor +
Properties
+-
+
- _ps +
- data +
- event
Name
+ - event
Property
+ - event
Transformer
+
Methods
+ +References
+PeerStore
+ Re-exports PeerStore
+ PeerStore
+ Re-exports PeerStore
+ PublicKey
+ Re-exports PublicKey
+ Constructors
+constructor
+-
+
+
Properties
+_ps
+ + +data
+ + +
+
+
+
+ Map known peers to their data.
+eventName
+
+
+ eventProperty
+
+
+ eventTransformer
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns any[]
+
+ -
+
+ -
+
Methods
+Protected _emit
+-
+
+
-
+
-
+
+ ++++
Emit data.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
Optional data: any
+
+
Returns void
+
+ -
+
Protected _setData
+ -
+
+
-
+
-
+
+ ++++
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
+
+ -
+
delete
+-
+
+
-
+
-
+
+ ++++
Deletes the provided peer from the book.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns boolean
+
+ -
+
get
+-
+
+
-
+
-
+
+ ++++
Get the known data of a provided peer. + Returns
+undefinedif there is no available data for the given peer.Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns any[] | any | undefined
+
+ -
+
set
+-
+
+
-
+
-
+
+ ++++
Set known data of a provided peer.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
data: any[] | any
+++
+
Returns void
+
+ -
+
+
+
+
+
+ Class MetadataBook
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_peer_store_persistent_index_.persistentpeerstore.html b/classes/_peer_store_persistent_index_.persistentpeerstore.html
new file mode 100644
index 00000000..134071fc
--- /dev/null
+++ b/classes/_peer_store_persistent_index_.persistentpeerstore.html
@@ -0,0 +1,1347 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ event
+
+
+
+
+
+ event
+
+
+
+
+
+ event
+
+
+
+
+
+
+
+
+
+
+ Protected _set
+
+
+
+ _set
+
+
+
+
+
+
+ delete
+
+
+
+
+
+
+ get
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Book
+
-
+
- + MetadataBook + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ References
+ +Constructors
+-
+
- constructor +
Properties
+-
+
- _ps +
- data +
- event
Name
+ - event
Property
+ - event
Transformer
+
Methods
+ +References
+PeerStore
+ Re-exports PeerStore
+ PeerStore
+ Re-exports PeerStore
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
The MetadataBook is responsible for keeping the known supported + protocols of a peer.
+Parameters
+-
+
-
+
peerStore: PeerStore
+++++
+
Returns MetadataBook
+
+ -
+
Properties
+_ps
+ + +data
+ + +
+
+
+
+ Map known peers to their data.
+eventName
+
+
+ eventProperty
+
+
+ eventTransformer
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns any[]
+
+ -
+
+ -
+
Methods
+Protected _emit
+-
+
+
-
+
-
+
+ ++++
Emit data.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
Optional data: any
+
+
Returns void
+
+ -
+
Protected _setData
+ -
+
+
-
+
-
+
+ ++++
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
+
+ -
+
_setValue
+ -
+
+
-
+
-
+
+ ++++ +
Set data into the datastructure
+Parameters
+-
+
-
+
peerId: any
+
+ -
+
key: any
+
+ -
+
value: any
+
+ -
+
Optional __namedParameters: { emit: undefined | false | true }
+-
+
-
+
emit: undefined | false | true
+
+
+ -
+
Returns void
+
+ -
+
delete
+-
+
+
-
+
-
+
+ ++++
Deletes the provided peer from the book.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns boolean
+
+ -
+
deleteValue
+ -
+
+
-
+
-
+
+ ++++
Deletes the provided peer metadata key from the book.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
key: string
+
+
Returns boolean
+
+ -
+
get
+-
+
+
-
+
-
+
+ ++++
Get the known data of a provided peer. + Returns
+undefinedif there is no available data for the given peer.Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns any[] | any | undefined
+
+ -
+
getValue
+ -
+
+
-
+
-
+
+ ++++
Get specific metadata value, if it exists
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
key: string
+
+
Returns Uint8Array | undefined
+
+ -
+
set
+-
+
+
-
+
-
+
+ ++++
Set known data of a provided peer.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
data: any[] | any
+++
+
Returns void
+
+ -
+
+
+
+
+
+ Class PersistentPeerStore
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_peer_store_proto_book_.protobook.html b/classes/_peer_store_proto_book_.protobook.html
new file mode 100644
index 00000000..e49a3046
--- /dev/null
+++ b/classes/_peer_store_proto_book_.protobook.html
@@ -0,0 +1,662 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Persistent
+ Re-exports PersistentPeerStoreOptions
+
+
+
+ Persistent
+ Re-exports PersistentPeerStoreProperties
+
+
+
+
+
+
+
+
+
+
+ Private _add
+
+
+
+
+
+ Private _add
+
+
+
+
+
+ Private _add
+
+
+
+
+
+ Private _batch
+
+
+
+
+
+ Private _batch
+
+
+
+
+
+ Private _batch
+
+
+
+
+
+ Private _batch
+
+
+
+
+
+ Private _commit
+
+
+
+
+
+
+
+
+ _dirty
+
+
+
+
+
+ _dirty
+
+
+
+
+
+ _peer
+
+
+
+
+
+ Private _process
+
+
+
+
+
+ address
+
+
+
+
+
+ key
+
+
+
+
+
+ metadata
+
+
+
+
+
+ proto
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ event
+
+
+
+
+
+
+ get
+
+
+
+ listener
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prepend
+
+
+
+ prepend
+
+
+
+ raw
+
+
+
+ remove
+
+
+
+ remove
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Responsible for managing the persistence of data in the PeerStore.
+Hierarchy
+-
+
-
+ PeerStore
+
-
+
- + PersistentPeerStore + +
+
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+ +Constructors
+-
+
- constructor +
Properties
+ +Accessors
+-
+
- peers +
Methods
+-
+
- add
Listener
+ - delete +
- emit +
- event
Names
+ - get +
- get
Max Listeners
+ - listener
Count
+ - listeners +
- off +
- on +
- once +
- prepend
Listener
+ - prepend
Once Listener
+ - raw
Listeners
+ - remove
All Listeners
+ - remove
Listener
+ - set
Max Listeners
+ - start +
- stop +
References
+Address
+ Re-exports Address +PersistentPeerStoreOptions
+ Re-exports PersistentPeerStoreOptions
+ PersistentPeerStoreProperties
+ Re-exports PersistentPeerStoreProperties
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
__namedParameters: { datastore: any; peerId: PeerId; threshold: undefined | number }
+-
+
-
+
datastore: any
+
+ -
+
peer
+Id: PeerId
+ -
+
threshold: undefined | number
+
+
+ -
+
Returns PersistentPeerStore
+
+ -
+
Properties
+Private _addDirtyPeer
+
+
+
+
+
+
+
+ Add modified peer to the dirty set
+Private _addDirtyPeerKey
+
+
+
+
+
+
+
+ Add modified peer key to the dirty set
+Private _addDirtyPeerMetadata
+
+
+
+
+
+
+
+ Add modified metadata peer to the set.
+Private _batchAddressBook
+
+
+
+
+
+
+
+ Add address book data of the peer to the batch.
+Private _batchKeyBook
+
+
+
+
+
+
+
+ Add Key book data of the peer to the batch.
+Private _batchMetadataBook
+
+
+
+
+
+
+
+ Add metadata book data of the peer to the batch.
+Private _batchProtoBook
+
+
+
+
+
+
+
+ Add proto book data of the peer to the batch.
+Private _commitData
+
+
+
+
+
+
+
+ Add all the peers current data to a datastore batch and commit it.
+_datastore
+ + +
+
+
+
+ Backend datastore used to persist data.
+_dirtyMetadata
+
+
+
+
+
+
+ Peers metadata changed mapping peer identifers to metadata changed.
+_dirtyPeers
+
+
+
+
+
+
+ Peers modified after the latest data persisted.
+_peerId
+
+
+ Private _processDatastoreEntry
+
+
+
+
+
+
+
+ Process datastore entry and add its data to the correct book.
+addressBook
+
+
+
+
+
+
+ AddressBook containing a map of peerIdStr to Address.
+keyBook
+
+
+
+
+
+
+ KeyBook containing a map of peerIdStr to their PeerId with public keys.
+metadataBook
+
+
+
+
+
+
+ MetadataBook containing a map of peerIdStr to their metadata Map.
+protoBook
+
+
+
+
+
+
+ ProtoBook containing a map of peerIdStr to supported protocols.
+threshold
+ + +Accessors
+peers
+-
+
+
Methods
+addListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
delete
+-
+
+
-
+
-
+
+ ++++
Delete the information of the given peer in every book.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns boolean
+true if found and removed
+
+ -
+
emit
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
Rest ...args: any[]
+
+
Returns boolean
+
+ -
+
eventNames
+ -
+
+
-
+
-
+
+
Returns Array<string | symbol>
+
+
get
+-
+
+
getMaxListeners
+ -
+
+
-
+
-
+
+
Returns number
+
+
listenerCount
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns number
+
+ -
+
listeners
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
off
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
on
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
once
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
prependOnceListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
rawListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+
Returns Function[]
+
+ -
+
removeAllListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Optional event: string | symbol
+
+
Returns this
+
+ -
+
removeListener
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
event: string | symbol
+
+ -
+
listener: (...args: any[]) => void
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Rest ...args: any[]
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
Returns this
+
+ -
+
setMaxListeners
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
n: number
+
+
Returns this
+
+ -
+
start
+-
+
+
-
+
-
+
+ ++++
Start the PeerStore.
+Returns void
+
+
stop
+-
+
+
-
+
-
+
+ ++++
Stop the PeerStore.
+Returns void
+
+
+
+
+
+
+ Class ProtoBook
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_pnet_index_.protector.html b/classes/_pnet_index_.protector.html
new file mode 100644
index 00000000..185d09e9
--- /dev/null
+++ b/classes/_pnet_index_.protector.html
@@ -0,0 +1,390 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ event
+
+
+
+
+
+ event
+
+
+
+
+
+ event
+
+
+
+
+
+
+
+
+
+
+ Protected _set
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ Book
+
-
+
- + ProtoBook + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ References
+ +Constructors
+-
+
- constructor +
Properties
+-
+
- _ps +
- data +
- event
Name
+ - event
Property
+ - event
Transformer
+
Methods
+ +References
+PeerStore
+ Re-exports PeerStore
+ PeerStore
+ Re-exports PeerStore
+ Constructors
+constructor
+-
+
+
Properties
+_ps
+ + +data
+ + +
+
+
+
+ Map known peers to their data.
+eventName
+
+
+ eventProperty
+
+
+ eventTransformer
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns any[]
+
+ -
+
+ -
+
Methods
+Protected _emit
+-
+
+
-
+
-
+
+ ++++
Emit data.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
Optional data: any
+
+
Returns void
+
+ -
+
Protected _setData
+ -
+
+
-
+
-
+
+ ++++
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
+-
+
+
delete
+-
+
+
-
+
-
+
+ ++++
Deletes the provided peer from the book.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns boolean
+
+ -
+
get
+-
+
+
-
+
-
+
+ ++++
Get the known data of a provided peer. + Returns
+undefinedif there is no available data for the given peer.Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns any[] | any | undefined
+
+ -
+
remove
+-
+
+
set
+-
+
+
-
+
-
+
+ ++++
Set known data of a provided peer.
+Parameters
+-
+
-
+
peerId: PeerId
+
+ -
+
data: any[] | any
+++
+
Returns void
+
+ -
+
+
+
+
+
+ Class Protector
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_record_envelope_index_.envelope.html b/classes/_record_envelope_index_.envelope.html
new file mode 100644
index 00000000..aab60bf0
--- /dev/null
+++ b/classes/_record_envelope_index_.envelope.html
@@ -0,0 +1,490 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Multiaddr
+ Re-exports MultiaddrConnection
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + Protector + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Multiaddr
Connection
+ - errors +
- generate +
Constructors
+-
+
- constructor +
Properties
+ +Methods
+-
+
- protect +
References
+MultiaddrConnection
+ Re-exports MultiaddrConnection
+ errors
+ Renames and exports Errors +generate
+ Re-exports generate +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Takes a Private Shared Key (psk) and provides a
+protectmethod + for wrapping existing connections in a private encryption stream.Parameters
+-
+
-
+
keyBuffer: Uint8Array
+++++The private shared key buffer
+
+
Returns Protector
+
+ -
+
Properties
+psk
+ + +tag
+ + +Methods
+protect
+-
+
+
-
+
-
+
+ ++++
Takes a given Connection and creates a private encryption stream + between its two peers from the PSK the Protector instance was + created with.
+Parameters
+-
+
-
+
connection: MultiaddrConnection
+++The connection to protect
+
+
Returns Promise<MultiaddrConnection>
+A protected duplex iterable
+
+ -
+
+
+
+
+
+ Class Envelope
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_record_peer_record_index_.peerrecord.html b/classes/_record_peer_record_index_.peerrecord.html
new file mode 100644
index 00000000..ceca7391
--- /dev/null
+++ b/classes/_record_peer_record_index_.peerrecord.html
@@ -0,0 +1,495 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ create
+ Re-exports createFromProtobuf
+
+
+
+ open
+ Re-exports openAndCertify
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ payload
+
+
+
+
+
+ peer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + Envelope + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Record +
- create
From Protobuf
+ - open
And Certify
+ - seal +
Constructors
+-
+
- constructor +
Properties
+-
+
- _marshal +
- payload +
- payload
Type
+ - peer
Id
+ - signature +
Methods
+ +References
+Record
+ Re-exports Record +createFromProtobuf
+ Re-exports createFromProtobuf
+ openAndCertify
+ Re-exports openAndCertify
+ seal
+ Re-exports seal +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
The Envelope is responsible for keeping an arbitrary signed record + by a libp2p peer.
+Parameters
+-
+
-
+
__namedParameters: { payload: Uint8Array; payloadType: Uint8Array; peerId: PeerId; signature: Uint8Array }
+-
+
-
+
payload: Uint8Array
+
+ -
+
payload
+Type: Uint8Array
+ -
+
peer
+Id: PeerId
+ -
+
signature: Uint8Array
+
+
+ -
+
Returns Envelope
+
+ -
+
Properties
+_marshal
+ + +payload
+ + +payloadType
+
+
+ peerId
+
+
+ signature
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Verifies if the other Envelope is identical to this one.
+Parameters
+-
+
-
+
other: Envelope
+
+
Returns boolean
+
+ -
+
marshal
+-
+
+
-
+
-
+
+ ++++
Marshal the envelope content.
+Returns Uint8Array
+
+
validate
+-
+
+
-
+
-
+
+ ++++
Validate envelope data signature for the given domain.
+Parameters
+-
+
-
+
domain: string
+
+
Returns Promise<boolean>
+
+ -
+
+
+
+
+
+ Class PeerRecord
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_registrar_.registrar.html b/classes/_registrar_.registrar.html
new file mode 100644
index 00000000..39f1c5ca
--- /dev/null
+++ b/classes/_registrar_.registrar.html
@@ -0,0 +1,577 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+
+
+
+ create
+ Re-exports createFromProtobuf
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ peer
+
+
+
+
+
+ seq
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + PeerRecord + +
Implements
+-
+
- Record +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- DOMAIN +
- Multiaddr +
- Peer
Id
+ - Record +
- create
From Protobuf
+
Constructors
+-
+
- constructor +
Properties
+ +Methods
+ +References
+DOMAIN
+ Renames and exports ENVELOPE_DOMAIN_PEER_RECORD +Multiaddr
+ Re-exports Multiaddr +PeerId
+ Re-exports PeerId
+ Record
+ Re-exports Record +createFromProtobuf
+ Re-exports createFromProtobuf
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
The PeerRecord is used for distributing peer routing records across the network. + It contains the peer's reachable listen addresses.
+Parameters
+-
+
-
+
__namedParameters: { multiaddrs: Multiaddr[]; peerId: PeerId; seqNumber: undefined | number }
+ +
+
Returns PeerRecord
+
+ -
+
Properties
+_marshal
+ + +codec
+ + +domain
+ + +multiaddrs
+ + +peerId
+
+
+ seqNumber
+
+
+ Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Returns true if
+thisrecord equals theother.Parameters
+-
+
-
+
other: unknown
+
+
Returns boolean
+
+ -
+
marshal
+-
+
+
-
+
-
+
+ ++++
Marshal a record to be used in an envelope.
+Returns Uint8Array
+
+
+
+
+
+
+ Class Registrar
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_transport_manager_.transportmanager.html b/classes/_transport_manager_.transportmanager.html
new file mode 100644
index 00000000..dc3713c5
--- /dev/null
+++ b/classes/_transport_manager_.transportmanager.html
@@ -0,0 +1,745 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Connection
+ Re-exports ConnectionManager
+
+
+
+ Peer
+ Re-exports PeerId
+
+
+
+ Peer
+ Re-exports PeerStore
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ connection
+
+
+
+
+
+ peer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ _on
+
+
+
+ get
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Responsible for notifying registered protocols of events in the network.
+Hierarchy
+-
+
- + Registrar + +
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Connection +
- Connection
Manager
+ - Peer
Id
+ - Peer
Store
+ - Topology +
Constructors
+-
+
- constructor +
Properties
+-
+
- _handle +
- connection
Manager
+ - peer
Store
+ - topologies +
Accessors
+-
+
- handle +
Methods
+-
+
- _on
Disconnect
+ - get
Connection
+ - register +
- unregister +
References
+Connection
+ Re-exports Connection +ConnectionManager
+ Re-exports ConnectionManager
+ PeerId
+ Re-exports PeerId
+ PeerStore
+ Re-exports PeerStore
+ Topology
+ Re-exports Topology +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
__namedParameters: { connectionManager: ConnectionManager; peerStore: PeerStore }
+-
+
-
+
connection
+Manager: ConnectionManager
+ -
+
peer
+Store: PeerStore
+
+ -
+
Returns Registrar
+
+ -
+
Properties
+_handle
+ + +connectionManager
+
+
+ peerStore
+
+
+ topologies
+ + +
+
+
+
+ Map of topologies
+Accessors
+handle
+-
+
+
+
-
+
-
+
+
Returns any
+
+ -
+
+
Parameters
+-
+
-
+
arg: any
+
+
Returns any
+
+ -
+
Methods
+_onDisconnect
+ -
+
+
-
+
-
+
+ ++++
Remove a disconnected peer from the record
+Parameters
+-
+
-
+
connection: Connection
+
+ -
+
Optional error: Error | undefined
+
+
Returns void
+
+ -
+
getConnection
+ -
+
+
-
+
-
+
+ ++++
Get a connection with a peer.
+Parameters
+-
+
-
+
peerId: PeerId
+
+
Returns Connection | null
+
+ -
+
register
+-
+
+
-
+
-
+
+ ++++
Register handlers for a set of multicodecs given
+Parameters
+-
+
-
+
topology: Topology
+++protocol topology
+
+
Returns string
+registrar identifier
+
+ -
+
unregister
+-
+
+
-
+
-
+
+ ++++
Unregister topology.
+Parameters
+-
+
-
+
id: string
+++registrar identifier
+
+
Returns boolean
+unregistered successfully
+
+ -
+
+
+
+
+
+ Class TransportManager
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/classes/_upgrader_.upgrader.html b/classes/_upgrader_.upgrader.html
new file mode 100644
index 00000000..6c6234ea
--- /dev/null
+++ b/classes/_upgrader_.upgrader.html
@@ -0,0 +1,832 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ FAULT_
+ Re-exports FAULT_TOLERANCE
+
+
+
+ Fault
+ Renames and exports FAULT_TOLERANCE
+
+
+
+
+
+
+
+
+
+ Transport
+ Re-exports TransportFactory
+
+
+
+ Transport
+ Re-exports TransportManagerOptions
+
+
+
+ Transport
+ Re-exports TransportManagerProperties
+
+
+
+
+
+
+
+
+
+
+ _listener
+
+
+
+
+
+
+
+
+
+
+
+ fault
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ get
+
+
+
+ get
+
+
+
+
+
+
+
+
+
+ remove
+
+
+
+ transport
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + TransportManager + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+ +Constructors
+-
+
- constructor +
Properties
+-
+
- _listener
Options
+ - _listeners +
- _transports +
- fault
Tolerance
+ - libp2p +
- upgrader +
Methods
+-
+
- add +
- close +
- dial +
- get
Addrs
+ - get
Transports
+ - listen +
- remove +
- remove
All
+ - transport
For Multiaddr
+
References
+Connection
+ Re-exports Connection +FAULT_TOLERANCE
+ Re-exports FAULT_TOLERANCE
+ FaultTolerance
+ Renames and exports FAULT_TOLERANCE
+ Multiaddr
+ Re-exports Multiaddr +Transport
+ Re-exports Transport +TransportFactory
+ Re-exports TransportFactory
+ TransportManagerOptions
+ Re-exports TransportManagerOptions
+ TransportManagerProperties
+ Re-exports TransportManagerProperties
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
__namedParameters: { faultTolerance: undefined | number; libp2p: Libp2p; upgrader: Upgrader }
+ +
+
Returns TransportManager
+
+ -
+
Properties
+_listenerOptions
+
+
+ _listeners
+ + +_transports
+ + +
+
+ faultTolerance
+
+
+ libp2p
+ + +upgrader
+ + +Methods
+add
+-
+
+
-
+
-
+
+ ++++
Adds a
+Transportto the managerParameters
+-
+
-
+
key: string
+
+ -
+
Transport: TransportFactory<any, any>
+
+ -
+
Optional transportOptions: any
+++Additional options to pass to the transport
+
+
Returns void
+
+ -
+
close
+-
+
+
-
+
-
+
+ ++++ +
Stops all listeners
+Returns Promise<void>
+
+
dial
+-
+
+
-
+
-
+
+ ++++
Dials the given Multiaddr over it's supported transport
+Parameters
+-
+
-
+
ma: Multiaddr
+
+ -
+
options: any
+
+
Returns Promise<Connection>
+
+ -
+
getAddrs
+ -
+
+
-
+
-
+
+ ++++
Returns all Multiaddr's the listeners are using
+Returns Multiaddr[]
+
+
getTransports
+ -
+
+
-
+
-
+
+ ++++
Returns all the transports instances.
+Returns IterableIterator<Transport<any, any>>
+
+
listen
+-
+
+
-
+
-
+
+ ++++ +
Starts listeners for each listen Multiaddr.
+Parameters
+-
+
-
+
addrs: Multiaddr[]
+++addresses to attempt to listen on
+
+
Returns Promise<void>
+
+ -
+
remove
+-
+
+
-
+
-
+
+ ++++ +
Removes the given transport from the manager. + If a transport has any running listeners, they will be closed.
+Parameters
+-
+
-
+
key: string
+++
+
Returns Promise<void>
+
+ -
+
removeAll
+ -
+
+
-
+
-
+
+ ++++ +
Removes all transports from the manager. + If any listeners are running, they will be closed.
+Returns Promise<void>
+
+
transportForMultiaddr
+ -
+
+
-
+
-
+
+ ++++
Finds a transport that matches the given Multiaddr
+Parameters
+-
+
-
+
ma: Multiaddr
+
+
Returns Transport<any, any> | null
+
+ -
+
+
+
+
+
+ Class Upgrader
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/enums/_types_.keytype.html b/enums/_types_.keytype.html
new file mode 100644
index 00000000..030d3a9d
--- /dev/null
+++ b/enums/_types_.keytype.html
@@ -0,0 +1,345 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Crypto
+ Re-exports CryptoResult
+
+
+
+
+
+
+ Multiaddr
+ Re-exports MultiaddrConnection
+
+
+
+ Muxed
+ Re-exports MuxedStream
+
+
+
+
+
+
+ Muxer
+ Re-exports MuxerFactory
+
+
+
+
+
+
+
+
+
+
+ Private _create
+
+
+
+
+
+ Private _encrypt
+
+
+
+
+
+ Private _encrypt
+
+
+
+
+
+ Private _multiplex
+
+
+
+
+
+ Private _multiplex
+
+
+
+
+
+ Private _on
+
+
+
+
+
+
+
+
+ local
+
+
+
+
+
+
+
+
+
+
+
+ on
+
+
+
+
+
+ on
+
+
+
+
+
+
+
+
+
+
+
+
+
+ upgrade
+
+
+
+ upgrade
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + Upgrader + +
Index
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Crypto +
- Crypto
Result
+ - Multiaddr +
- Multiaddr
Connection
+ - Muxed
Stream
+ - Muxer +
- Muxer
Factory
+
Constructors
+-
+
- constructor +
Properties
+-
+
- _create
Connection
+ - _encrypt
Inbound
+ - _encrypt
Outbound
+ - _multiplex
Inbound
+ - _multiplex
Outbound
+ - _on
Stream
+ - cryptos +
- local
Peer
+ - metrics +
- muxers +
- on
Connection
+ - on
Connection End
+ - protector +
- protocols +
Methods
+ +References
+Crypto
+ Re-exports Crypto +CryptoResult
+ Re-exports CryptoResult
+ Multiaddr
+ Re-exports Multiaddr +MultiaddrConnection
+ Re-exports MultiaddrConnection
+ MuxedStream
+ Re-exports MuxedStream
+ Muxer
+ Re-exports Muxer +MuxerFactory
+ Re-exports MuxerFactory
+ Constructors
+constructor
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
__namedParameters: { cryptos: undefined | Map<string, Crypto>; localPeer: PeerId; metrics: undefined | Metrics; muxers: undefined | Map<string, MuxerFactory>; onConnection: (Connection: any) => void; onConnectionEnd: (Connection: any) => void }
+-
+
-
+
cryptos: undefined | Map<string, Crypto>
+
+ -
+
local
+Peer: PeerId
+ -
+
metrics: undefined | Metrics
+
+ -
+
muxers: undefined | Map<string, MuxerFactory>
+
+ -
+
on
+Connection: (Connection: any) => void -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Connection: any
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
-
+
on
+Connection End: (Connection: any) => void -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Connection: any
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
+ -
+
Returns Upgrader
+
+ -
+
Properties
+Private _createConnection
+
+
+
+
+
+
+
+ A convenience method for generating a new Connection
Private _encryptInbound
+
+
+
+
+
+
+
+ Attempts to encrypt the incoming connection with the provided cryptos.
Private _encryptOutbound
+
+
+
+
+
+
+
+ Attempts to encrypt the given connection with the provided cryptos.
+ The first Crypto module to succeed will be used
Private _multiplexInbound
+
+
+
+
+
+
+
+ Registers support for one of the given muxers via multistream-select. The + selected muxer will be used for all future streams on the connection.
+Private _multiplexOutbound
+
+
+
+
+
+
+
+ Selects one of the given muxers via multistream-select. That + muxer will be used for all future streams on the connection.
+Private _onStream
+
+
+
+
+
+
+
+ Routes incoming streams to the correct handler
+cryptos
+ + +localPeer
+
+
+ metrics
+ + +muxers
+ + +onConnection
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Connection: any
+
+
Returns void
+
+ -
+
+ -
+
onConnectionEnd
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Connection: any
+
+
Returns void
+
+ -
+
+ -
+
protector
+ + +protocols
+ + +Methods
+upgradeInbound
+ -
+
+
-
+
-
+
+ ++++ +
Upgrades an inbound connection
+Parameters
+-
+
-
+
maConn: MultiaddrConnection
+
+
Returns Promise<Connection>
+
+ -
+
upgradeOutbound
+ -
+
+
-
+
-
+
+ ++++ +
Upgrades an outbound connection
+Parameters
+-
+
-
+
maConn: MultiaddrConnection
+
+
Returns Promise<Connection>
+
+ -
+
+
+
+
+
+ Enumeration KeyType
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/globals.html b/globals.html
new file mode 100644
index 00000000..576e26ef
Binary files /dev/null and b/globals.html differ
diff --git a/index.html b/index.html
index d9970db2..b1d31130 100644
--- a/index.html
+++ b/index.html
@@ -1,18729 +1,852 @@
-
+
-
-
-
- "address-manager/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/auto-relay" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/circuit/hop" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/circuit/stop" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/circuit/stream-handler" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/circuit/utils" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/constants" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/listener" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/multicodec" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/protocol/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/transport" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"circuit/utils" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"config" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"connection-manager/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"connection-manager/latency-monitor" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"connection-manager/visibility-change-emitter" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"constants" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+METRICS | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"content-routing" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"dialer/dial-request" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"dialer/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+codes | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"errors" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_errors_.messages.html b/modules/_errors_.messages.html
new file mode 100644
index 00000000..214e98f1
--- /dev/null
+++ b/modules/_errors_.messages.html
@@ -0,0 +1,255 @@
+
+
+
+
+
+ messages | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+getPeer | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"get-peer" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"identify/consts" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"identify/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+multicodecs | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"identify/message" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"insecure/plaintext" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"insecure/proto" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"keychain/cms" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"keychain/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"keychain/util" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"metrics/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"metrics/old-peers" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"metrics/stats" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-routing" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-store/address-book" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-store/book" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-store/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-store/key-book" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-store/metadata-book" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-store/persistent/consts" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-store/persistent/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-store/persistent/pb/address-book.proto" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-store/persistent/pb/proto-book.proto" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"peer-store/proto-book" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"ping/constants" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"ping/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+ping | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"ping/util" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"pnet/crypto" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"pnet/errors" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"pnet/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+generate | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"pnet/key-generator" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"pubsub-adapter" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+pubsubAdapter | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"record/envelope/envelope.proto" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"record/envelope/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"record/peer-record/consts" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"record/peer-record/index" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"record/peer-record/peer-record.proto" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"record/utils" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"registrar" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+FAULT_TOLERANCE | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"transport-manager" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"types" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+"upgrader" | libp2p - v0.30.0-rc.0
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
-
-
-
+
+
+
-
+
\ No newline at end of file
diff --git a/modules/__libp2p_.html b/modules/__libp2p_.html
new file mode 100644
index 00000000..9c488b1a
Binary files /dev/null and b/modules/__libp2p_.html differ
diff --git a/modules/_address_manager_index_.html b/modules/_address_manager_index_.html
new file mode 100644
index 00000000..f97d472d
--- /dev/null
+++ b/modules/_address_manager_index_.html
@@ -0,0 +1,267 @@
+
+
+
+
+
+
+
+
+
+
+ libp2p - v0.30.0-rc.0
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
+
+
+
+
+
+
+ 
+
+ The JavaScript implementation of the libp2p Networking Stack.
+
+ 
+ 
+ 
+ 
+ 
+ 
+
+
+
+
+
+
+ 
+ 
+ 
+ 
+ 
+
+
Project status
+ +We've come a long way, but this project is still in Alpha, lots of development is happening, API might change, beware of the Dragons 🐉..
+The documentation in the master branch may contain changes from a pre-release. + If you are looking for the documentation of the latest release, you can view the latest release on npm, or select the tag in github that matches the version you are looking for.
+Want to get started? Check our GETTING_STARTED.md guide and examples folder.
+Want to update libp2p in your project? Check our migrations folder.
+ + +Lead Maintainer
+ + + +Table of Contents
+ +-
+
- Background +
- Install +
- Usage + +
- Development + +
- Contribute +
- License +
Background
+ +libp2p is the product of a long and arduous quest to understand the evolution of the Internet networking stack. In order to build P2P applications, devs have long had to make custom ad-hoc solutions to fit their needs, sometimes making some hard assumptions about their runtimes and the state of the network at the time of their development. Today, looking back more than 20 years, we see a clear pattern in the types of mechanisms built around the Internet Protocol, IP, which can be found throughout many layers of the OSI layer system, libp2p distils these mechanisms into flat categories and defines clear interfaces that once exposed, enable other protocols and applications to use and swap them, enabling upgradability and adaptability for the runtime, without breaking the API.
+We are in the process of writing better documentation, blog posts, tutorials and a formal specification. Today you can find:
+-
+
- libp2p.io +
- docs.libp2p.io +
- Specification (WIP) +
- Discussion Forums +
- Talks + +
- Articles + +
To sum up, libp2p is a "network stack" -- a protocol suite -- that cleanly separates concerns, and enables sophisticated applications to only use the protocols they absolutely need, without giving up interoperability and upgradeability. libp2p grew out of IPFS, but it is built so that lots of people can use it, for lots of different projects.
+ +Install
+ +npm install libp2pUsage
+ + +Configuration
+ +For all the information on how you can configure libp2p see CONFIGURATION.md.
+ +API
+ +The specification is available on API.md.
+ +Getting started
+ +If you are starting your journey with js-libp2p, read the GETTING_STARTED.md guide.
Tutorials and Examples
+ +You can find multiple examples on the examples folder that will guide you through using libp2p for several scenarios.
+ +Development
+ +Clone and install dependencies:
+> git clone https://github.com/libp2p/js-libp2p.git
+> cd js-libp2p
+> npm installTests
+ + +Run unit tests
+ +# run all the unit tsts
+> npm test
-
-
-
-
- Libp2p
-
-
-
-
- src/index.js
-
-
-
-
+# run just Node.js tests
+> npm run test:node
-
- new Libp2p(_options: any)
-
-
-
- Extends
-
- EventEmitter
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- _options (any)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
- ▸
- create(options)
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Like new Libp2p(options) except it will create a PeerId
-instance if one is not provided in options.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- options (object
- = {})
- Libp2p configuration options
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Promise<Libp2p>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+# run just Browser tests (Chrome)
+> npm run test:browser
+
+ Packages
+
+ List of packages currently in existence for libp2p
+
+ This table is generated using the module package-table with package-table --data=package-list.json.
+
+
+
+
+ Package
+ Version
+ Deps
+ CI
+ Coverage
+ Lead Maintainer
+
+
+
+ libp2p
+
+
+ libp2p
Jacob Heun
+
+
+ libp2p-daemon
Jacob Heun
+
+
+ libp2p-daemon-client
Vasco Santos
+
+
+ libp2p-interfaces
Jacob Heun
+
+
+ interop-libp2p
Vasco Santos
+
+
+ transports
+
+
+ libp2p-tcp
Jacob Heun
+
+
+ libp2p-webrtc-direct
Vasco Santos
+
+
+ libp2p-webrtc-star
Vasco Santos
+
+
+ libp2p-websockets
Jacob Heun
+
+
+ secure channels
+
+
+ libp2p-noise
N/A
+
+
+ libp2p-secio
Friedel Ziegelmayer
+
+
+ stream multiplexers
+
+
+ libp2p-mplex
Vasco Santos
+
+
+ peer discovery
+
+
+ libp2p-bootstrap
Vasco Santos
+
+
+ libp2p-kad-dht
Vasco Santos
+
+
+ libp2p-mdns
Jacob Heun
+
+
+ libp2p-webrtc-starVasco Santos
+
+
+ @chainsafe/discv5
Cayman Nava
+
+
+ content routing
+
+
+ libp2p-delegated-content-routing
Jacob Heun
+
+
+ libp2p-kad-dhtVasco Santos
+
+
+ peer routing
+
+
+ libp2p-delegated-peer-routing
Jacob Heun
+
+
+ libp2p-kad-dhtVasco Santos
+
+
+ utilities
+
+
+ libp2p-crypto
Jacob Heun
+
+
+ libp2p-crypto-secp256k1
Friedel Ziegelmayer
+
+
+ data types
+
+
+ peer-id
Vasco Santos
+
+
+ pubsub
+
+
+ libp2p-floodsub
Vasco Santos
+
+
+ libp2p-gossipsub
Cayman Nava
+
+
+ extensions
+
+
+ libp2p-nat-mgnr
N/A
+
+
+ libp2p-utils
Vasco Santos
+
+
+
+ Contribute
+
+ The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:
+
+ - Go through the modules and check out existing issues. This would be especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
+ - Perform code reviews. Most of this has been developed by @diasdavid, which means that more eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
+ - Add tests. There can never be enough tests.
+
+
+ License
+
+ MIT © Protocol Labs
+
+ Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- emit(eventName, args)
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Overrides EventEmitter.emit to conditionally emit errors -if there is a handler. If not, errors will be logged.
- -emit(eventName: string, args: ...any): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- eventName
-
- (string)
-
-
-
-
-
- args
-
- (...any)
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- start()
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Starts the libp2p node and all its subsystems
- -start(): Promise<void>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- stop()
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Stop the libp2p node by closing its listeners and open connections
- -stop(): Promise<void>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- loadKeychain()
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Load keychain keys from the datastore. -Imports the private key as 'self', if needed.
- -loadKeychain(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- connections
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Gets a Map of the current connections. The keys are the stringified
-PeerId of the peer. The value is an array of Connections to that peer.
connections
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Map<string, Array<Connection>>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- dial(peer, options)
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Dials to the provided peer. If successful, the known metadata of the
-peer will be added to the nodes peerStore
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peer
-
- ((PeerId | Multiaddr | string))
- The peer to dial
-
-
-
-
-
-
-
-
- options
-
- (object)
-
- | Name | -Description | -
|---|---|
options.signal AbortSignal?
- |
- - |
Returns
- Promise<Connection>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- dialProtocol(peer, protocols, options)
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Dials to the provided peer and handshakes with the given protocol.
-If successful, the known metadata of the peer will be added to the nodes peerStore,
-and the Connection will be returned
dialProtocol(peer: (PeerId | Multiaddr | string), protocols: (Array<string> | string), options: object): Promise<(Connection | any)>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- peer
-
- ((PeerId | Multiaddr | string))
- The peer to dial
-
-
-
-
-
-
-
-
- options
-
- (object)
-
- | Name | -Description | -
|---|---|
options.signal AbortSignal?
- |
- - |
Returns
- Promise<(Connection | any)>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- multiaddrs
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Get peer advertising multiaddrs by concating the addresses used -by transports to listen with the announce addresses. -Duplicated addresses and noAnnounce addresses are filtered out.
- -multiaddrs
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Array<Multiaddr>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- hangUp(peer)
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Disconnects all connections to the given peer
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peer
-
- ((PeerId | multiaddr | string))
- the peer to close connections to
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- ping(peer)
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Pings the given peer in order to obtain the operation latency.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peer
-
- ((PeerId | Multiaddr | string))
- The peer to ping
-
- Returns
- Promise<number>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- handle(protocols, handler)
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Registers the handler for each protocol
handle(protocols: (Array<string> | string), handler: function ({connection: any, stream: any, protocol: string}))
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- unhandle(protocols)
-
-
-
-
-
-
-
-
-
-
-
-
- src/index.js
-
-
-
-
-
- Removes the handler for each protocol. The protocol -will no longer be supported on streams.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - findPeer -
- - - - src/peer-routing.js - - -Iterates over all peer routers in series to find the given peer.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- id
-
- (string)
- The id of the peer to find
-
- Returns
- Promise<{id: PeerId, multiaddrs: Array<Multiaddr>}>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - findProviders -
- - - - src/content-routing.js - - -Iterates over all content routers in series to find providers of the given key. -Once a content router succeeds, iteration will stop.
- -findProviders(key: CID, options: object?): AsyncIterable<{id: PeerId, multiaddrs: Array<Multiaddr>}>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- key
-
- (CID)
- The CID key of the content to find
-
- Returns
- AsyncIterable<{id: PeerId, multiaddrs: Array<Multiaddr>}>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - provide -
- - - - src/content-routing.js - - -Iterates over all content routers in parallel to notify it is -a provider of the given key.
- -provide(key: CID): Promise<void>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- key
-
- (CID)
- The CID key of the content to find
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - put -
- - - - src/content-routing.js - - -Store the given key/value pair in the DHT.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- key
-
- (Uint8Array)
-
-
-
-
-
-
-
- value
-
- (Uint8Array)
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - get -
- - - - src/content-routing.js - - -Get the value to the given key. -Times out after 1 minute by default.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- key
-
- (Uint8Array)
-
- Returns
- Promise<{from: PeerId, val: Uint8Array}>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - getMany -
- - - - src/content-routing.js - - -Get the n values to the given key without sorting.
getMany(key: Uint8Array, nVals: number, options: Object?): Promise<Array<{from: PeerId, val: Uint8Array}>>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- key
-
- (Uint8Array)
-
-
-
-
-
-
-
- nVals
-
- (number)
-
- Returns
- Promise<Array<{from: PeerId, val: Uint8Array}>>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - getPeer -
- - - - src/get-peer.js - - -Converts the given peer to a Peer object.
-If a multiaddr is received, the addressBook is updated.
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peer
-
- ((PeerId | Multiaddr | string))
-
- Returns
- {id: PeerId, multiaddrs: Array<Multiaddr>}:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - AddressManager -
- - - - src/address-manager/index.js - - -Responsible for managing this peers addresses. -Peers can specify their listen, announce and noAnnounce addresses. -The listen addresses will be used by the libp2p transports to listen for new connections, -while the announce an noAnnounce addresses will be combined with the listen addresses for -address adverstising to other peers in the network.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- $0
-
- (Object
- = {})
-
- | Name | -Description | -
|---|---|
$0.listen any
-
- (default [])
- |
- - |
$0.announce any
-
- (default [])
- |
- - |
$0.noAnnounce any
-
- (default [])
- |
- - |
-
-
-
- options
-
- (object?)
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getListenAddrs()
-
-
-
-
-
-
-
-
-
-
-
-
- src/address-manager/index.js
-
-
-
-
-
- Get peer listen multiaddrs.
- -getListenAddrs(): Array<Multiaddr>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Array<Multiaddr>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getAnnounceAddrs()
-
-
-
-
-
-
-
-
-
-
-
-
- src/address-manager/index.js
-
-
-
-
-
- Get peer announcing multiaddrs.
- -getAnnounceAddrs(): Array<Multiaddr>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Array<Multiaddr>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getNoAnnounceAddrs()
-
-
-
-
-
-
-
-
-
-
-
-
- src/address-manager/index.js
-
-
-
-
-
- Get peer noAnnouncing multiaddrs.
- -getNoAnnounceAddrs(): Array<Multiaddr>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Array<Multiaddr>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - ConnectionManager -
- - - - src/connection-manager/index.js - - -Responsible for managing known connections.
- - - - -- Extends - - EventEmitter - -
- - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- _peerValues
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Map of peer identifiers to their peer value for pruning connections.
- -_peerValues
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- connections
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Map of connections per peer
- -connections
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- size
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Get current number of open connections.
- -size
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- start()
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Starts the Connection Manager. If Metrics are not enabled on libp2p -only event loop and connection limits will be monitored.
- -start()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- stop()
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Stops the Connection Manager
- -stop()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- _close()
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Cleans up the connections
- -_close()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- setPeerValue(peerId, value)
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Sets the value of the given peer. Peers with lower values -will be disconnected first.
- -setPeerValue(peerId: PeerId, value: number)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
-
-
-
-
- value
-
- (number)
- A number between 0 and 1
-
-
-
-
-
-
-
- ▸
- onConnect(connection)
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Tracks the incoming connection and check the connection limit
- -onConnect(connection: Connection)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- connection
-
- (Connection)
-
-
-
-
-
-
-
- ▸
- onDisconnect(connection)
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Removes the connection from tracking
- -onDisconnect(connection: Connection)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- connection
-
- (Connection)
-
-
-
-
-
-
-
- ▸
- get(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Get a connection with a peer.
- -get(peerId: PeerId): Connection
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- Connection:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getAll(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/connection-manager/index.js
-
-
-
-
-
- Get all open connections with a peer.
- -getAll(peerId: PeerId): Array<Connection>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- Array<Connection>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - globalThis -
- - - - src/connection-manager/latency-monitor.js - - -This code is based on latency-monitor (https://github.com/mlucool/latency-monitor) by mlucool (https://github.com/mlucool), available under Apache License 2.0 (https://github.com/mlucool/latency-monitor/blob/master/LICENSE)
globalThis
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - SummaryObject -
- - - - src/connection-manager/latency-monitor.js - - -SummaryObject
-
- - Type: - Object -
- - - - - - - - - - - - - -Properties
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- events
-
- (number)
- : How many events were called
-
-
-
- minMS
-
- (number)
- : What was the min time for a cb to be called
-
-
-
- maxMS
-
- (number)
- : What was the max time for a cb to be called
-
-
-
- avgMs
-
- (number)
- : What was the average time for a cb to be called
-
-
-
- lengthMs
-
- (number)
- : How long this interval was in ms
-
-
-
-
-
-
-
- - LatencyMonitor -
- - - - src/connection-manager/latency-monitor.js - - -A class to monitor latency of any async function which works in a browser or node. This works by periodically calling -the asyncTestFn and timing how long it takes the callback to be called. It can also periodically emit stats about this. -This can be disabled and stats can be pulled via setting dataEmitIntervalMs = 0.
-The default implementation is an event loop latency monitor. This works by firing periodic events into the event loop -and timing how long it takes to get back.
- - - - -- Extends - - EventEmitter - -
- - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- $0
-
- (Object
- = {})
-
- | Name | -Description | -
|---|---|
$0.latencyCheckIntervalMs any
- |
- - |
$0.dataEmitIntervalMs any
- |
- - |
$0.asyncTestFn any
- |
- - |
$0.latencyRandomPercentage any
- |
- - |
-
-
-
- options
-
- (object?)
-
- Example
-
-
- const monitor = new LatencyMonitor();
-monitor.on('data', (summary) => console.log('Event Loop Latency: %O', summary));
-
-
- const monitor = new LatencyMonitor({latencyCheckIntervalMs: 1000, dataEmitIntervalMs: 60000, asyncTestFn:ping});
-monitor.on('data', (summary) => console.log('Ping Pong Latency: %O', summary));
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getSummary()
-
-
-
-
-
-
-
-
-
-
-
- Calling this function will end the collection period. If a timing event was already fired and somewhere in the queue, -it will not count for this time period
- -getSummary(): SummaryObject
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- SummaryObject:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
- - - - src/connection-manager/visibility-change-emitter.js - - -This code is based on latency-monitor (https://github.com/mlucool/latency-monitor) by mlucool (https://github.com/mlucool), available under Apache License 2.0 (https://github.com/mlucool/latency-monitor/blob/master/LICENSE)
-
-
-
-
- - VisibilityChangeEmitter -
- - - - src/connection-manager/visibility-change-emitter.js - - -Listen to page visibility change events (i.e. when the page is focused / blurred) by an event emitter.
-Warning: This does not work on all browsers, but should work on all modern browsers
- -new VisibilityChangeEmitter()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Example
-
-
- const myVisibilityEmitter = new VisibilityChangeEmitter();
-
- myVisibilityEmitter.on('visibilityChange', (pageInFocus) => {
- if ( pageInFocus ){
- // Page is in focus
- console.log('In focus');
- }
- else {
- // Page is blurred
- console.log('Out of focus');
- }
- });
- // To access the visibility state directly, call:
- console.log('Am I focused now? ' + myVisibilityEmitter.isVisible());
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - isVisible -
- - - - src/connection-manager/visibility-change-emitter.js - - -The function returns true if the page is visible or false if the page is not visible and
-undefined if the page visibility API is not supported by the browser.
isVisible(): (boolean | void)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- (boolean | void):
- whether the page is now visible or not (undefined is unknown)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - constructor -
- - - - src/circuit/index.js - - -Creates an instance of Circuit.
- -new constructor(options: object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - dial -
- - - - src/circuit/index.js - - -Dial a peer over a relay
- -dial(ma: multiaddr, options: Object): Connection
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- ma
-
- (multiaddr)
- the multiaddr of the peer to dial
-
-
-
-
-
-
-
-
- options
-
- (Object)
- dial options
-
- | Name | -Description | -
|---|---|
options.signal AbortSignal?
- |
- An optional abort signal - | -
Returns
- Connection:
- the connection
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - createListener -
- - - - src/circuit/index.js - - -Create a listener
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- options
-
- (any)
-
-
-
-
-
- handler
-
- (Function)
-
- Returns
- listener:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - filter -
- - - - src/circuit/index.js - - -Filter check for all Multiaddrs that this transport can dial on
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- multiaddrs
-
- (Array<Multiaddr>)
-
- Returns
- Array<Multiaddr>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - index -
- - - - src/circuit/index.js - - -index
-
- - Type: - Circuit -
- - - - - - - - - - - - - - - - - - - - - - - -Static Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- multicodecs
-
-
-
-
-
-
-
-
-
-
-
-
- src/identify/index.js
-
-
-
-
-
- The protocols the IdentifyService supports
- -multicodecs
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - listener -
- - - - src/circuit/listener.js - - -listener(circuit: any): Listener
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- circuit
-
- (any)
-
- Returns
- Listener:
- a transport listener
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- listen(addr)
-
-
-
-
-
-
-
-
-
-
-
-
- src/circuit/listener.js
-
-
-
-
-
- Add swarm handler and listen for incoming connections
- -listen(addr: Multiaddr): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- addr
-
- (Multiaddr)
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- close()
-
-
-
-
-
-
-
-
-
-
-
-
- src/circuit/listener.js
-
-
-
-
-
- TODO: Remove the peers from our topology
- -close(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getAddrs()
-
-
-
-
-
-
-
-
-
-
-
-
- src/circuit/listener.js
-
-
-
-
-
- Get fixed up multiaddrs
-NOTE: This method will grab the peers multiaddrs and expand them such that:
-a) If it's an existing /p2p-circuit address for a specific relay i.e.
-/ip4/0.0.0.0/tcp/0/ipfs/QmRelay/p2p-circuit this method will expand the
-address to /ip4/0.0.0.0/tcp/0/ipfs/QmRelay/p2p-circuit/ipfs/QmPeer where
-QmPeer is this peers id
-b) If it's not a /p2p-circuit address, it will encapsulate the address as a /p2p-circuit
-addr, such when dialing over a relay with this address, it will create the circuit using
-the encapsulated transport address. This is useful when for example, a peer should only
-be dialed over TCP rather than any other transport
getAddrs(): Array<Multiaddr>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Array<Multiaddr>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - hop -
- - - - src/circuit/circuit/hop.js - - -Performs a HOP request to a relay peer, to request a connection to another -peer. A new, virtual, connection will be created between the two via the relay.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- options
-
- (object)
-
- | Name | -Description | -
|---|---|
options.connection Connection
- |
- Connection to the relay - | -
options.request any
- |
- - |
Returns
- Promise<Connection>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - writeResponse -
- - - - src/circuit/circuit/utils.js - - -Write a response
- -writeResponse(streamHandler: StreamHandler, status: CircuitRelay.Status)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- streamHandler
-
- (StreamHandler)
-
-
-
-
-
- status
-
- (CircuitRelay.Status)
-
-
-
-
-
-
- - validateAddrs -
- - - - src/circuit/circuit/utils.js - - -Validate incomming HOP/STOP message
- -validateAddrs(msg: any, streamHandler: StreamHandler)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- msg
-
- (any)
- A CircuitRelay unencoded protobuf message
-
-
-
-
-
- streamHandler
-
- (StreamHandler)
-
-
-
-
-
-
- - constructor -
- - - - src/circuit/circuit/stream-handler.js - - -Create a stream handler for connection
- -constructor(options: object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - read -
- - - - src/circuit/circuit/stream-handler.js - - -Read and decode message
- -read(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - write -
- - - - src/circuit/circuit/stream-handler.js - - -Encode and write array of buffers
- -write(msg: any)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- msg
-
- (any)
- An unencoded CircuitRelay protobuf message
-
-
-
-
-
-
- - rest -
- - - - src/circuit/circuit/stream-handler.js - - -Return the handshake rest stream and invalidate handler
- -rest(): any
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- any:
- A duplex iterable
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - close -
- - - - src/circuit/circuit/stream-handler.js - - -Close the stream
- -close(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - constructor -
- - - - src/dialer/index.js - - -new constructor(options: object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- options
-
- (object)
-
- | Name | -Description | -
|---|---|
options.transportManager TransportManager
- |
- - |
options.peerStore Peerstore
- |
- - |
options.concurrency number
-
- (default MAX_PARALLEL_DIALS)
- |
- Number of max concurrent dials. - | -
options.timeout number
-
- (default DIAL_TIMEOUT)
- |
- How long a dial attempt is allowed to take. - | -
options.perPeerLimit number
-
- (default MAX_PER_PEER_DIALS)
- |
- Number of max concurrent dials per peer. - | -
options.resolvers object
-
- (default {})
- |
- multiaddr resolvers to use when dialing - | -
-
-
-
-
- - destroy -
- - - - src/dialer/index.js - - -Clears any pending dials
- -destroy()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - connectToPeer -
- - - - src/dialer/index.js - - -Connects to a given peer by dialing all of its known addresses.
-The dial to the first address that is successfully able to upgrade a connection
-will be used.
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peer
-
- ((PeerId | Multiaddr | string))
- The peer to dial
-
-
-
-
-
-
-
-
- options
-
- (object?
- = {})
-
- | Name | -Description | -
|---|---|
options.signal AbortSignal?
- |
- An AbortController signal - | -
Returns
- Promise<Connection>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - _createDialTarget -
- - - - src/dialer/index.js - - -_createDialTarget(peer: any)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
- peer
-
- (any)
-
- Properties
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - _createPendingDial -
- - - - src/dialer/index.js - - -_createPendingDial(dialTarget: any, options: any)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
- dialTarget
-
- (any)
-
-
-
-
-
- options
-
- (any)
-
- Properties
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- dialRequest
-
- (DialRequest)
-
-
-
- controller
-
- (TimeoutController)
-
-
-
- promise
-
- (Promise)
-
-
-
- destroy
-
- (function (): void)
-
-
-
-
-
-
-
- - _resolve -
- - - - src/dialer/index.js - - -Resolve multiaddr recursively.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- ma
-
- (Multiaddr)
-
- Returns
- Promise<Array<Multiaddr>>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - _resolveRecord -
- - - - src/dialer/index.js - - -Resolve a given multiaddr. If this fails, an empty array will be returned
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- ma
-
- (Multiaddr)
-
- Returns
- Promise<Array<Multiaddr>>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - constructor -
- - - - src/dialer/dial-request.js - - -Manages running the dialAction on multiple provided addrs in parallel
-up to a maximum determined by the number of tokens returned
-from dialer.getTokens. Once a DialRequest is created, it can be
-started using DialRequest.run(options). Once a single dial has succeeded,
-all other dials in the request will be cancelled.
constructor(options: object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - run -
- - - - src/dialer/dial-request.js - - -run(options: object): Connection
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- options
-
- (object)
-
- | Name | -Description | -
|---|---|
options.signal AbortSignal
- |
- An AbortController signal - | -
Returns
- Connection:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - KeyInfo -
- - - - src/keychain/index.js - - -Information about a key.
- -KeyInfo
-
- - Type: - Object -
- - - - - - - - - - - - - -Properties
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Keychain -
- - - - src/keychain/index.js - - -Manages the lifecycle of a key. Keys are encrypted at rest using PKCS #8.
-A key in the store has two entries
--
-
- '/info/key-name', contains the KeyInfo for the key -
- '/pkcs8/key-name', contains the PKCS #8 for the key -
new Keychain(store: DS, options: object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- store
-
- (DS)
- where the key are.
-
-
-
-
-
- options
-
- (object)
- ???
-
- Static Members
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- generateOptions()
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- Generates the options for a keychain. A random salt is produced.
- -generateOptions(): object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- object:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- options
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- Gets an object that can encrypt/decrypt protected data. -The default options for a keychain.
- -options
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- object:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- cms
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- Gets an object that can encrypt/decrypt protected data -using the Cryptographic Message Syntax (CMS).
-CMS describes an encapsulation syntax for data protection. It -is used to digitally sign, digest, authenticate, or encrypt -arbitrary message content.
- -cms
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- CMS:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- createKey(name, type, size?)
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- Create a new key.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- name
-
- (string)
- The local key name; cannot already exist.
-
-
-
-
-
- type
-
- (string)
- One of the key types; 'rsa'.
-
-
-
-
-
- size
-
- (int?)
- The key size in bits. Used for rsa keys only.
-
- Returns
- KeyInfo:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- listKeys()
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- List all the keys.
- - - - - - - - - - - - - - - - - - -Returns
- Array<KeyInfo>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- findKeyById(id)
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- Find a key by it's id.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- id
-
- (string)
- The universally unique key identifier.
-
- Returns
- KeyInfo:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- findKeyByName(name)
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- Find a key by it's name.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- name
-
- (string)
- The local key name.
-
- Returns
- KeyInfo:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- removeKey(name)
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- Remove an existing key.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- name
-
- (string)
- The local key name; must already exist.
-
- Returns
- KeyInfo:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- renameKey(oldName, newName)
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- Rename a key
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- oldName
-
- (string)
- The old local key name; must already exist.
-
-
-
-
-
- newName
-
- (string)
- The new local key name; must not already exist.
-
- Returns
- KeyInfo:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- exportKey(name, password)
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- Export an existing key as a PEM encrypted PKCS #8 string
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- name
-
- (string)
- The local key name; must already exist.
-
-
-
-
-
- password
-
- (string)
- The password
-
- Returns
- string:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- importKey(name, pem, password)
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/index.js
-
-
-
-
-
- Import a new key from a PEM encoded PKCS #8 string
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- name
-
- (string)
- The local key name; must not already exist.
-
-
-
-
-
- pem
-
- (string)
- The PEM encoded PKCS #8 string
-
-
-
-
-
- password
-
- (string)
- The password.
-
- Returns
- KeyInfo:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - CMS -
- - - - src/keychain/cms.js - - -Cryptographic Message Syntax (aka PKCS #7)
-CMS describes an encapsulation syntax for data protection. It -is used to digitally sign, digest, authenticate, or encrypt -arbitrary message content.
-See RFC 5652 for all the details.
- -new CMS(keychain: Keychain)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- keychain
-
- (Keychain)
- the available keys
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- encrypt(name, plain)
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/cms.js
-
-
-
-
-
- Creates some protected data.
-The output Uint8Array contains the PKCS #7 message in DER.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- name
-
- (string)
- The local key name.
-
-
-
-
-
- plain
-
- (Uint8Array)
- The data to encrypt.
-
- Returns
- undefined:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- decrypt(cmsData)
-
-
-
-
-
-
-
-
-
-
-
-
- src/keychain/cms.js
-
-
-
-
-
- Reads some protected data.
-The keychain must contain one of the keys used to encrypt the data. If none of the keys -exists, an Error is returned with the property 'missingKeys'. It is array of key ids.
- -decrypt(cmsData: Uint8Array): undefined
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- cmsData
-
- (Uint8Array)
- The CMS encrypted data to decrypt.
-
- Returns
- undefined:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - certificateForKey -
- - - - src/keychain/util.js - - -Gets a self-signed X.509 certificate for the key.
-The output Uint8Array contains the PKCS #7 message in DER.
-TODO: move to libp2p-crypto package
- -certificateForKey(key: KeyInfo, privateKey: RsaPrivateKey): Uint8Array
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- key
-
- (KeyInfo)
- The id and name of the key
-
-
-
-
-
- privateKey
-
- (RsaPrivateKey)
- The naked key
-
- Returns
- Uint8Array:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - findAsync -
- - - - src/keychain/util.js - - -Finds the first item in a collection that is matched in the
-asyncCompare function.
asyncCompare is an async function that must
-resolve to either true or false.
findAsync(array: Array, asyncCompare: function (any))
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- array
-
- (Array)
-
-
-
-
-
- asyncCompare
-
- (function (any))
- An async function that returns a boolean
-
-
-
-
-
-
-
- - constructor -
- - - - src/metrics/index.js - - -constructor(options: object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- options
-
- (object)
-
- | Name | -Description | -
|---|---|
options.connectionManager ConnectionManager
- |
- - |
options.computeThrottleMaxQueueSize number
- |
- - |
options.computeThrottleTimeout number
- |
- - |
options.movingAverageIntervals Array<number>
- |
- - |
options.maxOldPeersRetention number
- |
- - |
-
-
-
-
- - start -
- - - - src/metrics/index.js - - -Must be called for stats to saved. Any data pushed for tracking -will be ignored.
- -start()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - stop -
- - - - src/metrics/index.js - - -Stops all averages timers and prevents new data from being tracked.
-Once stop is called, start must be called to resume stats tracking.
stop()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - global -
- - - - src/metrics/index.js - - -Gets the global Stats object
global
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Stats:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - peers -
- - - - src/metrics/index.js - - -Returns a list of PeerId strings currently being tracked
peers
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Array<string>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - forPeer -
- - - - src/metrics/index.js - - -Returns the Stats object for the given PeerId whether it
-is a live peer, or in the disconnected peer LRU cache.
forPeer(peerId: PeerId): Stats
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- Stats:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - protocols -
- - - - src/metrics/index.js - - -Returns a list of all protocol strings currently being tracked.
- -protocols
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Array<string>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - forProtocol -
- - - - src/metrics/index.js - - -Returns the Stats object for the given protocol.
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- protocol
-
- (string)
-
- Returns
- Stats:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - onPeerDisconnected -
- - - - src/metrics/index.js - - -Should be called when all connections to a given peer
-have closed. The Stats collection for the peer will
-be stopped and moved to an LRU for temporary retention.
onPeerDisconnected(peerId: PeerId)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
-
-
-
-
-
- - updatePlaceholder -
- - - - src/metrics/index.js - - -Replaces the PeerId string with the given peerId.
-If stats are already being tracked for the given peerId, the
-placeholder stats will be merged with the existing stats.
updatePlaceholder(placeholder: PeerId, peerId: PeerId)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- placeholder
-
- (PeerId)
- A peerId string
-
-
-
-
-
- peerId
-
- (PeerId)
-
-
-
-
-
-
- - trackStream -
- - - - src/metrics/index.js - - -Tracks data running through a given Duplex Iterable stream. If
-the peerId is not provided, a placeholder string will be created and
-returned. This allows lazy tracking of a peer when the peer is not yet known.
-When the PeerId is known, Metrics.updatePlaceholder should be called
-with the placeholder string returned from here, and the known PeerId.
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- options
-
- (Object)
-
- | Name | -Description | -
|---|---|
options.stream {sink: function (any), source: function ()}
- |
- A duplex iterable stream - | -
options.remotePeer PeerId?
- |
- The id of the remote peer that's connected - | -
options.protocol string?
- |
- The protocol the stream is running - | -
Returns
- string:
- The peerId string or placeholder string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - mergeStats -
- - - - src/metrics/index.js - - -Merges other into target. target will be modified
-and returned.
Parameters
-
-
-
-
-
-
-
- Returns
- Stats:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - old-peers -
- - - - src/metrics/old-peers.js - - -Creates and returns a Least Recently Used Cache
- -old-peers(maxSize: number): LRUCache
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- maxSize
-
- (number)
-
- Returns
- LRUCache:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Stats -
- - - - src/metrics/stats.js - - -A queue based manager for stat processing
- - - - -- Extends - - EventEmitter - -
- - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- start()
-
-
-
-
-
-
-
-
-
-
-
-
- src/metrics/stats.js
-
-
-
-
-
- Initializes the internal timer if there are items in the queue. This
-should only need to be called if Stats.stop was previously called, as
-Stats.push will also start the processing.
start(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- stop()
-
-
-
-
-
-
-
-
-
-
-
-
- src/metrics/stats.js
-
-
-
-
-
- Stops processing and computing of stats by clearing the internal -timer.
- -stop(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- snapshot
-
-
-
-
-
-
-
-
-
-
-
-
- src/metrics/stats.js
-
-
-
-
-
- Returns a clone of the current stats.
- -snapshot
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Map<string, Stat>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- movingAverages
-
-
-
-
-
-
-
-
-
-
-
-
- src/metrics/stats.js
-
-
-
-
-
- Returns a clone of the internal movingAverages
- -movingAverages
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Array<MovingAverage>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- toJSON()
-
-
-
-
-
-
-
-
-
-
-
-
- src/metrics/stats.js
-
-
-
-
-
- Returns a plain JSON object of the stats
- -toJSON(): any
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- any:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- push(counter, inc)
-
-
-
-
-
-
-
-
-
-
-
-
- src/metrics/stats.js
-
-
-
-
-
- Pushes the given operation data to the queue, along with the -current Timestamp, then resets the update timer.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - constructor -
- - - - src/transport-manager.js - - -new constructor(options: object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- options
-
- (object)
-
- | Name | -Description | -
|---|---|
options.libp2p Libp2p
- |
- The Libp2p instance. It will be passed to the transports. - | -
options.upgrader Upgrader
- |
- The upgrader to provide to the transports - | -
options.faultTolerance boolean
-
- (default FAULT_TOLERANCE.FATAL_ALL)
- |
- Address listen error tolerance. - | -
-
-
-
-
- - add -
- - - - src/transport-manager.js - - -Adds a Transport to the manager
add(key: string, Transport: Transport, transportOptions: any): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- key
-
- (string)
-
-
-
-
-
- Transport
-
- (Transport)
-
-
-
-
-
- transportOptions
-
- (any
- = {})
- Additional options to pass to the transport
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - close -
- - - - src/transport-manager.js - - -Stops all listeners
- -close()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - dial -
- - - - src/transport-manager.js - - -Dials the given Multiaddr over it's supported transport
- -dial(ma: Multiaddr, options: any): Promise<Connection>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- ma
-
- (Multiaddr)
-
-
-
-
-
- options
-
- (any)
-
- Returns
- Promise<Connection>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - getAddrs -
- - - - src/transport-manager.js - - -Returns all Multiaddr's the listeners are using
- -getAddrs(): Array<Multiaddr>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Array<Multiaddr>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - getTransports -
- - - - src/transport-manager.js - - -Returns all the transports instances.
- -getTransports(): Iterator<Transport>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Iterator<Transport>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - transportForMultiaddr -
- - - - src/transport-manager.js - - -Finds a transport that matches the given Multiaddr
- -transportForMultiaddr(ma: Multiaddr): (Transport | null)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- ma
-
- (Multiaddr)
-
- Returns
- (Transport | null):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - listen -
- - - - src/transport-manager.js - - -Starts listeners for each listen Multiaddr.
- -listen()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - remove -
- - - - src/transport-manager.js - - -Removes the given transport from the manager. -If a transport has any running listeners, they will be closed.
- -remove(key: string)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- key
-
- (string)
-
-
-
-
-
-
- - removeAll -
- - - - src/transport-manager.js - - -Removes all transports from the manager. -If any listeners are running, they will be closed.
- -removeAll()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - FAULT_TOLERANCE -
- - - - src/transport-manager.js - - -Enum Transport Manager Fault Tolerance values. -FATAL_ALL should be used for failing in any listen circumstance. -NO_FATAL should be used for not failing when not listening.
- -FAULT_TOLERANCE
-
- - Type: - number -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
-
- - Upgrader -
- - - - src/upgrader.js - - -new Upgrader($0: Object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- $0
-
- (Object)
-
- | Name | -Description | -
|---|---|
$0.localPeer any
- |
- - |
$0.metrics any
- |
- - |
$0.cryptos any
- |
- - |
$0.muxers any
- |
- - |
$0.onConnectionEnd any
-
- (default ()=>{})
- |
- - |
$0.onConnection any
-
- (default ()=>{})
- |
- - |
Properties
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- sink
-
- (Function)
-
-
-
- source
-
- (AsyncIterator)
-
-
-
- conn
-
- (any)
-
-
-
- remoteAddr
-
- (Multiaddr)
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- upgradeInbound(maConn)
-
-
-
-
-
-
-
-
-
-
-
-
- src/upgrader.js
-
-
-
-
-
- Upgrades an inbound connection
- -upgradeInbound(maConn: MultiaddrConnection): Promise<Connection>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- maConn
-
- (MultiaddrConnection)
-
- Returns
- Promise<Connection>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- upgradeOutbound(maConn)
-
-
-
-
-
-
-
-
-
-
-
-
- src/upgrader.js
-
-
-
-
-
- Upgrades an outbound connection
- -upgradeOutbound(maConn: MultiaddrConnection): Promise<Connection>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- maConn
-
- (MultiaddrConnection)
-
- Returns
- Promise<Connection>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Upgrader -
- - - - src/upgrader.js - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- $0
-
- (Object)
-
- | Name | -Description | -
|---|---|
$0.localPeer any
- |
- - |
$0.metrics any
- |
- - |
$0.cryptos any
- |
- - |
$0.muxers any
- |
- - |
$0.onConnectionEnd any
-
- (default ()=>{})
- |
- - |
$0.onConnection any
-
- (default ()=>{})
- |
- - |
-
-
-
- options
-
- (object)
-
- Properties
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- conn
-
- (any)
- : A duplex iterable
-
-
-
- remotePeer
-
- (PeerId)
-
-
-
- protocol
-
- (string)
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- upgradeInbound(maConn)
-
-
-
-
-
-
-
-
-
-
-
-
- src/upgrader.js
-
-
-
-
-
- Upgrades an inbound connection
- -upgradeInbound(maConn: MultiaddrConnection): Promise<Connection>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- maConn
-
- (MultiaddrConnection)
-
- Returns
- Promise<Connection>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- upgradeOutbound(maConn)
-
-
-
-
-
-
-
-
-
-
-
-
- src/upgrader.js
-
-
-
-
-
- Upgrades an outbound connection
- -upgradeOutbound(maConn: MultiaddrConnection): Promise<Connection>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- maConn
-
- (MultiaddrConnection)
-
- Returns
- Promise<Connection>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - PeerStore -
- - - - src/peer-store/index.js - - -Responsible for managing known peers, as well as their addresses, protocols and metadata.
- - - - -- Extends - - EventEmitter - -
- - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- $0
-
- (Object)
-
- | Name | -Description | -
|---|---|
$0.peerId any
- |
- - |
-
-
-
- options
-
- (object)
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- addressBook
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/index.js
-
-
-
-
-
- AddressBook containing a map of peerIdStr to Address.
- -addressBook
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- keyBook
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/index.js
-
-
-
-
-
- KeyBook containing a map of peerIdStr to their PeerId with public keys.
- -keyBook
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- metadataBook
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/index.js
-
-
-
-
-
- MetadataBook containing a map of peerIdStr to their metadata Map.
- -metadataBook
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- protoBook
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/index.js
-
-
-
-
-
- ProtoBook containing a map of peerIdStr to supported protocols.
- -protoBook
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- start()
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/index.js
-
-
-
-
-
- Start the PeerStore.
- -start()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- stop()
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/index.js
-
-
-
-
-
- Stop the PeerStore.
- -stop()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- peers
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/index.js
-
-
-
-
-
- Get all the stored information of every peer known.
- -peers
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Map<string, Peer>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- delete(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/index.js
-
-
-
-
-
- Delete the information of the given peer in every book.
- -delete(peerId: PeerId): boolean
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- boolean:
- true if found and removed
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- get(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/index.js
-
-
-
-
-
- Get the stored information of a given peer.
- -get(peerId: PeerId): Peer
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- Peer:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - AddressBook -
- - - - src/peer-store/address-book.js - - -The AddressBook is responsible for keeping the known multiaddrs -of a peer.
- -new AddressBook(peerStore: PeerStore)
-
-
- - Extends - - Book - -
- - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerStore
-
- (PeerStore)
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- data
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/address-book.js
-
-
-
-
-
- Map known peers to their known Address Entries.
- -data
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- consumePeerRecord(envelope)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/address-book.js
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
-
-
- envelope
-
- (Envelope)
-
- Returns
- boolean:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getRawEnvelope(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/address-book.js
-
-
-
-
-
- Get the raw Envelope for a peer. Returns -undefined if no Envelope is found.
- -getRawEnvelope(peerId: PeerId): (Uint8Array | undefined)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- (Uint8Array | undefined):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getPeerRecord(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/address-book.js
-
-
-
-
-
- Get an Envelope containing a PeerRecord for the given peer. -Returns undefined if no record exists.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- Promise<(Envelope | void)>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- set(peerId, multiaddrs)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/address-book.js
-
-
-
-
-
- Set known multiaddrs of a provided peer.
-This will replace previously stored multiaddrs, if available.
-Replacing stored multiaddrs might result in losing obtained certified addresses.
-If you are not sure, it's recommended to use add instead.
set(peerId: PeerId, multiaddrs: Array<Multiaddr>): AddressBook
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
-
-
-
-
- multiaddrs
-
- (Array<Multiaddr>)
-
- Returns
- AddressBook:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- add(peerId, multiaddrs)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/address-book.js
-
-
-
-
-
- Add known addresses of a provided peer. -If the peer is not known, it is set with the given addresses.
- -add(peerId: PeerId, multiaddrs: Array<Multiaddr>): AddressBook
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
-
-
-
-
- multiaddrs
-
- (Array<Multiaddr>)
-
- Returns
- AddressBook:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- get(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/address-book.js
-
-
-
-
-
- Get the known data of a provided peer.
- -get(peerId: PeerId): Array<data>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- Array<data>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getMultiaddrsForPeer(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/address-book.js
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- (Array<Multiaddr> | undefined):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - eventTransformer -
- - - - src/peer-store/address-book.js - - -PeerStore Event emitter, used by the AddressBook to emit: -"peer" - emitted when a peer is discovered by the node. -"change:multiaddrs" - emitted when the known multiaddrs of a peer change.
- -eventTransformer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - eventTransformer -
- - - - src/peer-store/proto-book.js - - -PeerStore Event emitter, used by the ProtoBook to emit: -"change:protocols" - emitted when the known protocols of a peer change.
- -eventTransformer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - KeyBook -
- - - - src/peer-store/key-book.js - - -The KeyBook is responsible for keeping the known public keys of a peer.
- -new KeyBook(peerStore: PeerStore)
-
-
- - Extends - - Book - -
- - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerStore
-
- (PeerStore)
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- data
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/key-book.js
-
-
-
-
-
- Map known peers to their known Public Key.
- -data
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- set(peerId, publicKey)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/key-book.js
-
-
-
-
-
- Set the Peer public key.
- -set(peerId: PeerId, publicKey: (RsaPublicKey | Ed25519PublicKey | Secp256k1PublicKey)): KeyBook
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
-
-
-
-
- publicKey
-
- ((RsaPublicKey | Ed25519PublicKey | Secp256k1PublicKey))
-
- Returns
- KeyBook:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- get(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/key-book.js
-
-
-
-
-
- Get Public key of the given PeerId, if stored.
- -get(peerId: PeerId): (RsaPublicKey | Ed25519PublicKey | Secp256k1PublicKey)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- (RsaPublicKey | Ed25519PublicKey | Secp256k1PublicKey):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Book -
- - - - src/peer-store/book.js - - -The Book is the skeleton for the PeerStore books.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- $0
-
- (Object)
-
- | Name | -Description | -
|---|---|
$0.peerStore any
- |
- - |
$0.eventName any
- |
- - |
$0.eventProperty any
- |
- - |
$0.eventTransformer any
-
- (default passthrough)
- |
- - |
-
-
-
- properties
-
- (Object)
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- data
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/book.js
-
-
-
-
-
- Map known peers to their data.
- -data
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- set(peerId, data)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/book.js
-
-
-
-
-
- Set known data of a provided peer.
- -set(peerId: PeerId, data: (Array<Data> | Data))
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
-
-
-
-
- data
-
- ((Array<Data> | Data))
-
-
-
-
-
-
-
- ▸
- get(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/book.js
-
-
-
-
-
- Get the known data of a provided peer.
-Returns undefined if there is no available data for the given peer.
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- (Array<Data> | undefined):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- delete(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/book.js
-
-
-
-
-
- Deletes the provided peer from the book.
- -delete(peerId: PeerId): boolean
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- boolean:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - MetadataBook -
- - - - src/peer-store/metadata-book.js - - -The MetadataBook is responsible for keeping the known supported -protocols of a peer.
- -new MetadataBook(peerStore: PeerStore)
-
-
- - Extends - - Book - -
- - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerStore
-
- (PeerStore)
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- data
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/metadata-book.js
-
-
-
-
-
- Map known peers to their known protocols.
- -data
-
- - Type: - Map<string, Map<string, Uint8Array>> -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
-
-
- ▸
- set(peerId, key, value)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/metadata-book.js
-
-
-
-
-
- Set metadata key and value of a provided peer.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
-
-
-
-
- key
-
- (string)
- metadata key
-
-
-
-
-
- value
-
- (Uint8Array)
- metadata value
-
- Returns
- ProtoBook:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- _setValue(peerId, key, value, $3)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/metadata-book.js
-
-
-
-
-
- Set data into the datastructure
- -_setValue(peerId: any, key: any, value: any, $3: Object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (any)
-
-
-
-
-
- key
-
- (any)
-
-
-
-
-
- value
-
- (any)
-
-
-
-
-
-
-
-
- $3
-
- (Object
- = {})
-
- | Name | -Description | -
|---|---|
$3.emit any
-
- (default true)
- |
- - |
-
-
-
-
-
- ▸
- get(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/metadata-book.js
-
-
-
-
-
- Get the known data of a provided peer.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- Map<string, Uint8Array>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getValue(peerId, key)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/metadata-book.js
-
-
-
-
-
- Get specific metadata value, if it exists
- -getValue(peerId: PeerId, key: string): Uint8Array
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
-
-
-
-
- key
-
- (string)
-
- Returns
- Uint8Array:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- delete(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/metadata-book.js
-
-
-
-
-
- Deletes the provided peer from the book.
- -delete(peerId: PeerId): boolean
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- boolean:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- deleteValue(peerId, key)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/metadata-book.js
-
-
-
-
-
- Deletes the provided peer metadata key from the book.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
-
-
-
-
- key
-
- (string)
-
- Returns
- boolean:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - eventProperty -
- - - - src/peer-store/metadata-book.js - - -PeerStore Event emitter, used by the MetadataBook to emit: -"change:metadata" - emitted when the known metadata of a peer change.
- -eventProperty
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - ProtoBook -
- - - - src/peer-store/proto-book.js - - -The ProtoBook is responsible for keeping the known supported -protocols of a peer.
- -new ProtoBook(peerStore: PeerStore)
-
-
- - Extends - - Book - -
- - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerStore
-
- (PeerStore)
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- data
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/proto-book.js
-
-
-
-
-
- Map known peers to their known protocols.
- -data
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- set(peerId, protocols)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/proto-book.js
-
-
-
-
-
- Set known protocols of a provided peer. -If the peer was not known before, it will be added.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
- Returns
- ProtoBook:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- add(peerId, protocols)
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/proto-book.js
-
-
-
-
-
- Adds known protocols of a provided peer. -If the peer was not known before, it will be added.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
- Returns
- ProtoBook:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - subscribe -
- - - - src/pubsub-adapter.js - - -Subscribes to a given topic.
- -subscribe(topic: string, handler: function (msg: InMessage)?): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- topic
-
- (string)
-
-
-
-
-
- handler
-
- (function (msg: InMessage)?)
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - unsubscribe -
- - - - src/pubsub-adapter.js - - -Unsubscribe from the given topic.
- -unsubscribe(topic: string, handler: function (msg: InMessage)?): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- topic
-
- (string)
-
-
-
-
-
- handler
-
- (function (msg: InMessage)?)
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - PersistentPeerStore -
- - - - src/peer-store/persistent/index.js - - -Responsible for managing the persistence of data in the PeerStore.
- - - - -- Extends - - PeerStore - -
- - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- $0
-
- (Object)
-
- | Name | -Description | -
|---|---|
$0.peerId any
- |
- - |
$0.datastore any
- |
- - |
$0.threshold any
-
- (default 5)
- |
- - |
-
-
-
- properties
-
- (Object)
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- _datastore
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/persistent/index.js
-
-
-
-
-
- Backend datastore used to persist data.
- -_datastore
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- _dirtyPeers
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/persistent/index.js
-
-
-
-
-
- Peers modified after the latest data persisted.
- -_dirtyPeers
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- _dirtyMetadata
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/persistent/index.js
-
-
-
-
-
- Peers metadata changed mapping peer identifers to metadata changed.
- -_dirtyMetadata
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- start()
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/persistent/index.js
-
-
-
-
-
- Start Persistent PeerStore.
- -start(): Promise<void>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- stop()
-
-
-
-
-
-
-
-
-
-
-
-
- src/peer-store/persistent/index.js
-
-
-
-
-
- Stop Persistent PeerStore.
- -stop(): Promise<void>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Registrar -
- - - - src/registrar.js - - -Responsible for notifying registered protocols of events in the network.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- $0
-
- (Object)
-
- | Name | -Description | -
|---|---|
$0.peerStore any
- |
- - |
$0.connectionManager any
- |
- - |
-
-
-
- props
-
- (Object)
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- topologies
-
-
-
-
-
-
-
-
-
-
-
-
- src/registrar.js
-
-
-
-
-
- Map of topologies
- -topologies
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- getConnection(peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/registrar.js
-
-
-
-
-
- Get a connection with a peer.
- -getConnection(peerId: PeerId): Connection
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- Connection:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- register(topology)
-
-
-
-
-
-
-
-
-
-
-
-
- src/registrar.js
-
-
-
-
-
- Register handlers for a set of multicodecs given
- -register(topology: Topology): string
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- topology
-
- (Topology)
- protocol topology
-
- Returns
- string:
- registrar identifier
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- unregister(id)
-
-
-
-
-
-
-
-
-
-
-
-
- src/registrar.js
-
-
-
-
-
- Unregister topology.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- id
-
- (string)
- registrar identifier
-
- Returns
- boolean:
- unregistered successfully
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- _onDisconnect(connection, error?)
-
-
-
-
-
-
-
-
-
-
-
-
- src/registrar.js
-
-
-
-
-
- Remove a disconnected peer from the record
- -_onDisconnect(connection: Connection, error: Error?): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- connection
-
- (Connection)
-
-
-
-
-
- error
-
- (Error?)
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - ping -
- - - - src/ping/index.js - - -Ping a given peer and wait for its response, getting the operation latency.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- node
-
- (Libp2p)
-
-
-
-
-
- peer
-
- ((PeerId | multiaddr))
-
- Returns
- Promise<number>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - mount -
- - - - src/ping/index.js - - -Subscribe ping protocol handler.
- -mount(node: Libp2p)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- node
-
- (Libp2p)
-
-
-
-
-
-
- - unmount -
- - - - src/ping/index.js - - -Unsubscribe ping protocol handler.
- -unmount(node: Libp2p)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- node
-
- (Libp2p)
-
-
-
-
-
-
-
- - constructor -
- - - - src/identify/index.js - - -new constructor(options: object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - peerStore -
- - - - src/identify/index.js - - -peerStore
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - connectionManager -
- - - - src/identify/index.js - - -connectionManager
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - peerId -
- - - - src/identify/index.js - - -peerId
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - _libp2p -
- - - - src/identify/index.js - - -_libp2p
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - push -
- - - - src/identify/index.js - - -Send an Identify Push update to the list of connections
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- connections
-
- (Array<Connection>)
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - pushToPeerStore -
- - - - src/identify/index.js - - -Calls push for all peers in the peerStore that are connected
pushToPeerStore(peerStore: PeerStore)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- peerStore
-
- (PeerStore)
-
-
-
-
-
-
- - identify -
- - - - src/identify/index.js - - -Requests the Identify message from peer associated with the given connection.
-If the identified peer does not match the PeerId associated with the connection,
-an error will be thrown.
identify(connection: Connection): Promise<void>
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- connection
-
- (Connection)
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - handleMessage -
- - - - src/identify/index.js - - -A handler to register with Libp2p to process identify messages.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - _getSelfPeerRecord -
- - - - src/identify/index.js - - -Get self signed peer record raw envelope.
- -_getSelfPeerRecord(): Uint8Array
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Uint8Array:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - getCleanMultiaddr -
- - - - src/identify/index.js - - -Takes the addr and converts it to a Multiaddr if possible
getCleanMultiaddr(addr: (Uint8Array | string)): (Multiaddr | null)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- addr
-
- ((Uint8Array | string))
-
- Returns
- (Multiaddr | null):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Envelope -
- - - - src/record/envelope/index.js - - -The Envelope is responsible for keeping an arbitrary signed record -by a libp2p peer.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- $0
-
- (Object)
-
- | Name | -Description | -
|---|---|
$0.peerId any
- |
- - |
$0.payloadType any
- |
- - |
$0.payload any
- |
- - |
$0.signature any
- |
- - |
-
-
-
- params
-
- (object)
-
- Static Members
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- createFromProtobuf(data)
-
-
-
-
-
-
-
-
-
-
-
-
- src/record/envelope/index.js
-
-
-
-
-
- Unmarshal a serialized Envelope protobuf message.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- data
-
- (Uint8Array)
-
- Returns
- Promise<Envelope>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- seal(record, peerId)
-
-
-
-
-
-
-
-
-
-
-
-
- src/record/envelope/index.js
-
-
-
-
-
- Seal marshals the given Record, places the marshaled bytes inside an Envelope -and signs it with the given peerId's private key.
- -seal(record: Record, peerId: PeerId): Envelope
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- record
-
- (Record)
-
-
-
-
-
- peerId
-
- (PeerId)
-
- Returns
- Envelope:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- openAndCertify(data, domain)
-
-
-
-
-
-
-
-
-
-
-
-
- src/record/envelope/index.js
-
-
-
-
-
- Open and certify a given marshalled envelope. -Data is unmarshalled and the signature validated for the given domain.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- data
-
- (Uint8Array)
-
-
-
-
-
- domain
-
- (string)
-
- Returns
- Envelope:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- marshal()
-
-
-
-
-
-
-
-
-
-
-
-
- src/record/envelope/index.js
-
-
-
-
-
- Marshal the envelope content.
- -marshal(): Uint8Array
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Uint8Array:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- equals(other)
-
-
-
-
-
-
-
-
-
-
-
-
- src/record/envelope/index.js
-
-
-
-
-
- Verifies if the other Envelope is identical to this one.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- other
-
- (Envelope)
-
- Returns
- boolean:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- validate(domain)
-
-
-
-
-
-
-
-
-
-
-
-
- src/record/envelope/index.js
-
-
-
-
-
- Validate envelope data signature for the given domain.
- - - - - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- domain
-
- (string)
-
- Returns
- Promise<boolean>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - formatSignaturePayload -
- - - - src/record/envelope/index.js - - -Helper function that prepares a Uint8Array to sign or verify a signature.
- -formatSignaturePayload
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- domain
-
- (string)
-
-
-
-
-
- payloadType
-
- (Uint8Array)
-
-
-
-
-
- payload
-
- (Uint8Array)
-
- Returns
- Uint8Array:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - PeerRecord -
- - - - src/record/peer-record/index.js - - -The PeerRecord is used for distributing peer routing records across the network. -It contains the peer's reachable listen addresses.
- - - - -- Extends - - Record - -
- - - - - - - - - - -Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- $0
-
- (Object)
-
- | Name | -Description | -
|---|---|
$0.peerId any
- |
- - |
$0.multiaddrs any
-
- (default [])
- |
- - |
$0.seqNumber any
-
- (default Date.now())
- |
- - |
-
-
-
- params
-
- (object)
-
- Static Members
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- createFromProtobuf(buf)
-
-
-
-
-
-
-
-
-
-
-
-
- src/record/peer-record/index.js
-
-
-
-
-
- Unmarshal Peer Record Protobuf.
- -createFromProtobuf(buf: Uint8Array): PeerRecord
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- buf
-
- (Uint8Array)
- marshaled peer record.
-
- Returns
- PeerRecord:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- marshal()
-
-
-
-
-
-
-
-
-
-
-
-
- src/record/peer-record/index.js
-
-
-
-
-
- Marshal a record to be used in an envelope.
- -marshal(): Uint8Array
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Uint8Array:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ▸
- equals(other)
-
-
-
-
-
-
-
-
-
-
-
-
- src/record/peer-record/index.js
-
-
-
-
-
- Returns true if this record equals the other.
equals(other: Record): boolean
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
- other
-
- (Record)
-
- Returns
- boolean:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+ Module address-manager/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_auto_relay_.html b/modules/_circuit_auto_relay_.html
new file mode 100644
index 00000000..82bec4b5
--- /dev/null
+++ b/modules/_circuit_auto_relay_.html
@@ -0,0 +1,308 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Address
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Address
Manager
+
Type aliases
+ +Type aliases
+AddressManagerOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional announce?: string[] | undefined
+++++-
+
- list of multiaddrs string representation to announce. +
+ -
+
Optional listen?: string[] | undefined
+++++-
+
- list of multiaddrs string representation to listen. +
+
Multiaddr
+ + +
+
+
+
+
+ Module circuit/auto-relay
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_circuit_hop_.html b/modules/_circuit_circuit_hop_.html
new file mode 100644
index 00000000..64d23e60
--- /dev/null
+++ b/modules/_circuit_circuit_hop_.html
@@ -0,0 +1,473 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Auto
+
+
+
+
+
+ Auto
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Auto
Relay
+
Type aliases
+-
+
- Address +
- Auto
Relay Options
+ - Auto
Relay Properties
+ - Connection +
Type aliases
+Address
+ + +
+
+ Type declaration
+-
+
-
+
is
+Certified: boolean ++++obtained from a signed peer record.
+
+ -
+
multiaddr: Multiaddr
+++++peer multiaddr.
+
+
AutoRelayOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional max
+Listeners?: number | undefined ++++-
+
- maximum number of relays to listen. +
+
AutoRelayProperties
+
+
+
+
+ Type declaration
+-
+
-
+
libp2p: Libp2p
+
+
Connection
+ + +
+
+
+
+
+ Module circuit/circuit/hop
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_circuit_stop_.html b/modules/_circuit_circuit_stop_.html
new file mode 100644
index 00000000..15fc82a6
--- /dev/null
+++ b/modules/_circuit_circuit_stop_.html
@@ -0,0 +1,360 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Circuit
+
+
+
+
+
+
+
+
+ Hop
+
+
+
+
+
+ Stream
+
+
+
+
+
+
+
+
+
+
+ can
+
+
+
+ Private handle
+
+
+
+ handle
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Type aliases
+-
+
- Circuit
Request
+ - Connection +
- Hop
Request
+ - Stream
HandlerT
+ - Transport +
Functions
+-
+
- can
Hop
+ - handle
Can Hop
+ - handle
Hop
+ - hop +
Type aliases
+CircuitRequest
+
+
+
+
+ Type declaration
+-
+
-
+
dst
+Peer: { addrs: Uint8Array[]; id: Uint8Array } -
+
-
+
addrs: Uint8Array[]
+
+ -
+
id: Uint8Array
+
+
+ -
+
-
+
src
+Peer: { addrs: Uint8Array[]; id: Uint8Array } -
+
-
+
addrs: Uint8Array[]
+
+ -
+
id: Uint8Array
+
+
+ -
+
-
+
type: CircuitType
+
+
Connection
+ + +HopRequest
+
+
+
+
+ Type declaration
+-
+
-
+
circuit: Transport
+
+ -
+
connection: Connection
+
+ -
+
request: CircuitRequest
+
+ -
+
stream
+Handler: StreamHandler<{ dstPeer: CircuitPeer; srcPeer: CircuitPeer; type: CircuitType }>
+
StreamHandlerT
+
+
+ Transport
+ + +Functions
+canHop
+ -
+
+
-
+
-
+
+ ++++
Performs a CAN_HOP request to a relay peer, in order to understand its capabilities.
+Parameters
+-
+
-
+
__namedParameters: { connection: Connection }
+-
+
-
+
connection: Connection
+
+
+ -
+
Returns Promise<boolean>
+
+ -
+
Private handleCanHop
+ -
+
+
-
+
-
+
+ ++++
Creates an unencoded CAN_HOP response based on the Circuits configuration
+Parameters
+-
+
-
+
__namedParameters: { circuit: Circuit; connection: Connection; streamHandler: StreamHandler<CircuitRequest> }
+-
+
-
+
circuit: Circuit
+
+ -
+
connection: Connection
+
+ -
+
stream
+Handler: StreamHandler<CircuitRequest>
+
+ -
+
Returns void
+
+ -
+
handleHop
+ -
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
__namedParameters: { circuit: Circuit; connection: Connection; request: CircuitRequest; streamHandler: StreamHandler<CircuitRequest> }
+-
+
-
+
circuit: Circuit
+
+ -
+
connection: Connection
+
+ -
+
request: CircuitRequest
+
+ -
+
stream
+Handler: StreamHandler<CircuitRequest>
+
+ -
+
Returns Promise<void>
+
+ -
+
hop
+-
+
+
-
+
-
+
+ ++++
Performs a HOP request to a relay peer, to request a connection to another + peer. A new, virtual, connection will be created between the two via the relay.
+Parameters
+-
+
-
+
__namedParameters: { connection: Connection; request: CircuitRequest }
+-
+
-
+
connection: Connection
+
+ -
+
request: CircuitRequest
+
+
+ -
+
Returns Promise<Connection>
+
+ -
+
+
+
+
+
+ Module circuit/circuit/stop
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_circuit_stream_handler_.html b/modules/_circuit_circuit_stream_handler_.html
new file mode 100644
index 00000000..4a548d86
--- /dev/null
+++ b/modules/_circuit_circuit_stream_handler_.html
@@ -0,0 +1,231 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Circuit
+
+
+
+
+
+
+
+
+ Muxed
+
+
+
+
+
+ Stream
+
+
+
+
+
+
+
+ handle
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Type aliases
+-
+
- Circuit
Request
+ - Connection +
- Muxed
Stream
+ - Stream
HandlerT
+
Functions
+-
+
- handle
Stop
+ - stop +
Type aliases
+CircuitRequest
+
+
+
+
+ Type declaration
+-
+
-
+
dst
+Peer: { addrs: Uint8Array[]; id: Uint8Array } -
+
-
+
addrs: Uint8Array[]
+
+ -
+
id: Uint8Array
+
+
+ -
+
-
+
src
+Peer: { addrs: Uint8Array[]; id: Uint8Array } -
+
-
+
addrs: Uint8Array[]
+
+ -
+
id: Uint8Array
+
+
+ -
+
-
+
type: CircuitType
+
+
Connection
+ + +MuxedStream
+
+
+ StreamHandlerT
+
+
+ Functions
+handleStop
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
__namedParameters: { connection: Connection; request: CircuitRequest; streamHandler: StreamHandler<CircuitRequest> }
+-
+
-
+
connection: Connection
+
+ -
+
request: CircuitRequest
+
+ -
+
stream
+Handler: StreamHandler<CircuitRequest>
+
+ -
+
Returns Promise<MuxedStream> | void
+
+ -
+
stop
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
__namedParameters: { connection: Connection; request: CircuitRequest }
+-
+
-
+
connection: Connection
+
+ -
+
request: CircuitRequest
+
+
+ -
+
Returns Promise<MuxedStream | void>
+
+ -
+
+
+
+
+
+ Module circuit/circuit/stream-handler
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_circuit_utils_.html b/modules/_circuit_circuit_utils_.html
new file mode 100644
index 00000000..051c026c
--- /dev/null
+++ b/modules/_circuit_circuit_utils_.html
@@ -0,0 +1,278 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Muxed
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Stream
Handler
+
Type aliases
+-
+
- Muxed
Stream
+
Type aliases
+MuxedStream
+
+
+
+
+
+
+
+ Module circuit/circuit/utils
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_constants_.html b/modules/_circuit_constants_.html
new file mode 100644
index 00000000..9ecb9499
--- /dev/null
+++ b/modules/_circuit_constants_.html
@@ -0,0 +1,277 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Circuit
+
+
+
+
+
+ Stream
+
+
+
+
+
+
+
+ validate
+
+
+
+
+ Index
+
+
+
+
+
+
+ Type aliases
+-
+
- Circuit
Status
+ - Stream
Handler
+
Functions
+-
+
- validate
Addrs
+
Type aliases
+CircuitStatus
+
+
+ StreamHandler
+
+
+ Functions
+validateAddrs
+ -
+
+
-
+
-
+
+ ++++
Validate incomming HOP/STOP message
+Parameters
+-
+
-
+
msg: any
+++A CircuitRelay unencoded protobuf message
+
+ -
+
streamHandler: StreamHandler<any>
+++
+
Returns void
+
+ -
+
+
+
+
+
+ Module circuit/constants
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_index_.html b/modules/_circuit_index_.html
new file mode 100644
index 00000000..61efb4a0
--- /dev/null
+++ b/modules/_circuit_index_.html
@@ -0,0 +1,307 @@
+
+
+
+
+
+
+
+
+
+
+ Module circuit/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_listener_.html b/modules/_circuit_listener_.html
new file mode 100644
index 00000000..b3bd346d
--- /dev/null
+++ b/modules/_circuit_listener_.html
@@ -0,0 +1,265 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Auto
+
+
+
+
+
+ Hop
+
+
+
+
+
+
+
+
+ Relay
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Relay +
Type aliases
+ +Type aliases
+AutoRelayOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional enabled?: boolean | undefined
+
+ -
+
Optional max
+Listeners?: number | undefined ++++-
+
- maximum number of relays to listen. +
+
HopOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional active?: boolean | undefined
+
+ -
+
Optional enabled?: boolean | undefined
+
+
Libp2p
+ + +RelayAdvertiseOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional boot
+Delay?: number | undefined
+ -
+
Optional enabled?: boolean | undefined
+
+ -
+
Optional ttl?: number | undefined
+
+
+
+
+
+
+ Module circuit/listener
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_multicodec_.html b/modules/_circuit_multicodec_.html
new file mode 100644
index 00000000..4c486cca
--- /dev/null
+++ b/modules/_circuit_multicodec_.html
@@ -0,0 +1,222 @@
+
+
+
+
+
+
+
+
+
+
+ Module circuit/multicodec
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_protocol_index_.html b/modules/_circuit_protocol_index_.html
new file mode 100644
index 00000000..ab9b4fe4
--- /dev/null
+++ b/modules/_circuit_protocol_index_.html
@@ -0,0 +1,340 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- relay +
Variables
+Const relay
+ + +
+
+
+
+
+ Module circuit/protocol/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_transport_.html b/modules/_circuit_transport_.html
new file mode 100644
index 00000000..2378d7dc
--- /dev/null
+++ b/modules/_circuit_transport_.html
@@ -0,0 +1,294 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- _exports +
Variables
+Const _exports
+ + +
+
+ Type declaration
+-
+
-
+
Circuit
+Relay: { Status: { HOP_CANT_DIAL_DST: HOP_CANT_DIAL_DST; HOP_CANT_OPEN_DST_STREAM: HOP_CANT_OPEN_DST_STREAM; HOP_CANT_RELAY_TO_SELF: HOP_CANT_RELAY_TO_SELF; HOP_CANT_SPEAK_RELAY: HOP_CANT_SPEAK_RELAY; HOP_DST_ADDR_TOO_LONG: HOP_DST_ADDR_TOO_LONG; HOP_DST_MULTIADDR_INVALID: HOP_DST_MULTIADDR_INVALID; HOP_NO_CONN_TO_DST: HOP_NO_CONN_TO_DST; HOP_SRC_ADDR_TOO_LONG: HOP_SRC_ADDR_TOO_LONG; HOP_SRC_MULTIADDR_INVALID: HOP_SRC_MULTIADDR_INVALID; MALFORMED_MESSAGE: MALFORMED_MESSAGE; STOP_DST_ADDR_TOO_LONG: STOP_DST_ADDR_TOO_LONG; STOP_DST_MULTIADDR_INVALID: STOP_DST_MULTIADDR_INVALID; STOP_RELAY_REFUSED: STOP_RELAY_REFUSED; STOP_SRC_ADDR_TOO_LONG: STOP_SRC_ADDR_TOO_LONG; STOP_SRC_MULTIADDR_INVALID: STOP_SRC_MULTIADDR_INVALID; SUCCESS: SUCCESS }; Type: { CAN_HOP: CAN_HOP; HOP: HOP; STATUS: STATUS; STOP: STOP }; decode: any; encode: any } -
+
-
+
Status: { HOP_CANT_DIAL_DST: HOP_CANT_DIAL_DST; HOP_CANT_OPEN_DST_STREAM: HOP_CANT_OPEN_DST_STREAM; HOP_CANT_RELAY_TO_SELF: HOP_CANT_RELAY_TO_SELF; HOP_CANT_SPEAK_RELAY: HOP_CANT_SPEAK_RELAY; HOP_DST_ADDR_TOO_LONG: HOP_DST_ADDR_TOO_LONG; HOP_DST_MULTIADDR_INVALID: HOP_DST_MULTIADDR_INVALID; HOP_NO_CONN_TO_DST: HOP_NO_CONN_TO_DST; HOP_SRC_ADDR_TOO_LONG: HOP_SRC_ADDR_TOO_LONG; HOP_SRC_MULTIADDR_INVALID: HOP_SRC_MULTIADDR_INVALID; MALFORMED_MESSAGE: MALFORMED_MESSAGE; STOP_DST_ADDR_TOO_LONG: STOP_DST_ADDR_TOO_LONG; STOP_DST_MULTIADDR_INVALID: STOP_DST_MULTIADDR_INVALID; STOP_RELAY_REFUSED: STOP_RELAY_REFUSED; STOP_SRC_ADDR_TOO_LONG: STOP_SRC_ADDR_TOO_LONG; STOP_SRC_MULTIADDR_INVALID: STOP_SRC_MULTIADDR_INVALID; SUCCESS: SUCCESS }
+-
+
-
+
HOP_
+CANT_ DIAL_ DST: HOP_CANT_DIAL_DST
+ -
+
HOP_
+CANT_ OPEN_ DST_ STREAM: HOP_CANT_OPEN_DST_STREAM
+ -
+
HOP_
+CANT_ RELAY_ TO_ SELF: HOP_CANT_RELAY_TO_SELF
+ -
+
HOP_
+CANT_ SPEAK_ RELAY: HOP_CANT_SPEAK_RELAY
+ -
+
HOP_
+DST_ ADDR_ TOO_ LONG: HOP_DST_ADDR_TOO_LONG
+ -
+
HOP_
+DST_ MULTIADDR_ INVALID: HOP_DST_MULTIADDR_INVALID
+ -
+
HOP_
+NO_ CONN_ TO_ DST: HOP_NO_CONN_TO_DST
+ -
+
HOP_
+SRC_ ADDR_ TOO_ LONG: HOP_SRC_ADDR_TOO_LONG
+ -
+
HOP_
+SRC_ MULTIADDR_ INVALID: HOP_SRC_MULTIADDR_INVALID
+ -
+
MALFORMED_
+MESSAGE: MALFORMED_MESSAGE
+ -
+
STOP_
+DST_ ADDR_ TOO_ LONG: STOP_DST_ADDR_TOO_LONG
+ -
+
STOP_
+DST_ MULTIADDR_ INVALID: STOP_DST_MULTIADDR_INVALID
+ -
+
STOP_
+RELAY_ REFUSED: STOP_RELAY_REFUSED
+ -
+
STOP_
+SRC_ ADDR_ TOO_ LONG: STOP_SRC_ADDR_TOO_LONG
+ -
+
STOP_
+SRC_ MULTIADDR_ INVALID: STOP_SRC_MULTIADDR_INVALID
+ -
+
SUCCESS: SUCCESS
+
+
+ -
+
-
+
Type: { CAN_HOP: CAN_HOP; HOP: HOP; STATUS: STATUS; STOP: STOP }
+ +
+ -
+
decode: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
bytes: Uint8Array
+
+
Returns any
+
+ -
+
+ -
+
+
-
+
encode: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
value: any
+
+
Returns Uint8Array
+
+ -
+
+ -
+
+
+ -
+
+
+
+
+
+ Module circuit/transport
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_circuit_utils_.html b/modules/_circuit_utils_.html
new file mode 100644
index 00000000..99736dc6
--- /dev/null
+++ b/modules/_circuit_utils_.html
@@ -0,0 +1,235 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Circuit
+
+
+
+
+
+
+
+
+
+
+
+ Muxed
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Circuit +
Type aliases
+-
+
- Circuit
Request
+ - Connection +
- Multiaddr +
- Muxed
Stream
+
Type aliases
+CircuitRequest
+
+
+
+
+ Type declaration
+-
+
-
+
dst
+Peer: { addrs: Uint8Array[]; id: Uint8Array } -
+
-
+
addrs: Uint8Array[]
+
+ -
+
id: Uint8Array
+
+
+ -
+
-
+
src
+Peer: { addrs: Uint8Array[]; id: Uint8Array } -
+
-
+
addrs: Uint8Array[]
+
+ -
+
id: Uint8Array
+
+
+ -
+
-
+
type: CircuitType
+
+
Connection
+ + +Multiaddr
+ + +MuxedStream
+
+
+
+
+
+
+
+ Module circuit/utils
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_config_.html b/modules/_config_.html
new file mode 100644
index 00000000..ab01fbea
--- /dev/null
+++ b/modules/_config_.html
@@ -0,0 +1,235 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ namespace
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- namespace
ToCid
+
Functions
+namespaceToCid
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
namespace: string
+
+
Returns Promise<CID>
+
+ -
+
+
+
+
+
+ Module config
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_connection_manager_index_.html b/modules/_connection_manager_index_.html
new file mode 100644
index 00000000..0514ec22
--- /dev/null
+++ b/modules/_connection_manager_index_.html
@@ -0,0 +1,387 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- validate +
Functions
+validate
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
opts: any
+
+
Returns any
+
+ -
+
+
+
+
+
+ Module connection-manager/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_connection_manager_latency_monitor_.html b/modules/_connection_manager_latency_monitor_.html
new file mode 100644
index 00000000..043d6bb2
--- /dev/null
+++ b/modules/_connection_manager_latency_monitor_.html
@@ -0,0 +1,351 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Connection
+
+
+
+
+
+
+
+
+
+
+ Const Connection
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Classes
+ +Type aliases
+-
+
- Connection +
- Connection
Manager Options
+ - Libp2p +
Variables
+ +Type aliases
+Connection
+ + +ConnectionManagerOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional auto
+Dial?: boolean | undefined ++++-
+
- Should preemptively guarantee connections are above the low watermark. +
+ -
+
Optional auto
+Dial Interval?: number | undefined ++++-
+
- How often, in milliseconds, it should preemptively guarantee connections are above the low watermark. +
+ -
+
Optional default
+Peer Value?: number | undefined ++++-
+
- The value of the peer. +
+ -
+
Optional max
+Connections?: number | undefined ++++-
+
- The maximum number of connections allowed. +
+ -
+
Optional max
+Data?: number | undefined ++++-
+
- The max data (in and out), per average interval to allow. +
+ -
+
Optional max
+Event Loop Delay?: number | undefined ++++-
+
- The upper limit the event loop can take to run. +
+ -
+
Optional max
+Received Data?: number | undefined ++++-
+
- The max incoming data, per average interval to allow. +
+ -
+
Optional max
+Sent Data?: number | undefined ++++-
+
- The max outgoing data, per average interval to allow. +
+ -
+
Optional min
+Connections?: number | undefined ++++-
+
- The minimum number of connections to avoid pruning. +
+ -
+
Optional moving
+Average Interval?: number | undefined ++++-
+
- How often, in milliseconds, to compute averages. +
+ -
+
Optional poll
+Interval?: number | undefined ++++-
+
- How often, in milliseconds, metrics and latency should be checked. +
+
Export assignment Libp2p
+ + +Variables
+Const ConnectionManager_base
+
+
+
+
+
+
+
+ Module connection-manager/latency-monitor
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_connection_manager_visibility_change_emitter_.html b/modules/_connection_manager_visibility_change_emitter_.html
new file mode 100644
index 00000000..dc08eb8c
--- /dev/null
+++ b/modules/_connection_manager_visibility_change_emitter_.html
@@ -0,0 +1,231 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Latency
+
+
+
+
+
+ Summary
+
+
+
+
+
+
+
+ Const Latency
+
+
+
+
+
+
+ Index
+Type aliases
+LatencyMonitorOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional async
+Test Fn?: Function | undefined ++++-
+
- What cb-style async function to use +
+ -
+
Optional data
+Emit Interval Ms?: number | undefined ++++-
+
- How often to summarize latency check events. null or 0 disables event firing +
+ -
+
Optional latency
+Check Interval Ms?: number | undefined ++++-
+
- How often to add a latency check event (ms) +
+ -
+
Optional latency
+Random Percentage?: number | undefined ++++-
+
- What percent (+/-) of latencyCheckIntervalMs should we randomly use? This helps avoid alignment to other events. +
+
SummaryObject
+
+
+
+
+ Type declaration
+-
+
-
+
avg
+Ms: number ++++What was the average time for a cb to be called
+
+ -
+
events: number
+++++How many events were called
+
+ -
+
length
+Ms: number ++++How long this interval was in ms
+
+ -
+
maxMS: number
+++++What was the max time for a cb to be called
+
+ -
+
minMS: number
+++++What was the min time for a cb to be called
+
+
Variables
+Const LatencyMonitor_base
+
+
+
+
+
+
+
+ Module connection-manager/visibility-change-emitter
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_constants_.html b/modules/_constants_.html
new file mode 100644
index 00000000..0d218d0e
--- /dev/null
+++ b/modules/_constants_.html
@@ -0,0 +1,255 @@
+
+
+
+
+
+
+
+
+
+
+ Module constants
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_constants_.metrics.html b/modules/_constants_.metrics.html
new file mode 100644
index 00000000..4055a594
--- /dev/null
+++ b/modules/_constants_.metrics.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const DIAL_
+
+
+
+
+
+ Const MAX_
+
+
+
+
+
+ Const MAX_
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Namespaces
+-
+
- METRICS +
Variables
+ +Variables
+Const DIAL_TIMEOUT
+
+
+ Const MAX_PARALLEL_DIALS
+
+
+ Const MAX_PER_PEER_DIALS
+
+
+
+
+
+
+
+ Namespace METRICS
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_content_routing_.html b/modules/_content_routing_.html
new file mode 100644
index 00000000..43f7378b
--- /dev/null
+++ b/modules/_content_routing_.html
@@ -0,0 +1,275 @@
+
+
+
+
+
+
+
+
+
+
+ Module content-routing
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_dialer_dial_request_.html b/modules/_dialer_dial_request_.html
new file mode 100644
index 00000000..9521fa00
--- /dev/null
+++ b/modules/_dialer_dial_request_.html
@@ -0,0 +1,318 @@
+
+
+
+
+
+
+
+
+
+
+ Module dialer/dial-request
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_dialer_index_.html b/modules/_dialer_index_.html
new file mode 100644
index 00000000..1fbc0866
--- /dev/null
+++ b/modules/_dialer_index_.html
@@ -0,0 +1,489 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dial
+
+
+
+
+
+ Dial
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Dial
Request
+
Type aliases
+-
+
- Connection +
- Dial
Options
+ - Dial
Request Options
+ - Dialer +
- Multiaddr +
Type aliases
+Connection
+ + +DialOptions
+
+
+
+
+ Type declaration
+-
+
-
+
signal: AbortSignal
+
+
DialRequestOptions
+
+
+
+
+ Type declaration
+-
+
-
+
addrs: Multiaddr[]
+
+ -
+
dial
+Action: (m: Multiaddr, options: DialOptions) => Promise<Connection> -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
m: Multiaddr
+
+ -
+
options: DialOptions
+
+
Returns Promise<Connection>
+
+ -
+
+ -
+
+ -
+
-
+
dialer: Dialer
+
+
Export assignment Dialer
+ + +Multiaddr
+ + +
+
+
+
+
+ Module dialer/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_errors_.codes.html b/modules/_errors_.codes.html
new file mode 100644
index 00000000..d3491049
--- /dev/null
+++ b/modules/_errors_.codes.html
@@ -0,0 +1,523 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dial
+
+
+
+
+
+ Dialer
+
+
+
+
+
+ Dialer
+
+
+
+
+
+
+
+
+ Peer
+
+
+
+
+
+ Peer
+
+
+
+
+
+ Pending
+
+
+
+
+
+
+
+
+ Transport
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Dialer +
Type aliases
+-
+
- Address +
- Connection +
- Dial
Target
+ - Dialer
Options
+ - Dialer
Properties
+ - Multiaddr +
- Peer
Id
+ - Peer
Store
+ - Pending
Dial
+ - Resolver +
- Transport
Manager
+
Type aliases
+Address
+ + +
+
+ Type declaration
+-
+
-
+
is
+Certified: boolean ++++obtained from a signed peer record.
+
+ -
+
multiaddr: Multiaddr
+++++peer multiaddr.
+
+
Connection
+ + +DialTarget
+
+
+
+
+ Type declaration
+-
+
-
+
addrs: Multiaddr[]
+
+ -
+
id: string
+
+
DialerOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional address
+Sorter?: ((addresses: Address[]) => Address[]) | undefined ++++-
+
- Sort the known addresses of a peer before trying to dial. +
+ -
+
Optional concurrency?: number | undefined
+++++-
+
- Number of max concurrent dials. +
+ -
+
Optional per
+Peer Limit?: number | undefined ++++-
+
- Number of max concurrent dials per peer. +
+ -
+
Optional resolvers?: Record<string, (addr: Multiaddr) => Promise<string[]>> | undefined
+++++-
+
- multiaddr resolvers to use when dialing +
+ -
+
Optional timeout?: number | undefined
+++++-
+
- How long a dial attempt is allowed to take. +
+
DialerProperties
+
+
+
+
+ Type declaration
+-
+
-
+
peer
+Store: PeerStore
+ -
+
transport
+Manager: TransportManager
+
Multiaddr
+ + +PeerId
+
+
+ PeerStore
+
+
+ PendingDial
+
+
+
+
+ Type declaration
+-
+
-
+
controller: any
+
+ -
+
destroy: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
-
+
dial
+Request: DialRequest
+ -
+
promise: Promise<any>
+
+
Resolver
+ + +
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
addr: Multiaddr
+
+
Returns Promise<string[]>
+
+ -
+
+ -
+
TransportManager
+
+
+
+
+
+
+
+ Namespace codes
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_errors_.html b/modules/_errors_.html
new file mode 100644
index 00000000..60aafcbc
--- /dev/null
+++ b/modules/_errors_.html
@@ -0,0 +1,218 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CONN_
+ Renames and exports CONN_ENCRYPTION_REQUIRED_1
+
+
+
+ DHT_
+ Renames and exports DHT_DISABLED_1
+
+
+
+
+
+ Const CONN_
+
+
+
+
+
+ Const DHT_
+
+
+
+
+
+ Const DHT_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const ERR_
+
+
+
+
+
+ Const PUBSUB_
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ References
+ +Variables
+-
+
- CONN_
ENCRYPTION_ REQUIRED_ 1
+ - DHT_
DISABLED_ 1
+ - DHT_
NOT_ STARTED
+ - ERR_
ALREADY_ ABORTED
+ - ERR_
CONNECTION_ ENDED
+ - ERR_
CONNECTION_ FAILED
+ - ERR_
DIALED_ SELF
+ - ERR_
DISCOVERED_ SELF
+ - ERR_
DUPLICATE_ TRANSPORT
+ - ERR_
ENCRYPTION_ FAILED
+ - ERR_
HOP_ REQUEST_ FAILED
+ - ERR_
INVALID_ KEY
+ - ERR_
INVALID_ MESSAGE
+ - ERR_
INVALID_ MULTIADDR
+ - ERR_
INVALID_ PARAMETERS
+ - ERR_
INVALID_ PEER
+ - ERR_
MUXER_ UNAVAILABLE
+ - ERR_
NODE_ NOT_ STARTED
+ - ERR_
NO_ VALID_ ADDRESSES
+ - ERR_
SIGNATURE_ NOT_ VALID
+ - ERR_
TIMEOUT
+ - ERR_
TRANSPORT_ DIAL_ FAILED
+ - ERR_
TRANSPORT_ UNAVAILABLE
+ - ERR_
UNSUPPORTED_ PROTOCOL
+ - PUBSUB_
NOT_ STARTED
+
References
+CONN_ENCRYPTION_REQUIRED
+ Renames and exports CONN_ENCRYPTION_REQUIRED_1
+ DHT_DISABLED
+ Renames and exports DHT_DISABLED_1
+ Variables
+Const CONN_ENCRYPTION_REQUIRED_1
+
+
+ Const DHT_DISABLED_1
+
+
+ Const DHT_NOT_STARTED
+
+
+ Const ERR_ALREADY_ABORTED
+
+
+ Const ERR_CONNECTION_ENDED
+
+
+ Const ERR_CONNECTION_FAILED
+
+
+ Const ERR_DIALED_SELF
+
+
+ Const ERR_DISCOVERED_SELF
+
+
+ Const ERR_DUPLICATE_TRANSPORT
+
+
+ Const ERR_ENCRYPTION_FAILED
+
+
+ Const ERR_HOP_REQUEST_FAILED
+
+
+ Const ERR_INVALID_KEY
+
+
+ Const ERR_INVALID_MESSAGE
+
+
+ Const ERR_INVALID_MULTIADDR
+
+
+ Const ERR_INVALID_PARAMETERS
+
+
+ Const ERR_INVALID_PEER
+
+
+ Const ERR_MUXER_UNAVAILABLE
+
+
+ Const ERR_NODE_NOT_STARTED
+
+
+ Const ERR_NO_VALID_ADDRESSES
+
+
+ Const ERR_SIGNATURE_NOT_VALID
+
+
+ Const ERR_TIMEOUT
+
+
+ Const ERR_TRANSPORT_DIAL_FAILED
+
+
+ Const ERR_TRANSPORT_UNAVAILABLE
+
+
+ Const ERR_UNSUPPORTED_PROTOCOL
+
+
+ Const PUBSUB_NOT_STARTED
+
+
+
+
+
+
+
+ Module errors
+
+
+
+
+
+ Namespace messages
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_get_peer_.getpeer.html b/modules/_get_peer_.getpeer.html
new file mode 100644
index 00000000..88279cba
--- /dev/null
+++ b/modules/_get_peer_.getpeer.html
@@ -0,0 +1,261 @@
+
+
+
+
+
+
+
+
+
+
+ Namespace getPeer
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_get_peer_.html b/modules/_get_peer_.html
new file mode 100644
index 00000000..4059b773
--- /dev/null
+++ b/modules/_get_peer_.html
@@ -0,0 +1,233 @@
+
+
+
+
+
+
+
+
+
+
+ Module get-peer
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_identify_consts_.html b/modules/_identify_consts_.html
new file mode 100644
index 00000000..62ae45c2
--- /dev/null
+++ b/modules/_identify_consts_.html
@@ -0,0 +1,255 @@
+
+
+
+
+
+
+
+
+
+
+ Module identify/consts
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_identify_index_.html b/modules/_identify_index_.html
new file mode 100644
index 00000000..779b06a2
--- /dev/null
+++ b/modules/_identify_index_.html
@@ -0,0 +1,294 @@
+
+
+
+
+
+
+
+
+
+
+ Module identify/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_identify_index_.multicodecs.html b/modules/_identify_index_.multicodecs.html
new file mode 100644
index 00000000..f7a70c20
--- /dev/null
+++ b/modules/_identify_index_.multicodecs.html
@@ -0,0 +1,237 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Muxed
+
+
+
+
+
+
+
+ Const MULTICODEC_
+
+
+
+
+
+ Const MULTICODEC_
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+
+
+ Namespaces
+-
+
- multicodecs +
Classes
+-
+
- Identify
Service
+
Type aliases
+-
+
- Connection +
- Muxed
Stream
+
Variables
+ +Type aliases
+Connection
+ + +MuxedStream
+
+
+ Variables
+Const MULTICODEC_IDENTIFY
+
+
+ Const MULTICODEC_IDENTIFY_PUSH
+
+
+ Const Message
+ + +
+
+
+
+
+ Namespace multicodecs
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_identify_message_.html b/modules/_identify_message_.html
new file mode 100644
index 00000000..944a0b7f
--- /dev/null
+++ b/modules/_identify_message_.html
@@ -0,0 +1,222 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ IDENTIFY_
+ Renames and exports MULTICODEC_IDENTIFY_PUSH
+
+
+
+
+ Index
+
+
+
+
+ References
+-
+
- IDENTIFY +
- IDENTIFY_
PUSH
+
References
+IDENTIFY
+ Renames and exports MULTICODEC_IDENTIFY +IDENTIFY_PUSH
+ Renames and exports MULTICODEC_IDENTIFY_PUSH
+
+
+
+
+
+ Module identify/message
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_insecure_plaintext_.html b/modules/_insecure_plaintext_.html
new file mode 100644
index 00000000..8d6eb1b7
--- /dev/null
+++ b/modules/_insecure_plaintext_.html
@@ -0,0 +1,309 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- _exports +
Variables
+Const _exports
+ + +
+
+
+
+
+ Module insecure/plaintext
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_insecure_proto_.html b/modules/_insecure_proto_.html
new file mode 100644
index 00000000..3b8c7c9d
--- /dev/null
+++ b/modules/_insecure_proto_.html
@@ -0,0 +1,222 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ secure
+
+
+
+ secure
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Type aliases
+-
+
- Connection +
Variables
+-
+
- protocol +
Functions
+-
+
- secure
Inbound
+ - secure
Outbound
+
Type aliases
+Connection
+ + +Variables
+Const protocol
+ + +Functions
+secureInbound
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
localId: any
+
+ -
+
conn: any
+
+ -
+
remoteId: any
+
+
Returns Promise<{ conn: any; remotePeer: PeerId }>
+
+ -
+
secureOutbound
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
localId: any
+
+ -
+
conn: any
+
+ -
+
remoteId: any
+
+
Returns Promise<{ conn: any; remotePeer: PeerId }>
+
+ -
+
+
+
+
+
+ Module insecure/proto
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_keychain_cms_.html b/modules/_keychain_cms_.html
new file mode 100644
index 00000000..7e7572a9
--- /dev/null
+++ b/modules/_keychain_cms_.html
@@ -0,0 +1,212 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- _exports +
Variables
+Const _exports
+ + +
+
+
+
+
+ Module keychain/cms
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_keychain_index_.html b/modules/_keychain_index_.html
new file mode 100644
index 00000000..89e87ede
--- /dev/null
+++ b/modules/_keychain_index_.html
@@ -0,0 +1,261 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Classes
+-
+
- CMS +
+
+
+
+
+ Module keychain/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_keychain_util_.html b/modules/_keychain_util_.html
new file mode 100644
index 00000000..908602ba
--- /dev/null
+++ b/modules/_keychain_util_.html
@@ -0,0 +1,294 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Module keychain/util
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_metrics_index_.html b/modules/_metrics_index_.html
new file mode 100644
index 00000000..c37f9fa9
--- /dev/null
+++ b/modules/_metrics_index_.html
@@ -0,0 +1,374 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ certificate
+
+
+
+ find
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- certificate
For Key
+ - find
Async
+
Functions
+certificateForKey
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
key: any
+
+ -
+
privateKey: any
+
+
Returns Uint8Array
+
+ -
+
findAsync
+ -
+
+
-
+
-
+
+ ++++
Finds the first item in a collection that is matched in the +
+asyncComparefunction.
+asyncCompareis an async function that must + resolve to eithertrueorfalse.Parameters
+-
+
-
+
array: any[]
+
+ -
+
asyncCompare: (arg0: any) => any
+++An async function that returns a boolean
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
arg0: any
+
+
Returns any
+
+ -
+
+ -
+
+ -
+
Returns Promise<any>
+
+ -
+
+
+
+
+
+ Module metrics/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_metrics_old_peers_.html b/modules/_metrics_old_peers_.html
new file mode 100644
index 00000000..381b7ece
--- /dev/null
+++ b/modules/_metrics_old_peers_.html
@@ -0,0 +1,235 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Metrics
+
+
+
+
+
+ Metrics
+
+
+
+
+
+ Multiaddr
+
+
+
+
+
+ Peer
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Metrics +
Type aliases
+ +Type aliases
+MetricsOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional compute
+Throttle Max Queue Size?: number | undefined
+ -
+
Optional compute
+Throttle Timeout?: number | undefined
+ -
+
Optional max
+Old Peers Retention?: number | undefined
+ -
+
Optional moving
+Average Intervals?: number[] | undefined
+
MetricsProperties
+
+
+
+
+ Type declaration
+-
+
-
+
connection
+Manager: ConnectionManager
+
MultiaddrConnection
+
+
+
+
+ Type declaration
+-
+
-
+
close: (err?: Error | undefined) => Promise<void>
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional err: Error | undefined
+
+
Returns Promise<void>
+
+ -
+
+ -
+
+ -
+
-
+
conn: unknown
+
+ -
+
Optional local
+Addr?: Multiaddr | undefined
+ -
+
remote
+Addr: Multiaddr
+ -
+
sink: (source: Uint8Array) => Promise<Uint8Array>
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
source: Uint8Array
+
+
Returns Promise<Uint8Array>
+
+ -
+
+ -
+
+ -
+
-
+
source: () => AsyncIterable<Uint8Array>
+-
+
-
+
-
+
+
-
+
-
+
Returns AsyncIterable<Uint8Array>
+
+
+ -
+
+ -
+
-
+
timeline: { close?: undefined | number; open: number; upgraded?: undefined | number }
+-
+
-
+
Optional close?: undefined | number
+
+ -
+
open: number
+
+ -
+
Optional upgraded?: undefined | number
+
+
+ -
+
PeerId
+
+
+
+
+
+
+
+ Module metrics/old-peers
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_metrics_stats_.html b/modules/_metrics_stats_.html
new file mode 100644
index 00000000..ea729cfa
--- /dev/null
+++ b/modules/_metrics_stats_.html
@@ -0,0 +1,231 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- _exports +
Functions
+_exports
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
maxSize: number
+
+
Returns any
+
+ -
+
+
+
+
+
+ Module metrics/stats
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_routing_.html b/modules/_peer_routing_.html
new file mode 100644
index 00000000..ed4f21ef
--- /dev/null
+++ b/modules/_peer_routing_.html
@@ -0,0 +1,242 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const Stats_
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Stats +
Variables
+-
+
- Stats_
base
+
Variables
+Const Stats_base
+
+
+
+
+
+
+
+ Module peer-routing
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_store_address_book_.html b/modules/_peer_store_address_book_.html
new file mode 100644
index 00000000..62714e6b
--- /dev/null
+++ b/modules/_peer_store_address_book_.html
@@ -0,0 +1,357 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Peer
Routing
+
Type aliases
+ +Type aliases
+Multiaddr
+ + +PeerId
+
+
+
+
+
+
+
+ Module peer-store/address-book
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_store_book_.html b/modules/_peer_store_book_.html
new file mode 100644
index 00000000..67f412ab
--- /dev/null
+++ b/modules/_peer_store_book_.html
@@ -0,0 +1,231 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Certified
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+
+
+
+
+
+
+
+ Const Address
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Classes
+-
+
- Address
Book
+
Type aliases
+-
+
- Address +
- Certified
Record
+ - Entry +
- Multiaddr +
- Peer
Store
+
Variables
+-
+
- Address
Book_ base
+
Type aliases
+Address
+ + +
+
+ Type declaration
+-
+
-
+
is
+Certified: boolean ++++obtained from a signed peer record.
+
+ -
+
multiaddr: Multiaddr
+++++peer multiaddr.
+
+
CertifiedRecord
+
+
+
+
+ Type declaration
+-
+
-
+
raw: Uint8Array
+++++raw envelope.
+
+ -
+
seq
+Number: number ++++seq counter.
+
+
Entry
+ + +
+
+ Type declaration
+-
+
-
+
addresses: Address[]
+++++peer Addresses.
+
+ -
+
record: CertifiedRecord
+++++certified peer record.
+
+
Multiaddr
+ + +PeerStore
+
+
+ Variables
+Const AddressBook_base
+
+
+
+
+
+
+
+ Module peer-store/book
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_store_index_.html b/modules/_peer_store_index_.html
new file mode 100644
index 00000000..60bb69b4
--- /dev/null
+++ b/modules/_peer_store_index_.html
@@ -0,0 +1,271 @@
+
+
+
+
+
+
+
+
+
+
+ Module peer-store/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_store_key_book_.html b/modules/_peer_store_key_book_.html
new file mode 100644
index 00000000..8749ba64
--- /dev/null
+++ b/modules/_peer_store_key_book_.html
@@ -0,0 +1,261 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const Peer
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Classes
+-
+
- Peer
Store
+
Type aliases
+-
+
- Address +
Variables
+-
+
- Peer
Store_ base
+
Type aliases
+Address
+ + +
+
+ Type declaration
+-
+
-
+
is
+Certified: boolean ++++obtained from a signed peer record.
+
+ -
+
multiaddr: Multiaddr
+++++peer multiaddr.
+
+
Variables
+Const PeerStore_base
+
+
+
+
+
+
+
+ Module peer-store/key-book
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_store_metadata_book_.html b/modules/_peer_store_metadata_book_.html
new file mode 100644
index 00000000..8403c8e9
--- /dev/null
+++ b/modules/_peer_store_metadata_book_.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+
+
+
+
+
+ Public
+
+
+
+
+
+
+
+ Const Key
+
+
+
+
+
+
+ Index
+Type aliases
+PeerStore
+
+
+ PublicKey
+
+
+ Variables
+Const KeyBook_base
+
+
+
+
+
+
+
+ Module peer-store/metadata-book
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_store_persistent_consts_.html b/modules/_peer_store_persistent_consts_.html
new file mode 100644
index 00000000..c06d5607
--- /dev/null
+++ b/modules/_peer_store_persistent_consts_.html
@@ -0,0 +1,266 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+
+
+
+
+
+
+
+ Const Metadata
+
+
+
+
+
+
+ Index
+Type aliases
+PeerStore
+
+
+ Variables
+Const MetadataBook_base
+
+
+
+
+
+
+
+ Module peer-store/persistent/consts
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_store_persistent_index_.html b/modules/_peer_store_persistent_index_.html
new file mode 100644
index 00000000..b4d801b6
--- /dev/null
+++ b/modules/_peer_store_persistent_index_.html
@@ -0,0 +1,287 @@
+
+
+
+
+
+
+
+
+
+
+ Module peer-store/persistent/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_store_persistent_pb_address_book_proto_.html b/modules/_peer_store_persistent_pb_address_book_proto_.html
new file mode 100644
index 00000000..e489e192
--- /dev/null
+++ b/modules/_peer_store_persistent_pb_address_book_proto_.html
@@ -0,0 +1,222 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Persistent
+
+
+
+
+
+ Persistent
+
+
+
+
+
+
+
+ Const Persistent
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Classes
+ +Type aliases
+ +Variables
+ +Type aliases
+PersistentPeerStoreOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional threshold?: number | undefined
+++++-
+
- Number of dirty peers allowed before commit data. +
+
PersistentPeerStoreProperties
+
+
+
+
+ Type declaration
+-
+
-
+
datastore: any
+
+ -
+
peer
+Id: PeerId
+
Variables
+Const PersistentPeerStore_base
+
+
+
+
+
+
+
+ Module peer-store/persistent/pb/address-book.proto
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_store_persistent_pb_proto_book_proto_.html b/modules/_peer_store_persistent_pb_proto_book_proto_.html
new file mode 100644
index 00000000..eba31fb7
--- /dev/null
+++ b/modules/_peer_store_persistent_pb_proto_book_proto_.html
@@ -0,0 +1,222 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- _exports +
Variables
+Const _exports
+ + +
+
+
+
+
+ Module peer-store/persistent/pb/proto-book.proto
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_peer_store_proto_book_.html b/modules/_peer_store_proto_book_.html
new file mode 100644
index 00000000..f09390bc
--- /dev/null
+++ b/modules/_peer_store_proto_book_.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- _exports +
Variables
+Const _exports
+ + +
+
+
+
+
+ Module peer-store/proto-book
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_ping_constants_.html b/modules/_ping_constants_.html
new file mode 100644
index 00000000..370dde9c
--- /dev/null
+++ b/modules/_ping_constants_.html
@@ -0,0 +1,233 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+
+
+
+
+
+
+
+ Const Proto
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Classes
+-
+
- Proto
Book
+
Type aliases
+-
+
- Peer
Store
+
Variables
+-
+
- Proto
Book_ base
+
Type aliases
+PeerStore
+
+
+ Variables
+Const ProtoBook_base
+
+
+
+
+
+
+
+ Module ping/constants
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_ping_index_.html b/modules/_ping_index_.html
new file mode 100644
index 00000000..da4912ba
--- /dev/null
+++ b/modules/_ping_index_.html
@@ -0,0 +1,325 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const PING_
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- PING_
LENGTH
+ - PROTOCOL +
Variables
+Const PING_LENGTH
+
+
+ Const PROTOCOL
+ + +
+
+
+
+
+ Module ping/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_ping_index_.ping.html b/modules/_ping_index_.ping.html
new file mode 100644
index 00000000..a205341f
--- /dev/null
+++ b/modules/_ping_index_.ping.html
@@ -0,0 +1,291 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+Type aliases
+Libp2p
+ + +Multiaddr
+ + +PeerId
+
+
+ Functions
+mount
+-
+
+
-
+
-
+
+ ++++
Subscribe ping protocol handler.
+Parameters
+-
+
-
+
node: Libp2p
+++
+
Returns void
+
+ -
+
unmount
+-
+
+
-
+
-
+
+ ++++
Unsubscribe ping protocol handler.
+Parameters
+-
+
-
+
node: Libp2p
+++
+
Returns void
+
+ -
+
+
+
+
+
+ Namespace ping
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_ping_util_.html b/modules/_ping_util_.html
new file mode 100644
index 00000000..6455cd9f
--- /dev/null
+++ b/modules/_ping_util_.html
@@ -0,0 +1,235 @@
+
+
+
+
+
+
+
+
+
+
+ Module ping/util
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pnet_crypto_.html b/modules/_pnet_crypto_.html
new file mode 100644
index 00000000..225fed90
--- /dev/null
+++ b/modules/_pnet_crypto_.html
@@ -0,0 +1,289 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- rnd +
Functions
+rnd
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
length: any
+
+
Returns Uint8Array
+
+ -
+
+
+
+
+
+ Module pnet/crypto
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pnet_errors_.html b/modules/_pnet_errors_.html
new file mode 100644
index 00000000..a610efc4
--- /dev/null
+++ b/modules/_pnet_errors_.html
@@ -0,0 +1,266 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ create
+
+
+
+ create
+
+
+
+ decode
+
+
+
+
+ Index
+
+
+
+
+ Functions
+ +Functions
+createBoxStream
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
nonce: Uint8Array
+
+ -
+
psk: Uint8Array
+
+
Returns any
+
+ -
+
createUnboxStream
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
nonce: Uint8Array
+
+ -
+
psk: Uint8Array
+
+
Returns any
+
+ -
+
decodeV1PSK
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
pskBuffer: Uint8Array
+
+
Returns any
+
+ -
+
+
+
+
+
+ Module pnet/errors
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pnet_index_.html b/modules/_pnet_index_.html
new file mode 100644
index 00000000..55d0b108
--- /dev/null
+++ b/modules/_pnet_index_.html
@@ -0,0 +1,346 @@
+
+
+
+
+
+
+
+
+
+
+ Module pnet/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pnet_key_generator_.generate.html b/modules/_pnet_key_generator_.generate.html
new file mode 100644
index 00000000..c3e1478b
--- /dev/null
+++ b/modules/_pnet_key_generator_.generate.html
@@ -0,0 +1,264 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Multiaddr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+Type aliases
+MultiaddrConnection
+
+
+
+
+ Type declaration
+-
+
-
+
close: (err?: Error | undefined) => Promise<void>
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional err: Error | undefined
+
+
Returns Promise<void>
+
+ -
+
+ -
+
+ -
+
-
+
conn: unknown
+
+ -
+
Optional local
+Addr?: Multiaddr | undefined
+ -
+
remote
+Addr: Multiaddr
+ -
+
sink: (source: Uint8Array) => Promise<Uint8Array>
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
source: Uint8Array
+
+
Returns Promise<Uint8Array>
+
+ -
+
+ -
+
+ -
+
-
+
source: () => AsyncIterable<Uint8Array>
+-
+
-
+
-
+
+
-
+
-
+
Returns AsyncIterable<Uint8Array>
+
+
+ -
+
+ -
+
-
+
timeline: { close?: undefined | number; open: number; upgraded?: undefined | number }
+-
+
-
+
Optional close?: undefined | number
+
+ -
+
open: number
+
+ -
+
Optional upgraded?: undefined | number
+
+
+ -
+
Variables
+Const Errors
+ + +generate
+ + +
+
+
+
+
+ Namespace generate
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pnet_key_generator_.html b/modules/_pnet_key_generator_.html
new file mode 100644
index 00000000..f583314e
--- /dev/null
+++ b/modules/_pnet_key_generator_.html
@@ -0,0 +1,244 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ KEY_
+ Re-exports KEY_LENGTH
+
+
+
+ NONCE_
+ Re-exports NONCE_LENGTH
+
+
+
+
+ Callable
+-
+
+
-
+
-
+
+ ++++
Generates a PSK that can be used in a libp2p-pnet private network
+Parameters
+-
+
-
+
bytes: Uint8Array
+++An object to write the psk into
+
+
Returns void
+
+ -
+
Index
+
+
+
+
+ References
+-
+
- KEY_
LENGTH
+ - NONCE_
LENGTH
+
References
+KEY_LENGTH
+ Re-exports KEY_LENGTH
+ NONCE_LENGTH
+ Re-exports NONCE_LENGTH
+
+
+
+
+
+ Module pnet/key-generator
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_adapter_.html b/modules/_pubsub_adapter_.html
new file mode 100644
index 00000000..7fbe7fa7
--- /dev/null
+++ b/modules/_pubsub_adapter_.html
@@ -0,0 +1,270 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const KEY_
+
+
+
+
+
+ NONCE_
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Namespaces
+-
+
- generate +
Variables
+-
+
- KEY_
LENGTH
+ - NONCE_
LENGTH
+
Variables
+Const KEY_LENGTH
+
+
+ NONCE_LENGTH
+
+
+
+
+
+
+
+ Module pubsub-adapter
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_pubsub_adapter_.pubsubadapter.html b/modules/_pubsub_adapter_.pubsubadapter.html
new file mode 100644
index 00000000..e05b7570
--- /dev/null
+++ b/modules/_pubsub_adapter_.pubsubadapter.html
@@ -0,0 +1,264 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ In
+
+
+
+
+
+ Pubsub
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Namespaces
+-
+
- pubsub
Adapter
+
Type aliases
+-
+
- In
Message
+ - Pubsub
Router
+
Type aliases
+InMessage
+
+
+
+
+ Type declaration
+-
+
-
+
data: Uint8Array
+
+ -
+
Optional from?: string | undefined
+
+ -
+
Optional key?: Uint8Array | undefined
+
+ -
+
received
+From: string
+ -
+
Optional seqno?: Uint8Array | undefined
+
+ -
+
Optional signature?: Uint8Array | undefined
+
+ -
+
topicIDs: string[]
+
+
PubsubRouter
+
+
+
+
+
+
+
+ Namespace pubsubAdapter
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_record_envelope_envelope_proto_.html b/modules/_record_envelope_envelope_proto_.html
new file mode 100644
index 00000000..a3c3816c
--- /dev/null
+++ b/modules/_record_envelope_envelope_proto_.html
@@ -0,0 +1,270 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ In
+ Re-exports InMessage
+
+
+
+ Pubsub
+ Re-exports PubsubRouter
+
+
+
+
+ Callable
+-
+
+
-
+
-
+
+ ++
Parameters
+-
+
-
+
PubsubRouter: any
+
+ -
+
libp2p: any
+
+ -
+
options: any
+
+
Returns any
+
+ -
+
Index
+
+
+
+
+ References
+-
+
- In
Message
+ - Pubsub
Router
+
References
+InMessage
+ Re-exports InMessage
+ PubsubRouter
+ Re-exports PubsubRouter
+
+
+
+
+
+ Module record/envelope/envelope.proto
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_record_envelope_index_.html b/modules/_record_envelope_index_.html
new file mode 100644
index 00000000..7e3d0c41
--- /dev/null
+++ b/modules/_record_envelope_index_.html
@@ -0,0 +1,317 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- _exports +
Variables
+Const _exports
+ + +
+
+ Type declaration
+-
+
-
+
Envelope: { decode: any; encode: any }
+-
+
-
+
decode: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
bytes: Uint8Array
+
+
Returns any
+
+ -
+
+ -
+
+
-
+
encode: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
value: any
+
+
Returns Uint8Array
+
+ -
+
+ -
+
+
+ -
+
+
+
+
+
+ Module record/envelope/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_record_peer_record_consts_.html b/modules/_record_peer_record_consts_.html
new file mode 100644
index 00000000..4207c558
--- /dev/null
+++ b/modules/_record_peer_record_consts_.html
@@ -0,0 +1,233 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ create
+
+
+
+ open
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Classes
+-
+
- Envelope +
Type aliases
+-
+
- Record +
Functions
+-
+
- create
From Protobuf
+ - open
And Certify
+ - seal +
Type aliases
+Record
+ + +Functions
+createFromProtobuf
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
data: Uint8Array
+
+
Returns Promise<Envelope>
+
+ -
+
openAndCertify
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
data: Uint8Array
+
+ -
+
domain: string
+
+
Returns Promise<Envelope>
+
+ -
+
seal
+-
+
+
+
+
+
+
+ Module record/peer-record/consts
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_record_peer_record_index_.html b/modules/_record_peer_record_index_.html
new file mode 100644
index 00000000..378177bf
--- /dev/null
+++ b/modules/_record_peer_record_index_.html
@@ -0,0 +1,315 @@
+
+
+
+
+
+
+
+
+
+
+ Module record/peer-record/index
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_record_peer_record_peer_record_proto_.html b/modules/_record_peer_record_peer_record_proto_.html
new file mode 100644
index 00000000..9b63d540
--- /dev/null
+++ b/modules/_record_peer_record_peer_record_proto_.html
@@ -0,0 +1,270 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Peer
+
+
+
+
+
+
+
+
+
+
+ Const ENVELOPE_
+
+
+
+
+
+ Const Peer
+
+
+
+
+
+
+
+ create
+
+
+
+
+ Index
+Type aliases
+Multiaddr
+ + +PeerId
+
+
+ Record
+ + +Variables
+Const ENVELOPE_DOMAIN_PEER_RECORD
+
+
+ Const PeerId_1
+
+
+ Functions
+createFromProtobuf
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
buf: Uint8Array
+
+
Returns PeerRecord
+
+ -
+
+
+
+
+
+ Module record/peer-record/peer-record.proto
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_record_utils_.html b/modules/_record_utils_.html
new file mode 100644
index 00000000..9b533f3f
--- /dev/null
+++ b/modules/_record_utils_.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Variables
+-
+
- _exports +
Variables
+Const _exports
+ + +
+
+ Type declaration
+-
+
-
+
Peer
+Record: { decode: any; encode: any } -
+
-
+
decode: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
bytes: Uint8Array
+
+
Returns any
+
+ -
+
+ -
+
+
-
+
encode: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
value: any
+
+
Returns Uint8Array
+
+ -
+
+ -
+
+
+ -
+
+
+
+
+
+ Module record/utils
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_registrar_.html b/modules/_registrar_.html
new file mode 100644
index 00000000..f4a22613
--- /dev/null
+++ b/modules/_registrar_.html
@@ -0,0 +1,294 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ update
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Type aliases
+-
+
- Libp2p +
Functions
+ +Type aliases
+Libp2p
+ + +Functions
+updateSelfPeerRecord
+ -
+
+
-
+
-
+
+ ++++
Create (or update if existing) self peer record and store it in the AddressBook.
+Parameters
+-
+
-
+
libp2p: Libp2p
+
+
Returns Promise<void>
+
+ -
+
+
+
+
+
+ Module registrar
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_transport_manager_.fault_tolerance.html b/modules/_transport_manager_.fault_tolerance.html
new file mode 100644
index 00000000..2f8aa152
--- /dev/null
+++ b/modules/_transport_manager_.fault_tolerance.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Connection
+
+
+
+
+
+ Peer
+
+
+
+
+
+ Peer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+
+
+ Classes
+-
+
- Registrar +
Type aliases
+-
+
- Connection +
- Connection
Manager
+ - Peer
Id
+ - Peer
Store
+ - Topology +
Variables
+-
+
- Topology +
Type aliases
+Connection
+ + +ConnectionManager
+
+
+ PeerId
+
+
+ PeerStore
+
+
+ Topology
+ + +Variables
+Const Topology
+ + +
+
+
+
+
+ Namespace FAULT_TOLERANCE
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_transport_manager_.html b/modules/_transport_manager_.html
new file mode 100644
index 00000000..64043226
--- /dev/null
+++ b/modules/_transport_manager_.html
@@ -0,0 +1,323 @@
+
+
+
+
+
+
+
+
+
+
+ Module transport-manager
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_types_.html b/modules/_types_.html
new file mode 100644
index 00000000..365f6f18
--- /dev/null
+++ b/modules/_types_.html
@@ -0,0 +1,687 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Transport
+
+
+
+
+
+ Transport
+
+
+
+
+
+ Transport
+
+
+
+
+
+
+
+ Index
+Type aliases
+Connection
+ + +Multiaddr
+ + +Transport
+ + +TransportFactory
+
+
+ TransportManagerOptions
+
+
+
+
+ Type declaration
+-
+
-
+
Optional fault
+Tolerance?: number | undefined ++++-
+
- Address listen error tolerance. +
+
TransportManagerProperties
+
+
+
+
+
+
+
+
+ Module types
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/_upgrader_.html b/modules/_upgrader_.html
new file mode 100644
index 00000000..3c64bb8d
--- /dev/null
+++ b/modules/_upgrader_.html
@@ -0,0 +1,401 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ CAN_
+
+
+
+
+
+ Circuit
+
+
+
+
+
+ Circuit
+
+
+
+
+
+ Circuit
+
+
+
+
+
+ Circuit
+
+
+
+
+
+ Circuit
+
+
+
+
+
+
+
+
+ HOP_
+
+
+
+
+
+ HOP_
+
+
+
+
+
+ HOP_
+
+
+
+
+
+ HOP_
+
+
+
+
+
+ HOP_
+
+
+
+
+
+ HOP_
+
+
+
+
+
+ HOP_
+
+
+
+
+
+ HOP_
+
+
+
+
+
+ HOP_
+
+
+
+
+
+ MALFORMED_
+
+
+
+
+
+ Message
+
+
+
+
+
+
+
+
+
+
+
+ STOP_
+
+
+
+
+
+ STOP_
+
+
+
+
+
+ STOP_
+
+
+
+
+
+ STOP_
+
+
+
+
+
+ STOP_
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Enumerations
+-
+
- Key
Type
+
Type aliases
+-
+
- CAN_
HOP
+ - Circuit
Message Proto
+ - Circuit
Peer
+ - Circuit
Request
+ - Circuit
Status
+ - Circuit
Type
+ - HOP +
- HOP_
CANT_ DIAL_ DST
+ - HOP_
CANT_ OPEN_ DST_ STREAM
+ - HOP_
CANT_ RELAY_ TO_ SELF
+ - HOP_
CANT_ SPEAK_ RELAY
+ - HOP_
DST_ ADDR_ TOO_ LONG
+ - HOP_
DST_ MULTIADDR_ INVALID
+ - HOP_
NO_ CONN_ TO_ DST
+ - HOP_
SRC_ ADDR_ TOO_ LONG
+ - HOP_
SRC_ MULTIADDR_ INVALID
+ - MALFORMED_
MESSAGE
+ - Message
Proto
+ - STATUS +
- STOP +
- STOP_
DST_ ADDR_ TOO_ LONG
+ - STOP_
DST_ MULTIADDR_ INVALID
+ - STOP_
RELAY_ REFUSED
+ - STOP_
SRC_ ADDR_ TOO_ LONG
+ - STOP_
SRC_ MULTIADDR_ INVALID
+ - SUCCESS +
Type aliases
+CAN_HOP
+
+
+ CircuitMessageProto
+
+
+
+
+ Type declaration
+-
+
-
+
Status: { HOP_CANT_DIAL_DST: HOP_CANT_DIAL_DST; HOP_CANT_OPEN_DST_STREAM: HOP_CANT_OPEN_DST_STREAM; HOP_CANT_RELAY_TO_SELF: HOP_CANT_RELAY_TO_SELF; HOP_CANT_SPEAK_RELAY: HOP_CANT_SPEAK_RELAY; HOP_DST_ADDR_TOO_LONG: HOP_DST_ADDR_TOO_LONG; HOP_DST_MULTIADDR_INVALID: HOP_DST_MULTIADDR_INVALID; HOP_NO_CONN_TO_DST: HOP_NO_CONN_TO_DST; HOP_SRC_ADDR_TOO_LONG: HOP_SRC_ADDR_TOO_LONG; HOP_SRC_MULTIADDR_INVALID: HOP_SRC_MULTIADDR_INVALID; MALFORMED_MESSAGE: MALFORMED_MESSAGE; STOP_DST_ADDR_TOO_LONG: STOP_DST_ADDR_TOO_LONG; STOP_DST_MULTIADDR_INVALID: STOP_DST_MULTIADDR_INVALID; STOP_RELAY_REFUSED: STOP_RELAY_REFUSED; STOP_SRC_ADDR_TOO_LONG: STOP_SRC_ADDR_TOO_LONG; STOP_SRC_MULTIADDR_INVALID: STOP_SRC_MULTIADDR_INVALID; SUCCESS: SUCCESS }
+-
+
-
+
HOP_
+CANT_ DIAL_ DST: HOP_CANT_DIAL_DST
+ -
+
HOP_
+CANT_ OPEN_ DST_ STREAM: HOP_CANT_OPEN_DST_STREAM
+ -
+
HOP_
+CANT_ RELAY_ TO_ SELF: HOP_CANT_RELAY_TO_SELF
+ -
+
HOP_
+CANT_ SPEAK_ RELAY: HOP_CANT_SPEAK_RELAY
+ -
+
HOP_
+DST_ ADDR_ TOO_ LONG: HOP_DST_ADDR_TOO_LONG
+ -
+
HOP_
+DST_ MULTIADDR_ INVALID: HOP_DST_MULTIADDR_INVALID
+ -
+
HOP_
+NO_ CONN_ TO_ DST: HOP_NO_CONN_TO_DST
+ -
+
HOP_
+SRC_ ADDR_ TOO_ LONG: HOP_SRC_ADDR_TOO_LONG
+ -
+
HOP_
+SRC_ MULTIADDR_ INVALID: HOP_SRC_MULTIADDR_INVALID
+ -
+
MALFORMED_
+MESSAGE: MALFORMED_MESSAGE
+ -
+
STOP_
+DST_ ADDR_ TOO_ LONG: STOP_DST_ADDR_TOO_LONG
+ -
+
STOP_
+DST_ MULTIADDR_ INVALID: STOP_DST_MULTIADDR_INVALID
+ -
+
STOP_
+RELAY_ REFUSED: STOP_RELAY_REFUSED
+ -
+
STOP_
+SRC_ ADDR_ TOO_ LONG: STOP_SRC_ADDR_TOO_LONG
+ -
+
STOP_
+SRC_ MULTIADDR_ INVALID: STOP_SRC_MULTIADDR_INVALID
+ -
+
SUCCESS: SUCCESS
+
+
+ -
+
-
+
Type: { CAN_HOP: CAN_HOP; HOP: HOP; STATUS: STATUS; STOP: STOP }
+ +
+ -
+
decode: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
bytes: Uint8Array
+
+
Returns any
+
+ -
+
+ -
+
+
-
+
encode: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
value: any
+
+
Returns Uint8Array
+
+ -
+
+ -
+
+
CircuitPeer
+
+
+
+
+ Type declaration
+-
+
-
+
addrs: Uint8Array[]
+
+ -
+
id: Uint8Array
+
+
CircuitRequest
+
+
+
+
+ Type declaration
+-
+
-
+
dst
+Peer: CircuitPeer
+ -
+
src
+Peer: CircuitPeer
+ -
+
type: CircuitType
+
+
CircuitStatus
+
+
+ CircuitType
+
+
+ HOP
+ + +HOP_CANT_DIAL_DST
+
+
+ HOP_CANT_OPEN_DST_STREAM
+
+
+ HOP_CANT_RELAY_TO_SELF
+
+
+ HOP_CANT_SPEAK_RELAY
+
+
+ HOP_DST_ADDR_TOO_LONG
+
+
+ HOP_DST_MULTIADDR_INVALID
+
+
+ HOP_NO_CONN_TO_DST
+
+
+ HOP_SRC_ADDR_TOO_LONG
+
+
+ HOP_SRC_MULTIADDR_INVALID
+
+
+ MALFORMED_MESSAGE
+
+
+ MessageProto
+
+
+
+
+ Type declaration
+-
+
-
+
decode: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
bytes: Uint8Array
+
+
Returns any
+
+ -
+
+ -
+
+
-
+
encode: function
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
value: any
+
+
Returns Uint8Array
+
+ -
+
+ -
+
+
STATUS
+ + +STOP
+ + +STOP_DST_ADDR_TOO_LONG
+
+
+ STOP_DST_MULTIADDR_INVALID
+
+
+ STOP_RELAY_REFUSED
+
+
+ STOP_SRC_ADDR_TOO_LONG
+
+
+ STOP_SRC_MULTIADDR_INVALID
+
+
+ SUCCESS
+ + +
+
+
+
+
+ Module upgrader
+
+
+
+
+
+
+
\ No newline at end of file
+
+
+
+
+
+
+
+
+
+
+
+
+ Crypto
+
+
+
+
+
+
+
+
+ Multiaddr
+
+
+
+
+
+ Muxed
+
+
+
+
+
+
+
+
+ Muxer
+
+
+
+
+
+
+ Index
+
+
+
+
+
+
+ Classes
+-
+
- Upgrader +
Type aliases
+-
+
- Crypto +
- Crypto
Result
+ - Multiaddr +
- Multiaddr
Connection
+ - Muxed
Stream
+ - Muxer +
- Muxer
Factory
+
Type aliases
+Crypto
+ + +CryptoResult
+
+
+
+
+ Type declaration
+-
+
-
+
conn: MultiaddrConnection
+++++A duplex iterable
+
+ -
+
protocol: string
+
+ -
+
remote
+Peer: PeerId
+
Multiaddr
+ + +MultiaddrConnection
+
+
+
+
+ Type declaration
+-
+
-
+
close: (err?: Error | undefined) => Promise<void>
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
Optional err: Error | undefined
+
+
Returns Promise<void>
+
+ -
+
+ -
+
+ -
+
-
+
conn: unknown
+
+ -
+
Optional local
+Addr?: Multiaddr | undefined
+ -
+
remote
+Addr: Multiaddr
+ -
+
sink: (source: Uint8Array) => Promise<Uint8Array>
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
source: Uint8Array
+
+
Returns Promise<Uint8Array>
+
+ -
+
+ -
+
+ -
+
-
+
source: () => AsyncIterable<Uint8Array>
+-
+
-
+
-
+
+
-
+
-
+
Returns AsyncIterable<Uint8Array>
+
+
+ -
+
+ -
+
-
+
timeline: { close?: undefined | number; open: number; upgraded?: undefined | number }
+-
+
-
+
Optional close?: undefined | number
+
+ -
+
open: number
+
+ -
+
Optional upgraded?: undefined | number
+
+
+ -
+
+- property
+ - property
+
+{string[]} [listen = []] - list of multiaddrs string representation to listen.
+{string[]} [announce = []] - list of multiaddrs string representation to announce.
+