@libp2p/utils 5.2.0-ee7ffe9b9 → 5.2.1-8bbd43628

package/dist/src/rate-limiter.d.ts

@@ -0,0 +1,86 @@
+export interface RateLimiterInit {
+    /**
+     * Number of points
+     *
+     * @default 4
+     */
+    points?: number;
+    /**
+     * Per seconds
+     *
+     * @default 1
+     */
+    duration?: number;
+    /**
+     * Block if consumed more than points in current duration for blockDuration seconds
+     *
+     * @default 0
+     */
+    blockDuration?: number;
+    /**
+     * Execute allowed actions evenly over duration
+     *
+     * @default false
+     */
+    execEvenly?: boolean;
+    /**
+     * ms, works with execEvenly=true option
+     *
+     * @default duration * 1000 / points
+     */
+    execEvenlyMinDelayMs?: number;
+    /**
+     * @default rlflx
+     */
+    keyPrefix?: string;
+}
+export interface GetKeySecDurationOptions {
+    customDuration?: number;
+}
+export interface RateLimiterResult {
+    remainingPoints: number;
+    msBeforeNext: number;
+    consumedPoints: number;
+    isFirstInDuration: boolean;
+}
+export interface RateRecord {
+    value: number;
+    expiresAt?: Date;
+    timeoutId?: ReturnType<typeof setTimeout>;
+}
+export declare class RateLimiter {
+    readonly memoryStorage: MemoryStorage;
+    protected points: number;
+    protected duration: number;
+    protected blockDuration: number;
+    protected execEvenly: boolean;
+    protected execEvenlyMinDelayMs: number;
+    protected keyPrefix: string;
+    constructor(opts?: RateLimiterInit);
+    consume(key: string, pointsToConsume?: number, options?: GetKeySecDurationOptions): Promise<RateLimiterResult>;
+    penalty(key: string, points?: number, options?: GetKeySecDurationOptions): RateLimiterResult;
+    reward(key: string, points?: number, options?: GetKeySecDurationOptions): RateLimiterResult;
+    /**
+     * Block any key for secDuration seconds
+     *
+     * @param key
+     * @param secDuration
+     */
+    block(key: string, secDuration: number): RateLimiterResult;
+    set(key: string, points: number, secDuration?: number): RateLimiterResult;
+    get(key: string): RateLimiterResult | undefined;
+    delete(key: string): void;
+    private _getKeySecDuration;
+    getKey(key: string): string;
+    parseKey(rlKey: string): string;
+}
+declare class MemoryStorage {
+    readonly storage: Map<string, RateRecord>;
+    constructor();
+    incrby(key: string, value: number, durationSec: number): RateLimiterResult;
+    set(key: string, value: number, durationSec: number): RateLimiterResult;
+    get(key: string): RateLimiterResult | undefined;
+    delete(key: string): boolean;
+}
+export {};
+//# sourceMappingURL=rate-limiter.d.ts.map

package/dist/src/rate-limiter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter.d.ts","sourceRoot":"","sources":["../../src/rate-limiter.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,cAAc,EAAE,MAAM,CAAA;IACtB,iBAAiB,EAAE,OAAO,CAAA;CAC3B;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;CAC1C;AAED,qBAAa,WAAW;IACtB,SAAgB,aAAa,EAAE,aAAa,CAAA;IAC5C,SAAS,CAAC,MAAM,EAAE,MAAM,CAAA;IACxB,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAA;IAC1B,SAAS,CAAC,aAAa,EAAE,MAAM,CAAA;IAC/B,SAAS,CAAC,UAAU,EAAE,OAAO,CAAA;IAC7B,SAAS,CAAC,oBAAoB,EAAE,MAAM,CAAA;IACtC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAA;gBAEd,IAAI,GAAE,eAAoB;IAUjC,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,eAAe,GAAE,MAAU,EAAE,OAAO,GAAE,wBAA6B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA2B5H,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,MAAU,EAAE,OAAO,GAAE,wBAA6B,GAAG,iBAAiB;IASpG,MAAM,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,MAAU,EAAE,OAAO,GAAE,wBAA6B,GAAG,iBAAiB;IASnG;;;;;OAKG;IACH,KAAK,CAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,iBAAiB;IAc3D,GAAG,CAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAE,MAAU,GAAG,iBAAiB;IAa7E,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAUhD,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAI1B,OAAO,CAAC,kBAAkB;IAQ1B,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAI5B,QAAQ,CAAE,KAAK,EAAE,MAAM,GAAG,MAAM;CAGjC;AAED,cAAM,aAAa;IACjB,SAAgB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;;IAMhD,MAAM,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,iBAAiB;IA0B3E,GAAG,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,iBAAiB;IAiCxE,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAgBhD,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO;CAc9B"}

