@libp2p/utils 5.4.0-9d13a2f6a → 5.4.0-bfa7660d5

package/dist/src/abort-options.d.ts

@@ -0,0 +1,7 @@
+import type { AbortOptions } from '@libp2p/interface';
+import type { ClearableSignal } from 'any-signal';
+export declare function createTimeoutOptions(timeout: number): AbortOptions;
+export declare function createTimeoutOptions(timeout: number, ...existingSignals: AbortSignal[]): {
+    signal: ClearableSignal;
+};
+//# sourceMappingURL=abort-options.d.ts.map

package/dist/src/abort-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort-options.d.ts","sourceRoot":"","sources":["../../src/abort-options.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD,wBAAgB,oBAAoB,CAAE,OAAO,EAAE,MAAM,GAAG,YAAY,CAAA;AACpE,wBAAgB,oBAAoB,CAAE,OAAO,EAAE,MAAM,EAAE,GAAG,eAAe,EAAE,WAAW,EAAE,GAAG;IAAE,MAAM,EAAE,eAAe,CAAA;CAAE,CAAA"}

package/dist/src/abort-options.js

@@ -0,0 +1,14 @@
+import { setMaxListeners } from '@libp2p/interface';
+import { anySignal } from 'any-signal';
+export function createTimeoutOptions(timeout, ...existingSignals) {
+    let signal = AbortSignal.timeout(timeout);
+    setMaxListeners(Infinity, signal);
+    if (existingSignals.length > 0) {
+        signal = anySignal([signal, ...existingSignals]);
+        setMaxListeners(Infinity, signal);
+    }
+    return {
+        signal
+    };
+}
+//# sourceMappingURL=abort-options.js.map

package/dist/src/abort-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort-options.js","sourceRoot":"","sources":["../../src/abort-options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAMtC,MAAM,UAAU,oBAAoB,CAAE,OAAe,EAAE,GAAG,eAA8B;IACtF,IAAI,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IACzC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAEjC,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,GAAG,SAAS,CAAC,CAAC,MAAM,EAAE,GAAG,eAAe,CAAC,CAAC,CAAA;QAChD,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACnC,CAAC;IAED,OAAO;QACL,MAAM;KACP,CAAA;AACH,CAAC"}

package/dist/src/adaptive-timeout.d.ts

@@ -0,0 +1,35 @@
+import { type ClearableSignal } from 'any-signal';
+import type { Metrics } from '@libp2p/interface';
+export declare const DEFAULT_TIMEOUT_MULTIPLIER = 1.2;
+export declare const DEFAULT_FAILURE_MULTIPLIER = 2;
+export declare const DEFAULT_MIN_TIMEOUT = 2000;
+export interface AdaptiveTimeoutSignal extends ClearableSignal {
+    start: number;
+    timeout: number;
+}
+export interface AdaptiveTimeoutInit {
+    metricName?: string;
+    metrics?: Metrics;
+    interval?: number;
+    initialValue?: number;
+    timeoutMultiplier?: number;
+    failureMultiplier?: number;
+    minTimeout?: number;
+}
+export interface GetTimeoutSignalOptions {
+    timeoutFactor?: number;
+    signal?: AbortSignal;
+}
+export declare class AdaptiveTimeout {
+    private readonly success;
+    private readonly failure;
+    private readonly next;
+    private readonly metric?;
+    private readonly timeoutMultiplier;
+    private readonly failureMultiplier;
+    private readonly minTimeout;
+    constructor(init?: AdaptiveTimeoutInit);
+    getTimeoutSignal(options?: GetTimeoutSignalOptions): AdaptiveTimeoutSignal;
+    cleanUp(signal: AdaptiveTimeoutSignal): void;
+}
+//# sourceMappingURL=adaptive-timeout.d.ts.map

