@libp2p/kad-dht 0.28.6

package/dist/src/query/events.js

@@ -0,0 +1,73 @@
+import { MESSAGE_TYPE_LOOKUP } from '../message/index.js';
+const MESSAGE_NAMES = [
+    'PUT_VALUE',
+    'GET_VALUE',
+    'ADD_PROVIDER',
+    'GET_PROVIDERS',
+    'FIND_NODE',
+    'PING'
+];
+export function sendingQueryEvent(fields) {
+    return {
+        ...fields,
+        name: 'SENDING_QUERY',
+        type: 0,
+        // @ts-expect-error cannot look up values like this
+        messageName: MESSAGE_TYPE_LOOKUP[fields.type],
+        messageType: fields.type
+    };
+}
+export function peerResponseEvent(fields) {
+    return {
+        ...fields,
+        name: 'PEER_RESPONSE',
+        type: 1,
+        // @ts-expect-error cannot look up values like this
+        messageName: MESSAGE_NAMES[fields.messageType],
+        closer: (fields.closer != null) ? fields.closer : [],
+        providers: (fields.providers != null) ? fields.providers : []
+    };
+}
+export function finalPeerEvent(fields) {
+    return {
+        ...fields,
+        name: 'FINAL_PEER',
+        type: 2
+    };
+}
+export function queryErrorEvent(fields) {
+    return {
+        ...fields,
+        name: 'QUERY_ERROR',
+        type: 3
+    };
+}
+export function providerEvent(fields) {
+    return {
+        ...fields,
+        name: 'PROVIDER',
+        type: 4
+    };
+}
+export function valueEvent(fields) {
+    return {
+        ...fields,
+        name: 'VALUE',
+        type: 5
+    };
+}
+export function addingPeerEvent(fields) {
+    return {
+        ...fields,
+        name: 'ADDING_PEER',
+        type: 6
+    };
+}
+export function dialingPeerEvent(fields) {
+    return {
+        ...fields,
+        name: 'DIALING_PEER',
+        type: 7
+    };
+}
+//# sourceMappingURL=events.js.map

package/dist/src/query/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/query/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAMzD,MAAM,aAAa,GAAG;IACpB,WAAW;IACX,WAAW;IACX,cAAc;IACd,eAAe;IACf,WAAW;IACX,MAAM;CACP,CAAA;AAOD,MAAM,UAAU,iBAAiB,CAAE,MAAwB;IACzD,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,CAAC;QACP,mDAAmD;QACnD,WAAW,EAAE,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC;QAC7C,WAAW,EAAE,MAAM,CAAC,IAAI;KACzB,CAAA;AACH,CAAC;AAUD,MAAM,UAAU,iBAAiB,CAAE,MAA8B;IAC/D,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,CAAC;QACP,mDAAmD;QACnD,WAAW,EAAE,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC;QAC9C,MAAM,EAAE,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;QACpD,SAAS,EAAE,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;KAC9D,CAAA;AACH,CAAC;AAOD,MAAM,UAAU,cAAc,CAAE,MAA4B;IAC1D,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,CAAC;KACR,CAAA;AACH,CAAC;AAOD,MAAM,UAAU,eAAe,CAAE,MAAwB;IACvD,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,CAAC;KACR,CAAA;AACH,CAAC;AAOD,MAAM,UAAU,aAAa,CAAE,MAA2B;IACxD,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,CAAC;KACR,CAAA;AACH,CAAC;AAOD,MAAM,UAAU,UAAU,CAAE,MAAwB;IAClD,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,CAAC;KACR,CAAA;AACH,CAAC;AAMD,MAAM,UAAU,eAAe,CAAE,MAAuB;IACtD,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,CAAC;KACR,CAAA;AACH,CAAC;AAMD,MAAM,UAAU,gBAAgB,CAAE,MAA8B;IAC9D,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,CAAC;KACR,CAAA;AACH,CAAC"}

package/dist/src/query/manager.d.ts

@@ -0,0 +1,40 @@
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { ComponentMetricsTracker } from '@libp2p/interfaces/metrics';
+import type { Startable } from '@libp2p/interfaces';
+import type { QueryFunc } from './types.js';
+import type { QueryOptions } from '@libp2p/interfaces/dht';
+export interface CleanUpEvents {
+    'cleanup': CustomEvent;
+}
+export interface QueryManagerOptions {
+    peerId: PeerId;
+    lan?: boolean;
+    metrics?: ComponentMetricsTracker;
+    disjointPaths?: number;
+    alpha?: number;
+}
+/**
+ * Keeps track of all running queries
+ */
+export declare class QueryManager implements Startable {
+    private readonly peerId;
+    private readonly lan;
+    private readonly metrics?;
+    disjointPaths: number;
+    private readonly alpha;
+    private readonly controllers;
+    private running;
+    private queries;
+    constructor(options: QueryManagerOptions);
+    isStarted(): boolean;
+    /**
+     * Starts the query manager
+     */
+    start(): Promise<void>;
+    /**
+     * Stops all queries
+     */
+    stop(): Promise<void>;
+    run(key: Uint8Array, peers: PeerId[], queryFunc: QueryFunc, options?: QueryOptions): AsyncGenerator<import("@libp2p/interfaces/dht").QueryEvent, void, unknown>;
+}
+//# sourceMappingURL=manager.d.ts.map