package/dist/src/rate-limiter.js

@@ -0,0 +1,184 @@
+import { CodeError } from '@libp2p/interface';
+import delay from 'delay';
+export class RateLimiter {
+    memoryStorage;
+    points;
+    duration;
+    blockDuration;
+    execEvenly;
+    execEvenlyMinDelayMs;
+    keyPrefix;
+    constructor(opts = {}) {
+        this.points = opts.points ?? 4;
+        this.duration = opts.duration ?? 1;
+        this.blockDuration = opts.blockDuration ?? 0;
+        this.execEvenly = opts.execEvenly ?? false;
+        this.execEvenlyMinDelayMs = opts.execEvenlyMinDelayMs ?? (this.duration * 1000 / this.points);
+        this.keyPrefix = opts.keyPrefix ?? 'rlflx';
+        this.memoryStorage = new MemoryStorage();
+    }
+    async consume(key, pointsToConsume = 1, options = {}) {
+        const rlKey = this.getKey(key);
+        const secDuration = this._getKeySecDuration(options);
+        let res = this.memoryStorage.incrby(rlKey, pointsToConsume, secDuration);
+        res.remainingPoints = Math.max(this.points - res.consumedPoints, 0);
+        if (res.consumedPoints > this.points) {
+            // Block only first time when consumed more than points
+            if (this.blockDuration > 0 && res.consumedPoints <= (this.points + pointsToConsume)) {
+                // Block key
+                res = this.memoryStorage.set(rlKey, res.consumedPoints, this.blockDuration);
+            }
+            throw new CodeError('Rate limit exceeded', 'ERR_RATE_LIMIT_EXCEEDED', res);
+        }
+        else if (this.execEvenly && res.msBeforeNext > 0 && !res.isFirstInDuration) {
+            // Execute evenly
+            let delayMs = Math.ceil(res.msBeforeNext / (res.remainingPoints + 2));
+            if (delayMs < this.execEvenlyMinDelayMs) {
+                delayMs = res.consumedPoints * this.execEvenlyMinDelayMs;
+            }
+            await delay(delayMs);
+        }
+        return res;
+    }
+    penalty(key, points = 1, options = {}) {
+        const rlKey = this.getKey(key);
+        const secDuration = this._getKeySecDuration(options);
+        const res = this.memoryStorage.incrby(rlKey, points, secDuration);
+        res.remainingPoints = Math.max(this.points - res.consumedPoints, 0);
+        return res;
+    }
+    reward(key, points = 1, options = {}) {
+        const rlKey = this.getKey(key);
+        const secDuration = this._getKeySecDuration(options);
+        const res = this.memoryStorage.incrby(rlKey, -points, secDuration);
+        res.remainingPoints = Math.max(this.points - res.consumedPoints, 0);
+        return res;
+    }
+    /**
+     * Block any key for secDuration seconds
+     *
+     * @param key
+     * @param secDuration
+     */
+    block(key, secDuration) {
+        const msDuration = secDuration * 1000;
+        const initPoints = this.points + 1;
+        this.memoryStorage.set(this.getKey(key), initPoints, secDuration);
+        return {
+            remainingPoints: 0,
+            msBeforeNext: msDuration === 0 ? -1 : msDuration,
+            consumedPoints: initPoints,
+            isFirstInDuration: false
+        };
+    }
+    set(key, points, secDuration = 0) {
+        const msDuration = (secDuration >= 0 ? secDuration : this.duration) * 1000;
+        this.memoryStorage.set(this.getKey(key), points, secDuration);
+        return {
+            remainingPoints: 0,
+            msBeforeNext: msDuration === 0 ? -1 : msDuration,
+            consumedPoints: points,
+            isFirstInDuration: false
+        };
+    }
+    get(key) {
+        const res = this.memoryStorage.get(this.getKey(key));
+        if (res != null) {
+            res.remainingPoints = Math.max(this.points - res.consumedPoints, 0);
+        }
+        return res;
+    }
+    delete(key) {
+        this.memoryStorage.delete(this.getKey(key));
+    }
+    _getKeySecDuration(options) {
+        if (options?.customDuration != null && options.customDuration >= 0) {
+            return options.customDuration;
+        }
+        return this.duration;
+    }
+    getKey(key) {
+        return this.keyPrefix.length > 0 ? `${this.keyPrefix}:${key}` : key;
+    }
+    parseKey(rlKey) {
+        return rlKey.substring(this.keyPrefix.length);
+    }
+}
+class MemoryStorage {
+    storage;
+    constructor() {
+        this.storage = new Map();
+    }
+    incrby(key, value, durationSec) {
+        const existing = this.storage.get(key);
+        if (existing != null) {
+            const msBeforeExpires = existing.expiresAt != null
+                ? existing.expiresAt.getTime() - new Date().getTime()
+                : -1;
+            if (existing.expiresAt == null || msBeforeExpires > 0) {
+                // Change value
+                existing.value += value;
+                return {
+                    remainingPoints: 0,
+                    msBeforeNext: msBeforeExpires,
+                    consumedPoints: existing.value,
+                    isFirstInDuration: false
+                };
+            }
+            return this.set(key, value, durationSec);
+        }
+        return this.set(key, value, durationSec);
+    }
+    set(key, value, durationSec) {
+        const durationMs = durationSec * 1000;
+        const existing = this.storage.get(key);
+        if (existing != null) {
+            clearTimeout(existing.timeoutId);
+        }
+        const record = {
+            value,
+            expiresAt: durationMs > 0 ? new Date(Date.now() + durationMs) : undefined
+        };
+        this.storage.set(key, record);
+        if (durationMs > 0) {
+            record.timeoutId = setTimeout(() => {
+                this.storage.delete(key);
+            }, durationMs);
+            if (record.timeoutId.unref != null) {
+                record.timeoutId.unref();
+            }
+        }
+        return {
+            remainingPoints: 0,
+            msBeforeNext: durationMs === 0 ? -1 : durationMs,
+            consumedPoints: record.value,
+            isFirstInDuration: true
+        };
+    }
+    get(key) {
+        const existing = this.storage.get(key);
+        if (existing != null) {
+            const msBeforeExpires = existing.expiresAt != null
+                ? existing.expiresAt.getTime() - new Date().getTime()
+                : -1;
+            return {
+                remainingPoints: 0,
+                msBeforeNext: msBeforeExpires,
+                consumedPoints: existing.value,
+                isFirstInDuration: false
+            };
+        }
+    }
+    delete(key) {
+        const record = this.storage.get(key);
+        if (record != null) {
+            if (record.timeoutId != null) {
+                clearTimeout(record.timeoutId);
+            }
+            this.storage.delete(key);
+            return true;
+        }
+        return false;
+    }
+}
+//# sourceMappingURL=rate-limiter.js.map