package/dist/src/adaptive-timeout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adaptive-timeout.d.ts","sourceRoot":"","sources":["../../src/adaptive-timeout.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,KAAK,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5D,OAAO,KAAK,EAAe,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE7D,eAAO,MAAM,0BAA0B,MAAM,CAAA;AAC7C,eAAO,MAAM,0BAA0B,IAAI,CAAA;AAC3C,eAAO,MAAM,mBAAmB,OAAO,CAAA;AAEvC,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAED,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAe;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAa;IACrC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAQ;IAC1C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAQ;IAC1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;gBAEtB,IAAI,GAAE,mBAAwB;IAa3C,gBAAgB,CAAE,OAAO,GAAE,uBAA4B,GAAG,qBAAqB;IAiB/E,OAAO,CAAE,MAAM,EAAE,qBAAqB,GAAG,IAAI;CAyB9C"}

package/dist/src/adaptive-timeout.js

@@ -0,0 +1,63 @@
+import { setMaxListeners } from '@libp2p/interface';
+import { anySignal } from 'any-signal';
+import { MovingAverage } from './moving-average.js';
+export const DEFAULT_TIMEOUT_MULTIPLIER = 1.2;
+export const DEFAULT_FAILURE_MULTIPLIER = 2;
+export const DEFAULT_MIN_TIMEOUT = 2000;
+export class AdaptiveTimeout {
+    success;
+    failure;
+    next;
+    metric;
+    timeoutMultiplier;
+    failureMultiplier;
+    minTimeout;
+    constructor(init = {}) {
+        this.success = new MovingAverage(init.interval ?? 5000);
+        this.failure = new MovingAverage(init.interval ?? 5000);
+        this.next = new MovingAverage(init.interval ?? 5000);
+        this.failureMultiplier = init.failureMultiplier ?? DEFAULT_FAILURE_MULTIPLIER;
+        this.timeoutMultiplier = init.timeoutMultiplier ?? DEFAULT_TIMEOUT_MULTIPLIER;
+        this.minTimeout = init.minTimeout ?? DEFAULT_MIN_TIMEOUT;
+        if (init.metricName != null) {
+            this.metric = init.metrics?.registerMetricGroup(init.metricName);
+        }
+    }
+    getTimeoutSignal(options = {}) {
+        // calculate timeout for individual peers based on moving average of
+        // previous successful requests
+        const timeout = Math.max(Math.round(this.next.movingAverage * (options.timeoutFactor ?? this.timeoutMultiplier)), this.minTimeout);
+        const sendTimeout = AbortSignal.timeout(timeout);
+        const timeoutSignal = anySignal([options.signal, sendTimeout]);
+        setMaxListeners(Infinity, timeoutSignal, sendTimeout);
+        timeoutSignal.start = Date.now();
+        timeoutSignal.timeout = timeout;
+        return timeoutSignal;
+    }
+    cleanUp(signal) {
+        const time = Date.now() - signal.start;
+        if (signal.aborted) {
+            this.failure.push(time);
+            this.next.push(time * this.failureMultiplier);
+            this.metric?.update({
+                failureMovingAverage: this.failure.movingAverage,
+                failureDeviation: this.failure.deviation,
+                failureForecast: this.failure.forecast,
+                failureVariance: this.failure.variance,
+                failure: time
+            });
+        }
+        else {
+            this.success.push(time);
+            this.next.push(time);
+            this.metric?.update({
+                successMovingAverage: this.success.movingAverage,
+                successDeviation: this.success.deviation,
+                successForecast: this.success.forecast,
+                successVariance: this.success.variance,
+                success: time
+            });
+        }
+    }
+}
+//# sourceMappingURL=adaptive-timeout.js.map