package/dist/src/query/manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manager.d.ts","sourceRoot":"","sources":["../../../src/query/manager.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAA;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAI1D,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,WAAW,CAAA;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,OAAO,CAAC,EAAE,uBAAuB,CAAA;IACjC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,qBAAa,YAAa,YAAW,SAAS;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAyB;IAC3C,aAAa,EAAE,MAAM,CAAA;IAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAClD,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAQ;gBAEV,OAAO,EAAE,mBAAmB;IAYzC,SAAS;IAIT;;OAEG;IACG,KAAK;IAIX;;OAEG;IACG,IAAI;IAUF,GAAG,CAAE,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,GAAE,YAAiB;CAwGhG"}

package/dist/src/query/manager.js

@@ -0,0 +1,140 @@
+import { TimeoutController } from 'timeout-abort-controller';
+import { anySignal } from 'any-signal';
+import { ALPHA, K, DEFAULT_QUERY_TIMEOUT } from '../constants.js';
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string';
+import { queryPath } from './query-path.js';
+import merge from 'it-merge';
+import { 
+// @ts-expect-error only defined in node 15+
+setMaxListeners } from 'events';
+import { EventEmitter, CustomEvent } from '@libp2p/interfaces';
+import { logger } from '@libp2p/logger';
+const METRIC_RUNNING_QUERIES = 'running-queries';
+/**
+ * Keeps track of all running queries
+ */
+export class QueryManager {
+    constructor(options) {
+        const { peerId, lan = false, metrics, disjointPaths = K, alpha = ALPHA } = options;
+        this.peerId = peerId;
+        this.disjointPaths = disjointPaths ?? K;
+        this.controllers = new Set();
+        this.running = false;
+        this.alpha = alpha ?? ALPHA;
+        this.lan = lan;
+        this.metrics = metrics;
+        this.queries = 0;
+    }
+    isStarted() {
+        return this.running;
+    }
+    /**
+     * Starts the query manager
+     */
+    async start() {
+        this.running = true;
+    }
+    /**
+     * Stops all queries
+     */
+    async stop() {
+        this.running = false;
+        for (const controller of this.controllers) {
+            controller.abort();
+        }
+        this.controllers.clear();
+    }
+    async *run(key, peers, queryFunc, options = {}) {
+        if (!this.running) {
+            throw new Error('QueryManager not started');
+        }
+        let timeoutController;
+        if (options.signal == null) {
+            // don't let queries run forever
+            timeoutController = new TimeoutController(DEFAULT_QUERY_TIMEOUT);
+            options.signal = timeoutController.signal;
+        }
+        // allow us to stop queries on shut down
+        const abortController = new AbortController();
+        this.controllers.add(abortController);
+        const signals = [abortController.signal];
+        if (options.signal != null) {
+            signals.push(options.signal);
+        }
+        const signal = anySignal(signals);
+        // this signal will get listened to for every invocation of queryFunc
+        // so make sure we don't make a lot of noise in the logs
+        try {
+            if (setMaxListeners != null) {
+                setMaxListeners(0, signal);
+            }
+        }
+        catch { } // fails on node < 15.4
+        const log = logger(`libp2p:kad-dht:${this.lan ? 'lan' : 'wan'}:query:` + uint8ArrayToString(key, 'base58btc'));
+        // query a subset of peers up to `kBucketSize / 2` in length
+        const peersToQuery = peers.slice(0, Math.min(this.disjointPaths, peers.length));
+        const startTime = Date.now();
+        const cleanUp = new EventEmitter();
+        try {
+            log('query:start');
+            this.queries++;
+            this.metrics?.updateComponentMetric({
+                system: 'libp2p',
+                component: `kad-dht-${this.lan ? 'lan' : 'wan'}`,
+                metric: METRIC_RUNNING_QUERIES,
+                value: this.queries
+            });
+            if (peers.length === 0) {
+                log.error('Running query with no peers');
+                return;
+            }
+            // Create query paths from the starting peers
+            const paths = peersToQuery.map((peer, index) => {
+                return queryPath({
+                    key,
+                    startingPeer: peer,
+                    ourPeerId: this.peerId,
+                    signal,
+                    query: queryFunc,
+                    pathIndex: index,
+                    numPaths: peersToQuery.length,
+                    alpha: this.alpha,
+                    cleanUp,
+                    queryFuncTimeout: options.queryFuncTimeout,
+                    log
+                });
+            });
+            // Execute the query along each disjoint path and yield their results as they become available
+            for await (const event of merge(...paths)) {
+                yield event;
+                if (event.name === 'QUERY_ERROR') {
+                    log('error', event.error);
+                }
+            }
+        }
+        catch (err) {
+            if (!this.running && err.code === 'ERR_QUERY_ABORTED') {
+                // ignore query aborted errors that were thrown during query manager shutdown
+            }
+            else {
+                throw err;
+            }
+        }
+        finally {
+            this.controllers.delete(abortController);
+            if (timeoutController != null) {
+                timeoutController.clear();
+            }
+            this.queries--;
+            this.metrics?.updateComponentMetric({
+                system: 'libp2p',
+                component: `kad-dht-${this.lan ? 'lan' : 'wan'}`,
+                metric: METRIC_RUNNING_QUERIES,
+                value: this.queries
+            });
+            cleanUp.dispatchEvent(new CustomEvent('cleanup'));
+            log('query:done in %dms', Date.now() - startTime);
+        }
+    }
+}
+//# sourceMappingURL=manager.js.map

