libp2p 0.36.2 → 0.37.0

package/dist/src/pnet/errors.js

@@ -0,0 +1,6 @@
+export const INVALID_PEER = 'Not a valid peer connection';
+export const INVALID_PSK = 'Your private shared key is invalid';
+export const NO_LOCAL_ID = 'No local private key provided';
+export const NO_HANDSHAKE_CONNECTION = 'No connection for the handshake provided';
+export const STREAM_ENDED = 'Stream ended prematurely';
+//# sourceMappingURL=errors.js.map

package/dist/src/pnet/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/pnet/errors.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,YAAY,GAAG,6BAA6B,CAAA;AACzD,MAAM,CAAC,MAAM,WAAW,GAAG,oCAAoC,CAAA;AAC/D,MAAM,CAAC,MAAM,WAAW,GAAG,+BAA+B,CAAA;AAC1D,MAAM,CAAC,MAAM,uBAAuB,GAAG,0CAA0C,CAAA;AACjF,MAAM,CAAC,MAAM,YAAY,GAAG,0BAA0B,CAAA"}

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

@@ -1,32 +1,24 @@
-export = Protector;
-/**
- * @typedef {import('libp2p-interfaces/src/transport/types').MultiaddrConnection} MultiaddrConnection
- */
-declare class Protector {
+import type { MultiaddrConnection } from '@libp2p/interfaces/transport';
+import type { ConnectionProtector } from '@libp2p/interfaces/connection';
+export { generateKey } from './key-generator.js';
+export interface ProtectorInit {
+    enabled?: boolean;
+    psk: Uint8Array;
+}
+export declare class PreSharedKeyConnectionProtector implements ConnectionProtector {
+    tag: string;
+    private readonly psk;
+    private readonly enabled;
     /**
      * Takes a Private Shared Key (psk) and provides a `protect` method
      * for wrapping existing connections in a private encryption stream.
-     *
-     * @param {Uint8Array} keyBuffer - The private shared key buffer
-     * @class
      */
-    constructor(keyBuffer: Uint8Array);
-    psk: Uint8Array;
-    tag: string | undefined;
+    constructor(init: ProtectorInit);
     /**
      * Takes a given Connection and creates a private encryption stream
      * between its two peers from the PSK the Protector instance was
      * created with.
-     *
-     * @param {MultiaddrConnection} connection - The connection to protect
-     * @returns {Promise<MultiaddrConnection>} A protected duplex iterable
      */
     protect(connection: MultiaddrConnection): Promise<MultiaddrConnection>;
 }
-declare namespace Protector {
-    export { Errors as errors, generate, MultiaddrConnection };
-}
-type MultiaddrConnection = import('libp2p-interfaces/src/transport/types').MultiaddrConnection;
-import Errors = require("./errors");
-declare var generate: typeof import("./key-generator");
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/pnet/index.js"],"names":[],"mappings":";AAwBA;;GAEG;AAEH;IACE;;;;;;OAMG;IACH,uBAHW,UAAU,EAOpB;IAFC,gBAAyB;IACzB,wBAAyB;IAG3B;;;;;;;OAOG;IACH,oBAHW,mBAAmB,GACjB,QAAQ,mBAAmB,CAAC,CAgCxC;CACF;;;;2BAxDY,OAAO,uCAAuC,EAAE,mBAAmB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/pnet/index.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAA;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AAIxE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAEhD,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,qBAAa,+BAAgC,YAAW,mBAAmB;IAClE,GAAG,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAY;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;;OAGG;gBACU,IAAI,EAAE,aAAa;IAahC;;;;OAIG;IACG,OAAO,CAAE,UAAU,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CA2C9E"}

package/dist/src/pnet/index.js

@@ -0,0 +1,67 @@
+import { logger } from '@libp2p/logger';
+import { pipe } from 'it-pipe';
+import errCode from 'err-code';
+import { duplexPair } from 'it-pair/duplex';
+import { randomBytes } from '@libp2p/crypto';
+import * as Errors from './errors.js';
+import { codes } from '../errors.js';
+import { createBoxStream, createUnboxStream, decodeV1PSK } from './crypto.js';
+import { handshake } from 'it-handshake';
+import { NONCE_LENGTH } from './key-generator.js';
+const log = logger('libp2p:pnet');
+export { generateKey } from './key-generator.js';
+export class PreSharedKeyConnectionProtector {
+    /**
+     * Takes a Private Shared Key (psk) and provides a `protect` method
+     * for wrapping existing connections in a private encryption stream.
+     */
+    constructor(init) {
+        this.enabled = init.enabled !== false;
+        if (this.enabled) {
+            const decodedPSK = decodeV1PSK(init.psk);
+            this.psk = decodedPSK.psk;
+            this.tag = decodedPSK.tag ?? '';
+        }
+        else {
+            this.psk = new Uint8Array();
+            this.tag = '';
+        }
+    }
+    /**
+     * Takes a given Connection and creates a private encryption stream
+     * between its two peers from the PSK the Protector instance was
+     * created with.
+     */
+    async protect(connection) {
+        if (!this.enabled) {
+            return connection;
+        }
+        if (connection == null) {
+            throw errCode(new Error(Errors.NO_HANDSHAKE_CONNECTION), codes.ERR_INVALID_PARAMETERS);
+        }
+        // Exchange nonces
+        log('protecting the connection');
+        const localNonce = randomBytes(NONCE_LENGTH);
+        const shake = handshake(connection);
+        shake.write(localNonce);
+        const result = await shake.reader.next(NONCE_LENGTH);
+        if (result.value == null) {
+            throw errCode(new Error(Errors.STREAM_ENDED), codes.ERR_INVALID_PARAMETERS);
+        }
+        const remoteNonce = result.value.slice();
+        shake.rest();
+        // Create the boxing/unboxing pipe
+        log('exchanged nonces');
+        const [internal, external] = duplexPair();
+        pipe(external, 
+        // Encrypt all outbound traffic
+        createBoxStream(localNonce, this.psk), shake.stream, 
+        // Decrypt all inbound traffic
+        createUnboxStream(remoteNonce, this.psk), external).catch(log.error);
+        return {
+            ...connection,
+            ...internal
+        };
+    }
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/pnet/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAC9B,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACpC,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,WAAW,EACZ,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAIjD,MAAM,GAAG,GAAG,MAAM,CAAC,aAAa,CAAC,CAAA;AAEjC,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAOhD,MAAM,OAAO,+BAA+B;IAK1C;;;OAGG;IACH,YAAa,IAAmB;QAC9B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,KAAK,KAAK,CAAA;QAErC,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACxC,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,CAAA;YACzB,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,IAAI,EAAE,CAAA;SAChC;aAAM;YACL,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,EAAE,CAAA;YAC3B,IAAI,CAAC,GAAG,GAAG,EAAE,CAAA;SACd;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAE,UAA+B;QAC5C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO,UAAU,CAAA;SAClB;QAED,IAAI,UAAU,IAAI,IAAI,EAAE;YACtB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAA;SACvF;QAED,kBAAkB;QAClB,GAAG,CAAC,2BAA2B,CAAC,CAAA;QAChC,MAAM,UAAU,GAAG,WAAW,CAAC,YAAY,CAAC,CAAA;QAE5C,MAAM,KAAK,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;QACnC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAEvB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAEpD,IAAI,MAAM,CAAC,KAAK,IAAI,IAAI,EAAE;YACxB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAA;SAC5E;QAED,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;QACxC,KAAK,CAAC,IAAI,EAAE,CAAA;QAEZ,kCAAkC;QAClC,GAAG,CAAC,kBAAkB,CAAC,CAAA;QACvB,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,UAAU,EAAc,CAAA;QACrD,IAAI,CACF,QAAQ;QACR,+BAA+B;QAC/B,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,EACrC,KAAK,CAAC,MAAM;QACZ,8BAA8B;QAC9B,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,EACxC,QAAQ,CACT,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAElB,OAAO;YACL,GAAG,UAAU;YACb,GAAG,QAAQ;SACZ,CAAA;IACH,CAAC;CACF"}

package/dist/src/pnet/key-generator.d.ts

@@ -1,14 +1,10 @@
-export = generate;
 /**
  * Generates a PSK that can be used in a libp2p-pnet private network
  *
  * @param {Uint8Array} bytes - An object to write the psk into
  * @returns {void}
  */
-declare function generate(bytes: Uint8Array): void;
-declare namespace generate {
-    export { NONCE_LENGTH, KEY_LENGTH };
-}
-declare var NONCE_LENGTH: number;
-declare const KEY_LENGTH: 32;
+export declare function generateKey(bytes: Uint8Array): void;
+export declare const NONCE_LENGTH = 24;
+export declare const KEY_LENGTH = 32;
 //# sourceMappingURL=key-generator.d.ts.map

package/dist/src/pnet/key-generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"key-generator.d.ts","sourceRoot":"","sources":["../../../src/pnet/key-generator.js"],"names":[],"mappings":";AAOA;;;;;GAKG;AACH,iCAHW,UAAU,GACR,IAAI,CAOhB;;;;;AAfD,6BAAqB"}
+{"version":3,"file":"key-generator.d.ts","sourceRoot":"","sources":["../../../src/pnet/key-generator.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,wBAAgB,WAAW,CAAE,KAAK,EAAE,UAAU,QAK7C;AAED,eAAO,MAAM,YAAY,KAAK,CAAA;AAC9B,eAAO,MAAM,UAAU,KAAK,CAAA"}

package/dist/src/pnet/key-generator.js

@@ -0,0 +1,25 @@
+import { randomBytes } from '@libp2p/crypto';
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string';
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string';
+/**
+ * Generates a PSK that can be used in a libp2p-pnet private network
+ *
+ * @param {Uint8Array} bytes - An object to write the psk into
+ * @returns {void}
+ */
+export function generateKey(bytes) {
+    const psk = uint8ArrayToString(randomBytes(KEY_LENGTH), 'base16');
+    const key = uint8ArrayFromString('/key/swarm/psk/1.0.0/\n/base16/\n' + psk);
+    bytes.set(key);
+}
+export const NONCE_LENGTH = 24;
+export const KEY_LENGTH = 32;
+try {
+    if (require.main === module) {
+        // @ts-expect-error
+        generate(process.stdout);
+    }
+}
+catch (error) {
+}
+//# sourceMappingURL=key-generator.js.map

package/dist/src/pnet/key-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"key-generator.js","sourceRoot":"","sources":["../../../src/pnet/key-generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AACtE,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAE5E;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAE,KAAiB;IAC5C,MAAM,GAAG,GAAG,kBAAkB,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAA;IACjE,MAAM,GAAG,GAAG,oBAAoB,CAAC,mCAAmC,GAAG,GAAG,CAAC,CAAA;IAE3E,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAChB,CAAC;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,EAAE,CAAA;AAC9B,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,CAAA;AAE5B,IAAI;IACF,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;QAC3B,mBAAmB;QACnB,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;KACzB;CACF;AAAC,OAAO,KAAU,EAAE;CAEpB"}

package/dist/src/pubsub/dummy-pubsub.d.ts

@@ -0,0 +1,17 @@
+import { EventEmitter } from '@libp2p/interfaces/events';
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { PublishResult, PubSub, PubSubEvents, StrictNoSign, StrictSign } from '@libp2p/interfaces/pubsub';
+export declare class DummyPubSub extends EventEmitter<PubSubEvents> implements PubSub {
+    isStarted(): boolean;
+    start(): void | Promise<void>;
+    stop(): void | Promise<void>;
+    get globalSignaturePolicy(): typeof StrictSign | typeof StrictNoSign;
+    get multicodecs(): string[];
+    getPeers(): PeerId[];
+    getTopics(): string[];
+    subscribe(): void;
+    unsubscribe(): void;
+    getSubscribers(): PeerId[];
+    publish(): Promise<PublishResult>;
+}
+//# sourceMappingURL=dummy-pubsub.d.ts.map

package/dist/src/pubsub/dummy-pubsub.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dummy-pubsub.d.ts","sourceRoot":"","sources":["../../../src/pubsub/dummy-pubsub.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAI9G,qBAAa,WAAY,SAAQ,YAAY,CAAC,YAAY,CAAE,YAAW,MAAM;IAC3E,SAAS,IAAK,OAAO;IAIrB,KAAK,IAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9B,IAAI,IAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7B,IAAI,qBAAqB,IAAK,OAAO,UAAU,GAAG,OAAO,YAAY,CAEpE;IAED,IAAI,WAAW,IAAK,MAAM,EAAE,CAE3B;IAED,QAAQ,IAAK,MAAM,EAAE;IAIrB,SAAS,IAAK,MAAM,EAAE;IAItB,SAAS,IAAK,IAAI;IAIlB,WAAW,IAAK,IAAI;IAIpB,cAAc,IAAK,MAAM,EAAE;IAIrB,OAAO,IAAK,OAAO,CAAC,aAAa,CAAC;CAGzC"}

package/dist/src/pubsub/dummy-pubsub.js

@@ -0,0 +1,37 @@
+import { EventEmitter } from '@libp2p/interfaces/events';
+import errCode from 'err-code';
+import { messages, codes } from '../errors.js';
+export class DummyPubSub extends EventEmitter {
+    isStarted() {
+        return false;
+    }
+    start() {
+    }
+    stop() {
+    }
+    get globalSignaturePolicy() {
+        throw errCode(new Error(messages.PUBSUB_DISABLED), codes.ERR_PUBSUB_DISABLED);
+    }
+    get multicodecs() {
+        throw errCode(new Error(messages.PUBSUB_DISABLED), codes.ERR_PUBSUB_DISABLED);
+    }
+    getPeers() {
+        throw errCode(new Error(messages.PUBSUB_DISABLED), codes.ERR_PUBSUB_DISABLED);
+    }
+    getTopics() {
+        throw errCode(new Error(messages.PUBSUB_DISABLED), codes.ERR_PUBSUB_DISABLED);
+    }
+    subscribe() {
+        throw errCode(new Error(messages.PUBSUB_DISABLED), codes.ERR_PUBSUB_DISABLED);
+    }
+    unsubscribe() {
+        throw errCode(new Error(messages.PUBSUB_DISABLED), codes.ERR_PUBSUB_DISABLED);
+    }
+    getSubscribers() {
+        throw errCode(new Error(messages.PUBSUB_DISABLED), codes.ERR_PUBSUB_DISABLED);
+    }
+    async publish() {
+        throw errCode(new Error(messages.PUBSUB_DISABLED), codes.ERR_PUBSUB_DISABLED);
+    }
+}
+//# sourceMappingURL=dummy-pubsub.js.map

package/dist/src/pubsub/dummy-pubsub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dummy-pubsub.js","sourceRoot":"","sources":["../../../src/pubsub/dummy-pubsub.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAGxD,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AAE9C,MAAM,OAAO,WAAY,SAAQ,YAA0B;IACzD,SAAS;QACP,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK;IAEL,CAAC;IAED,IAAI;IAEJ,CAAC;IAED,IAAI,qBAAqB;QACvB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAC/E,CAAC;IAED,IAAI,WAAW;QACb,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAC/E,CAAC;IAED,QAAQ;QACN,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAC/E,CAAC;IAED,SAAS;QACP,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAC/E,CAAC;IAED,SAAS;QACP,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAC/E,CAAC;IAED,WAAW;QACT,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAC/E,CAAC;IAED,cAAc;QACZ,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAC/E,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAC/E,CAAC;CACF"}

package/dist/src/registrar.d.ts

@@ -1,82 +1,43 @@
-export = Registrar;
-/**
- * @typedef {import('peer-id')} PeerId
- * @typedef {import('./peer-store/types').PeerStore} PeerStore
- * @typedef {import('./connection-manager')} ConnectionManager
- * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection
- * @typedef {import('./').HandlerProps} HandlerProps
- */
-/**
- *
- */
+import { Topology } from '@libp2p/interfaces/topology';
+import type { Registrar, StreamHandler } from '@libp2p/interfaces/registrar';
+import type { PeerProtocolsChangeData } from '@libp2p/interfaces/peer-store';
+import type { Connection } from '@libp2p/interfaces/connection';
+import type { Components } from '@libp2p/interfaces/components';
 /**
  * Responsible for notifying registered protocols of events in the network.
  */
-declare class Registrar {
+export declare class DefaultRegistrar implements Registrar {
+    private readonly topologies;
+    private readonly handlers;
+    private readonly components;
+    constructor(components: Components);
+    getProtocols(): string[];
+    getHandler(protocol: string): StreamHandler;
+    getTopologies(protocol: string): Topology[];
     /**
-     * @param {Object} props
-     * @param {PeerStore} props.peerStore
-     * @param {ConnectionManager} props.connectionManager
-     * @class
+     * Registers the `handler` for each protocol
      */
-    constructor({ peerStore, connectionManager }: {
-        peerStore: PeerStore;
-        connectionManager: ConnectionManager;
-    });
-    peerStore: import("./peer-store/types").PeerStore;
-    connectionManager: import("./connection-manager");
+    handle(protocols: string | string[], handler: StreamHandler): Promise<void>;
     /**
-     * Map of topologies
-     *
-     * @type {Map<string, Topology>}
-     */
-    topologies: Map<string, Topology>;
-    /** @type {(protocols: string[]|string, handler: (props: HandlerProps) => void) => void} */
-    _handle: (protocols: string[] | string, handler: (props: HandlerProps) => void) => void;
-    /**
-     * Remove a disconnected peer from the record
-     *
-     * @param {Connection} connection
-     * @returns {void}
+     * Removes the handler for each protocol. The protocol
+     * will no longer be supported on streams.
      */
-    _onDisconnect(connection: Connection): void;
+    unhandle(protocols: string | string[]): Promise<void>;
     /**
-     * @param {(protocols: string[]|string, handler: (props: HandlerProps) => void) => void} handle
-     */
-    set handle(arg: (protocols: string[] | string, handler: (props: HandlerProps) => void) => void);
-    /**
-     * @returns {(protocols: string[]|string, handler: (props: HandlerProps) => void) => void}
+     * Register handlers for a set of multicodecs given
      */
-    get handle(): (protocols: string[] | string, handler: (props: HandlerProps) => void) => void;
+    register(protocols: string | string[], topology: Topology): Promise<string>;
     /**
-     * Get a connection with a peer.
-     *
-     * @param {PeerId} peerId
-     * @returns {Connection | null}
+     * Unregister topology
      */
-    getConnection(peerId: PeerId): Connection | null;
+    unregister(id: string): void;
     /**
-     * Register handlers for a set of multicodecs given
-     *
-     * @param {Topology} topology - protocol topology
-     * @returns {Promise<string>} registrar identifier
+     * Remove a disconnected peer from the record
      */
-    register(topology: Topology): Promise<string>;
+    _onDisconnect(evt: CustomEvent<Connection>): void;
     /**
-     * Unregister topology.
-     *
-     * @param {string} id - registrar identifier
-     * @returns {boolean} unregistered successfully
+     * Check if a new peer support the multicodecs for this topology
      */
-    unregister(id: string): boolean;
-}
-declare namespace Registrar {
-    export { PeerId, PeerStore, ConnectionManager, Connection, HandlerProps };
+    _onProtocolChange(evt: CustomEvent<PeerProtocolsChangeData>): void;
 }
-import Topology = require("libp2p-interfaces/src/topology");
-type Connection = import("libp2p-interfaces/src/connection/connection");
-type PeerId = import('peer-id');
-type PeerStore = import('./peer-store/types').PeerStore;
-type ConnectionManager = import('./connection-manager');
-type HandlerProps = import('./').HandlerProps;
 //# sourceMappingURL=registrar.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"registrar.d.ts","sourceRoot":"","sources":["../../src/registrar.js"],"names":[],"mappings":";AAaA;;;;;;GAMG;AAEH;;GAEG;AAEH;;GAEG;AACH;IACE;;;;;OAKG;IACH;QAJ4B,SAAS,EAA1B,SAAS;QACgB,iBAAiB,EAA1C,iBAAiB;OAsB3B;IAjBC,kDAA0B;IAE1B,kDAA0C;IAE1C;;;;OAIG;IACH,YAFU,IAAI,MAAM,EAAE,QAAQ,CAAC,CAEJ;IAE3B,2FAA2F;IAE3F,qBAFuB,MAAM,EAAE,GAAC,MAAM,mBAAmB,YAAY,KAAK,IAAI,KAAK,IAAI,CAE/D;IA+D1B;;;;;OAKG;IACH,0BAHW,UAAU,GACR,IAAI,CAMhB;IA5DD;;OAEG;IACH,4BATyB,MAAM,EAAE,GAAC,MAAM,mBAAmB,YAAY,KAAK,IAAI,KAAK,IAAI,EAWxF;IAZD;;OAEG;IACH,0BAFyB,MAAM,EAAE,GAAC,MAAM,mBAAmB,YAAY,KAAK,IAAI,KAAK,IAAI,CAIxF;IASD;;;;;OAKG;IACH,sBAHW,MAAM,GACJ,UAAU,GAAG,IAAI,CAI7B;IAED;;;;;OAKG;IACH,mBAHW,QAAQ,GACN,QAAQ,MAAM,CAAC,CAiB3B;IAED;;;;;OAKG;IACH,eAHW,MAAM,GACJ,OAAO,CAInB;CAaF;;;;;;cA9GY,OAAO,SAAS,CAAC;iBACjB,OAAO,oBAAoB,EAAE,SAAS;yBACtC,OAAO,sBAAsB,CAAC;oBAE9B,OAAO,IAAI,EAAE,YAAY"}
+{"version":3,"file":"registrar.d.ts","sourceRoot":"","sources":["../../src/registrar.ts"],"names":[],"mappings":"AAGA,OAAO,EAAc,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAA;AAC5E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAc/D;;GAEG;AACH,qBAAa,gBAAiB,YAAW,SAAS;IAChD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA0D;IACrF,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IACrD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;gBAE1B,UAAU,EAAE,UAAU;IAcnC,YAAY;IAcZ,UAAU,CAAE,QAAQ,EAAE,MAAM;IAU5B,aAAa,CAAE,QAAQ,EAAE,MAAM;IAY/B;;OAEG;IACG,MAAM,CAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAelF;;;OAGG;IACG,QAAQ,CAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE;IAW5C;;OAEG;IACG,QAAQ,CAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBlF;;OAEG;IACH,UAAU,CAAE,EAAE,EAAE,MAAM;IAItB;;OAEG;IACH,aAAa,CAAE,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC;IAgB3C;;OAEG;IACH,iBAAiB,CAAE,GAAG,EAAE,WAAW,CAAC,uBAAuB,CAAC;CAwB7D"}

package/dist/src/registrar.js

@@ -0,0 +1,144 @@
+import { logger } from '@libp2p/logger';
+import errCode from 'err-code';
+import { codes } from './errors.js';
+import { isTopology } from '@libp2p/interfaces/topology';
+const log = logger('libp2p:registrar');
+function supportsProtocol(peerProtocols, topologyProtocols) {
+    for (const peerProtocol of peerProtocols) {
+        if (topologyProtocols.includes(peerProtocol)) {
+            return true;
+        }
+    }
+    return false;
+}
+/**
+ * Responsible for notifying registered protocols of events in the network.
+ */
+export class DefaultRegistrar {
+    constructor(components) {
+        this.topologies = new Map();
+        this.handlers = new Map();
+        this.components = components;
+        this._onDisconnect = this._onDisconnect.bind(this);
+        this._onProtocolChange = this._onProtocolChange.bind(this);
+        this.components.getConnectionManager().addEventListener('peer:disconnect', this._onDisconnect);
+        // happens after identify
+        this.components.getPeerStore().addEventListener('change:protocols', this._onProtocolChange);
+    }
+    getProtocols() {
+        const protocols = new Set();
+        for (const topology of this.topologies.values()) {
+            topology.protocols.forEach(protocol => protocols.add(protocol));
+        }
+        for (const protocol of this.handlers.keys()) {
+            protocols.add(protocol);
+        }
+        return Array.from(protocols).sort();
+    }
+    getHandler(protocol) {
+        const handler = this.handlers.get(protocol);
+        if (handler == null) {
+            throw new Error(`No handler registered for protocol ${protocol}`);
+        }
+        return handler;
+    }
+    getTopologies(protocol) {
+        const output = [];
+        for (const { topology, protocols } of this.topologies.values()) {
+            if (protocols.includes(protocol)) {
+                output.push(topology);
+            }
+        }
+        return output;
+    }
+    /**
+     * Registers the `handler` for each protocol
+     */
+    async handle(protocols, handler) {
+        const protocolList = Array.isArray(protocols) ? protocols : [protocols];
+        for (const protocol of protocolList) {
+            if (this.handlers.has(protocol)) {
+                throw errCode(new Error(`Handler already registered for protocol ${protocol}`), codes.ERR_PROTOCOL_HANDLER_ALREADY_REGISTERED);
+            }
+            this.handlers.set(protocol, handler);
+        }
+        // Add new protocols to self protocols in the Protobook
+        await this.components.getPeerStore().protoBook.add(this.components.getPeerId(), protocolList);
+    }
+    /**
+     * Removes the handler for each protocol. The protocol
+     * will no longer be supported on streams.
+     */
+    async unhandle(protocols) {
+        const protocolList = Array.isArray(protocols) ? protocols : [protocols];
+        protocolList.forEach(protocol => {
+            this.handlers.delete(protocol);
+        });
+        // Remove protocols from self protocols in the Protobook
+        await this.components.getPeerStore().protoBook.remove(this.components.getPeerId(), protocolList);
+    }
+    /**
+     * Register handlers for a set of multicodecs given
+     */
+    async register(protocols, topology) {
+        if (!isTopology(topology)) {
+            log.error('topology must be an instance of interfaces/topology');
+            throw errCode(new Error('topology must be an instance of interfaces/topology'), codes.ERR_INVALID_PARAMETERS);
+        }
+        // Create topology
+        const id = `${(Math.random() * 1e9).toString(36)}${Date.now()}`;
+        this.topologies.set(id, {
+            topology,
+            protocols: Array.isArray(protocols) ? protocols : [protocols]
+        });
+        // Set registrar
+        await topology.setRegistrar(this);
+        return id;
+    }
+    /**
+     * Unregister topology
+     */
+    unregister(id) {
+        this.topologies.delete(id);
+    }
+    /**
+     * Remove a disconnected peer from the record
+     */
+    _onDisconnect(evt) {
+        const connection = evt.detail;
+        void this.components.getPeerStore().protoBook.get(connection.remotePeer)
+            .then(peerProtocols => {
+            for (const { topology, protocols } of this.topologies.values()) {
+                if (supportsProtocol(peerProtocols, protocols)) {
+                    topology.onDisconnect(connection.remotePeer);
+                }
+            }
+        })
+            .catch(err => {
+            log.error(err);
+        });
+    }
+    /**
+     * Check if a new peer support the multicodecs for this topology
+     */
+    _onProtocolChange(evt) {
+        const { peerId, protocols, oldProtocols } = evt.detail;
+        const removed = oldProtocols.filter(protocol => !protocols.includes(protocol));
+        const added = protocols.filter(protocol => !oldProtocols.includes(protocol));
+        for (const { topology, protocols } of this.topologies.values()) {
+            if (supportsProtocol(removed, protocols)) {
+                topology.onDisconnect(peerId);
+            }
+        }
+        for (const { topology, protocols } of this.topologies.values()) {
+            if (supportsProtocol(added, protocols)) {
+                const connection = this.components.getConnectionManager().getConnections(peerId)[0];
+                if (connection == null) {
+                    continue;
+                }
+                topology.onConnect(peerId, connection);
+            }
+        }
+    }
+}
+//# sourceMappingURL=registrar.js.map

package/dist/src/registrar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registrar.js","sourceRoot":"","sources":["../../src/registrar.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,UAAU,EAAY,MAAM,6BAA6B,CAAA;AAMlE,MAAM,GAAG,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAA;AAEtC,SAAS,gBAAgB,CAAE,aAAuB,EAAE,iBAA2B;IAC7E,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;QACxC,IAAI,iBAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YAC5C,OAAO,IAAI,CAAA;SACZ;KACF;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAK3B,YAAa,UAAsB;QACjC,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAA;QAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAA;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAE5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAE1D,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,IAAI,CAAC,aAAa,CAAC,CAAA;QAE9F,yBAAyB;QACzB,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAC7F,CAAC;IAED,YAAY;QACV,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAA;QAEnC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE;YAC/C,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;SAChE;QAED,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE;YAC3C,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;SACxB;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAA;IACrC,CAAC;IAED,UAAU,CAAE,QAAgB;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAE3C,IAAI,OAAO,IAAI,IAAI,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,sCAAsC,QAAQ,EAAE,CAAC,CAAA;SAClE;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,aAAa,CAAE,QAAgB;QAC7B,MAAM,MAAM,GAAe,EAAE,CAAA;QAE7B,KAAK,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE;YAC9D,IAAI,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;gBAChC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;aACtB;SACF;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAE,SAA4B,EAAE,OAAsB;QAChE,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;QAEvE,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE;YACnC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAC/B,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,2CAA2C,QAAQ,EAAE,CAAC,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAA;aAC/H;YAED,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;SACrC;QAED,uDAAuD;QACvD,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,YAAY,CAAC,CAAA;IAC/F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CAAE,SAA4B;QAC1C,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;QAEvE,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC9B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAChC,CAAC,CAAC,CAAA;QAEF,wDAAwD;QACxD,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,YAAY,CAAC,CAAA;IAClG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAE,SAA4B,EAAE,QAAkB;QAC9D,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACzB,GAAG,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAA;YAChE,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,qDAAqD,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAA;SAC9G;QAED,kBAAkB;QAClB,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAA;QAE/D,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE;YACtB,QAAQ;YACR,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;SAC9D,CAAC,CAAA;QAEF,gBAAgB;QAChB,MAAM,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QAEjC,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;OAEG;IACH,UAAU,CAAE,EAAU;QACpB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAC5B,CAAC;IAED;;OAEG;IACH,aAAa,CAAE,GAA4B;QACzC,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAA;QAE7B,KAAK,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC;aACrE,IAAI,CAAC,aAAa,CAAC,EAAE;YACpB,KAAK,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE;gBAC9D,IAAI,gBAAgB,CAAC,aAAa,EAAE,SAAS,CAAC,EAAE;oBAC9C,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;iBAC7C;aACF;QACH,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAChB,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAE,GAAyC;QAC1D,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,GAAG,CAAC,MAAM,CAAA;QAEtD,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC9E,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAA;QAE5E,KAAK,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE;YAC9D,IAAI,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE;gBACxC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;aAC9B;SACF;QAED,KAAK,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE;YAC9D,IAAI,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE;gBACtC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;gBAEnF,IAAI,UAAU,IAAI,IAAI,EAAE;oBACtB,SAAQ;iBACT;gBAED,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;aACvC;SACF;IACH,CAAC;CACF"}