package/dist/src/adaptive-timeout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adaptive-timeout.js","sourceRoot":"","sources":["../../src/adaptive-timeout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAwB,MAAM,YAAY,CAAA;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGnD,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,CAAA;AAC7C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAA;AAC3C,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,CAAA;AAsBvC,MAAM,OAAO,eAAe;IACT,OAAO,CAAe;IACtB,OAAO,CAAe;IACtB,IAAI,CAAe;IACnB,MAAM,CAAc;IACpB,iBAAiB,CAAQ;IACzB,iBAAiB,CAAQ;IACzB,UAAU,CAAQ;IAEnC,YAAa,OAA4B,EAAE;QACzC,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAA;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAA;QACvD,IAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAA;QACpD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,IAAI,0BAA0B,CAAA;QAC7E,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,IAAI,0BAA0B,CAAA;QAC7E,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,mBAAmB,CAAA;QAExD,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAClE,CAAC;IACH,CAAC;IAED,gBAAgB,CAAE,UAAmC,EAAE;QACrD,oEAAoE;QACpE,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,IAAI,CAAC,iBAAiB,CAAC,CAAC,EACvF,IAAI,CAAC,UAAU,CAChB,CAAA;QACD,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAChD,MAAM,aAAa,GAAG,SAAS,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CAA0B,CAAA;QACvF,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;QAErD,aAAa,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAChC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAA;QAE/B,OAAO,aAAa,CAAA;IACtB,CAAC;IAED,OAAO,CAAE,MAA6B;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,KAAK,CAAA;QAEtC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAA;YAC7C,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;gBAClB,oBAAoB,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa;gBAChD,gBAAgB,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;gBACxC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;gBACtC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;gBACtC,OAAO,EAAE,IAAI;aACd,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACpB,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;gBAClB,oBAAoB,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa;gBAChD,gBAAgB,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;gBACxC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;gBACtC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;gBACtC,OAAO,EAAE,IAAI;aACd,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;CACF"}

package/dist/src/close.d.ts

@@ -0,0 +1,21 @@
+import type { Connection, Stream, AbortOptions } from '@libp2p/interface';
+/**
+ * Close the passed stream, falling back to aborting the stream if closing
+ * cleanly fails.
+ */
+export declare function safelyCloseStream(stream?: Stream, options?: AbortOptions): Promise<void>;
+export interface SafelyCloseConnectionOptions extends AbortOptions {
+    /**
+     * Only close the stream if it either has no protocol streams open or only
+     * ones in this list.
+     *
+     * @default ['/ipfs/id/1.0.0']
+     */
+    closableProtocols?: string[];
+}
+/**
+ * Close the passed connection if it has no streams, or only closable protocol
+ * streams, falling back to aborting the connection if closing it cleanly fails.
+ */
+export declare function safelyCloseConnectionIfUnused(connection?: Connection, options?: SafelyCloseConnectionOptions): Promise<void>;
+//# sourceMappingURL=close.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"close.d.ts","sourceRoot":"","sources":["../../src/close.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEzE;;;GAGG;AACH,wBAAsB,iBAAiB,CAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAM/F;AAuBD,MAAM,WAAW,4BAA6B,SAAQ,YAAY;IAChE;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC7B;AAED;;;GAGG;AACH,wBAAsB,6BAA6B,CAAE,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC,CAenI"}

package/dist/src/close.js

@@ -0,0 +1,49 @@
+/**
+ * Close the passed stream, falling back to aborting the stream if closing
+ * cleanly fails.
+ */
+export async function safelyCloseStream(stream, options) {
+    try {
+        await stream?.close(options);
+    }
+    catch (err) {
+        stream?.abort(err);
+    }
+}
+/**
+ * These are speculative protocols that are run automatically on connection open
+ * so are usually not the reason the connection was opened.
+ *
+ * Consequently when requested it should be safe to close connections that only
+ * have these protocol streams open.
+ */
+const DEFAULT_CLOSABLE_PROTOCOLS = [
+    // identify
+    '/ipfs/id/1.0.0',
+    // identify-push
+    '/ipfs/id/push/1.0.0',
+    // autonat
+    '/libp2p/autonat/1.0.0',
+    // dcutr
+    '/libp2p/dcutr'
+];
+/**
+ * Close the passed connection if it has no streams, or only closable protocol
+ * streams, falling back to aborting the connection if closing it cleanly fails.
+ */
+export async function safelyCloseConnectionIfUnused(connection, options) {
+    const streamProtocols = connection?.streams?.map(stream => stream.protocol) ?? [];
+    const closableProtocols = options?.closableProtocols ?? DEFAULT_CLOSABLE_PROTOCOLS;
+    // if the connection has protocols not in the closable protocols list, do not
+    // close the connection
+    if (streamProtocols.filter(proto => proto != null && !closableProtocols.includes(proto)).length > 0) {
+        return;
+    }
+    try {
+        await connection?.close(options);
+    }
+    catch (err) {
+        connection?.abort(err);
+    }
+}
+//# sourceMappingURL=close.js.map