package/dist/src/query/manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manager.js","sourceRoot":"","sources":["../../../src/query/manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EACL,KAAK,EAAE,CAAC,EAAE,qBAAqB,EAChC,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,MAAM,UAAU,CAAA;AAC5B,OAAO;AACL,4CAA4C;AAC5C,eAAe,EAChB,MAAM,QAAQ,CAAA;AACf,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAOvC,MAAM,sBAAsB,GAAG,iBAAiB,CAAA;AAchD;;GAEG;AACH,MAAM,OAAO,YAAY;IAUvB,YAAa,OAA4B;QACvC,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,KAAK,EAAE,OAAO,EAAE,aAAa,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,EAAE,GAAG,OAAO,CAAA;QAClF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,CAAC,CAAA;QACvC,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,KAAK,CAAA;QAC3B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;IAClB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QAEpB,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACzC,UAAU,CAAC,KAAK,EAAE,CAAA;SACnB;QAED,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAA;IAC1B,CAAC;IAED,KAAK,CAAC,CAAE,GAAG,CAAE,GAAe,EAAE,KAAe,EAAE,SAAoB,EAAE,UAAwB,EAAE;QAC7F,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;SAC5C;QAED,IAAI,iBAAiB,CAAA;QAErB,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE;YAC1B,gCAAgC;YAChC,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,CAAA;YAChE,OAAO,CAAC,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAA;SAC1C;QAED,wCAAwC;QACxC,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC7C,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;QAExC,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE;YAC1B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;SAC7B;QAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAA;QAEjC,qEAAqE;QACrE,wDAAwD;QACxD,IAAI;YACF,IAAI,eAAe,IAAI,IAAI,EAAE;gBAC3B,eAAe,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;aAC3B;SACF;QAAC,MAAM,GAAE,CAAC,uBAAuB;QAElC,MAAM,GAAG,GAAG,MAAM,CAAC,kBAAkB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,GAAG,kBAAkB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAA;QAE9G,4DAA4D;QAC5D,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;QAC/E,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAC5B,MAAM,OAAO,GAAG,IAAI,YAAY,EAAiB,CAAA;QAEjD,IAAI;YACF,GAAG,CAAC,aAAa,CAAC,CAAA;YAClB,IAAI,CAAC,OAAO,EAAE,CAAA;YACd,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC;gBAClC,MAAM,EAAE,QAAQ;gBAChB,SAAS,EAAE,WAAW,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;gBAChD,MAAM,EAAE,sBAAsB;gBAC9B,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC,CAAA;YAEF,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtB,GAAG,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;gBACxC,OAAM;aACP;YAED,6CAA6C;YAC7C,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;gBAC7C,OAAO,SAAS,CAAC;oBACf,GAAG;oBACH,YAAY,EAAE,IAAI;oBAClB,SAAS,EAAE,IAAI,CAAC,MAAM;oBACtB,MAAM;oBACN,KAAK,EAAE,SAAS;oBAChB,SAAS,EAAE,KAAK;oBAChB,QAAQ,EAAE,YAAY,CAAC,MAAM;oBAC7B,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,OAAO;oBACP,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;oBAC1C,GAAG;iBACJ,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YAEF,8FAA8F;YAC9F,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,KAAK,CAAC,GAAG,KAAK,CAAC,EAAE;gBACzC,MAAM,KAAK,CAAA;gBAEX,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE;oBAChC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;iBAC1B;aACF;SACF;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,KAAK,mBAAmB,EAAE;gBACrD,6EAA6E;aAC9E;iBAAM;gBACL,MAAM,GAAG,CAAA;aACV;SACF;gBAAS;YACR,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;YAExC,IAAI,iBAAiB,IAAI,IAAI,EAAE;gBAC7B,iBAAiB,CAAC,KAAK,EAAE,CAAA;aAC1B;YAED,IAAI,CAAC,OAAO,EAAE,CAAA;YACd,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC;gBAClC,MAAM,EAAE,QAAQ;gBAChB,SAAS,EAAE,WAAW,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;gBAChD,MAAM,EAAE,sBAAsB;gBAC9B,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC,CAAA;YAEF,OAAO,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC,CAAA;YACjD,GAAG,CAAC,oBAAoB,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAA;SAClD;IACH,CAAC;CACF"}

