@libp2p/interface 0.0.1-05abd49f

package/LICENSE

@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md

@@ -0,0 +1,45 @@
+# @libp2p/interface <!-- omit in toc -->
+
+[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
+[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amaster)
+
+> The interface implemented by a libp2p node
+
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
+- [API Docs](#api-docs)
+- [License](#license)
+- [Contribution](#contribution)
+
+## Install
+
+```console
+$ npm i @libp2p/interface
+```
+
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pInterface` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/interface/dist/index.min.js"></script>
+```
+
+## API Docs
+
+- <https://libp2p.github.io/js-libp2p/modules/_libp2p_interface.html>
+
+## License
+
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

package/dist/index.min.js

@@ -0,0 +1,3 @@
+(function (root, factory) {(typeof module === 'object' && module.exports) ? module.exports = factory() : root.Libp2PInterface = factory()}(typeof self !== 'undefined' ? self : this, function () {
+"use strict";var Libp2PInterface=(()=>{var t=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var d=(o,e,x,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let p of b(e))!c.call(o,p)&&p!==x&&t(o,p,{get:()=>e[p],enumerable:!(r=a(e,p))||r.enumerable});return o};var f=o=>d(t({},"__esModule",{value:!0}),o);var g={};return f(g);})();
+return Libp2PInterface}));

package/dist/src/connection/index.d.ts

@@ -0,0 +1,188 @@
+import type * as Status from './status.js';
+import type { AbortOptions } from '../index.js';
+import type { PeerId } from '../peer-id/index.js';
+import type { Multiaddr } from '@multiformats/multiaddr';
+import type { Duplex, Source } from 'it-stream-types';
+import type { Uint8ArrayList } from 'uint8arraylist';
+export interface ConnectionTimeline {
+    open: number;
+    upgraded?: number;
+    close?: number;
+}
+/**
+ * Outbound conections are opened by the local node, inbound streams are opened by the remote
+ */
+export type Direction = 'inbound' | 'outbound';
+export interface ConnectionStat {
+    /**
+     * Outbound conections are opened by the local node, inbound streams are opened by the remote
+     */
+    direction: Direction;
+    /**
+     * Lifecycle times for the connection
+     */
+    timeline: ConnectionTimeline;
+    /**
+     * Once a multiplexer has been negotiated for this stream, it will be set on the stat object
+     */
+    multiplexer?: string;
+    /**
+     * Once a connection encrypter has been negotiated for this stream, it will be set on the stat object
+     */
+    encryption?: string;
+    /**
+     * The current status of the connection
+     */
+    status: keyof typeof Status;
+}
+export interface StreamTimeline {
+    /**
+     * A timestamp of when the stream was opened
+     */
+    open: number;
+    /**
+     * A timestamp of when the stream was closed for both reading and writing
+     */
+    close?: number;
+    /**
+     * A timestamp of when the stream was closed for reading
+     */
+    closeRead?: number;
+    /**
+     * A timestamp of when the stream was closed for writing
+     */
+    closeWrite?: number;
+    /**
+     * A timestamp of when the stream was reset
+     */
+    reset?: number;
+}
+export interface StreamStat {
+    /**
+     * Outbound streams are opened by the local node, inbound streams are opened by the remote
+     */
+    direction: Direction;
+    /**
+     * Lifecycle times for the stream
+     */
+    timeline: StreamTimeline;
+    /**
+     * Once a protocol has been negotiated for this stream, it will be set on the stat object
+     */
+    protocol?: string;
+}
+/**
+ * A Stream is a data channel between two peers that
+ * can be written to and read from at both ends.
+ *
+ * It may be encrypted and multiplexed depending on the
+ * configuration of the nodes.
+ */
+export interface Stream extends Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>, Promise<void>> {
+    /**
+     * Closes the stream for **reading** *and* **writing**.
+     *
+     * Any buffered data in the source can still be consumed and the stream will end normally.
+     *
+     * This will cause a `CLOSE` message to be sent to the remote, *unless* the sink has already ended.
+     *
+     * The sink and the source will return normally.
+     */
+    close: () => void;
+    /**
+     * Closes the stream for **reading**. If iterating over the source of this stream in a `for await of` loop, it will return (exit the loop) after any buffered data has been consumed.
+     *
+     * This function is called automatically by the muxer when it receives a `CLOSE` message from the remote.
+     *
+     * The source will return normally, the sink will continue to consume.
+     */
+    closeRead: () => void;
+    /**
+     * Closes the stream for **writing**. If iterating over the source of this stream in a `for await of` loop, it will return (exit the loop) after any buffered data has been consumed.
+     *
+     * The source will return normally, the sink will continue to consume.
+     */
+    closeWrite: () => void;
+    /**
+     * Closes the stream for **reading** *and* **writing**. This should be called when a *local error* has occurred.
+     *
+     * Note, if called without an error any buffered data in the source can still be consumed and the stream will end normally.
+     *
+     * This will cause a `RESET` message to be sent to the remote, *unless* the sink has already ended.
+     *
+     * The sink will return and the source will throw if an error is passed or return normally if not.
+     */
+    abort: (err: Error) => void;
+    /**
+     * Closes the stream *immediately* for **reading** *and* **writing**. This should be called when a *remote error* has occurred.
+     *
+     * This function is called automatically by the muxer when it receives a `RESET` message from the remote.
+     *
+     * The sink will return and the source will throw.
+     */
+    reset: () => void;
+    /**
+     * Unique identifier for a stream. Identifiers are not unique across muxers.
+     */
+    id: string;
+    /**
+     * Stats about this stream
+     */
+    stat: StreamStat;
+    /**
+     * User defined stream metadata
+     */
+    metadata: Record<string, any>;
+}
+export interface NewStreamOptions extends AbortOptions {
+    /**
+     * If specified, and no handler has been registered with the registrar for the
+     * successfully negotiated protocol, use this as the max outbound stream limit
+     * for the protocol
+     */
+    maxOutboundStreams?: number;
+}
+/**
+ * A Connection is a high-level representation of a connection
+ * to a remote peer that may have been secured by encryption and
+ * multiplexed, depending on the configuration of the nodes
+ * between which the connection is made.
+ */
+export interface Connection {
+    id: string;
+    stat: ConnectionStat;
+    remoteAddr: Multiaddr;
+    remotePeer: PeerId;
+    tags: string[];
+    streams: Stream[];
+    newStream: (multicodecs: string | string[], options?: NewStreamOptions) => Promise<Stream>;
+    addStream: (stream: Stream) => void;
+    removeStream: (id: string) => void;
+    close: () => Promise<void>;
+}
+export declare const symbol: unique symbol;
+export declare function isConnection(other: any): other is Connection;
+export interface ConnectionProtector {
+    /**
+     * Takes a given Connection and creates a private encryption stream
+     * between its two peers from the PSK the Protector instance was
+     * created with.
+     */
+    protect: (connection: MultiaddrConnection) => Promise<MultiaddrConnection>;
+}
+export interface MultiaddrConnectionTimeline {
+    open: number;
+    upgraded?: number;
+    close?: number;
+}
+/**
+ * A MultiaddrConnection is returned by transports after dialing
+ * a peer. It is a low-level primitive and is the raw connection
+ * without encryption or stream multiplexing.
+ */
+export interface MultiaddrConnection extends Duplex<AsyncGenerator<Uint8Array>, Source<Uint8Array>, Promise<void>> {
+    close: (err?: Error) => Promise<void>;
+    remoteAddr: Multiaddr;
+    timeline: MultiaddrConnectionTimeline;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/connection/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/connection/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,UAAU,CAAA;AAE9C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAA;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,OAAO,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,MAAO,SAAQ,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACxH;;;;;;;;OAQG;IACH,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,IAAI,CAAA;IAErB;;;;OAIG;IACH,UAAU,EAAE,MAAM,IAAI,CAAA;IAEtB;;;;;;;;OAQG;IACH,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAA;IAE3B;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;IACpB,UAAU,EAAE,SAAS,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,OAAO,EAAE,MAAM,EAAE,CAAA;IAEjB,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;IAC1F,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IACnC,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IAClC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B;AAED,eAAO,MAAM,MAAM,eAAmC,CAAA;AAEtD,wBAAgB,YAAY,CAAE,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAE7D;AAED,MAAM,WAAW,mBAAmB;IAElC;;;;OAIG;IACH,OAAO,EAAE,CAAC,UAAU,EAAE,mBAAmB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAA;CAC3E;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAChH,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrC,UAAU,EAAE,SAAS,CAAA;IACrB,QAAQ,EAAE,2BAA2B,CAAA;CACtC"}

package/dist/src/connection/index.js

@@ -0,0 +1,5 @@
+export const symbol = Symbol.for('@libp2p/connection');
+export function isConnection(other) {
+    return other != null && Boolean(other[symbol]);
+}
+//# sourceMappingURL=index.js.map

package/dist/src/connection/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/connection/index.ts"],"names":[],"mappings":"AA6LA,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;AAEtD,MAAM,UAAU,YAAY,CAAE,KAAU;IACtC,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;AAChD,CAAC"}

package/dist/src/connection/status.d.ts

@@ -0,0 +1,4 @@
+export declare const OPEN = "OPEN";
+export declare const CLOSING = "CLOSING";
+export declare const CLOSED = "CLOSED";
+//# sourceMappingURL=status.d.ts.map

package/dist/src/connection/status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../../src/connection/status.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,IAAI,SAAS,CAAA;AAC1B,eAAO,MAAM,OAAO,YAAY,CAAA;AAChC,eAAO,MAAM,MAAM,WAAW,CAAA"}

package/dist/src/connection/status.js

@@ -0,0 +1,4 @@
+export const OPEN = 'OPEN';
+export const CLOSING = 'CLOSING';
+export const CLOSED = 'CLOSED';
+//# sourceMappingURL=status.js.map

package/dist/src/connection/status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.js","sourceRoot":"","sources":["../../../src/connection/status.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAA;AAC1B,MAAM,CAAC,MAAM,OAAO,GAAG,SAAS,CAAA;AAChC,MAAM,CAAC,MAAM,MAAM,GAAG,QAAQ,CAAA"}

package/dist/src/connection-encrypter/index.d.ts

@@ -0,0 +1,27 @@
+import type { PeerId } from '../peer-id/index.js';
+import type { Duplex, Source } from 'it-stream-types';
+/**
+ * A libp2p connection encrypter module must be compliant to this interface
+ * to ensure all exchanged data between two peers is encrypted.
+ */
+export interface ConnectionEncrypter<Extension = unknown> {
+    protocol: string;
+    /**
+     * Encrypt outgoing data to the remote party. If the remote PeerId is known,
+     * pass it for extra verification, otherwise it will be determined during
+     * the handshake.
+     */
+    secureOutbound: (localPeer: PeerId, connection: Duplex<AsyncGenerator<Uint8Array>, Source<Uint8Array>, Promise<void>>, remotePeer?: PeerId) => Promise<SecuredConnection<Extension>>;
+    /**
+     * Decrypt incoming data. If the remote PeerId is known,
+     * pass it for extra verification, otherwise it will be determined during
+     * the handshake
+     */
+    secureInbound: (localPeer: PeerId, connection: Duplex<AsyncGenerator<Uint8Array>, Source<Uint8Array>, Promise<void>>, remotePeer?: PeerId) => Promise<SecuredConnection<Extension>>;
+}
+export interface SecuredConnection<Extension = unknown> {
+    conn: Duplex<AsyncGenerator<Uint8Array>, Source<Uint8Array>, Promise<void>>;
+    remoteExtensions?: Extension;
+    remotePeer: PeerId;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/connection-encrypter/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/connection-encrypter/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAErD;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,SAAS,GAAG,OAAO;IACtD,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAA;IAEpL;;;;OAIG;IACH,aAAa,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAA;CACpL;AAED,MAAM,WAAW,iBAAiB,CAAC,SAAS,GAAG,OAAO;IACpD,IAAI,EAAE,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;IAC3E,gBAAgB,CAAC,EAAE,SAAS,CAAA;IAC5B,UAAU,EAAE,MAAM,CAAA;CACnB"}

package/dist/src/connection-encrypter/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/src/connection-encrypter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/connection-encrypter/index.ts"],"names":[],"mappings":""}

package/dist/src/connection-gater/index.d.ts

@@ -0,0 +1,117 @@
+import type { MultiaddrConnection } from '../connection/index.js';
+import type { PeerId } from '../peer-id/index.js';
+import type { Multiaddr } from '@multiformats/multiaddr';
+export interface ConnectionGater {
+    /**
+     * denyDialPeer tests whether we're permitted to Dial the
+     * specified peer.
+     *
+     * This is called by the dialer.connectToPeer implementation before
+     * dialling a peer.
+     *
+     * Return true to prevent dialing the passed peer.
+     */
+    denyDialPeer?: (peerId: PeerId) => Promise<boolean>;
+    /**
+     * denyDialMultiaddr tests whether we're permitted to dial the specified
+     * multiaddr.
+     *
+     * This is called by the connection manager - if the peer id of the remote
+     * node is known it will be present in the multiaddr.
+     *
+     * Return true to prevent dialing the passed peer on the passed multiaddr.
+     */
+    denyDialMultiaddr?: (multiaddr: Multiaddr) => Promise<boolean>;
+    /**
+     * denyInboundConnection tests whether an incipient inbound connection is allowed.
+     *
+     * This is called by the upgrader, or by the transport directly (e.g. QUIC,
+     * Bluetooth), straight after it has accepted a connection from its socket.
+     *
+     * Return true to deny the incoming passed connection.
+     */
+    denyInboundConnection?: (maConn: MultiaddrConnection) => Promise<boolean>;
+    /**
+     * denyOutboundConnection tests whether an incipient outbound connection is allowed.
+     *
+     * This is called by the upgrader, or by the transport directly (e.g. QUIC,
+     * Bluetooth), straight after it has created a connection with its socket.
+     *
+     * Return true to deny the incoming passed connection.
+     */
+    denyOutboundConnection?: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>;
+    /**
+     * denyInboundEncryptedConnection tests whether a given connection, now encrypted,
+     * is allowed.
+     *
+     * This is called by the upgrader, after it has performed the security
+     * handshake, and before it negotiates the muxer, or by the directly by the
+     * transport, at the exact same checkpoint.
+     *
+     * Return true to deny the passed secured connection.
+     */
+    denyInboundEncryptedConnection?: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>;
+    /**
+     * denyOutboundEncryptedConnection tests whether a given connection, now encrypted,
+     * is allowed.
+     *
+     * This is called by the upgrader, after it has performed the security
+     * handshake, and before it negotiates the muxer, or by the directly by the
+     * transport, at the exact same checkpoint.
+     *
+     * Return true to deny the passed secured connection.
+     */
+    denyOutboundEncryptedConnection?: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>;
+    /**
+     * denyInboundUpgradedConnection tests whether a fully capable connection is allowed.
+     *
+     * This is called after encryption has been negotiated and the connection has been
+     * multiplexed, if a multiplexer is configured.
+     *
+     * Return true to deny the passed upgraded connection.
+     */
+    denyInboundUpgradedConnection?: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>;
+    /**
+     * denyOutboundUpgradedConnection tests whether a fully capable connection is allowed.
+     *
+     * This is called after encryption has been negotiated and the connection has been
+     * multiplexed, if a multiplexer is configured.
+     *
+     * Return true to deny the passed upgraded connection.
+     */
+    denyOutboundUpgradedConnection?: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>;
+    /**
+     * denyInboundRelayReservation tests whether a remote peer is allowed make a
+     * relay reservation on this node.
+     *
+     * Return true to deny the relay reservation.
+     */
+    denyInboundRelayReservation?: (source: PeerId) => Promise<boolean>;
+    /**
+     * denyOutboundRelayedConnection tests whether a remote peer is allowed to open a relayed
+     * connection to the destination node.
+     *
+     * This is invoked on the relay server when a source client with a reservation instructs
+     * the server to relay a connection to a destination peer.
+     *
+     * Return true to deny the relayed connection.
+     */
+    denyOutboundRelayedConnection?: (source: PeerId, destination: PeerId) => Promise<boolean>;
+    /**
+     * denyInboundRelayedConnection tests whether a remote peer is allowed to open a relayed
+     * connection to this node.
+     *
+     * This is invoked on the relay client when a remote relay has received an instruction to
+     * relay a connection to the client.
+     *
+     * Return true to deny the relayed connection.
+     */
+    denyInboundRelayedConnection?: (relay: PeerId, remotePeer: PeerId) => Promise<boolean>;
+    /**
+     * Used by the address book to filter passed addresses.
+     *
+     * Return true to allow storing the passed multiaddr for the passed peer.
+     */
+    filterMultiaddrForPeer?: (peer: PeerId, multiaddr: Multiaddr) => Promise<boolean>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/connection-gater/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/connection-gater/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,eAAe;IAC9B;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAEnD;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAE9D;;;;;;;OAOG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAEzE;;;;;;;OAOG;IACH,sBAAsB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAE1F;;;;;;;;;OASG;IACH,8BAA8B,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAElG;;;;;;;;;OASG;IACH,+BAA+B,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAEnG;;;;;;;OAOG;IACH,6BAA6B,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAEjG;;;;;;;OAOG;IACH,8BAA8B,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAElG;;;;;OAKG;IACH,2BAA2B,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAElE;;;;;;;;OAQG;IACH,6BAA6B,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAEzF;;;;;;;;OAQG;IACH,4BAA4B,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAEtF;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CAClF"}

package/dist/src/connection-gater/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/src/connection-gater/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/connection-gater/index.ts"],"names":[],"mappings":""}

package/dist/src/content-routing/index.d.ts

@@ -0,0 +1,79 @@
+import type { AbortOptions } from '../index.js';
+import type { PeerInfo } from '../peer-info/index.js';
+import type { CID } from 'multiformats/cid';
+/**
+ * Any object that implements this Symbol as a property should return a
+ * ContentRouting instance as the property value, similar to how
+ * `Symbol.Iterable` can be used to return an `Iterable` from an `Iterator`.
+ *
+ * @example
+ *
+ * ```js
+ * import { contentRouting, ContentRouting } from '@libp2p/content-routing'
+ *
+ * class MyContentRouter implements ContentRouting {
+ *   get [contentRouting] () {
+ *     return this
+ *   }
+ *
+ *   // ...other methods
+ * }
+ * ```
+ */
+export declare const contentRouting: unique symbol;
+export interface ContentRouting {
+    /**
+     * The implementation of this method should ensure that network peers know the
+     * caller can provide content that corresponds to the passed CID.
+     *
+     * @example
+     *
+     * ```js
+     * // ...
+     * await contentRouting.provide(cid)
+     * ```
+     */
+    provide: (cid: CID, options?: AbortOptions) => Promise<void>;
+    /**
+     * Find the providers of the passed CID.
+     *
+     * @example
+     *
+     * ```js
+     * // Iterate over the providers found for the given cid
+     * for await (const provider of contentRouting.findProviders(cid)) {
+     *  console.log(provider.id, provider.multiaddrs)
+     * }
+     * ```
+     */
+    findProviders: (cid: CID, options?: AbortOptions) => AsyncIterable<PeerInfo>;
+    /**
+     * Puts a value corresponding to the passed key in a way that can later be
+     * retrieved by another network peer using the get method.
+     *
+     * @example
+     *
+     * ```js
+     * // ...
+     * const key = '/key'
+     * const value = uint8ArrayFromString('oh hello there')
+     *
+     * await contentRouting.put(key, value)
+     * ```
+     */
+    put: (key: Uint8Array, value: Uint8Array, options?: AbortOptions) => Promise<void>;
+    /**
+     * Retrieves a value from the network corresponding to the passed key.
+     *
+     * @example
+     *
+     * ```js
+     * // ...
+     *
+     * const key = '/key'
+     * const value = await contentRouting.get(key)
+     * ```
+     */
+    get: (key: Uint8Array, options?: AbortOptions) => Promise<Uint8Array>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/content-routing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/content-routing/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAE3C;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,cAAc,eAAwC,CAAA;AAEnE,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;OAUG;IACH,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5D;;;;;;;;;;;OAWG;IACH,aAAa,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,aAAa,CAAC,QAAQ,CAAC,CAAA;IAE5E;;;;;;;;;;;;;OAaG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAElF;;;;;;;;;;;OAWG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;CACtE"}

package/dist/src/content-routing/index.js

@@ -0,0 +1,21 @@
+/**
+ * Any object that implements this Symbol as a property should return a
+ * ContentRouting instance as the property value, similar to how
+ * `Symbol.Iterable` can be used to return an `Iterable` from an `Iterator`.
+ *
+ * @example
+ *
+ * ```js
+ * import { contentRouting, ContentRouting } from '@libp2p/content-routing'
+ *
+ * class MyContentRouter implements ContentRouting {
+ *   get [contentRouting] () {
+ *     return this
+ *   }
+ *
+ *   // ...other methods
+ * }
+ * ```
+ */
+export const contentRouting = Symbol.for('@libp2p/content-routing');
+//# sourceMappingURL=index.js.map

package/dist/src/content-routing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/content-routing/index.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAA"}

package/dist/src/errors.d.ts

@@ -0,0 +1,33 @@
+/**
+ * When this error is thrown it means an operation was aborted,
+ * usually in response to the `abort` event being emitted by an
+ * AbortSignal.
+ */
+export declare class AbortError extends Error {
+    readonly code: string;
+    readonly type: string;
+    constructor(message?: string);
+    static readonly code = "ABORT_ERR";
+    static readonly type = "aborted";
+}
+export declare class CodeError<T extends Record<string, any> = Record<string, never>> extends Error {
+    readonly code: string;
+    readonly props: T;
+    constructor(message: string, code: string, props?: T);
+}
+export declare class UnexpectedPeerError extends Error {
+    code: string;
+    constructor(message?: string);
+    static readonly code = "ERR_UNEXPECTED_PEER";
+}
+export declare class InvalidCryptoExchangeError extends Error {
+    code: string;
+    constructor(message?: string);
+    static readonly code = "ERR_INVALID_CRYPTO_EXCHANGE";
+}
+export declare class InvalidCryptoTransmissionError extends Error {
+    code: string;
+    constructor(message?: string);
+    static readonly code = "ERR_INVALID_CRYPTO_TRANSMISSION";
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/src/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AACA;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,KAAK;IACnC,SAAgB,IAAI,EAAE,MAAM,CAAA;IAC5B,SAAgB,IAAI,EAAE,MAAM,CAAA;gBAEf,OAAO,GAAE,MAAoC;IAM1D,MAAM,CAAC,QAAQ,CAAC,IAAI,eAAc;IAElC,MAAM,CAAC,QAAQ,CAAC,IAAI,aAAY;CACjC;AAED,qBAAa,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAE,SAAQ,KAAK;aAKvE,IAAI,EAAE,MAAM;IAJ9B,SAAgB,KAAK,EAAE,CAAC,CAAA;gBAGtB,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,MAAM,EAC5B,KAAK,CAAC,EAAE,CAAC;CAOZ;AAED,qBAAa,mBAAoB,SAAQ,KAAK;IACrC,IAAI,EAAE,MAAM,CAAA;gBAEN,OAAO,SAAoB;IAKxC,MAAM,CAAC,QAAQ,CAAC,IAAI,yBAAwB;CAC7C;AAED,qBAAa,0BAA2B,SAAQ,KAAK;IAC5C,IAAI,EAAE,MAAM,CAAA;gBAEN,OAAO,SAA4B;IAKhD,MAAM,CAAC,QAAQ,CAAC,IAAI,iCAAgC;CACrD;AAED,qBAAa,8BAA+B,SAAQ,KAAK;IAChD,IAAI,EAAE,MAAM,CAAA;gBAEN,OAAO,SAAgC;IAKpD,MAAM,CAAC,QAAQ,CAAC,IAAI,qCAAoC;CACzD"}

package/dist/src/errors.js

@@ -0,0 +1,51 @@
+/**
+ * When this error is thrown it means an operation was aborted,
+ * usually in response to the `abort` event being emitted by an
+ * AbortSignal.
+ */
+export class AbortError extends Error {
+    code;
+    type;
+    constructor(message = 'The operation was aborted') {
+        super(message);
+        this.code = AbortError.code;
+        this.type = AbortError.type;
+    }
+    static code = 'ABORT_ERR';
+    static type = 'aborted';
+}
+export class CodeError extends Error {
+    code;
+    props;
+    constructor(message, code, props) {
+        super(message);
+        this.code = code;
+        this.name = props?.name ?? 'CodeError';
+        this.props = props ?? {}; // eslint-disable-line @typescript-eslint/consistent-type-assertions
+    }
+}
+export class UnexpectedPeerError extends Error {
+    code;
+    constructor(message = 'Unexpected Peer') {
+        super(message);
+        this.code = UnexpectedPeerError.code;
+    }
+    static code = 'ERR_UNEXPECTED_PEER';
+}
+export class InvalidCryptoExchangeError extends Error {
+    code;
+    constructor(message = 'Invalid crypto exchange') {
+        super(message);
+        this.code = InvalidCryptoExchangeError.code;
+    }
+    static code = 'ERR_INVALID_CRYPTO_EXCHANGE';
+}
+export class InvalidCryptoTransmissionError extends Error {
+    code;
+    constructor(message = 'Invalid crypto transmission') {
+        super(message);
+        this.code = InvalidCryptoTransmissionError.code;
+    }
+    static code = 'ERR_INVALID_CRYPTO_TRANSMISSION';
+}
+//# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AACA;;;;GAIG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnB,IAAI,CAAQ;IACZ,IAAI,CAAQ;IAE5B,YAAa,UAAkB,2BAA2B;QACxD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;QAC3B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;IAC7B,CAAC;IAED,MAAM,CAAU,IAAI,GAAG,WAAW,CAAA;IAElC,MAAM,CAAU,IAAI,GAAG,SAAS,CAAA;;AAGlC,MAAM,OAAO,SAAiE,SAAQ,KAAK;IAKvE;IAJF,KAAK,CAAG;IAExB,YACE,OAAe,EACC,IAAY,EAC5B,KAAS;QAET,KAAK,CAAC,OAAO,CAAC,CAAA;QAHE,SAAI,GAAJ,IAAI,CAAQ;QAK5B,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,WAAW,CAAA;QACtC,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,EAAO,CAAA,CAAC,oEAAoE;IACpG,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IACrC,IAAI,CAAQ;IAEnB,YAAa,OAAO,GAAG,iBAAiB;QACtC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAA;IACtC,CAAC;IAED,MAAM,CAAU,IAAI,GAAG,qBAAqB,CAAA;;AAG9C,MAAM,OAAO,0BAA2B,SAAQ,KAAK;IAC5C,IAAI,CAAQ;IAEnB,YAAa,OAAO,GAAG,yBAAyB;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC,IAAI,CAAA;IAC7C,CAAC;IAED,MAAM,CAAU,IAAI,GAAG,6BAA6B,CAAA;;AAGtD,MAAM,OAAO,8BAA+B,SAAQ,KAAK;IAChD,IAAI,CAAQ;IAEnB,YAAa,OAAO,GAAG,6BAA6B;QAClD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,8BAA8B,CAAC,IAAI,CAAA;IACjD,CAAC;IAED,MAAM,CAAU,IAAI,GAAG,iCAAiC,CAAA"}