package/dist/src/close.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"close.js","sourceRoot":"","sources":["../../src/close.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAE,MAAe,EAAE,OAAsB;IAC9E,IAAI,CAAC;QACH,MAAM,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;IAC9B,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;IACpB,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,0BAA0B,GAAG;IACjC,WAAW;IACX,gBAAgB;IAEhB,gBAAgB;IAChB,qBAAqB;IAErB,UAAU;IACV,uBAAuB;IAEvB,QAAQ;IACR,eAAe;CAChB,CAAA;AAYD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAAE,UAAuB,EAAE,OAAsC;IAClH,MAAM,eAAe,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;IACjF,MAAM,iBAAiB,GAAG,OAAO,EAAE,iBAAiB,IAAI,0BAA0B,CAAA;IAElF,6EAA6E;IAC7E,uBAAuB;IACvB,IAAI,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpG,OAAM;IACR,CAAC;IAED,IAAI,CAAC;QACH,MAAM,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;IAClC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;AACH,CAAC"}

package/dist/src/moving-average.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Implements exponential moving average. Ported from `moving-average`.
+ *
+ * @see https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average
+ * @see https://www.npmjs.com/package/moving-average
+ */
+export declare class MovingAverage {
+    movingAverage: number;
+    variance: number;
+    deviation: number;
+    forecast: number;
+    private readonly timespan;
+    private previousTime?;
+    constructor(timespan: number);
+    alpha(t: number, pt: number): number;
+    push(value: number, time?: number): void;
+}
+//# sourceMappingURL=moving-average.d.ts.map

package/dist/src/moving-average.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"moving-average.d.ts","sourceRoot":"","sources":["../../src/moving-average.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,qBAAa,aAAa;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,YAAY,CAAC,CAAQ;gBAEhB,QAAQ,EAAE,MAAM;IAQ7B,KAAK,CAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM;IAIrC,IAAI,CAAE,KAAK,EAAE,MAAM,EAAE,IAAI,GAAE,MAAmB,GAAG,IAAI;CAkBtD"}

package/dist/src/moving-average.js

@@ -0,0 +1,43 @@
+/**
+ * Implements exponential moving average. Ported from `moving-average`.
+ *
+ * @see https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average
+ * @see https://www.npmjs.com/package/moving-average
+ */
+export class MovingAverage {
+    movingAverage;
+    variance;
+    deviation;
+    forecast;
+    timespan;
+    previousTime;
+    constructor(timespan) {
+        this.timespan = timespan;
+        this.movingAverage = 0;
+        this.variance = 0;
+        this.deviation = 0;
+        this.forecast = 0;
+    }
+    alpha(t, pt) {
+        return 1 - (Math.exp(-(t - pt) / this.timespan));
+    }
+    push(value, time = Date.now()) {
+        if (this.previousTime != null) {
+            // calculate moving average
+            const a = this.alpha(time, this.previousTime);
+            const diff = value - this.movingAverage;
+            const incr = a * diff;
+            this.movingAverage = a * value + (1 - a) * this.movingAverage;
+            // calculate variance & deviation
+            this.variance = (1 - a) * (this.variance + diff * incr);
+            this.deviation = Math.sqrt(this.variance);
+            // calculate forecast
+            this.forecast = this.movingAverage + a * diff;
+        }
+        else {
+            this.movingAverage = value;
+        }
+        this.previousTime = time;
+    }
+}
+//# sourceMappingURL=moving-average.js.map