package/dist/src/query/query-path.d.ts

@@ -0,0 +1,58 @@
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { EventEmitter } from '@libp2p/interfaces';
+import type { CleanUpEvents } from './manager.js';
+import type { Logger } from '@libp2p/logger';
+import type { QueryFunc } from '../query/types.js';
+import type { QueryEvent } from '@libp2p/interfaces/dht';
+export interface QueryPathOptions {
+    /**
+     * What are we trying to find
+     */
+    key: Uint8Array;
+    /**
+     * Where we start our query
+     */
+    startingPeer: PeerId;
+    /**
+     * Who we are
+     */
+    ourPeerId: PeerId;
+    /**
+     * When to stop querying
+     */
+    signal: AbortSignal;
+    /**
+     * The query function to run with each peer
+     */
+    query: QueryFunc;
+    /**
+     * How many concurrent node/value lookups to run
+     */
+    alpha: number;
+    /**
+     * How many concurrent node/value lookups to run
+     */
+    pathIndex: number;
+    /**
+     * How many concurrent node/value lookups to run
+     */
+    numPaths: number;
+    /**
+     * will emit a 'cleanup' event if the caller exits the for..await of early
+     */
+    cleanUp: EventEmitter<CleanUpEvents>;
+    /**
+     * A timeout for queryFunc in ms
+     */
+    queryFuncTimeout?: number;
+    /**
+     * Query log
+     */
+    log: Logger;
+}
+/**
+ * Walks a path through the DHT, calling the passed query function for
+ * every peer encountered that we have not seen before
+ */
+export declare function queryPath(options: QueryPathOptions): AsyncGenerator<QueryEvent, void, undefined>;
+//# sourceMappingURL=query-path.d.ts.map

package/dist/src/query/query-path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-path.d.ts","sourceRoot":"","sources":["../../../src/query/query-path.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAElD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAIxD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,EAAE,UAAU,CAAA;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;IAEnB;;OAEG;IACH,KAAK,EAAE,SAAS,CAAA;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,aAAa,CAAC,CAAA;IAEpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;;GAGG;AACH,wBAAwB,SAAS,CAAE,OAAO,EAAE,gBAAgB,+CAkH3D"}

package/dist/src/query/query-path.js