package/dist/src/rate-limiter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter.js","sourceRoot":"","sources":["../../src/rate-limiter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAA;AA6DzB,MAAM,OAAO,WAAW;IACN,aAAa,CAAe;IAClC,MAAM,CAAQ;IACd,QAAQ,CAAQ;IAChB,aAAa,CAAQ;IACrB,UAAU,CAAS;IACnB,oBAAoB,CAAQ;IAC5B,SAAS,CAAQ;IAE3B,YAAa,OAAwB,EAAE;QACrC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAA;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAA;QAClC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,IAAI,CAAC,CAAA;QAC5C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,KAAK,CAAA;QAC1C,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAA;QAC7F,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,OAAO,CAAA;QAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,EAAE,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,OAAO,CAAE,GAAW,EAAE,kBAA0B,CAAC,EAAE,UAAoC,EAAE;QAC7F,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC9B,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACpD,IAAI,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,eAAe,EAAE,WAAW,CAAC,CAAA;QACxE,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAA;QAEnE,IAAI,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YACrC,uDAAuD;YACvD,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,GAAG,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,EAAE,CAAC;gBACpF,YAAY;gBACZ,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,CAAA;YAC7E,CAAC;YAED,MAAM,IAAI,SAAS,CAAC,qBAAqB,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAA;QAC5E,CAAC;aAAM,IAAI,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC;YAC7E,iBAAiB;YACjB,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,GAAG,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC,CAAA;YACrE,IAAI,OAAO,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBACxC,OAAO,GAAG,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAA;YAC1D,CAAC;YAED,MAAM,KAAK,CAAC,OAAO,CAAC,CAAA;QACtB,CAAC;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,OAAO,CAAE,GAAW,EAAE,SAAiB,CAAC,EAAE,UAAoC,EAAE;QAC9E,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC9B,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,CAAA;QACjE,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAA;QAEnE,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,MAAM,CAAE,GAAW,EAAE,SAAiB,CAAC,EAAE,UAAoC,EAAE;QAC7E,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC9B,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QAClE,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAA;QAEnE,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAE,GAAW,EAAE,WAAmB;QACrC,MAAM,UAAU,GAAG,WAAW,GAAG,IAAI,CAAA;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAA;QAElC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,WAAW,CAAC,CAAA;QAEjE,OAAO;YACL,eAAe,EAAE,CAAC;YAClB,YAAY,EAAE,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU;YAChD,cAAc,EAAE,UAAU;YAC1B,iBAAiB,EAAE,KAAK;SACzB,CAAA;IACH,CAAC;IAED,GAAG,CAAE,GAAW,EAAE,MAAc,EAAE,cAAsB,CAAC;QACvD,MAAM,UAAU,GAAG,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAA;QAE1E,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,CAAA;QAE7D,OAAO;YACL,eAAe,EAAE,CAAC;YAClB,YAAY,EAAE,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU;YAChD,cAAc,EAAE,MAAM;YACtB,iBAAiB,EAAE,KAAK;SACzB,CAAA;IACH,CAAC;IAED,GAAG,CAAE,GAAW;QACd,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;QAEpD,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YAChB,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAA;QACrE,CAAC;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7C,CAAC;IAEO,kBAAkB,CAAE,OAAkC;QAC5D,IAAI,OAAO,EAAE,cAAc,IAAI,IAAI,IAAI,OAAO,CAAC,cAAc,IAAI,CAAC,EAAE,CAAC;YACnE,OAAO,OAAO,CAAC,cAAc,CAAA;QAC/B,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;IACrE,CAAC;IAED,QAAQ,CAAE,KAAa;QACrB,OAAO,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC/C,CAAC;CACF;AAED,MAAM,aAAa;IACD,OAAO,CAAyB;IAEhD;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAA;IAC1B,CAAC;IAED,MAAM,CAAE,GAAW,EAAE,KAAa,EAAE,WAAmB;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEtC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,eAAe,GAAG,QAAQ,CAAC,SAAS,IAAI,IAAI;gBAChD,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;gBACrD,CAAC,CAAC,CAAC,CAAC,CAAA;YAEN,IAAI,QAAQ,CAAC,SAAS,IAAI,IAAI,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;gBACtD,eAAe;gBACf,QAAQ,CAAC,KAAK,IAAI,KAAK,CAAA;gBAEvB,OAAO;oBACL,eAAe,EAAE,CAAC;oBAClB,YAAY,EAAE,eAAe;oBAC7B,cAAc,EAAE,QAAQ,CAAC,KAAK;oBAC9B,iBAAiB,EAAE,KAAK;iBACzB,CAAA;YACH,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAA;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAA;IAC1C,CAAC;IAED,GAAG,CAAE,GAAW,EAAE,KAAa,EAAE,WAAmB;QAClD,MAAM,UAAU,GAAG,WAAW,GAAG,IAAI,CAAA;QACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEtC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAClC,CAAC;QAED,MAAM,MAAM,GAAe;YACzB,KAAK;YACL,SAAS,EAAE,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;SAC1E,CAAA;QAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;QAE7B,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACnB,MAAM,CAAC,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBACjC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAC1B,CAAC,EAAE,UAAU,CAAC,CAAA;YAEd,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;gBACnC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,CAAA;YAC1B,CAAC;QACH,CAAC;QAED,OAAO;YACL,eAAe,EAAE,CAAC;YAClB,YAAY,EAAE,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU;YAChD,cAAc,EAAE,MAAM,CAAC,KAAK;YAC5B,iBAAiB,EAAE,IAAI;SACxB,CAAA;IACH,CAAC;IAED,GAAG,CAAE,GAAW;QACd,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEtC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,eAAe,GAAG,QAAQ,CAAC,SAAS,IAAI,IAAI;gBAChD,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;gBACrD,CAAC,CAAC,CAAC,CAAC,CAAA;YACN,OAAO;gBACL,eAAe,EAAE,CAAC;gBAClB,YAAY,EAAE,eAAe;gBAC7B,cAAc,EAAE,QAAQ,CAAC,KAAK;gBAC9B,iBAAiB,EAAE,KAAK;aACzB,CAAA;QACH,CAAC;IACH,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEpC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,IAAI,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;gBAC7B,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;YAChC,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAExB,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/utils",
-  "version": "5.2.0-ee7ffe9b9",
+  "version": "5.2.1-8bbd43628",
   "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",
