JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 26164
  • Score
    100M100P100Q66893F
  • License MIT

IPFS Peer abstraction JavaScript implementation

Package Exports

  • peer-info

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (peer-info) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

js-peer-info

Build Status Coverage Status Dependency Status js-standard-style standard-readme compliant

Sauce Test Status

A PeerInfo object contains information about a PeerID and its multiaddrs. This module is used by IPFS and libp2p.

Table of Contents

Installation

npm

> npm i peer-info

Node.JS, Browserify, Webpack

const PeerInfo = require('peer-info')

Browser: <script> Tag

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

Usage

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'))

API

const PeerInfo = require('peer-info')

PeerInfo.create([id, ] callback)

  • id: PeerID, optional
  • callback: Function

Creates a new PeerInfo instance and if no id is passed it generates a new underlying PeerID for it.

new PeerInfo(id)

  • id: PeerID

Creates a new PeerInfo instance from an existing PeerID.

multiaddrs

A list of multiaddresses instances that peer can be reached at.

multiaddr.add(addr)

  • addr: Multiaddr

Adds a new multiaddress that peer can be reached at. addr is an instance of a multiaddr.

multiaddr.addSafe(addr)

  • addr: Multiaddr

The 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: Multiaddr

Removes a multiaddress instance addr from peer.

multiaddr.replace(existing, fresh)

  • existing: Multiaddr
  • fresh: Multiaddr

Removes the array of multiaddresses existing from peer, and adds the array of multiaddresses fresh.

Contribute

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT © David Dias