@@ -0,0 +1,171 @@
+import Queue from 'p-queue';
+import { xor } from 'uint8arrays/xor';
+import { toString } from 'uint8arrays/to-string';
+import defer from 'p-defer';
+import errCode from 'err-code';
+import { convertPeerId, convertBuffer } from '../utils.js';
+import { TimeoutController } from 'timeout-abort-controller';
+import { anySignal } from 'any-signal';
+import { queryErrorEvent } from './events.js';
+import { base58btc } from 'multiformats/bases/base58';
+const MAX_XOR = BigInt('0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF');
+/**
+ * Walks a path through the DHT, calling the passed query function for
+ * every peer encountered that we have not seen before
+ */
+export async function* queryPath(options) {
+    const { key, startingPeer, ourPeerId, signal, query, alpha, pathIndex, numPaths, cleanUp, queryFuncTimeout, log } = options;
+    // Only ALPHA node/value lookups are allowed at any given time for each process
+    // https://github.com/libp2p/specs/tree/master/kad-dht#alpha-concurrency-parameter-%CE%B1
+    const queue = new Queue({
+        concurrency: alpha
+    });
+    // perform lookups on kadId, not the actual value
+    const kadId = await convertBuffer(key);
+    // make sure we don't get trapped in a loop
+    const peersSeen = new Set();
+    /**
+     * Adds the passed peer to the query queue if it's not us and no
+     * other path has passed through this peer
+     */
+    function queryPeer(peer, peerKadId) {
+        if (peer == null) {
+            return;
+        }
+        peersSeen.add(peer.toString(base58btc));
+        const peerXor = BigInt('0x' + toString(xor(peerKadId, kadId), 'base16'));
+        queue.add(async () => {
+            let timeout;
+            const signals = [signal];
+            if (queryFuncTimeout != null) {
+                timeout = new TimeoutController(queryFuncTimeout);
+                signals.push(timeout.signal);
+            }
+            const compoundSignal = anySignal(signals);
+            try {
+                for await (const event of query({
+                    key,
+                    peer,
+                    signal: compoundSignal,
+                    pathIndex,
+                    numPaths
+                })) {
+                    if (compoundSignal.aborted) {
+                        return;
+                    }
+                    // if there are closer peers and the query has not completed, continue the query
+                    if (event.name === 'PEER_RESPONSE') {
+                        for (const closerPeer of event.closer) {
+                            if (peersSeen.has(closerPeer.id.toString(base58btc))) { // eslint-disable-line max-depth
+                                log('already seen %p in query', closerPeer.id);
+                                continue;
+                            }
+                            if (ourPeerId.equals(closerPeer.id)) { // eslint-disable-line max-depth
+                                log('not querying ourselves');
+                                continue;
+                            }
+                            const closerPeerKadId = await convertPeerId(closerPeer.id);
+                            const closerPeerXor = BigInt('0x' + toString(xor(closerPeerKadId, kadId), 'base16'));
+                            // only continue query if closer peer is actually closer
+                            if (closerPeerXor > peerXor) { // eslint-disable-line max-depth
+                                log('skipping %p as they are not closer to %b than %p', closerPeer.id, key, peer);
+                                continue;
+                            }
+                            log('querying closer peer %p', closerPeer.id);
+                            queryPeer(closerPeer.id, closerPeerKadId);
+                        }
+                    }
+                    // TODO: we have upgraded to p-queue@7, this should no longer be necessary
+                    queue.emit('completed', event);
+                }
+                timeout?.clear();
+            }
+            catch (err) {
+                if (signal.aborted) {
+                    // TODO: we have upgraded to p-queue@7, this should no longer be necessary
+                    queue.emit('error', err);
+                }
+                else {
+                    // TODO: we have upgraded to p-queue@7, this should no longer be necessary
+                    queue.emit('completed', queryErrorEvent({
+                        from: peer,
+                        error: err
+                    }));
+                }
+            }
+            finally {
+                timeout?.clear();
+            }
+        }, {
+            // use xor value as the queue priority - closer peers should execute first
+            // subtract it from MAX_XOR because higher priority values execute sooner
+            // @ts-expect-error this is supposed to be a Number but it's ok to use BigInts
+            // as long as all priorities are BigInts since we won't mix BigInts and Number
+            // values in arithmetic operations
+            priority: MAX_XOR - peerXor
+        }).catch(err => {
+            log.error(err);
+        });
+    }
+    // begin the query with the starting peer
+    queryPeer(startingPeer, await convertPeerId(startingPeer));
+    // yield results as they come in
+    yield* toGenerator(queue, signal, cleanUp, log);
+}
+async function* toGenerator(queue, signal, cleanUp, log) {
+    let deferred = defer();
+    let running = true;
+    const results = [];
+    const cleanup = () => {
+        if (!running) {
+            return;
+        }
+        log('clean up queue, results %d, queue size %d, pending tasks %d', results.length, queue.size, queue.pending);
+        running = false;
+        queue.clear();
+        results.splice(0, results.length);
+    };
+    queue.on('completed', result => {
+        results.push(result);
+        deferred.resolve();
+    });
+    queue.on('error', err => {
+        log('queue error', err);
+        cleanup();
+        deferred.reject(err);
+    });
+    queue.on('idle', () => {
+        log('queue idle');
+        running = false;
+        deferred.resolve();
+    });
+    // clear the queue and throw if the query is aborted
+    signal.addEventListener('abort', () => {
+        log('abort queue');
+        const wasRunning = running;
+        cleanup();
+        if (wasRunning) {
+            deferred.reject(errCode(new Error('Query aborted'), 'ERR_QUERY_ABORTED'));
+        }
+    });
+    // the user broke out of the loop early, ensure we resolve the deferred result
+    // promise and clear the queue of any remaining jobs
+    cleanUp.addEventListener('cleanup', () => {
+        cleanup();
+        deferred.resolve();
+    });
+    while (running) { // eslint-disable-line no-unmodified-loop-condition
+        await deferred.promise;
+        deferred = defer();
+        // yield all available results
+        while (results.length > 0) {
+            const result = results.shift();
+            if (result != null) {
+                yield result;
+            }
+        }
+    }
+    // yield any remaining results
+    yield* results;
+}
+//# sourceMappingURL=query-path.js.map

