2019-09-23 15:24:47 +02:00
# js-libp2p-utils
2019-09-23 17:39:32 +02:00
[](http://protocol.ai)
[](http://libp2p.io/)
[](http://webchat.freenode.net/?channels=%23libp2p)
[](https://discuss.libp2p.io)
[](https://codecov.io/gh/libp2p/js-libp2p-utils)
[](https://travis-ci.com/libp2p/js-libp2p-utils)
[](https://david-dm.org/libp2p/js-libp2p-utils)
[](https://github.com/feross/standard)
> 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 ](https://github.com/vasco-santos )
## Install
```bash
$ npm install --save libp2p-utils
```
## Usage
Each function should be imported directly.
```js
const ipAndPortToMultiaddr = require('libp2p-utils/src/ip-port-to-multiaddr')
const ma = ipAndPortToMultiaddr('127.0.0.1', 9000)
```
2020-10-07 17:02:08 +02:00
## API
2020-10-07 15:01:44 +02:00
### 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
```js
const PeerId = require('peer-id')
2020-10-07 18:37:24 +02:00
const arrayEquals = require('libp2p-utils/src/array-equals')
2020-10-07 15:01:44 +02:00
const peerId1 = await PeerId.create()
const peerId2 = await PeerId.create()
const equals = arrayEquals([peerId1], [peerId2])
```
2020-10-07 17:02:08 +02:00
### 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
```js
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
```js
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)
```
2020-10-07 15:01:44 +02:00
### 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` | port for multiaddr |
#### Returns
| Type | Description |
|------|-------------|
| `Multiaddr` | returns created multiaddr |
#### Example
```js
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 ](https://github.com/libp2p/interface-transport#multiaddrconnection ).
#### Parameters
| Name | Type | Description |
|------|------|-------------|
| streamProperties | `object` | duplex stream properties |
| streamProperties.stream | [`DuplexStream` ](https://github.com/libp2p/js-libp2p/blob/master/doc/STREAMING_ITERABLES.md#duplex ) | 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 ](https://github.com/libp2p/js-libp2p-interfaces/tree/master/src/connection ) |
#### Example
```js
const streamToMaConnection = require('libp2p-utils/src/stream-to-ma-conn')
const stream = {
sink: async source => {/* ... */},
source: { [Symbol.asyncIterator] () {/* ... */} }
}
const conn = streamToMaConnection({
stream,
remoteAddr: /* ... */
localAddr; /* ... */
})
```
2019-09-23 17:39:32 +02:00
## Contribute
Contributions welcome. Please check out [the issues ](https://github.com/libp2p/js-libp2p-utils/issues ).
Check out our [contributing document ](https://github.com/ipfs/community/blob/master/contributing.md ) 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 ](https://github.com/ipfs/community/blob/master/code-of-conduct.md ).
## License
[MIT ](LICENSE ) © Protocol Labs Inc.