package/dist/src/moving-average.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moving-average.js","sourceRoot":"","sources":["../../src/moving-average.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IACjB,aAAa,CAAQ;IACrB,QAAQ,CAAQ;IAChB,SAAS,CAAQ;IACjB,QAAQ,CAAQ;IACN,QAAQ,CAAQ;IACzB,YAAY,CAAS;IAE7B,YAAa,QAAgB;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QACtB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;QACjB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QAClB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;IACnB,CAAC;IAED,KAAK,CAAE,CAAS,EAAE,EAAU;QAC1B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;IAClD,CAAC;IAED,IAAI,CAAE,KAAa,EAAE,OAAe,IAAI,CAAC,GAAG,EAAE;QAC5C,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;YAC9B,2BAA2B;YAC3B,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;YAC7C,MAAM,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC,aAAa,CAAA;YACvC,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAA;YACrB,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,aAAa,CAAA;YAC7D,iCAAiC;YACjC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC,CAAA;YACvD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACzC,qBAAqB;YACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,IAAI,CAAA;QAC/C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;QAC5B,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;IAC1B,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/utils",
-  "version": "5.4.0-9d13a2f6a",
+  "version": "5.4.0-bfa7660d5",
   "description": "Package to aggregate shared logic and dependencies for the libp2p ecosystem",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/utils#readme",
@@ -44,6 +44,10 @@
       "types": "./src/index.d.ts",
       "import": "./dist/src/index.js"
     },
+    "./abort-options": {
+      "types": "./dist/src/abort-options.d.ts",
+      "import": "./dist/src/abort-options.js"
+    },
     "./abstract-stream": {
       "types": "./dist/src/abstract-stream.d.ts",
       "import": "./dist/src/abstract-stream.js"
@@ -52,6 +56,10 @@
       "types": "./dist/src/address-sort.d.ts",
       "import": "./dist/src/address-sort.js"
     },
+    "./adaptive-timeout": {
+      "types": "./dist/src/adaptive-timeout.d.ts",
+      "import": "./dist/src/adaptive-timeout.js"
+    },
     "./array-equals": {
       "types": "./dist/src/array-equals.d.ts",
       "import": "./dist/src/array-equals.js"
@@ -60,6 +68,10 @@
       "types": "./dist/src/close-source.d.ts",
       "import": "./dist/src/close-source.js"
     },
+    "./close": {
+      "types": "./dist/src/close.d.ts",
+      "import": "./dist/src/close.js"
+    },
     "./filters": {
       "types": "./dist/src/filters/index.d.ts",
       "import": "./dist/src/filters/index.js"
@@ -72,6 +84,10 @@
       "types": "./dist/src/is-promise.d.ts",
       "import": "./dist/src/is-promise.js"
     },
