Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libp2p/js-peer-info
libp2p Peer abstraction Node.js implementation
https://github.com/libp2p/js-peer-info
Last synced: 9 days ago
JSON representation
libp2p Peer abstraction Node.js implementation
- Host: GitHub
- URL: https://github.com/libp2p/js-peer-info
- Owner: libp2p
- License: mit
- Archived: true
- Created: 2015-07-08T22:49:06.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-06-12T09:48:31.000Z (over 4 years ago)
- Last Synced: 2024-04-14T12:09:59.270Z (7 months ago)
- Language: JavaScript
- Homepage: https://libp2p.io
- Size: 1.43 MB
- Stars: 37
- Watchers: 21
- Forks: 28
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-peer-to-peer - peer-info
README
⛔️ DEPRECATED: peer-info is not used anymore in favour of storing this data in the [PeerStore](https://github.com/libp2p/js-libp2p/tree/master/src/peer-store) from [[email protected]](https://github.com/libp2p/js-libp2p/releases/tag/v0.28.0).
======
# js-peer-info
[](http://protocol.ai)
[](http://libp2p.io/)
[](http://webchat.freenode.net/?channels=%23libp2p)
[](https://discuss.libp2p.io)
[](https://codecov.io/gh/libp2p/js-peer-info)
[](https://travis-ci.com/libp2p/js-peer-info)
[](https://david-dm.org/libp2p/js-peer-info)
[](https://github.com/feross/standard)
## Lead Maintainer
[Vasco Santos](https://github.com/vasco-santos)
## Table of Contents
- [js-peer-info](#js-peer-info)
- [Lead Maintainer](#lead-maintainer)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [npm](#npm)
- [Node.JS, Browserify, Webpack](#nodejs-browserify-webpack)
- [Browser: `` Tag](#browser-script-tag)
- [Usage](#usage)
- [API](#api)
- [`PeerInfo.create([id])`](#peerinfocreateid)
- [`new PeerInfo(id)`](#new-peerinfoid)
- [`.id`](#id)
- [`protocols`](#protocols)
- [`.protocols.add(protocol)`](#protocolsaddprotocol)
- [`.protocols.delete(protocol)`](#protocolsdeleteprotocol)
- [`.multiaddrs`](#multiaddrs)
- [`.multiaddrs.add(addr)`](#multiaddrsaddaddr)
- [`.multiaddrs.addSafe(addr)`](#multiaddrsaddsafeaddr)
- [`.multiaddrs.delete(addr)`](#multiaddrsdeleteaddr)
- [`.multiaddrs.replace(existing, fresh)`](#multiaddrsreplaceexisting-fresh)
- [`.connect(ma)`](#connectma)
- [`.disconnect()`](#disconnect)
- [`.isConnected()`](#isconnected)
- [Contribute](#contribute)
- [License](#license)
## Installation
### npm
```sh
> npm i peer-info
```
### Node.JS, Browserify, Webpack
```js
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.
```html
<script src="https://unpkg.com/peer-info/dist/index.min.js">
```
## Usage
```js
const PeerInfo = require('peer-info')
const peer = new PeerInfo()
// TCP port 5001
peer.multiaddrs.add('/ip4/1.2.3.4/tcp/5001')
// UDP port 8001
peer.multiaddrs.add('/ip4/1.2.3.4/udp/8001')
// mic/speaker soundwaves using frequencies 697 and 1209
peer.multiaddrs.add('/sonic/bfsk/697/1209')
```
## API
```js
const PeerInfo = require('peer-info')
```
### `PeerInfo.create([id])`
- `id` optional - can be a PeerId or a JSON object(will be parsed with https://github.com/libp2p/js-peer-id#createfromjsonobj)
Creates a new PeerInfo instance and if no `id` is passed it
generates a new underlying [PeerID](https://github.com/libp2p/js-peer-id)
for it.
Returns `Promise`.
### `new PeerInfo(id)`
- `id: PeerId` - instance of PeerId (optional)
Creates a new PeerInfo instance from an existing PeerId.
### `.id`
The [PeerId](https://github.com/libp2p/js-peer-id) of the peer this info relates to.
### `protocols`
A list of protocols that `peer` supports.
### `.protocols.add(protocol)`
Adds a protocol that `peer` can support. `protocol` is a string.
### `.protocols.delete(protocol)`
Removes a protocol that `peer` no longer supports. `protocol` is a string.
### `.multiaddrs`
A list of multiaddresses instances that `peer` can be reached at.
### `.multiaddrs.add(addr)`
- `addr: Multiaddr`
Adds a new multiaddress that `peer` can be reached at. `addr` is an instance of
a [multiaddr](https://github.com/multiformats/js-multiaddr).
### `.multiaddrs.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).
### `.multiaddrs.delete(addr)`
- `addr: Multiaddr`
Removes a multiaddress instance `addr` from `peer`.
### `.multiaddrs.replace(existing, fresh)`
- `existing: Multiaddr`
- `fresh: Multiaddr`
Removes the array of multiaddresses `existing` from `peer`, and adds the array
of multiaddresses `fresh`.
### `.connect(ma)`
Records the given multiaddr, `ma` as the active multiaddr of the peer.
- `ma: Multiaddr`
### `.disconnect()`
Removes the existing connected Multiaddr from tracking.
### `.isConnected()`
Returns `true` if a connected Multiaddr exists, otherwise returns `false`.
## Contribute
PRs accepted.
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## License
[MIT © David Dias](LICENSE)