package/dist/src/query/query-path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-path.js","sourceRoot":"","sources":["../../../src/query/query-path.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,SAAS,CAAA;AAC3B,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,KAAK,MAAM,SAAS,CAAA;AAC3B,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAM7C,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAGrD,MAAM,OAAO,GAAG,MAAM,CAAC,oEAAoE,CAAC,CAAA;AA2D5F;;;GAGG;AACH,MAAM,CAAC,KAAK,SAAU,CAAC,CAAC,SAAS,CAAE,OAAyB;IAC1D,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAE,GAAG,EAAE,GAAG,OAAO,CAAA;IAC3H,+EAA+E;IAC/E,yFAAyF;IACzF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC;QACtB,WAAW,EAAE,KAAK;KACnB,CAAC,CAAA;IAEF,iDAAiD;IACjD,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,CAAA;IAEtC,2CAA2C;IAC3C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAE,CAAA;IAE3B;;;OAGG;IACH,SAAS,SAAS,CAAE,IAAY,EAAE,SAAqB;QACrD,IAAI,IAAI,IAAI,IAAI,EAAE;YAChB,OAAM;SACP;QAED,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAA;QAEvC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAA;QAExE,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YACnB,IAAI,OAAO,CAAA;YACX,MAAM,OAAO,GAAG,CAAC,MAAM,CAAC,CAAA;YAExB,IAAI,gBAAgB,IAAI,IAAI,EAAE;gBAC5B,OAAO,GAAG,IAAI,iBAAiB,CAAC,gBAAgB,CAAC,CAAA;gBACjD,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;aAC7B;YAED,MAAM,cAAc,GAAG,SAAS,CAAC,OAAO,CAAC,CAAA;YAEzC,IAAI;gBACF,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,KAAK,CAAC;oBAC9B,GAAG;oBACH,IAAI;oBACJ,MAAM,EAAE,cAAc;oBACtB,SAAS;oBACT,QAAQ;iBACT,CAAC,EAAE;oBACF,IAAI,cAAc,CAAC,OAAO,EAAE;wBAC1B,OAAM;qBACP;oBAED,gFAAgF;oBAChF,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE;wBAClC,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,MAAM,EAAE;4BACrC,IAAI,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,gCAAgC;gCACtF,GAAG,CAAC,0BAA0B,EAAE,UAAU,CAAC,EAAE,CAAC,CAAA;gCAC9C,SAAQ;6BACT;4BAED,IAAI,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,EAAE,gCAAgC;gCACrE,GAAG,CAAC,wBAAwB,CAAC,CAAA;gCAC7B,SAAQ;6BACT;4BAED,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;4BAC1D,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAA;4BAEpF,wDAAwD;4BACxD,IAAI,aAAa,GAAG,OAAO,EAAE,EAAE,gCAAgC;gCAC7D,GAAG,CAAC,kDAAkD,EAAE,UAAU,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAA;gCACjF,SAAQ;6BACT;4BAED,GAAG,CAAC,yBAAyB,EAAE,UAAU,CAAC,EAAE,CAAC,CAAA;4BAC7C,SAAS,CAAC,UAAU,CAAC,EAAE,EAAE,eAAe,CAAC,CAAA;yBAC1C;qBACF;oBAED,0EAA0E;oBAC1E,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;iBAC/B;gBAED,OAAO,EAAE,KAAK,EAAE,CAAA;aACjB;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAI,MAAM,CAAC,OAAO,EAAE;oBAClB,0EAA0E;oBAC1E,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;iBACzB;qBAAM;oBACL,0EAA0E;oBAC1E,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC;wBACtC,IAAI,EAAE,IAAI;wBACV,KAAK,EAAE,GAAG;qBACX,CAAC,CAAC,CAAA;iBACJ;aACF;oBAAS;gBACR,OAAO,EAAE,KAAK,EAAE,CAAA;aACjB;QACH,CAAC,EAAE;YACD,0EAA0E;YAC1E,yEAAyE;YAEzE,8EAA8E;YAC9E,8EAA8E;YAC9E,kCAAkC;YAClC,QAAQ,EAAE,OAAO,GAAG,OAAO;SAC5B,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACb,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAChB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,yCAAyC;IACzC,SAAS,CAAC,YAAY,EAAE,MAAM,aAAa,CAAC,YAAY,CAAC,CAAC,CAAA;IAE1D,gCAAgC;IAChC,KAAM,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;AAClD,CAAC;AAED,KAAK,SAAU,CAAC,CAAC,WAAW,CAAE,KAAY,EAAE,MAAmB,EAAE,OAAoC,EAAE,GAAW;IAChH,IAAI,QAAQ,GAAG,KAAK,EAAE,CAAA;IACtB,IAAI,OAAO,GAAG,IAAI,CAAA;IAClB,MAAM,OAAO,GAAiB,EAAE,CAAA;IAEhC,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,IAAI,CAAC,OAAO,EAAE;YACZ,OAAM;SACP;QAED,GAAG,CAAC,6DAA6D,EAAE,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;QAE7G,OAAO,GAAG,KAAK,CAAA;QACf,KAAK,CAAC,KAAK,EAAE,CAAA;QACb,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IACnC,CAAC,CAAA;IAED,KAAK,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE;QAC7B,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACpB,QAAQ,CAAC,OAAO,EAAE,CAAA;IACpB,CAAC,CAAC,CAAA;IACF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;QACtB,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;QACvB,OAAO,EAAE,CAAA;QACT,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACtB,CAAC,CAAC,CAAA;IACF,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;QACpB,GAAG,CAAC,YAAY,CAAC,CAAA;QACjB,OAAO,GAAG,KAAK,CAAA;QACf,QAAQ,CAAC,OAAO,EAAE,CAAA;IACpB,CAAC,CAAC,CAAA;IAEF,oDAAoD;IACpD,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;QACpC,GAAG,CAAC,aAAa,CAAC,CAAA;QAClB,MAAM,UAAU,GAAG,OAAO,CAAA;QAC1B,OAAO,EAAE,CAAA;QAET,IAAI,UAAU,EAAE;YACd,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAA;SAC1E;IACH,CAAC,CAAC,CAAA;IAEF,8EAA8E;IAC9E,oDAAoD;IACpD,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,GAAG,EAAE;QACvC,OAAO,EAAE,CAAA;QACT,QAAQ,CAAC,OAAO,EAAE,CAAA;IACpB,CAAC,CAAC,CAAA;IAEF,OAAO,OAAO,EAAE,EAAE,mDAAmD;QACnE,MAAM,QAAQ,CAAC,OAAO,CAAA;QACtB,QAAQ,GAAG,KAAK,EAAE,CAAA;QAElB,8BAA8B;QAC9B,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAA;YAE9B,IAAI,MAAM,IAAI,IAAI,EAAE;gBAClB,MAAM,MAAM,CAAA;aACb;SACF;KACF;IAED,8BAA8B;IAC9B,KAAM,CAAC,CAAC,OAAO,CAAA;AACjB,CAAC"}