+    "./moving-average": {
+      "types": "./dist/src/moving-average.d.ts",
+      "import": "./dist/src/moving-average.js"
+    },
     "./multiaddr/is-loopback": {
       "types": "./dist/src/multiaddr/is-loopback.d.ts",
       "import": "./dist/src/multiaddr/is-loopback.js"
@@ -132,13 +148,14 @@
   },
   "dependencies": {
     "@chainsafe/is-ip": "^2.0.2",
-    "@libp2p/crypto": "4.1.1-9d13a2f6a",
-    "@libp2p/interface": "1.3.1-9d13a2f6a",
-    "@libp2p/logger": "4.0.12-9d13a2f6a",
+    "@libp2p/crypto": "4.1.1-bfa7660d5",
+    "@libp2p/interface": "1.3.1-bfa7660d5",
+    "@libp2p/logger": "4.0.12-bfa7660d5",
     "@multiformats/multiaddr": "^12.2.1",
     "@multiformats/multiaddr-matcher": "^1.2.0",
     "@sindresorhus/fnv1a": "^3.1.0",
     "@types/murmurhash3js-revisited": "^3.0.3",
+    "any-signal": "^4.1.1",
     "delay": "^6.0.0",
     "get-iterator": "^2.0.1",
     "is-loopback-addr": "^2.0.2",
@@ -153,7 +170,7 @@
     "uint8arrays": "^5.0.3"
   },
   "devDependencies": {
-    "@libp2p/peer-id-factory": "4.1.1-9d13a2f6a",
+    "@libp2p/peer-id-factory": "4.1.1-bfa7660d5",
     "@types/netmask": "^2.0.5",
     "aegir": "^42.2.5",
     "delay": "^6.0.0",

package/src/abort-options.ts

@@ -0,0 +1,20 @@
+import { setMaxListeners } from '@libp2p/interface'
+import { anySignal } from 'any-signal'
+import type { AbortOptions } from '@libp2p/interface'
+import type { ClearableSignal } from 'any-signal'
+
+export function createTimeoutOptions (timeout: number): AbortOptions
+export function createTimeoutOptions (timeout: number, ...existingSignals: AbortSignal[]): { signal: ClearableSignal }
+export function createTimeoutOptions (timeout: number, ...existingSignals: AbortSignal[]): AbortOptions {
+  let signal = AbortSignal.timeout(timeout)
+  setMaxListeners(Infinity, signal)
+
+  if (existingSignals.length > 0) {
+    signal = anySignal([signal, ...existingSignals])
+    setMaxListeners(Infinity, signal)
+  }
+
+  return {
+    signal
+  }
+}

package/src/adaptive-timeout.ts

@@ -0,0 +1,94 @@
+import { setMaxListeners } from '@libp2p/interface'
+import { anySignal, type ClearableSignal } from 'any-signal'
+import { MovingAverage } from './moving-average.js'
+import type { MetricGroup, Metrics } from '@libp2p/interface'
+
+export const DEFAULT_TIMEOUT_MULTIPLIER = 1.2
+export const DEFAULT_FAILURE_MULTIPLIER = 2
+export const DEFAULT_MIN_TIMEOUT = 2000
+
+export interface AdaptiveTimeoutSignal extends ClearableSignal {
+  start: number
+  timeout: number
+}
+
+export interface AdaptiveTimeoutInit {
+  metricName?: string
+  metrics?: Metrics
+  interval?: number
+  initialValue?: number
+  timeoutMultiplier?: number
+  failureMultiplier?: number
+  minTimeout?: number
+}
+
+export interface GetTimeoutSignalOptions {
+  timeoutFactor?: number
+  signal?: AbortSignal
+}
+
+export class AdaptiveTimeout {
+  private readonly success: MovingAverage
+  private readonly failure: MovingAverage
+  private readonly next: MovingAverage
+  private readonly metric?: MetricGroup
+  private readonly timeoutMultiplier: number
+  private readonly failureMultiplier: number
+  private readonly minTimeout: number
+
+  constructor (init: AdaptiveTimeoutInit = {}) {
+    this.success = new MovingAverage(init.interval ?? 5000)
+    this.failure = new MovingAverage(init.interval ?? 5000)
+    this.next = new MovingAverage(init.interval ?? 5000)
+    this.failureMultiplier = init.failureMultiplier ?? DEFAULT_FAILURE_MULTIPLIER
+    this.timeoutMultiplier = init.timeoutMultiplier ?? DEFAULT_TIMEOUT_MULTIPLIER
+    this.minTimeout = init.minTimeout ?? DEFAULT_MIN_TIMEOUT
+
+    if (init.metricName != null) {
+      this.metric = init.metrics?.registerMetricGroup(init.metricName)
+    }
+  }
+
+  getTimeoutSignal (options: GetTimeoutSignalOptions = {}): AdaptiveTimeoutSignal {
+    // calculate timeout for individual peers based on moving average of
+    // previous successful requests
+    const timeout = Math.max(
+      Math.round(this.next.movingAverage * (options.timeoutFactor ?? this.timeoutMultiplier)),
+      this.minTimeout
+    )
+    const sendTimeout = AbortSignal.timeout(timeout)
+    const timeoutSignal = anySignal([options.signal, sendTimeout]) as AdaptiveTimeoutSignal
+    setMaxListeners(Infinity, timeoutSignal, sendTimeout)
+
+    timeoutSignal.start = Date.now()
+    timeoutSignal.timeout = timeout
+
+    return timeoutSignal
+  }
+
+  cleanUp (signal: AdaptiveTimeoutSignal): void {
+    const time = Date.now() - signal.start
+
+    if (signal.aborted) {
+      this.failure.push(time)
+      this.next.push(time * this.failureMultiplier)
+      this.metric?.update({
+        failureMovingAverage: this.failure.movingAverage,
+        failureDeviation: this.failure.deviation,
+        failureForecast: this.failure.forecast,
+        failureVariance: this.failure.variance,
+        failure: time
+      })
+    } else {
+      this.success.push(time)
+      this.next.push(time)
+      this.metric?.update({
+        successMovingAverage: this.success.movingAverage,
+        successDeviation: this.success.deviation,
+        successForecast: this.success.forecast,
+        successVariance: this.success.variance,
+        success: time
+      })
+    }
+  }
+}

package/src/close.ts

@@ -0,0 +1,65 @@
+import type { Connection, Stream, AbortOptions } from '@libp2p/interface'
+
+/**
+ * Close the passed stream, falling back to aborting the stream if closing
+ * cleanly fails.
+ */
+export async function safelyCloseStream (stream?: Stream, options?: AbortOptions): Promise<void> {
+  try {
+    await stream?.close(options)
+  } catch (err: any) {
+    stream?.abort(err)
+  }
+}
+
+/**
+ * These are speculative protocols that are run automatically on connection open
+ * so are usually not the reason the connection was opened.
+ *
+ * Consequently when requested it should be safe to close connections that only
+ * have these protocol streams open.
+ */
+const DEFAULT_CLOSABLE_PROTOCOLS = [
+  // identify
+  '/ipfs/id/1.0.0',
+
+  // identify-push
+  '/ipfs/id/push/1.0.0',
+
+  // autonat
+  '/libp2p/autonat/1.0.0',
+
+  // dcutr
+  '/libp2p/dcutr'
+]
+
+export interface SafelyCloseConnectionOptions extends AbortOptions {
+  /**
+   * Only close the stream if it either has no protocol streams open or only
+   * ones in this list.
+   *
+   * @default ['/ipfs/id/1.0.0']
+   */
+  closableProtocols?: string[]
+}
+
+/**
+ * Close the passed connection if it has no streams, or only closable protocol
+ * streams, falling back to aborting the connection if closing it cleanly fails.
+ */
+export async function safelyCloseConnectionIfUnused (connection?: Connection, options?: SafelyCloseConnectionOptions): Promise<void> {
+  const streamProtocols = connection?.streams?.map(stream => stream.protocol) ?? []
+  const closableProtocols = options?.closableProtocols ?? DEFAULT_CLOSABLE_PROTOCOLS
+
+  // if the connection has protocols not in the closable protocols list, do not
+  // close the connection
+  if (streamProtocols.filter(proto => proto != null && !closableProtocols.includes(proto)).length > 0) {
+    return
+  }
+
+  try {
+    await connection?.close(options)
+  } catch (err: any) {
+    connection?.abort(err)
+  }
+}

package/src/moving-average.ts

@@ -0,0 +1,45 @@
+/**
+ * Implements exponential moving average. Ported from `moving-average`.
+ *
+ * @see https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average
+ * @see https://www.npmjs.com/package/moving-average
+ */
+export class MovingAverage {
+  public movingAverage: number
+  public variance: number
+  public deviation: number
+  public forecast: number
+  private readonly timespan: number
+  private previousTime?: number
+
+  constructor (timespan: number) {
+    this.timespan = timespan
+    this.movingAverage = 0
+    this.variance = 0
+    this.deviation = 0
+    this.forecast = 0
+  }
+
+  alpha (t: number, pt: number): number {
+    return 1 - (Math.exp(-(t - pt) / this.timespan))
+  }
+
+  push (value: number, time: number = Date.now()): void {
+    if (this.previousTime != null) {
+      // calculate moving average
+      const a = this.alpha(time, this.previousTime)
+      const diff = value - this.movingAverage
+      const incr = a * diff
+      this.movingAverage = a * value + (1 - a) * this.movingAverage
+      // calculate variance & deviation
+      this.variance = (1 - a) * (this.variance + diff * incr)
+      this.deviation = Math.sqrt(this.variance)
+      // calculate forecast
+      this.forecast = this.movingAverage + a * diff
+    } else {
+      this.movingAverage = value
+    }
+
+    this.previousTime = time
+  }
+}