A PeerInfo object contains information about a PeerID and its multiaddrs. This module is used by IPFS and libp2p.
> npm i peer-info
const PeerInfo = require('peer-info')
<script> TagLoading this module through a script tag will make the PeerInfo obj available in the global namespace.
<script src="https://unpkg.com/peer-info/dist/index.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/peer-info/dist/index.js"></script>
const PeerInfo = require('peer-info')
const multiaddr = require('multiaddr')
const peer = new PeerInfo()
// TCP port 5001
peer.multiaddr.add(multiaddr('/ip4/1.2.3.4/tcp/5001'))
// UDP port 8001
peer.multiaddr.add(multiaddr('/ip4/1.2.3.4/udp/8001'))
// mic/speaker soundwaves using frequencies 697 and 1209
peer.multiaddr.add(multiaddr('/sonic/bfsk/697/1209'))
const PeerInfo = require('peer-info')
PeerInfo.create([id, ] callback)id: PeerID, optionalcallback: FunctionCreates a new PeerInfo instance and if no id is passed it
generates a new underlying PeerID
for it.
new PeerInfo(id)id: PeerIDCreates a new PeerInfo instance from an existing PeerID.
multiaddrsA list of multiaddresses instances that peer can be reached at.
multiaddr.add(addr)addr: MultiaddrAdds a new multiaddress that peer can be reached at. addr is an instance of
a multiaddr.
multiaddr.addSafe(addr)addr: MultiaddrThe addSafe call, in comparison to add, will only add the multiaddr to
multiaddrs if the same multiaddr tries to be added twice.
This is a simple mechanism to prevent multiaddrs from becoming bloated with
unusable addresses, which happens when we exchange observed multiaddrs with
peers which will not provide a useful multiaddr to be shared to the rest of the
network (e.g. a multiaddr referring to a peer inside a LAN being shared to the
outside world).
multiaddr.rm(addr)addr: MultiaddrRemoves a multiaddress instance addr from peer.
multiaddr.replace(existing, fresh)existing: Multiaddrfresh: MultiaddrRemoves the array of multiaddresses existing from peer, and adds the array
of multiaddresses fresh.
PRs accepted.
Small note: If editing the Readme, please conform to the standard-readme specification.
0.8.1 (2016-11-22)
<a name="0.8.0"></a>
FAQs
IPFS Peer abstraction JavaScript implementation
The npm package peer-info receives a total of 4,282 weekly downloads. As such, peer-info popularity was classified as popular.
We found that peer-info demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.