package/dist/src/query/types.d.ts

@@ -0,0 +1,16 @@
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { QueryEvent } from '@libp2p/interfaces/dht';
+export interface QueryContext {
+    key: Uint8Array;
+    peer: PeerId;
+    signal: AbortSignal;
+    pathIndex: number;
+    numPaths: number;
+}
+/**
+ * Query function
+ */
+export interface QueryFunc {
+    (context: QueryContext): AsyncIterable<QueryEvent>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/src/query/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/query/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAExD,MAAM,WAAW,YAAY;IAE3B,GAAG,EAAE,UAAU,CAAA;IAEf,IAAI,EAAE,MAAM,CAAA;IAEZ,MAAM,EAAE,WAAW,CAAA;IAEnB,SAAS,EAAE,MAAM,CAAA;IAEjB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,CAAC,OAAO,EAAE,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,CAAA;CACnD"}

package/dist/src/query/types.js

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

package/dist/src/query/types.js.map

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

package/dist/src/query-self.d.ts

@@ -0,0 +1,31 @@
+import type { PeerRouting } from './peer-routing/index.js';
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { Startable } from '@libp2p/interfaces';
+export interface QuerySelfOptions {
+    peerId: PeerId;
+    lan: boolean;
+    peerRouting: PeerRouting;
+    count?: number;
+    interval?: number;
+    queryTimeout?: number;
+}
+/**
+ * Receives notifications of new peers joining the network that support the DHT protocol
+ */
+export declare class QuerySelf implements Startable {
+    private readonly log;
+    private readonly peerId;
+    private readonly peerRouting;
+    private readonly count;
+    private readonly interval;
+    private readonly queryTimeout;
+    private running;
+    private timeoutId?;
+    private controller?;
+    constructor(options: QuerySelfOptions);
+    isStarted(): boolean;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    _querySelf(): void;
+}
+//# sourceMappingURL=query-self.d.ts.map

package/dist/src/query-self.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-self.d.ts","sourceRoot":"","sources":["../../src/query-self.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAGnD,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,OAAO,CAAA;IACZ,WAAW,EAAE,WAAW,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,qBAAa,SAAU,YAAW,SAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;IACrC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAC,CAAc;IAChC,OAAO,CAAC,UAAU,CAAC,CAAiB;gBAEvB,OAAO,EAAE,gBAAgB;IAYtC,SAAS;IAIH,KAAK;IASL,IAAI;IAYV,UAAU;CAgCX"}

package/dist/src/query-self.js

@@ -0,0 +1,73 @@
+// @ts-expect-error setMaxListeners is missing from the types
+import { setMaxListeners } from 'events';
+import take from 'it-take';
+import length from 'it-length';
+import { QUERY_SELF_INTERVAL, QUERY_SELF_TIMEOUT, K } from './constants.js';
+import { TimeoutController } from 'timeout-abort-controller';
+import { anySignal } from 'any-signal';
+import { logger } from '@libp2p/logger';
+import { pipe } from 'it-pipe';
+/**
+ * Receives notifications of new peers joining the network that support the DHT protocol
+ */
+export class QuerySelf {
+    constructor(options) {
+        const { peerId, peerRouting, lan, count, interval, queryTimeout } = options;
+        this.log = logger(`libp2p:kad-dht:${lan ? 'lan' : 'wan'}:query-self`);
+        this.running = false;
+        this.peerId = peerId;
+        this.peerRouting = peerRouting;
+        this.count = count ?? K;
+        this.interval = interval ?? QUERY_SELF_INTERVAL;
+        this.queryTimeout = queryTimeout ?? QUERY_SELF_TIMEOUT;
+    }
+    isStarted() {
+        return this.running;
+    }
+    async start() {
+        if (this.running) {
+            return;
+        }
+        this.running = true;
+        this._querySelf();
+    }
+    async stop() {
+        this.running = false;
+        if (this.timeoutId != null) {
+            clearTimeout(this.timeoutId);
+        }
+        if (this.controller != null) {
+            this.controller.abort();
+        }
+    }
+    _querySelf() {
+        Promise.resolve().then(async () => {
+            const timeoutController = new TimeoutController(this.queryTimeout);
+            try {
+                this.controller = new AbortController();
+                const signal = anySignal([this.controller.signal, timeoutController.signal]);
+                // this controller will get used for lots of dial attempts so make sure we don't cause warnings to be logged
+                try {
+                    if (setMaxListeners != null) {
+                        setMaxListeners(Infinity, signal);
+                    }
+                }
+                catch { } // fails on node < 15.4
+                const found = await pipe(this.peerRouting.getClosestPeers(this.peerId.toBytes(), {
+                    signal
+                }), (source) => take(source, this.count), async (source) => await length(source));
+                this.log('query ran successfully - found %d peers', found);
+            }
+            catch (err) {
+                this.log('query error', err);
+            }
+            finally {
+                this.timeoutId = setTimeout(this._querySelf.bind(this), this.interval);
+                timeoutController.clear();
+            }
+        }).catch(err => {
+            this.log('query error', err);
+        });
+    }
+}
+//# sourceMappingURL=query-self.js.map

package/dist/src/query-self.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-self.js","sourceRoot":"","sources":["../../src/query-self.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,IAAI,MAAM,SAAS,CAAA;AAC1B,OAAO,MAAM,MAAM,WAAW,CAAA;AAC9B,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,CAAC,EAAE,MAAM,gBAAgB,CAAA;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAAE,MAAM,EAAU,MAAM,gBAAgB,CAAA;AAI/C,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAW9B;;GAEG;AACH,MAAM,OAAO,SAAS;IAWpB,YAAa,OAAyB;QACpC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,OAAO,CAAA;QAE3E,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,kBAAkB,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAA;QACrE,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,CAAC,CAAA;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,IAAI,mBAAmB,CAAA;QAC/C,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,kBAAkB,CAAA;IACxD,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAM;SACP;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,IAAI,CAAC,UAAU,EAAE,CAAA;IACnB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QAEpB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE;YAC1B,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;SAC7B;QAED,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAAE;YAC3B,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;SACxB;IACH,CAAC;IAED,UAAU;QACR,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;YAChC,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YAElE,IAAI;gBACF,IAAI,CAAC,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;gBACvC,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAA;gBAC5E,4GAA4G;gBAC5G,IAAI;oBACF,IAAI,eAAe,IAAI,IAAI,EAAE;wBAC3B,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;qBAClC;iBACF;gBAAC,MAAM,GAAE,CAAC,uBAAuB;gBAClC,MAAM,KAAK,GAAG,MAAM,IAAI,CACtB,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE;oBACtD,MAAM;iBACP,CAAC,EACF,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,EACpC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,CACvC,CAAA;gBAED,IAAI,CAAC,GAAG,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAA;aAC3D;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;aAC7B;oBAAS;gBACR,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;gBACtE,iBAAiB,CAAC,KAAK,EAAE,CAAA;aAC1B;QACH,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACb,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;QAC9B,CAAC,CAAC,CAAA;IACJ,CAAC;CACF"}