libp2p 0.36.2 → 0.37.0

package/dist/src/metrics/stats.d.ts

@@ -1,139 +1,87 @@
-export = Stats;
-/**
- * @typedef {import('@vascosantos/moving-average').IMovingAverage} IMovingAverage
- * @typedef {import('bignumber.js').BigNumber} Big
- */
-declare class Stats extends EventEmitter {
+import { EventEmitter } from '@libp2p/interfaces/events';
+import type { MovingAverages, Stats, TransferStats } from '@libp2p/interfaces/metrics';
+export interface StatsEvents {
+    'update': CustomEvent<TransferStats>;
+}
+export interface StatsInit {
+    enabled: boolean;
+    initialCounters: ['dataReceived', 'dataSent'];
+    movingAverageIntervals: number[];
+    computeThrottleMaxQueueSize: number;
+    computeThrottleTimeout: number;
+}
+export declare class DefaultStats extends EventEmitter<StatsEvents> implements Stats {
+    private readonly enabled;
+    queue: Array<[string, number, number]>;
+    private stats;
+    private frequencyLastTime;
+    private frequencyAccumulators;
+    private movingAverages;
+    private timeout?;
+    private readonly computeThrottleMaxQueueSize;
+    private readonly computeThrottleTimeout;
+    private readonly movingAverageIntervals;
     /**
      * A queue based manager for stat processing
-     *
-     * @class
-     * @param {string[]} initialCounters
-     * @param {any} options
      */
-    constructor(initialCounters: string[], options: any);
-    _options: any;
-    _queue: any[];
-    /** @type {{ dataReceived: Big, dataSent: Big }} */
-    _stats: {
-        dataReceived: Big;
-        dataSent: Big;
-    };
-    _frequencyLastTime: number;
-    _frequencyAccumulators: {};
-    /** @type {{ dataReceived: IMovingAverage[], dataSent: IMovingAverage[] }} */
-    _movingAverages: {
-        dataReceived: IMovingAverage[];
-        dataSent: IMovingAverage[];
-    };
-    /**
-     * If there are items in the queue, they will will be processed and
-     * the frequency for all items will be updated based on the Timestamp
-     * of the last item in the queue. The `update` event will also be emitted
-     * with the latest stats.
-     *
-     * If there are no items in the queue, no action is taken.
-     *
-     * @private
-     * @returns {void}
-     */
-    private _update;
+    constructor(init: StatsInit);
     /**
      * Initializes the internal timer if there are items in the queue. This
      * should only need to be called if `Stats.stop` was previously called, as
-     * `Stats.push` will also start the processing.
-     *
-     * @returns {void}
+     * `Stats.push` will also start the processing
      */
     start(): void;
     /**
      * Stops processing and computing of stats by clearing the internal
-     * timer.
-     *
-     * @returns {void}
+     * timer
      */
     stop(): void;
-    _timeout: any;
     /**
      * Returns a clone of the current stats.
      */
-    get snapshot(): {
-        dataReceived: Big;
-        dataSent: Big;
-    };
+    getSnapshot(): TransferStats;
     /**
      * Returns a clone of the internal movingAverages
      */
-    get movingAverages(): {
-        dataReceived: IMovingAverage[];
-        dataSent: IMovingAverage[];
-    };
-    /**
-     * Returns a plain JSON object of the stats
-     *
-     * @returns {*}
-     */
-    toJSON(): any;
+    getMovingAverages(): MovingAverages;
     /**
      * Pushes the given operation data to the queue, along with the
      * current Timestamp, then resets the update timer.
-     *
-     * @param {string} counter
-     * @param {number} inc
-     * @returns {void}
      */
     push(counter: string, inc: number): void;
     /**
      * Resets the timeout for triggering updates.
-     *
-     * @private
-     * @returns {void}
      */
-    private _resetComputeTimeout;
+    _resetComputeTimeout(): void;
     /**
      * Calculates and returns the timeout for the next update based on
      * the urgency of the update.
+     */
+    _nextTimeout(): number;
+    /**
+     * If there are items in the queue, they will will be processed and
+     * the frequency for all items will be updated based on the Timestamp
+     * of the last item in the queue. The `update` event will also be emitted
+     * with the latest stats.
      *
-     * @private
-     * @returns {number}
+     * If there are no items in the queue, no action is taken.
      */
-    private _nextTimeout;
+    _update(): void;
     /**
      * For each key in the stats, the frequency and moving averages
      * will be updated via Stats._updateFrequencyFor based on the time
      * difference between calls to this method.
-     *
-     * @private
-     * @param {Timestamp} latestTime
-     * @returns {void}
      */
-    private _updateFrequency;
+    _updateFrequency(latestTime: number): void;
     /**
      * Updates the `movingAverages` for the given `key` and also
      * resets the `frequencyAccumulator` for the `key`.
-     *
-     * @private
-     * @param {string} key
-     * @param {number} timeDiffMS - Time in milliseconds
-     * @param {Timestamp} latestTime - Time in ticks
-     * @returns {void}
      */
-    private _updateFrequencyFor;
+    _updateFrequencyFor(key: 'dataReceived' | 'dataSent', timeDiffMS: number, latestTime: number): void;
     /**
      * For the given operation, `op`, the stats and `frequencyAccumulator`
      * will be updated or initialized if they don't already exist.
-     *
-     * @private
-     * @param {{string, number}[]} op
-     * @throws {InvalidNumber}
-     * @returns {void}
      */
-    private _applyOp;
-}
-declare namespace Stats {
-    export { IMovingAverage, Big };
+    _applyOp(op: [string, number, number]): void;
 }
-import { EventEmitter } from "events";
-type IMovingAverage = import('@vascosantos/moving-average').IMovingAverage;
-type Big = import('bignumber.js').BigNumber;
 //# sourceMappingURL=stats.d.ts.map

package/dist/src/metrics/stats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../../src/metrics/stats.js"],"names":[],"mappings":";AAQA;;;GAGG;AAEH;IACE;;;;;;OAMG;IACH,6BAHW,MAAM,EAAE,WACR,GAAG,EAkCb;IA7BC,cAAuB;IACvB,cAAgB;IAEhB,mDAAmD;IACnD;sBAD2B,GAAG;kBAAY,GAAG;MAI5C;IAED,2BAAoC;IACpC,2BAAgC;IAEhC,6EAA6E;IAC7E;sBAD2B,cAAc,EAAE;kBAAY,cAAc,EAAE;MAC9C;IAwH3B;;;;;;;;;;OAUG;IACH,gBAaC;IA9HD;;;;;;OAMG;IACH,SAFa,IAAI,CAMhB;IAED;;;;;OAKG;IACH,QAFa,IAAI,CAOhB;IAFG,cAAoB;IAIxB;;OAEG;IACH;sBAzD6B,GAAG;kBAAY,GAAG;MA2D9C;IAED;;OAEG;IACH;sBAvD6B,cAAc,EAAE;kBAAY,cAAc,EAAE;MAyDxE;IAED;;;;OAIG;IACH,cAkBC;IAED;;;;;;;OAOG;IACH,cAJW,MAAM,OACN,MAAM,GACJ,IAAI,CAKhB;IAED;;;;;OAKG;IACH,6BAEC;IAED;;;;;;OAMG;IACH,qBAKC;IA4BD;;;;;;;;OAQG;IACH,yBAQC;IAED;;;;;;;;;OASG;IACH,4BAsBC;IAED;;;;;;;;OAQG;IACH,iBAqBC;CACF;;;;;sBAlQY,OAAO,6BAA6B,EAAE,cAAc;WACpD,OAAO,cAAc,EAAE,SAAS"}
+{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../../src/metrics/stats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAIrE,OAAO,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAEtF,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,WAAW,CAAC,aAAa,CAAC,CAAA;CACrC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAA;IAC7C,sBAAsB,EAAE,MAAM,EAAE,CAAA;IAChC,2BAA2B,EAAE,MAAM,CAAA;IACnC,sBAAsB,EAAE,MAAM,CAAA;CAC/B;AAED,qBAAa,YAAa,SAAQ,YAAY,CAAC,WAAW,CAAE,YAAW,KAAK;IAC1E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAC1B,KAAK,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAC7C,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,iBAAiB,CAAQ;IACjC,OAAO,CAAC,qBAAqB,CAAwB;IACrD,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,OAAO,CAAC,CAAK;IACrB,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAQ;IACpD,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAQ;IAC/C,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAU;IAEjD;;OAEG;gBACU,IAAI,EAAE,SAAS;IAmC5B;;;;OAIG;IACH,KAAK;IAUL;;;OAGG;IACH,IAAI;IAOJ;;OAEG;IACH,WAAW;IAIX;;OAEG;IACH,iBAAiB,IAAK,cAAc;IAIpC;;;OAGG;IACH,IAAI,CAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKlC;;OAEG;IACH,oBAAoB;IAIpB;;;OAGG;IACH,YAAY;IAOZ;;;;;;;OAOG;IACH,OAAO;IAqBP;;;;OAIG;IACH,gBAAgB,CAAE,UAAU,EAAE,MAAM;IASpC;;;OAGG;IACH,mBAAmB,CAAE,GAAG,EAAE,cAAc,GAAG,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAwB7F;;;OAGG;IACH,QAAQ,CAAE,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;CA2BvC"}

package/dist/src/metrics/stats.js

@@ -0,0 +1,183 @@
+import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events';
+import { createMovingAverage } from './moving-average.js';
+// @ts-expect-error no types
+import retimer from 'retimer';
+export class DefaultStats extends EventEmitter {
+    /**
+     * A queue based manager for stat processing
+     */
+    constructor(init) {
+        super();
+        this.enabled = init.enabled;
+        this.queue = [];
+        this.stats = {
+            dataReceived: 0n,
+            dataSent: 0n
+        };
+        this.frequencyLastTime = Date.now();
+        this.frequencyAccumulators = {};
+        this.movingAverages = {
+            dataReceived: [],
+            dataSent: []
+        };
+        this.computeThrottleMaxQueueSize = init.computeThrottleMaxQueueSize;
+        this.computeThrottleTimeout = init.computeThrottleTimeout;
+        this._update = this._update.bind(this);
+        this.movingAverageIntervals = init.movingAverageIntervals;
+        for (let i = 0; i < init.initialCounters.length; i++) {
+            const key = init.initialCounters[i];
+            this.stats[key] = 0n;
+            this.movingAverages[key] = [];
+            for (let k = 0; k < this.movingAverageIntervals.length; k++) {
+                const interval = this.movingAverageIntervals[k];
+                const ma = this.movingAverages[key][interval] = createMovingAverage(interval);
+                ma.push(this.frequencyLastTime, 0);
+            }
+        }
+    }
+    /**
+     * Initializes the internal timer if there are items in the queue. This
+     * should only need to be called if `Stats.stop` was previously called, as
+     * `Stats.push` will also start the processing
+     */
+    start() {
+        if (!this.enabled) {
+            return;
+        }
+        if (this.queue.length > 0) {
+            this._resetComputeTimeout();
+        }
+    }
+    /**
+     * Stops processing and computing of stats by clearing the internal
+     * timer
+     */
+    stop() {
+        if (this.timeout != null) {
+            this.timeout.clear();
+            this.timeout = null;
+        }
+    }
+    /**
+     * Returns a clone of the current stats.
+     */
+    getSnapshot() {
+        return Object.assign({}, this.stats);
+    }
+    /**
+     * Returns a clone of the internal movingAverages
+     */
+    getMovingAverages() {
+        return Object.assign({}, this.movingAverages);
+    }
+    /**
+     * Pushes the given operation data to the queue, along with the
+     * current Timestamp, then resets the update timer.
+     */
+    push(counter, inc) {
+        this.queue.push([counter, inc, Date.now()]);
+        this._resetComputeTimeout();
+    }
+    /**
+     * Resets the timeout for triggering updates.
+     */
+    _resetComputeTimeout() {
+        this.timeout = retimer(this._update, this._nextTimeout());
+    }
+    /**
+     * Calculates and returns the timeout for the next update based on
+     * the urgency of the update.
+     */
+    _nextTimeout() {
+        // calculate the need for an update, depending on the queue length
+        const urgency = this.queue.length / this.computeThrottleMaxQueueSize;
+        const timeout = Math.max(this.computeThrottleTimeout * (1 - urgency), 0);
+        return timeout;
+    }
+    /**
+     * If there are items in the queue, they will will be processed and
+     * the frequency for all items will be updated based on the Timestamp
+     * of the last item in the queue. The `update` event will also be emitted
+     * with the latest stats.
+     *
+     * If there are no items in the queue, no action is taken.
+     */
+    _update() {
+        this.timeout = null;
+        if (this.queue.length > 0) {
+            let last = ['', 0, 0];
+            for (last of this.queue) {
+                this._applyOp(last);
+            }
+            this.queue = [];
+            if (last.length > 2 && last[0] !== '') {
+                this._updateFrequency(last[2]); // contains timestamp of last op
+            }
+            this.dispatchEvent(new CustomEvent('update', {
+                detail: this.stats
+            }));
+        }
+    }
+    /**
+     * For each key in the stats, the frequency and moving averages
+     * will be updated via Stats._updateFrequencyFor based on the time
+     * difference between calls to this method.
+     */
+    _updateFrequency(latestTime) {
+        const timeDiff = latestTime - this.frequencyLastTime;
+        this._updateFrequencyFor('dataReceived', timeDiff, latestTime);
+        this._updateFrequencyFor('dataSent', timeDiff, latestTime);
+        this.frequencyLastTime = latestTime;
+    }
+    /**
+     * Updates the `movingAverages` for the given `key` and also
+     * resets the `frequencyAccumulator` for the `key`.
+     */
+    _updateFrequencyFor(key, timeDiffMS, latestTime) {
+        const count = this.frequencyAccumulators[key] ?? 0;
+        this.frequencyAccumulators[key] = 0;
+        // if `timeDiff` is zero, `hz` becomes Infinity, so we fallback to 1ms
+        const safeTimeDiff = timeDiffMS ?? 1;
+        const hz = (count / safeTimeDiff) * 1000;
+        let movingAverages = this.movingAverages[key];
+        if (movingAverages == null) {
+            movingAverages = this.movingAverages[key] = [];
+        }
+        const intervals = this.movingAverageIntervals;
+        for (let i = 0; i < intervals.length; i++) {
+            const movingAverageInterval = intervals[i];
+            let movingAverage = movingAverages[movingAverageInterval];
+            if (movingAverage == null) {
+                movingAverage = movingAverages[movingAverageInterval] = createMovingAverage(movingAverageInterval);
+            }
+            movingAverage.push(latestTime, hz);
+        }
+    }
+    /**
+     * For the given operation, `op`, the stats and `frequencyAccumulator`
+     * will be updated or initialized if they don't already exist.
+     */
+    _applyOp(op) {
+        const key = op[0];
+        const inc = op[1];
+        if (typeof inc !== 'number') {
+            throw new Error('invalid increment number');
+        }
+        let n;
+        if (!Object.prototype.hasOwnProperty.call(this.stats, key)) {
+            // @ts-expect-error cannot index type with key
+            n = this.stats[key] = 0n;
+        }
+        else {
+            // @ts-expect-error cannot index type with key
+            n = this.stats[key];
+        }
+        // @ts-expect-error cannot index type with key
+        this.stats[key] = n + BigInt(inc);
+        if (this.frequencyAccumulators[key] == null) {
+            this.frequencyAccumulators[key] = 0;
+        }
+        this.frequencyAccumulators[key] += inc;
+    }
+}
+//# sourceMappingURL=stats.js.map

package/dist/src/metrics/stats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stats.js","sourceRoot":"","sources":["../../../src/metrics/stats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACzD,4BAA4B;AAC5B,OAAO,OAAO,MAAM,SAAS,CAAA;AAe7B,MAAM,OAAO,YAAa,SAAQ,YAAyB;IAYzD;;OAEG;IACH,YAAa,IAAe;QAC1B,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,CAAC,KAAK,GAAG;YACX,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,EAAE;SACb,CAAA;QACD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACnC,IAAI,CAAC,qBAAqB,GAAG,EAAE,CAAA;QAC/B,IAAI,CAAC,cAAc,GAAG;YACpB,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,EAAE;SACb,CAAA;QACD,IAAI,CAAC,2BAA2B,GAAG,IAAI,CAAC,2BAA2B,CAAA;QACnE,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAA;QAEzD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEtC,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAA;QAEzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACpD,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;YACnC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;YACpB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;YAE7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAA;gBAC/C,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAA;gBAC7E,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAA;aACnC;SACF;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAM;SACP;QAED,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,IAAI,CAAC,oBAAoB,EAAE,CAAA;SAC5B;IACH,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,EAAE;YACxB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;YACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;SACpB;IACH,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACtC,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAA;IAC/C,CAAC;IAED;;;OAGG;IACH,IAAI,CAAE,OAAe,EAAE,GAAW;QAChC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;QAC3C,IAAI,CAAC,oBAAoB,EAAE,CAAA;IAC7B,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAA;IAC3D,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,kEAAkE;QAClE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,2BAA2B,CAAA;QACpE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;QACxE,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,IAAI,IAAI,GAA6B,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;YAE/C,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;gBACvB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;aACpB;YAED,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;YAEf,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE;gBACrC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,gCAAgC;aAChE;YAED,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAgB,QAAQ,EAAE;gBAC1D,MAAM,EAAE,IAAI,CAAC,KAAK;aACnB,CAAC,CAAC,CAAA;SACJ;IACH,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAE,UAAkB;QAClC,MAAM,QAAQ,GAAG,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAA;QAEpD,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAA;QAC9D,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAA;QAE1D,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAA;IACrC,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAE,GAAgC,EAAE,UAAkB,EAAE,UAAkB;QAC3F,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAClD,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACnC,sEAAsE;QACtE,MAAM,YAAY,GAAG,UAAU,IAAI,CAAC,CAAA;QACpC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,YAAY,CAAC,GAAG,IAAI,CAAA;QAExC,IAAI,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;QAC7C,IAAI,cAAc,IAAI,IAAI,EAAE;YAC1B,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;SAC/C;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAA;QAE7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACzC,MAAM,qBAAqB,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;YAC1C,IAAI,aAAa,GAAG,cAAc,CAAC,qBAAqB,CAAC,CAAA;YACzD,IAAI,aAAa,IAAI,IAAI,EAAE;gBACzB,aAAa,GAAG,cAAc,CAAC,qBAAqB,CAAC,GAAG,mBAAmB,CAAC,qBAAqB,CAAC,CAAA;aACnG;YACD,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;SACnC;IACH,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAE,EAA4B;QACpC,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,CAAA;QACjB,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,CAAA;QAEjB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;SAC5C;QAED,IAAI,CAAS,CAAA;QAEb,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE;YAC1D,8CAA8C;YAC9C,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;SACzB;aAAM;YACL,8CAA8C;YAC9C,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;SACpB;QAED,8CAA8C;QAC9C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;QAEjC,IAAI,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE;YAC3C,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;SACpC;QAED,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAA;IACxC,CAAC;CACF"}

package/dist/src/nat-manager.d.ts

@@ -1,121 +1,64 @@
-export = NatManager;
-declare class NatManager {
+import { NatAPI } from '@achingbrain/nat-port-mapper';
+import type { Startable } from '@libp2p/interfaces/startable';
+import type { Components } from '@libp2p/interfaces/components';
+export interface PMPOptions {
     /**
-     * @class
-     * @param {NatManagerProperties & NatManagerOptions} options
+     * Whether to enable PMP as well as UPnP
      */
-    constructor({ peerId, addressManager, transportManager, ...options }: NatManagerProperties & NatManagerOptions);
-    _peerId: import("peer-id");
-    _addressManager: import("./address-manager");
-    _transportManager: import("./transport-manager");
-    _enabled: boolean;
-    _externalIp: string | undefined;
-    _options: {
-        description: string;
-        ttl: number;
-        autoUpdate: true;
-        gateway: string | undefined;
-        enablePMP: boolean;
-    };
-    /**
-     * Starts the NAT manager
-     */
-    start(): void;
-    _start(): Promise<void>;
-    _getClient(): {
-        /**
-         * @param  {...any} args
-         * @returns {Promise<void>}
-         */
-        map: (...args: any[]) => Promise<void>;
-        /**
-         * @param  {...any} args
-         * @returns {Promise<void>}
-         */
-        destroy: (...args: any[]) => Promise<void>;
-        /**
-         * @param  {...any} args
-         * @returns {Promise<string>}
-         */
-        externalIp: (...args: any[]) => Promise<string>;
-    };
-    _client: {
-        /**
-         * @param  {...any} args
-         * @returns {Promise<void>}
-         */
-        map: (...args: any[]) => Promise<void>;
-        /**
-         * @param  {...any} args
-         * @returns {Promise<void>}
-         */
-        destroy: (...args: any[]) => Promise<void>;
-        /**
-         * @param  {...any} args
-         * @returns {Promise<string>}
-         */
-        externalIp: (...args: any[]) => Promise<string>;
-    } | null | undefined;
-    /**
-     * Stops the NAT manager
-     *
-     * @async
-     */
-    stop(): Promise<void>;
+    enabled?: boolean;
 }
-declare namespace NatManager {
-    export { PeerId, TransportManager, AddressManager, NatManagerProperties, NatManagerOptions };
-}
-type NatManagerProperties = {
+export interface NatManagerInit {
     /**
-     * - The peer ID of the current node
+     * Whether to enable the NAT manager
      */
-    peerId: PeerId;
-    /**
-     * - A transport manager
-     */
-    transportManager: TransportManager;
+    enabled: boolean;
     /**
-     * - An address manager
+     * Pass a value to use instead of auto-detection
      */
-    addressManager: AddressManager;
-};
-type NatManagerOptions = {
+    externalAddress?: string;
     /**
-     * - Whether to enable the NAT manager
+     * Pass a value to use instead of auto-detection
      */
-    enabled: boolean;
+    localAddress?: string;
     /**
-     * - Pass a value to use instead of auto-detection
+     * A string value to use for the port mapping description on the gateway
      */
-    externalIp?: string | undefined;
+    description?: string;
     /**
-     * - A string value to use for the port mapping description on the gateway
+     * How long UPnP port mappings should last for in seconds (minimum 1200)
      */
-    description?: string | undefined;
+    ttl?: number;
     /**
-     * - How long UPnP port mappings should last for in seconds (minimum 1200)
+     * Whether to automatically refresh UPnP port mappings when their TTL is reached
      */
-    ttl?: number | undefined;
+    keepAlive: boolean;
     /**
-     * - Whether to automatically refresh UPnP port mappings when their TTL is reached
+     * Pass a value to use instead of auto-detection
      */
-    keepAlive?: boolean | undefined;
+    gateway?: string;
+}
+export declare class NatManager implements Startable {
+    private readonly components;
+    private readonly enabled;
+    private readonly externalAddress?;
+    private readonly localAddress?;
+    private readonly description;
+    private readonly ttl;
+    private readonly keepAlive;
+    private readonly gateway?;
+    private started;
+    private client?;
+    constructor(components: Components, init: NatManagerInit);
+    isStarted(): boolean;
     /**
-     * - Pass a value to use instead of auto-detection
+     * Starts the NAT manager
      */
-    gateway?: string | undefined;
+    start(): void;
+    _start(): Promise<void>;
+    _getClient(): Promise<NatAPI>;
     /**
-     * - PMP options
+     * Stops the NAT manager
      */
-    pmp?: {
-        /**
-         * - Whether to enable PMP as well as UPnP
-         */
-        enabled?: boolean | undefined;
-    } | undefined;
-};
-type PeerId = import('peer-id');
-type TransportManager = import('./transport-manager');
-type AddressManager = import('./address-manager');
+    stop(): Promise<void>;
+}
 //# sourceMappingURL=nat-manager.d.ts.map

package/dist/src/nat-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nat-manager.d.ts","sourceRoot":"","sources":["../../src/nat-manager.js"],"names":[],"mappings":";AAiDA;IACE;;;OAGG;IACH,sEAFW,oBAAoB,GAAG,iBAAiB,EAoBlD;IAjBC,2BAAqB;IACrB,6CAAqC;IACrC,iDAAyC;IAEzC,kBAA+B;IAC/B,gCAAqC;IACrC;;;;;;MAMC;IAOH;;OAEG;IACH,cAUC;IAED,wBAgDC;IAED;QAgBI;;;WAGG;uBAFY,GAAG,OACL,QAAQ,IAAI,CAAC;QAI1B;;;WAGG;2BAFY,GAAG,OACL,QAAQ,IAAI,CAAC;QAI1B;;;WAGG;8BAFY,GAAG,OACL,QAAQ,MAAM,CAAC;MAM/B;IArBC;QACE;;;WAGG;uBAFY,GAAG,OACL,QAAQ,IAAI,CAAC;QAI1B;;;WAGG;2BAFY,GAAG,OACL,QAAQ,IAAI,CAAC;QAI1B;;;WAGG;8BAFY,GAAG,OACL,QAAQ,MAAM,CAAC;yBAG7B;IAKH;;;;OAIG;IACH,sBAWC;CACF;;;;;;;;YApKa,MAAM;;;;sBACN,gBAAgB;;;;oBAChB,cAAc;;;;;;aAGd,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAZR,OAAO,SAAS,CAAC;wBACjB,OAAO,qBAAqB,CAAC;sBAC7B,OAAO,mBAAmB,CAAC"}
+{"version":3,"file":"nat-manager.d.ts","sourceRoot":"","sources":["../../src/nat-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,MAAM,EAAE,MAAM,8BAA8B,CAAA;AAS9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAS/D,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,SAAS,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,qBAAa,UAAW,YAAW,SAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAQ;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAQ;IACjC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,MAAM,CAAC,CAAQ;gBAEV,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,cAAc;IAiBzD,SAAS;IAIT;;OAEG;IACH,KAAK;IAcC,MAAM;IAkDN,UAAU;IAehB;;OAEG;IACG,IAAI;CAYX"}

package/dist/src/nat-manager.js

@@ -0,0 +1,114 @@
+import { upnpNat } from '@achingbrain/nat-port-mapper';
+import { logger } from '@libp2p/logger';
+import { Multiaddr } from '@multiformats/multiaddr';
+import { isBrowser } from 'wherearewe';
+import isPrivateIp from 'private-ip';
+import * as pkg from './version.js';
+import errCode from 'err-code';
+import { codes } from './errors.js';
+import { isLoopback } from '@libp2p/utils/multiaddr/is-loopback';
+const log = logger('libp2p:nat');
+const DEFAULT_TTL = 7200;
+function highPort(min = 1024, max = 65535) {
+    return Math.floor(Math.random() * (max - min + 1) + min);
+}
+export class NatManager {
+    constructor(components, init) {
+        this.components = components;
+        this.started = false;
+        this.enabled = init.enabled;
+        this.externalAddress = init.externalAddress;
+        this.localAddress = init.localAddress;
+        this.description = init.description ?? `${pkg.name}@${pkg.version} ${this.components.getPeerId().toString()}`;
+        this.ttl = init.ttl ?? DEFAULT_TTL;
+        this.keepAlive = init.keepAlive ?? true;
+        this.gateway = init.gateway;
+        if (this.ttl < DEFAULT_TTL) {
+            throw errCode(new Error(`NatManager ttl should be at least ${DEFAULT_TTL} seconds`), codes.ERR_INVALID_PARAMETERS);
+        }
+    }
+    isStarted() {
+        return this.started;
+    }
+    /**
+     * Starts the NAT manager
+     */
+    start() {
+        if (isBrowser || !this.enabled || this.started) {
+            return;
+        }
+        this.started = true;
+        // done async to not slow down startup
+        this._start().catch((err) => {
+            // hole punching errors are non-fatal
+            log.error(err);
+        });
+    }
+    async _start() {
+        const addrs = this.components.getTransportManager().getAddrs();
+        for (const addr of addrs) {
+            // try to open uPnP ports for each thin waist address
+            const { family, host, port, transport } = addr.toOptions();
+            if (!addr.isThinWaistAddress() || transport !== 'tcp') {
+                // only bare tcp addresses
+                // eslint-disable-next-line no-continue
+                continue;
+            }
+            if (isLoopback(addr)) {
+                // eslint-disable-next-line no-continue
+                continue;
+            }
+            if (family !== 4) {
+                // ignore ipv6
+                // eslint-disable-next-line no-continue
+                continue;
+            }
+            const client = await this._getClient();
+            const publicIp = this.externalAddress ?? await client.externalIp();
+            if (isPrivateIp(publicIp)) {
+                throw new Error(`${publicIp} is private - please set config.nat.externalIp to an externally routable IP or ensure you are not behind a double NAT`);
+            }
+            const publicPort = highPort();
+            log(`opening uPnP connection from ${publicIp}:${publicPort} to ${host}:${port}`);
+            await client.map({
+                publicPort,
+                localPort: port,
+                localAddress: this.localAddress,
+                protocol: transport.toUpperCase() === 'TCP' ? 'TCP' : 'UDP'
+            });
+            this.components.getAddressManager().addObservedAddr(Multiaddr.fromNodeAddress({
+                family: 4,
+                address: publicIp,
+                port: publicPort
+            }, transport));
+        }
+    }
+    async _getClient() {
+        if (this.client != null) {
+            return this.client;
+        }
+        this.client = await upnpNat({
+            description: this.description,
+            ttl: this.ttl,
+            keepAlive: this.keepAlive,
+            gateway: this.gateway
+        });
+        return this.client;
+    }
+    /**
+     * Stops the NAT manager
+     */
+    async stop() {
+        if (isBrowser || this.client == null) {
+            return;
+        }
+        try {
+            await this.client.close();
+            this.client = undefined;
+        }
+        catch (err) {
+            log.error(err);
+        }
+    }
+}
+//# sourceMappingURL=nat-manager.js.map