@gearbox-protocol/cli-utils 6.10.1 → 6.13.0

package/dist/Whitelist.d.ts

@@ -0,0 +1,30 @@
+import { WhitelistItemSchema } from "@gearbox-protocol/deploy-tools-shared";
+import type { ILogger, NetworkType } from "@gearbox-protocol/sdk";
+export interface WhitelistOptions {
+    url: string;
+    network: NetworkType;
+    logger?: ILogger;
+}
+/**
+ * Fetches a network-scoped whitelist from the deploy-tools backend and keeps
+ * it in memory with a 10-minute refresh interval.
+ *
+ * On fetch failure the previous in-memory copy is retained; if no successful
+ * fetch has occurred yet the whitelist is considered empty.
+ */
+export declare class Whitelist {
+    #private;
+    constructor({ url, network, logger }: WhitelistOptions);
+    /**
+     * Performs the initial fetch and starts the periodic refresh timer.
+     * Failure of the initial fetch is non-fatal: the whitelist stays empty.
+     */
+    start(): Promise<void>;
+    /** Stops the refresh timer. */
+    stop(): void;
+    /**
+     * Returns the matching whitelist entry for the given address, or
+     * `undefined` if absent or expired.
+     */
+    has(address: string): WhitelistItemSchema | undefined;
+}

package/dist/Whitelist.js

@@ -0,0 +1,83 @@
+import { setInterval } from "node:timers";
+import { fetchRetry, WhitelistItemSchema, } from "@gearbox-protocol/deploy-tools-shared";
+import { AddressMap } from "@gearbox-protocol/sdk";
+import { z } from "zod/v4";
+const REFRESH_INTERVAL_MS = 10 * 60 * 1000;
+const WhitelistResponse = z.array(WhitelistItemSchema);
+/**
+ * Fetches a network-scoped whitelist from the deploy-tools backend and keeps
+ * it in memory with a 10-minute refresh interval.
+ *
+ * On fetch failure the previous in-memory copy is retained; if no successful
+ * fetch has occurred yet the whitelist is considered empty.
+ */
+export class Whitelist {
+    #url;
+    #network;
+    #logger;
+    #items = new AddressMap();
+    #refreshInterval;
+    constructor({ url, network, logger }) {
+        this.#url = url;
+        this.#network = network;
+        this.#logger = logger?.child?.({ name: "whitelist" }) ?? logger;
+    }
+    /**
+     * Performs the initial fetch and starts the periodic refresh timer.
+     * Failure of the initial fetch is non-fatal: the whitelist stays empty.
+     */
+    async start() {
+        this.#logger?.info(`loading ${this.#network} whitelist from ${this.#url}, refresh every ${REFRESH_INTERVAL_MS / 1000}s`);
+        await this.#refresh();
+        this.#refreshInterval = setInterval(() => {
+            this.#refresh().catch(e => {
+                this.#logger?.warn(`unexpected whitelist refresh error: ${e}`);
+            });
+        }, REFRESH_INTERVAL_MS);
+    }
+    /** Stops the refresh timer. */
+    stop() {
+        if (this.#refreshInterval) {
+            clearInterval(this.#refreshInterval);
+            this.#refreshInterval = undefined;
+        }
+    }
+    /**
+     * Fetches the whitelist from the backend, parses it and atomically
+     * replaces the in-memory map. On any error logs a warning and retains
+     * the previous map.
+     */
+    async #refresh() {
+        try {
+            const resp = await fetchRetry(this.#url);
+            if (!resp.ok) {
+                throw new Error(`whitelist fetch failed: ${resp.status} ${resp.statusText}`);
+            }
+            const data = await resp.json();
+            const items = WhitelistResponse.parse(data).filter(i => i.network === this.#network);
+            const next = new AddressMap();
+            for (const item of items) {
+                next.upsert(item.address, item);
+            }
+            this.#items = next;
+            this.#logger?.debug(`loaded ${items.length} whitelist entries for ${this.#network}`);
+        }
+        catch (e) {
+            this.#logger?.warn(`failed to refresh whitelist from ${this.#url}, keeping previous version: ${e}`);
+        }
+    }
+    /**
+     * Returns the matching whitelist entry for the given address, or
+     * `undefined` if absent or expired.
+     */
+    has(address) {
+        const item = this.#items.get(address);
+        if (!item) {
+            return undefined;
+        }
+        if (item.expiresAt !== undefined && Date.now() / 1000 >= item.expiresAt) {
+            return undefined;
+        }
+        return item;
+    }
+}

package/dist/index.d.ts

@@ -11,4 +11,5 @@ export * from "./SecretsManager.js";
 export * from "./SSMManager.js";
 export * from "./schema-primitives.js";
 export * from "./uncensorMap.js";
+export * from "./Whitelist.js";
 export * from "./Zommand.js";

package/dist/index.js

@@ -11,4 +11,5 @@ export * from "./SecretsManager.js";
 export * from "./SSMManager.js";
 export * from "./schema-primitives.js";
 export * from "./uncensorMap.js";
+export * from "./Whitelist.js";
 export * from "./Zommand.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gearbox-protocol/cli-utils",
   "description": "Utils for creating cli apps",
-  "version": "6.10.1",
+  "version": "6.13.0",
   "homepage": "https://gearbox.fi",
   "keywords": [
     "gearbox"