@libp2p/utils 0.0.0 → 1.0.0

package/LICENSE

@@ -0,0 +1,2 @@
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md

@@ -0,0 +1,51 @@
+# js-libp2p-utils
+
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
+[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
+[![](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-utils.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-utils)
+[![](https://img.shields.io/travis/libp2p/js-libp2p-utils.svg?style=flat-square)](https://travis-ci.com/libp2p/js-libp2p-utils)
+[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-utils.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-utils)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](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
+import ipAndPortToMultiaddr from '@libp2p/utils/ip-port-to-multiaddr'
+
+const ma = ipAndPortToMultiaddr('127.0.0.1', 9000)
+```
+
+You can check the [API docs](./API.md).
+
+## 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.

package/dist/src/address-sort.d.ts

@@ -0,0 +1,12 @@
+import type { Multiaddr } from '@multiformats/multiaddr';
+interface Address {
+    multiaddr: Multiaddr;
+    isCertified: boolean;
+}
+/**
+ * Sort given addresses by putting public addresses first.
+ * In case of equality, a certified address will come first.
+ */
+export declare function publicAddressesFirst(addresses: Address[]): Address[];
+export {};
+//# sourceMappingURL=address-sort.d.ts.map

package/dist/src/address-sort.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"address-sort.d.ts","sourceRoot":"","sources":["../../src/address-sort.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGxD,UAAU,OAAO;IACf,SAAS,EAAE,SAAS,CAAA;IACpB,WAAW,EAAE,OAAO,CAAA;CACrB;AAoCD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAE,SAAS,EAAE,OAAO,EAAE,aAEzD"}

package/dist/src/address-sort.js

@@ -0,0 +1,41 @@
+import { isPrivate } from './multiaddr/is-private.js';
+/**
+ * @typedef {Object} Address
+ * @property {Multiaddr} multiaddr peer multiaddr.
+ * @property {boolean} isCertified obtained from a signed peer record.
+ */
+/**
+ * Compare function for array.sort().
+ * This sort aims to move the private adresses to the end of the array.
+ * In case of equality, a certified address will come first.
+ *
+ * @param {Address} a
+ * @param {Address} b
+ * @returns {number}
+ */
+function addressesPublicFirstCompareFunction(a, b) {
+    const isAPrivate = isPrivate(a.multiaddr);
+    const isBPrivate = isPrivate(b.multiaddr);
+    if (isAPrivate && !isBPrivate) {
+        return 1;
+    }
+    else if (!isAPrivate && isBPrivate) {
+        return -1;
+    }
+    // Check certified?
+    if (a.isCertified && !b.isCertified) {
+        return -1;
+    }
+    else if (!a.isCertified && b.isCertified) {
+        return 1;
+    }
+    return 0;
+}
+/**
+ * Sort given addresses by putting public addresses first.
+ * In case of equality, a certified address will come first.
+ */
+export function publicAddressesFirst(addresses) {
+    return [...addresses].sort(addressesPublicFirstCompareFunction);
+}
+//# sourceMappingURL=address-sort.js.map

package/dist/src/address-sort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address-sort.js","sourceRoot":"","sources":["../../src/address-sort.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAOrD;;;;GAIG;AAEH;;;;;;;;GAQG;AACH,SAAS,mCAAmC,CAAE,CAAU,EAAE,CAAU;IAClE,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IACzC,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAEzC,IAAI,UAAU,IAAI,CAAC,UAAU,EAAE;QAC7B,OAAO,CAAC,CAAA;KACT;SAAM,IAAI,CAAC,UAAU,IAAI,UAAU,EAAE;QACpC,OAAO,CAAC,CAAC,CAAA;KACV;IACD,mBAAmB;IACnB,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE;QACnC,OAAO,CAAC,CAAC,CAAA;KACV;SAAM,IAAI,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,WAAW,EAAE;QAC1C,OAAO,CAAC,CAAA;KACT;IAED,OAAO,CAAC,CAAA;AACV,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAE,SAAoB;IACxD,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAA;AACjE,CAAC"}

package/dist/src/array-equals.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Verify if two arrays of non primitive types with the "equals" function are equal.
+ * Compatible with multiaddr, peer-id and others.
+ */
+export declare function arrayEquals(a: any[], b: any[]): boolean;
+//# sourceMappingURL=array-equals.d.ts.map

package/dist/src/array-equals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array-equals.d.ts","sourceRoot":"","sources":["../../src/array-equals.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,WAAW,CAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,WAG9C"}

package/dist/src/array-equals.js

@@ -0,0 +1,9 @@
+/**
+ * Verify if two arrays of non primitive types with the "equals" function are equal.
+ * Compatible with multiaddr, peer-id and others.
+ */
+export function arrayEquals(a, b) {
+    const sort = (a, b) => a.toString().localeCompare(b.toString());
+    return a.length === b.length && b.sort(sort) && a.sort(sort).every((item, index) => b[index].equals(item));
+}
+//# sourceMappingURL=array-equals.js.map

package/dist/src/array-equals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array-equals.js","sourceRoot":"","sources":["../../src/array-equals.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAE,CAAQ,EAAE,CAAQ;IAC7C,MAAM,IAAI,GAAG,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IACzE,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AAC5G,CAAC"}

package/dist/src/ip-port-to-multiaddr.d.ts

@@ -0,0 +1,11 @@
+import { Multiaddr } from '@multiformats/multiaddr';
+export declare const Errors: {
+    ERR_INVALID_IP_PARAMETER: string;
+    ERR_INVALID_PORT_PARAMETER: string;
+    ERR_INVALID_IP: string;
+};
+/**
+ * Transform an IP, Port pair into a multiaddr
+ */
+export declare function ipPortToMultiaddr(ip: string, port: number | string): Multiaddr;
+//# sourceMappingURL=ip-port-to-multiaddr.d.ts.map

package/dist/src/ip-port-to-multiaddr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ip-port-to-multiaddr.d.ts","sourceRoot":"","sources":["../../src/ip-port-to-multiaddr.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAQnD,eAAO,MAAM,MAAM;;;;CAIlB,CAAA;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,aA8BnE"}

package/dist/src/ip-port-to-multiaddr.js

@@ -0,0 +1,45 @@
+import debug from 'debug';
+import { Multiaddr } from '@multiformats/multiaddr';
+import errCode from 'err-code';
+import { Address4, Address6 } from '@achingbrain/ip-address';
+const log = Object.assign(debug('libp2p:ip-port-to-multiaddr'), {
+    error: debug('libp2p:ip-port-to-multiaddr:err')
+});
+export const Errors = {
+    ERR_INVALID_IP_PARAMETER: 'ERR_INVALID_IP_PARAMETER',
+    ERR_INVALID_PORT_PARAMETER: 'ERR_INVALID_PORT_PARAMETER',
+    ERR_INVALID_IP: 'ERR_INVALID_IP'
+};
+/**
+ * Transform an IP, Port pair into a multiaddr
+ */
+export function ipPortToMultiaddr(ip, port) {
+    if (typeof ip !== 'string') {
+        throw errCode(new Error(`invalid ip provided: ${ip}`), Errors.ERR_INVALID_IP_PARAMETER); // eslint-disable-line @typescript-eslint/restrict-template-expressions
+    }
+    if (typeof port === 'string') {
+        port = parseInt(port);
+    }
+    if (isNaN(port)) {
+        throw errCode(new Error(`invalid port provided: ${port}`), Errors.ERR_INVALID_PORT_PARAMETER);
+    }
+    try {
+        // Test valid IPv4
+        new Address4(ip); // eslint-disable-line no-new
+        return new Multiaddr(`/ip4/${ip}/tcp/${port}`);
+    }
+    catch { }
+    try {
+        // Test valid IPv6
+        const ip6 = new Address6(ip);
+        return ip6.is4()
+            ? new Multiaddr(`/ip4/${ip6.to4().correctForm()}/tcp/${port}`)
+            : new Multiaddr(`/ip6/${ip}/tcp/${port}`);
+    }
+    catch (err) {
+        const errMsg = `invalid ip:port for creating a multiaddr: ${ip}:${port}`;
+        log.error(errMsg);
+        throw errCode(new Error(errMsg), Errors.ERR_INVALID_IP);
+    }
+}
+//# sourceMappingURL=ip-port-to-multiaddr.js.map

package/dist/src/ip-port-to-multiaddr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ip-port-to-multiaddr.js","sourceRoot":"","sources":["../../src/ip-port-to-multiaddr.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AAE5D,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,EAAE;IAC9D,KAAK,EAAE,KAAK,CAAC,iCAAiC,CAAC;CAChD,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,wBAAwB,EAAE,0BAA0B;IACpD,0BAA0B,EAAE,4BAA4B;IACxD,cAAc,EAAE,gBAAgB;CACjC,CAAA;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAE,EAAU,EAAE,IAAqB;IAClE,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QAC1B,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,wBAAwB,EAAE,EAAE,CAAC,EAAE,MAAM,CAAC,wBAAwB,CAAC,CAAA,CAAC,uEAAuE;KAChK;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;KACtB;IAED,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE;QACf,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,0BAA0B,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,0BAA0B,CAAC,CAAA;KAC9F;IAED,IAAI;QACF,kBAAkB;QAClB,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAA,CAAC,6BAA6B;QAC9C,OAAO,IAAI,SAAS,CAAC,QAAQ,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAA;KAC/C;IAAC,MAAM,GAAE;IAEV,IAAI;QACF,kBAAkB;QAClB,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAA;QAC5B,OAAO,GAAG,CAAC,GAAG,EAAE;YACd,CAAC,CAAC,IAAI,SAAS,CAAC,QAAQ,GAAG,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,QAAQ,IAAI,EAAE,CAAC;YAC9D,CAAC,CAAC,IAAI,SAAS,CAAC,QAAQ,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAA;KAC5C;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,MAAM,GAAG,6CAA6C,EAAE,IAAI,IAAI,EAAE,CAAA;QACxE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QACjB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC,CAAA;KACxD;AACH,CAAC"}

package/dist/src/multiaddr/is-loopback.d.ts

@@ -0,0 +1,6 @@
+import type { Multiaddr } from '@multiformats/multiaddr';
+/**
+ * Check if a given multiaddr is a loopback address.
+ */
+export declare function isLoopback(ma: Multiaddr): any;
+//# sourceMappingURL=is-loopback.d.ts.map

package/dist/src/multiaddr/is-loopback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-loopback.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-loopback.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD;;GAEG;AACH,wBAAgB,UAAU,CAAE,EAAE,EAAE,SAAS,OAIxC"}

package/dist/src/multiaddr/is-loopback.js

@@ -0,0 +1,10 @@
+// @ts-expect-error is-loopback-addr does not publish types
+import isLoopbackAddr from 'is-loopback-addr';
+/**
+ * Check if a given multiaddr is a loopback address.
+ */
+export function isLoopback(ma) {
+    const { address } = ma.nodeAddress();
+    return isLoopbackAddr(address);
+}
+//# sourceMappingURL=is-loopback.js.map

package/dist/src/multiaddr/is-loopback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-loopback.js","sourceRoot":"","sources":["../../../src/multiaddr/is-loopback.ts"],"names":[],"mappings":"AAAA,2DAA2D;AAC3D,OAAO,cAAc,MAAM,kBAAkB,CAAA;AAG7C;;GAEG;AACH,MAAM,UAAU,UAAU,CAAE,EAAa;IACvC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,CAAA;IAEpC,OAAO,cAAc,CAAC,OAAO,CAAC,CAAA;AAChC,CAAC"}

package/dist/src/multiaddr/is-private.d.ts

@@ -0,0 +1,6 @@
+import type { Multiaddr } from '@multiformats/multiaddr';
+/**
+ * Check if a given multiaddr has a private address.
+ */
+export declare function isPrivate(ma: Multiaddr): boolean;
+//# sourceMappingURL=is-private.d.ts.map

package/dist/src/multiaddr/is-private.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-private.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-private.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGxD;;GAEG;AACH,wBAAgB,SAAS,CAAE,EAAE,EAAE,SAAS,WAIvC"}

package/dist/src/multiaddr/is-private.js

@@ -0,0 +1,9 @@
+import isIpPrivate from 'private-ip';
+/**
+ * Check if a given multiaddr has a private address.
+ */
+export function isPrivate(ma) {
+    const { address } = ma.nodeAddress();
+    return Boolean(isIpPrivate(address));
+}
+//# sourceMappingURL=is-private.js.map

package/dist/src/multiaddr/is-private.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-private.js","sourceRoot":"","sources":["../../../src/multiaddr/is-private.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,YAAY,CAAA;AAEpC;;GAEG;AACH,MAAM,UAAU,SAAS,CAAE,EAAa;IACtC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,CAAA;IAEpC,OAAO,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;AACtC,CAAC"}

package/dist/src/stream-to-ma-conn.d.ts

@@ -0,0 +1,38 @@
+import type { MuxedStream } from '@libp2p/interfaces/stream-muxer';
+import type { Multiaddr } from '@multiformats/multiaddr';
+import type { MultiaddrConnection } from '@libp2p/interfaces/transport';
+/**
+ * @typedef {Object} Timeline
+ * @property {number} open -
+ * @property {number} [upgraded] - .
+ * @property {number} [close]
+ */
+export interface Timeline {
+    /**
+     * Connection opening timestamp
+     */
+    open: number;
+    /**
+     * Connection upgraded timestamp
+     */
+    upgraded?: number;
+    /**
+     * Connection closed timestamp
+     */
+    close?: number;
+}
+interface StreamOptions {
+    signal?: AbortSignal;
+}
+interface StreamProperties {
+    stream: MuxedStream<Uint8Array>;
+    remoteAddr: Multiaddr;
+    localAddr: Multiaddr;
+}
+/**
+ * Convert a duplex iterable into a MultiaddrConnection.
+ * https://github.com/libp2p/interface-transport#multiaddrconnection
+ */
+export declare function streamToMaConnection(props: StreamProperties, options?: StreamOptions): MultiaddrConnection<Uint8Array>;
+export {};
+//# sourceMappingURL=stream-to-ma-conn.d.ts.map

package/dist/src/stream-to-ma-conn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-to-ma-conn.d.ts","sourceRoot":"","sources":["../../src/stream-to-ma-conn.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAA;AAIvE;;;;;GAKG;AAEH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,UAAU,aAAa;IACrB,MAAM,CAAC,EAAE,WAAW,CAAA;CAErB;AAED,UAAU,gBAAgB;IACxB,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC,CAAA;IAC/B,UAAU,EAAE,SAAS,CAAA;IACrB,SAAS,EAAE,SAAS,CAAA;CACrB;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAE,KAAK,EAAE,gBAAgB,EAAE,OAAO,GAAE,aAAkB,mCA4CzF"}

package/dist/src/stream-to-ma-conn.js

@@ -0,0 +1,51 @@
+import { source as abortable } from 'abortable-iterator';
+import debug from 'debug';
+const log = debug('libp2p:stream:converter');
+/**
+ * Convert a duplex iterable into a MultiaddrConnection.
+ * https://github.com/libp2p/interface-transport#multiaddrconnection
+ */
+export function streamToMaConnection(props, options = {}) {
+    const { stream, remoteAddr, localAddr } = props;
+    const { sink, source } = stream;
+    const maConn = {
+        async sink(source) {
+            if (options.signal != null) {
+                source = abortable(source, options.signal);
+            }
+            try {
+                await sink(source);
+                await close();
+            }
+            catch (err) {
+                // If aborted we can safely ignore
+                if (err.type !== 'aborted') {
+                    // If the source errored the socket will already have been destroyed by
+                    // toIterable.duplex(). If the socket errored it will already be
+                    // destroyed. There's nothing to do here except log the error & return.
+                    log(err);
+                }
+            }
+        },
+        source: (options.signal != null) ? abortable(source, options.signal) : source,
+        conn: stream,
+        localAddr,
+        remoteAddr,
+        /** @type {Timeline} */
+        timeline: { open: Date.now(), close: undefined },
+        async close() {
+            await sink(async function* () {
+                yield new Uint8Array(0);
+            }());
+            await close();
+        }
+    };
+    async function close() {
+        if (maConn.timeline.close == null) {
+            maConn.timeline.close = Date.now();
+        }
+        return await Promise.resolve();
+    }
+    return maConn;
+}
+//# sourceMappingURL=stream-to-ma-conn.js.map

package/dist/src/stream-to-ma-conn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-to-ma-conn.js","sourceRoot":"","sources":["../../src/stream-to-ma-conn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,MAAM,GAAG,GAAG,KAAK,CAAC,yBAAyB,CAAC,CAAA;AAqC5C;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAE,KAAuB,EAAE,UAAyB,EAAE;IACxF,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,KAAK,CAAA;IAC/C,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC/B,MAAM,MAAM,GAAwB;QAClC,KAAK,CAAC,IAAI,CAAE,MAAM;YAChB,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE;gBAC1B,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;aAC3C;YAED,IAAI;gBACF,MAAM,IAAI,CAAC,MAAM,CAAC,CAAA;gBAClB,MAAM,KAAK,EAAE,CAAA;aACd;YAAC,OAAO,GAAQ,EAAE;gBACjB,kCAAkC;gBAClC,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE;oBAC1B,uEAAuE;oBACvE,gEAAgE;oBAChE,uEAAuE;oBACvE,GAAG,CAAC,GAAG,CAAC,CAAA;iBACT;aACF;QACH,CAAC;QACD,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM;QAC7E,IAAI,EAAE,MAAM;QACZ,SAAS;QACT,UAAU;QACV,uBAAuB;QACvB,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;QAChD,KAAK,CAAC,KAAK;YACT,MAAM,IAAI,CAAC,KAAK,SAAU,CAAC;gBACzB,MAAM,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;YACzB,CAAC,EAAE,CAAC,CAAA;YACJ,MAAM,KAAK,EAAE,CAAA;QACf,CAAC;KACF,CAAA;IAED,KAAK,UAAU,KAAK;QAClB,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,EAAE;YACjC,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;SACnC;QACD,OAAO,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;IAChC,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC"}

package/package.json

@@ -1,7 +1,91 @@
 {
   "name": "@libp2p/utils",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
-  "license": "(Apache-2.0 OR MIT)"
+  "version": "1.0.0",
+  "description": "Package to aggregate shared logic and dependencies for the libp2p ecosystem",
+  "leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>",
+  "type": "module",
+  "exports": {
+    "multiaddr/is-loopback": {
+      "import": "./dist/src/multiaddr/is-loopback.js",
+      "types": "./dist/src/multiaddr/is-loopback.d.ts"
+    },
+    "multiaddr/is-private": {
+      "import": "./dist/src/multiaddr/is-private.js",
+      "types": "./dist/src/multiaddr/is-private.d.ts"
+    },
+    "address-sort": {
+      "import": "./dist/src/address-sort.js",
+      "types": "./dist/src/address-sort.d.ts"
+    },
+    "array-equals": {
+      "import": "./dist/src/array-equals.js",
+      "types": "./dist/src/array-equals.d.ts"
+    },
+    "ip-port-to-multiaddr": {
+      "import": "./dist/src/ip-port-to-multiaddr.js",
+      "types": "./dist/src/ip-port-to-multiaddr.d.ts"
+    },
+    "stream-to-ma-conn": {
+      "import": "./dist/src/stream-to-ma-connr.js",
+      "types": "./dist/src/stream-to-ma-connr.d.ts"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "src/*": [
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist/src"
+  ],
+  "scripts": {
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check dist/src/**/*.js dist/test/**/*.js",
+    "build": "tsc",
+    "pretest": "npm run build",
+    "test": "aegir test -f ./dist/test/**/*.js",
+    "test:chrome": "npm run test -- -t browser",
+    "test:chrome-webworker": "npm run test -- -t webworker",
+    "test:firefox": "npm run test -- -t browser -- --browser firefox",
+    "test:firefox-webworker": "npm run test -- -t webworker -- --browser firefox",
+    "test:node": "npm run test -- -t node --cov",
+    "test:electron-main": "npm run test -- -t electron-main",
+    "release": "semantic-release"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/libp2p/js-libp2p-utils.git"
+  },
+  "license": "(Apache-2.0 OR MIT)",
+  "bugs": {
+    "url": "https://github.com/libp2p/js-libp2p-utils/issues"
+  },
+  "homepage": "https://github.com/libp2p/js-libp2p-utils#readme",
+  "devDependencies": {
+    "@libp2p/interfaces": "^0.2.0",
+    "@types/debug": "^4.1.5",
+    "aegir": "^36.1.2",
+    "it-pair": "^1.0.0",
+    "it-pipe": "^1.1.0",
+    "streaming-iterables": "^6.0.0",
+    "util": "^0.12.3"
+  },
+  "dependencies": {
+    "@achingbrain/ip-address": "^8.1.0",
+    "@multiformats/multiaddr": "^10.1.1",
+    "abortable-iterator": "^3.0.0",
+    "debug": "^4.3.0",
+    "err-code": "^3.0.1",
+    "is-loopback-addr": "^1.0.0",
+    "private-ip": "^2.1.1"
+  },
+  "contributors": [
+    "Vasco Santos <vasco.santos@moxy.studio>",
+    "Alex Potsides <alex@achingbrain.net>",
+    "Jacob Heun <jacobheun@gmail.com>"
+  ]
 }

package/src/address-sort.ts

@@ -0,0 +1,49 @@
+import type { Multiaddr } from '@multiformats/multiaddr'
+import { isPrivate } from './multiaddr/is-private.js'
+
+interface Address {
+  multiaddr: Multiaddr
+  isCertified: boolean
+}
+
+/**
+ * @typedef {Object} Address
+ * @property {Multiaddr} multiaddr peer multiaddr.
+ * @property {boolean} isCertified obtained from a signed peer record.
+ */
+
+/**
+ * Compare function for array.sort().
+ * This sort aims to move the private adresses to the end of the array.
+ * In case of equality, a certified address will come first.
+ *
+ * @param {Address} a
+ * @param {Address} b
+ * @returns {number}
+ */
+function addressesPublicFirstCompareFunction (a: Address, b: Address) {
+  const isAPrivate = isPrivate(a.multiaddr)
+  const isBPrivate = isPrivate(b.multiaddr)
+
+  if (isAPrivate && !isBPrivate) {
+    return 1
+  } else if (!isAPrivate && isBPrivate) {
+    return -1
+  }
+  // Check certified?
+  if (a.isCertified && !b.isCertified) {
+    return -1
+  } else if (!a.isCertified && b.isCertified) {
+    return 1
+  }
+
+  return 0
+}
+
+/**
+ * Sort given addresses by putting public addresses first.
+ * In case of equality, a certified address will come first.
+ */
+export function publicAddressesFirst (addresses: Address[]) {
+  return [...addresses].sort(addressesPublicFirstCompareFunction)
+}

package/src/array-equals.ts

@@ -0,0 +1,8 @@
+/**
+ * Verify if two arrays of non primitive types with the "equals" function are equal.
+ * Compatible with multiaddr, peer-id and others.
+ */
+export function arrayEquals (a: any[], b: any[]) {
+  const sort = (a: any, b: any) => a.toString().localeCompare(b.toString())
+  return a.length === b.length && b.sort(sort) && a.sort(sort).every((item, index) => b[index].equals(item))
+}

package/src/ip-port-to-multiaddr.ts

@@ -0,0 +1,49 @@
+import debug from 'debug'
+import { Multiaddr } from '@multiformats/multiaddr'
+import errCode from 'err-code'
+import { Address4, Address6 } from '@achingbrain/ip-address'
+
+const log = Object.assign(debug('libp2p:ip-port-to-multiaddr'), {
+  error: debug('libp2p:ip-port-to-multiaddr:err')
+})
+
+export const Errors = {
+  ERR_INVALID_IP_PARAMETER: 'ERR_INVALID_IP_PARAMETER',
+  ERR_INVALID_PORT_PARAMETER: 'ERR_INVALID_PORT_PARAMETER',
+  ERR_INVALID_IP: 'ERR_INVALID_IP'
+}
+
+/**
+ * Transform an IP, Port pair into a multiaddr
+ */
+export function ipPortToMultiaddr (ip: string, port: number | string) {
+  if (typeof ip !== 'string') {
+    throw errCode(new Error(`invalid ip provided: ${ip}`), Errors.ERR_INVALID_IP_PARAMETER) // eslint-disable-line @typescript-eslint/restrict-template-expressions
+  }
+
+  if (typeof port === 'string') {
+    port = parseInt(port)
+  }
+
+  if (isNaN(port)) {
+    throw errCode(new Error(`invalid port provided: ${port}`), Errors.ERR_INVALID_PORT_PARAMETER)
+  }
+
+  try {
+    // Test valid IPv4
+    new Address4(ip) // eslint-disable-line no-new
+    return new Multiaddr(`/ip4/${ip}/tcp/${port}`)
+  } catch {}
+
+  try {
+    // Test valid IPv6
+    const ip6 = new Address6(ip)
+    return ip6.is4()
+      ? new Multiaddr(`/ip4/${ip6.to4().correctForm()}/tcp/${port}`)
+      : new Multiaddr(`/ip6/${ip}/tcp/${port}`)
+  } catch (err) {
+    const errMsg = `invalid ip:port for creating a multiaddr: ${ip}:${port}`
+    log.error(errMsg)
+    throw errCode(new Error(errMsg), Errors.ERR_INVALID_IP)
+  }
+}

package/src/multiaddr/is-loopback.ts

@@ -0,0 +1,12 @@
+// @ts-expect-error is-loopback-addr does not publish types
+import isLoopbackAddr from 'is-loopback-addr'
+import type { Multiaddr } from '@multiformats/multiaddr'
+
+/**
+ * Check if a given multiaddr is a loopback address.
+ */
+export function isLoopback (ma: Multiaddr) {
+  const { address } = ma.nodeAddress()
+
+  return isLoopbackAddr(address)
+}

package/src/multiaddr/is-private.ts

@@ -0,0 +1,11 @@
+import type { Multiaddr } from '@multiformats/multiaddr'
+import isIpPrivate from 'private-ip'
+
+/**
+ * Check if a given multiaddr has a private address.
+ */
+export function isPrivate (ma: Multiaddr) {
+  const { address } = ma.nodeAddress()
+
+  return Boolean(isIpPrivate(address))
+}

package/src/stream-to-ma-conn.ts

@@ -0,0 +1,92 @@
+import { source as abortable } from 'abortable-iterator'
+import debug from 'debug'
+import type { MuxedStream } from '@libp2p/interfaces/stream-muxer'
+import type { Multiaddr } from '@multiformats/multiaddr'
+import type { MultiaddrConnection } from '@libp2p/interfaces/transport'
+
+const log = debug('libp2p:stream:converter')
+
+/**
+ * @typedef {Object} Timeline
+ * @property {number} open -
+ * @property {number} [upgraded] - .
+ * @property {number} [close]
+ */
+
+export interface Timeline {
+  /**
+   * Connection opening timestamp
+   */
+  open: number
+
+  /**
+   * Connection upgraded timestamp
+   */
+  upgraded?: number
+
+  /**
+   * Connection closed timestamp
+   */
+  close?: number
+}
+
+interface StreamOptions {
+  signal?: AbortSignal
+
+}
+
+interface StreamProperties {
+  stream: MuxedStream<Uint8Array>
+  remoteAddr: Multiaddr
+  localAddr: Multiaddr
+}
+
+/**
+ * Convert a duplex iterable into a MultiaddrConnection.
+ * https://github.com/libp2p/interface-transport#multiaddrconnection
+ */
+export function streamToMaConnection (props: StreamProperties, options: StreamOptions = {}) {
+  const { stream, remoteAddr, localAddr } = props
+  const { sink, source } = stream
+  const maConn: MultiaddrConnection = {
+    async sink (source) {
+      if (options.signal != null) {
+        source = abortable(source, options.signal)
+      }
+
+      try {
+        await sink(source)
+        await close()
+      } catch (err: any) {
+        // If aborted we can safely ignore
+        if (err.type !== 'aborted') {
+          // If the source errored the socket will already have been destroyed by
+          // toIterable.duplex(). If the socket errored it will already be
+          // destroyed. There's nothing to do here except log the error & return.
+          log(err)
+        }
+      }
+    },
+    source: (options.signal != null) ? abortable(source, options.signal) : source,
+    conn: stream,
+    localAddr,
+    remoteAddr,
+    /** @type {Timeline} */
+    timeline: { open: Date.now(), close: undefined },
+    async close () {
+      await sink(async function * () {
+        yield new Uint8Array(0)
+      }())
+      await close()
+    }
+  }
+
+  async function close () {
+    if (maConn.timeline.close == null) {
+      maConn.timeline.close = Date.now()
+    }
+    return await Promise.resolve()
+  }
+
+  return maConn
+}