js-libp2p-utils/README.md

js-libp2p-utils

This package serves as a central repository for shared logic and dependencies for all libp2p packages, using libp2p-utils helps to easily re-use small scoped blocks of logic across all libp2p modules and also as a dependency proxy (think aegir for domain logic dependencies).

The libp2p ecosystem has lots of repos with it comes several problems like:

• Domain logic dedupe - all modules shared a lot of logic like validation, streams handling, etc.
• Dependencies management - it's really easy with so many repos for dependencies to go out of control, they become outdated, different repos use different modules to do the same thing (like merging defaults options), browser bundles ends up with multiple versions of the same package, bumping versions is cumbersome to do because we need to go through several repos, etc.

These problems are the motivation for this package, having shared logic in this package avoids creating cyclic dependencies, centralizes common use modules/functions (exactly like aegir does for the tooling), semantic versioning for 3rd party dependencies is handled in one single place (a good example is going from streams 2 to 3) and maintainers should only care about having libp2p-utils updated.

Lead Maintainer

Vasco Santos

Install

$ npm install --save libp2p-utils

Usage

Each function should be imported directly.

const ipAndPortToMultiaddr = require('libp2p-utils/src/ip-port-to-multiaddr')

const ma = ipAndPortToMultiaddr('127.0.0.1', 9000)

API

arrayEquals(a, b)

Verify if two arrays of non primitive types with the "equals" function are equal. Compatible with multiaddr, peer-id and others.

Parameters

Name	Type	Description
a	Array<*>	First array to verify
b	Array<*>	Second array to verify

Returns

Type	Description
boolean	returns true if arrays are equal, false otherwise

Example

const PeerId = require('peer-id')
const arrayEquals = require('libp2p-utils/src/array-equals')

const peerId1 = await PeerId.create()
const peerId2 = await PeerId.create()

const equals = arrayEquals([peerId1], [peerId2])

multiaddr .isLoopback(ma)

Check if a given multiaddr is a loopback address.

Parameters

Name	Type	Description
ma	Multiaddr	multiaddr to verify

Returns

Type	Description
boolean	returns true if multiaddr is a loopback address, false otherwise

Example

const multiaddr = require('multiaddr')
const isLoopback = require('libp2p-utils/src/multiaddr/is-loopback')

const ma = multiaddr('/ip4/127.0.0.1/tcp/1000')
isMultiaddrLoopbackAddrs = isLoopback(ma)

multiaddr .isPrivate(ma)

Check if a given multiaddr has a private address.

Parameters

Name	Type	Description
ma	Multiaddr	multiaddr to verify

Returns

Type	Description
boolean	returns true if multiaddr is a private address, false otherwise

Example

const multiaddr = require('multiaddr')
const isPrivate = require('libp2p-utils/src/multiaddr/is-private')

const ma = multiaddr('/ip4/10.0.0.1/tcp/1000')
isMultiaddrPrivateAddrs = isPrivate(ma)

ipPortToMultiaddr(ip, port)

Transform an IP, Port pair into a multiaddr with tcp transport.

Parameters

Name	Type	Description
ip	string	ip for multiaddr
port	`number	string`

Returns

Type	Description
Multiaddr	returns created multiaddr

Example

const ipPortPairToMultiaddr = require('libp2p-utils/src/multiaddr/ip-port-to-multiaddr')
const ip = '127.0.0.1'
const port = '9090'

const ma = ipPortPairToMultiaddr(ma)

streamToMaConnection(streamProperties, options)

Convert a duplex stream into a MultiaddrConnection.

Parameters

Name	Type	Description
streamProperties	object	duplex stream properties
streamProperties.stream	DuplexStream	duplex stream
streamProperties.remoteAddr	Multiaddr	stream remote address
streamProperties.localAddr	Multiaddr	stream local address
[options]	object	options
[options.signal]	AbortSignal	abort signal

Returns

Type	Description
Connection	returns a multiaddr Connection

Example

const streamToMaConnection = require('libp2p-utils/src/stream-to-ma-conn')

const stream = {
  sink: async source => {/* ... */},
  source: { [Symbol.asyncIterator] () {/* ... */} }
}

const conn = streamToMaConnection({
  stream,
  remoteAddr: /* ... */
  localAddr; /* ... */
})

Contribute

Contributions welcome. Please check out the issues.

Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

License

MIT © Protocol Labs Inc.