@@ -76,13 +76,17 @@
       "types": "./dist/src/multiaddr/is-private.d.ts",
       "import": "./dist/src/multiaddr/is-private.js"
     },
+    "./peer-queue": {
+      "types": "./dist/src/peer-queue.d.ts",
+      "import": "./dist/src/peer-queue.js"
+    },
     "./queue": {
       "types": "./dist/src/queue/index.d.ts",
       "import": "./dist/src/queue/index.js"
     },
-    "./peer-queue": {
-      "types": "./dist/src/peer-queue.d.ts",
-      "import": "./dist/src/peer-queue.js"
+    "./rate-limiter": {
+      "types": "./dist/src/rate-limiter.d.ts",
+      "import": "./dist/src/rate-limiter.js"
     },
     "./stream-to-ma-conn": {
       "types": "./dist/src/stream-to-ma-conn.d.ts",
@@ -119,22 +123,23 @@
   },
   "dependencies": {
     "@chainsafe/is-ip": "^2.0.2",
-    "@libp2p/interface": "1.1.1-ee7ffe9b9",
-    "@libp2p/logger": "4.0.4-ee7ffe9b9",
+    "@libp2p/interface": "1.1.1-8bbd43628",
+    "@libp2p/logger": "4.0.4-8bbd43628",
     "@multiformats/multiaddr": "^12.1.10",
     "@multiformats/multiaddr-matcher": "^1.1.0",
+    "delay": "^6.0.0",
     "get-iterator": "^2.0.1",
     "is-loopback-addr": "^2.0.1",
-    "it-pushable": "^3.2.2",
+    "it-pushable": "^3.2.3",
     "it-stream-types": "^2.0.1",
     "p-defer": "^4.0.0",
     "private-ip": "^3.0.1",
     "race-event": "^1.1.0",
-    "race-signal": "^1.0.1",
-    "uint8arraylist": "^2.4.3"
+    "race-signal": "^1.0.2",
+    "uint8arraylist": "^2.4.7"
   },
   "devDependencies": {
-    "@libp2p/peer-id-factory": "4.0.3-ee7ffe9b9",
+    "@libp2p/peer-id-factory": "4.0.4-8bbd43628",
     "aegir": "^42.0.0",
     "delay": "^6.0.0",
     "it-all": "^3.0.3",

package/src/rate-limiter.ts

@@ -0,0 +1,287 @@
+import { CodeError } from '@libp2p/interface'
+import delay from 'delay'
+
+export interface RateLimiterInit {
+  /**
+   * Number of points
+   *
+   * @default 4
+   */
+  points?: number
+
+  /**
+   * Per seconds
+   *
+   * @default 1
+   */
+  duration?: number
+
+  /**
+   * Block if consumed more than points in current duration for blockDuration seconds
+   *
+   * @default 0
+   */
+  blockDuration?: number
+
+  /**
+   * Execute allowed actions evenly over duration
+   *
+   * @default false
+   */
+  execEvenly?: boolean
+
+  /**
+   * ms, works with execEvenly=true option
+   *
+   * @default duration * 1000 / points
+   */
+  execEvenlyMinDelayMs?: number
+
+  /**
+   * @default rlflx
+   */
+  keyPrefix?: string
+}
+
+export interface GetKeySecDurationOptions {
+  customDuration?: number
+}
+
+export interface RateLimiterResult {
+  remainingPoints: number
+  msBeforeNext: number
+  consumedPoints: number
+  isFirstInDuration: boolean
+}
+
+export interface RateRecord {
+  value: number
+  expiresAt?: Date
+  timeoutId?: ReturnType<typeof setTimeout>
+}
+
+export class RateLimiter {
+  public readonly memoryStorage: MemoryStorage
+  protected points: number
+  protected duration: number
+  protected blockDuration: number
+  protected execEvenly: boolean
+  protected execEvenlyMinDelayMs: number
+  protected keyPrefix: string
+
+  constructor (opts: RateLimiterInit = {}) {
+    this.points = opts.points ?? 4
+    this.duration = opts.duration ?? 1
+    this.blockDuration = opts.blockDuration ?? 0
+    this.execEvenly = opts.execEvenly ?? false
+    this.execEvenlyMinDelayMs = opts.execEvenlyMinDelayMs ?? (this.duration * 1000 / this.points)
+    this.keyPrefix = opts.keyPrefix ?? 'rlflx'
+    this.memoryStorage = new MemoryStorage()
+  }
+
+  async consume (key: string, pointsToConsume: number = 1, options: GetKeySecDurationOptions = {}): Promise<RateLimiterResult> {
+    const rlKey = this.getKey(key)
+    const secDuration = this._getKeySecDuration(options)
+    let res = this.memoryStorage.incrby(rlKey, pointsToConsume, secDuration)
+    res.remainingPoints = Math.max(this.points - res.consumedPoints, 0)
+
+    if (res.consumedPoints > this.points) {
+      // Block only first time when consumed more than points
+      if (this.blockDuration > 0 && res.consumedPoints <= (this.points + pointsToConsume)) {
+        // Block key
+        res = this.memoryStorage.set(rlKey, res.consumedPoints, this.blockDuration)
+      }
+
+      throw new CodeError('Rate limit exceeded', 'ERR_RATE_LIMIT_EXCEEDED', res)
+    } else if (this.execEvenly && res.msBeforeNext > 0 && !res.isFirstInDuration) {
+      // Execute evenly
+      let delayMs = Math.ceil(res.msBeforeNext / (res.remainingPoints + 2))
+      if (delayMs < this.execEvenlyMinDelayMs) {
+        delayMs = res.consumedPoints * this.execEvenlyMinDelayMs
+      }
+
+      await delay(delayMs)
+    }
+
+    return res
+  }
+
+  penalty (key: string, points: number = 1, options: GetKeySecDurationOptions = {}): RateLimiterResult {
+    const rlKey = this.getKey(key)
+    const secDuration = this._getKeySecDuration(options)
+    const res = this.memoryStorage.incrby(rlKey, points, secDuration)
+    res.remainingPoints = Math.max(this.points - res.consumedPoints, 0)
+
+    return res
+  }
+
+  reward (key: string, points: number = 1, options: GetKeySecDurationOptions = {}): RateLimiterResult {
+    const rlKey = this.getKey(key)
+    const secDuration = this._getKeySecDuration(options)
+    const res = this.memoryStorage.incrby(rlKey, -points, secDuration)
+    res.remainingPoints = Math.max(this.points - res.consumedPoints, 0)
+
+    return res
+  }
+
+  /**
+   * Block any key for secDuration seconds
+   *
+   * @param key
+   * @param secDuration
+   */
+  block (key: string, secDuration: number): RateLimiterResult {
+    const msDuration = secDuration * 1000
+    const initPoints = this.points + 1
+
+    this.memoryStorage.set(this.getKey(key), initPoints, secDuration)
+
+    return {
+      remainingPoints: 0,
+      msBeforeNext: msDuration === 0 ? -1 : msDuration,
+      consumedPoints: initPoints,
+      isFirstInDuration: false
+    }
+  }
+
+  set (key: string, points: number, secDuration: number = 0): RateLimiterResult {
+    const msDuration = (secDuration >= 0 ? secDuration : this.duration) * 1000
+
+    this.memoryStorage.set(this.getKey(key), points, secDuration)
+
+    return {
+      remainingPoints: 0,
+      msBeforeNext: msDuration === 0 ? -1 : msDuration,
+      consumedPoints: points,
+      isFirstInDuration: false
+    }
+  }
+
+  get (key: string): RateLimiterResult | undefined {
+    const res = this.memoryStorage.get(this.getKey(key))
+
+    if (res != null) {
+      res.remainingPoints = Math.max(this.points - res.consumedPoints, 0)
+    }
+
+    return res
+  }
+
+  delete (key: string): void {
+    this.memoryStorage.delete(this.getKey(key))
+  }
+
+  private _getKeySecDuration (options?: GetKeySecDurationOptions): number {
+    if (options?.customDuration != null && options.customDuration >= 0) {
+      return options.customDuration
+    }
+
+    return this.duration
+  }
+
+  getKey (key: string): string {
+    return this.keyPrefix.length > 0 ? `${this.keyPrefix}:${key}` : key
+  }
+
+  parseKey (rlKey: string): string {
+    return rlKey.substring(this.keyPrefix.length)
+  }
+}
+
+class MemoryStorage {
+  public readonly storage: Map<string, RateRecord>
+
+  constructor () {
+    this.storage = new Map()
+  }
+
+  incrby (key: string, value: number, durationSec: number): RateLimiterResult {
+    const existing = this.storage.get(key)
+
+    if (existing != null) {
+      const msBeforeExpires = existing.expiresAt != null
+        ? existing.expiresAt.getTime() - new Date().getTime()
+        : -1
+
+      if (existing.expiresAt == null || msBeforeExpires > 0) {
+        // Change value
+        existing.value += value
+
+        return {
+          remainingPoints: 0,
+          msBeforeNext: msBeforeExpires,
+          consumedPoints: existing.value,
+          isFirstInDuration: false
+        }
+      }
+
+      return this.set(key, value, durationSec)
+    }
+
+    return this.set(key, value, durationSec)
+  }
+
+  set (key: string, value: number, durationSec: number): RateLimiterResult {
+    const durationMs = durationSec * 1000
+    const existing = this.storage.get(key)
+
+    if (existing != null) {
+      clearTimeout(existing.timeoutId)
+    }
+
+    const record: RateRecord = {
+      value,
+      expiresAt: durationMs > 0 ? new Date(Date.now() + durationMs) : undefined
+    }
+
+    this.storage.set(key, record)
+
+    if (durationMs > 0) {
+      record.timeoutId = setTimeout(() => {
+        this.storage.delete(key)
+      }, durationMs)
+
+      if (record.timeoutId.unref != null) {
+        record.timeoutId.unref()
+      }
+    }
+
+    return {
+      remainingPoints: 0,
+      msBeforeNext: durationMs === 0 ? -1 : durationMs,
+      consumedPoints: record.value,
+      isFirstInDuration: true
+    }
+  }
+
+  get (key: string): RateLimiterResult | undefined {
+    const existing = this.storage.get(key)
+
+    if (existing != null) {
+      const msBeforeExpires = existing.expiresAt != null
+        ? existing.expiresAt.getTime() - new Date().getTime()
+        : -1
+      return {
+        remainingPoints: 0,
+        msBeforeNext: msBeforeExpires,
+        consumedPoints: existing.value,
+        isFirstInDuration: false
+      }
+    }
+  }
+
+  delete (key: string): boolean {
+    const record = this.storage.get(key)
+
+    if (record != null) {
+      if (record.timeoutId != null) {
+        clearTimeout(record.timeoutId)
+      }
+
+      this.storage.delete(key)
+
+      return true
+    }
+    return false
+  }
+}