@bifrostwallet/assets 1.3.0 → 1.3.2

package/README.md

@@ -22,7 +22,7 @@ yarn add @bifrostwallet/assets --exact
 
 `<version>` is the package version and the git tag. That tag is written into the package at build time. Returned `logoURL` values are absolute. A missing record is still `null`.
 
-An exact version tag is immutable on jsDelivr. Cache headers last one year, and the file is stored permanently, so this pinned URL does not go stale ([Caching](https://www.jsdelivr.com/documentation#id-caching)). Self-host when you want a copy you control: `npx @bifrostwallet/assets@<version> fetch-logos ./logos` checks each file against the hash in that package. Pin the exact version and run it again on every bump.
+An exact version tag is immutable on jsDelivr. Cache headers last one year, and the file is stored permanently, so this pinned URL does not go stale ([Caching](https://www.jsdelivr.com/documentation#id-caching)). Self-host when you want a copy you control. The steps are in [Self-hosting logos](#self-hosting-logos).
 
 Don't load logos from `raw.githubusercontent.com`. GitHub's raw file host is not a CDN: it rate-limits requests per IP and returns HTTP 429 under load. jsDelivr is built for this traffic.
 
@@ -43,23 +43,35 @@ Pass `baseURL` when you host the files yourself. A trailing slash is optional. T
 
 ### Optional: check a downloaded logo
 
-Use this when you download logos or self-host them with `fetch-logos`. `verifyLogoHash(bytes, logoHash)` is true when the SHA-256 of the decoded file bytes equals `logoHash`: 64 lowercase hex characters, no `0x` prefix. `fetchLogo(entry)` is a convenience that downloads `logoURL` and runs that check in one step.
+`verifyLogoHash(bytes, logoHash)` is true when the SHA-256 of the decoded file bytes equals `logoHash`: 64 lowercase hex characters, no `0x` prefix. `fetchLogo(entry)` downloads `logoURL` and runs that check in one step. It does not retry unless you pass `retries` (the delay before the first retry is `retryDelay`, 500 ms by default, and it doubles each time).
 
 ### Self-hosting logos
 
-Logo files are not in the npm package. You do not need to clone the repository.
+Logo files are not in the npm package. Clone this repository and check out the same version as your installed `@bifrostwallet/assets`. Tags have no `v` prefix.
 
-1. Download this version's logos. The command checks each file against the hash in the installed package. A missing hash or a mismatch does not write that file, and the command exits non-zero. Do not upload the directory if it fails.
+```sh
+git clone https://github.com/bifrostwallet/assets
+cd assets
+git checkout <version>
+```
+
+`<version>` is the installed package version, for example `1.2.2`.
+
+Upload only the `logo.webp` files under `data/`. Keep those relative paths (`tokens/…`, `providers/…`, `contracts/…`, `dapps/…`) so `baseURL` can join them.
+
+Google Cloud:
 
 ```sh
-npx --yes @bifrostwallet/assets@<version> fetch-logos ./logos
+gcloud storage rsync data gs://<your-bucket> --recursive --exclude='^(?!.*logo\.webp$).*'
 ```
 
-Files land at `./logos/providers/…`, `./logos/tokens/…`, `./logos/contracts/…`, and `./logos/dapps/…`.
+Amazon S3:
 
-2. Upload that directory to any static host or bucket. The public URL must serve those paths at its root. [Cloud Storage](https://cloud.google.com/storage/docs/uploading-objects) or [S3](https://docs.aws.amazon.com/cli/latest/reference/s3/sync.html) can do that.
+```sh
+aws s3 sync data s3://<your-bucket> --exclude '*' --include '*logo.webp'
+```
 
-3. Point the package at the public URL:
+Point the package at the public URL of that directory:
 
 ```typescript
 import { createAssets } from "@bifrostwallet/assets";
@@ -69,7 +81,7 @@ const assets = createAssets({
 });
 ```
 
-4. When you bump `@bifrostwallet/assets`, run `fetch-logos` for the new version and upload again before you ship. The default jsDelivr URL changes with the version. A copy you host does not.
+When you bump `@bifrostwallet/assets`, check out that version and upload again before you ship. The default jsDelivr URL changes with the version. A copy you host does not.
 
 ### Listed providers
 

package/index.d.ts

@@ -186,6 +186,14 @@ export interface FetchLogoOptions {
   /** Defaults to global fetch. Tests pass a substitute. */
   fetch?: typeof fetch;
   signal?: AbortSignal;
+  /**
+   * Extra attempts after a network error or HTTP 403, 408, 429, or 5xx.
+   * Defaults to 0.
+   * A hash mismatch or a response over 256KB is never retried.
+   */
+  retries?: number;
+  /** Milliseconds before the first retry. Doubles on each later retry. Defaults to 500. */
+  retryDelay?: number;
 }
 
 /**
@@ -201,7 +209,7 @@ export declare function fetchLogo(
 /**
  * True when SHA-256 of the decoded logo bytes equals expectedHash.
  * expectedHash is 64 lowercase hex characters with no 0x prefix (catalog logoHash).
- * For bytes you already have, such as a file from fetch-logos.
+ * For bytes you already have.
  * fetchLogo calls this after a download.
  */
 export declare function verifyLogoHash(

package/index.js

@@ -50,7 +50,7 @@ const CONTRACT_CATEGORIES = ["dex","aggregator","bridge","lending","staking","yi
 const CONTRACT_CATEGORY_LABELS = {"dex":"DEX","aggregator":"Aggregator","bridge":"Bridge","lending":"Lending","staking":"Staking","yield":"Yield","perpetuals":"Perpetuals","predictions":"Predictions","nft-marketplace":"NFT Marketplace","governance":"Governance","fassets":"FAssets","rewards":"Rewards","other":"Other"};
 const DAPP_CATEGORIES = ["featured","dex","lending","yield","staking","bridges","marketplaces","social","games","other"];
 const DAPP_CATEGORY_LABELS = {"featured":"Featured","dex":"DEX","lending":"Lending","yield":"Yield","staking":"Staking","bridges":"Bridges","marketplaces":"Marketplaces","social":"Social","games":"Games","other":"Other"};
-const DEFAULT_LOGO_BASE_URL = "https://cdn.jsdelivr.net/gh/bifrostwallet/assets@1.3.0/data/";
+const DEFAULT_LOGO_BASE_URL = "https://cdn.jsdelivr.net/gh/bifrostwallet/assets@1.3.2/data/";
 
 const EIP712_DOMAIN_SALT = "0xffc5336f20c2026b0f53d269def3cdffa3ca99b07e238af05f263a89517104f7";
 const PROVIDER_LISTING_PRIMARY_TYPE = "ProviderListing";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bifrostwallet/assets",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Curated catalog of data providers, validators, tokens, contracts and dapps for Bifrost Wallet.",
   "repository": "https://github.com/bifrostwallet/assets.git",
   "author": "Bifrost Software Ltd",
@@ -17,9 +17,6 @@
       "default": "./signatures.js"
     }
   },
-  "bin": {
-    "fetch-logos": "./fetch-logos.js"
-  },
   "sideEffects": false,
   "dependencies": {}
 }

package/tokens/eip155-56.json

@@ -1916,6 +1916,15 @@
     "logoURL": "tokens/eip155-56/0xba9425ec55ee0e72216d18e0ad8bbba2553bfb60/logo.webp",
     "logoHash": "935a9ac318bf75dfdf1f5a61a4162be707c624d6f43781ac91182f96180a64b1"
   },
+  {
+    "name": "Wrapped BNB",
+    "symbol": "WBNB",
+    "decimals": 18,
+    "address": "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c",
+    "coingeckoId": "wbnb",
+    "logoURL": "tokens/eip155-56/0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c/logo.webp",
+    "logoHash": "8926a7bc9572fbc38319d019f3cd92f6eeaca99d2f7ca57358b5771856721a98"
+  },
   {
     "name": "Alchemy Pay",
     "symbol": "ACH",
@@ -2598,6 +2607,6 @@
     "address": null,
     "coingeckoId": "binancecoin",
     "logoURL": "tokens/eip155-56/native/logo.webp",
-    "logoHash": "ef582e6a8c2a95b3db2ae03803304c422a63aaf38a40914fbb809d625a39c461"
+    "logoHash": "8926a7bc9572fbc38319d019f3cd92f6eeaca99d2f7ca57358b5771856721a98"
   }
 ]

package/tokens/eip155-97.json

@@ -6,6 +6,6 @@
     "address": null,
     "coingeckoId": null,
     "logoURL": "tokens/eip155-97/native/logo.webp",
-    "logoHash": "ef582e6a8c2a95b3db2ae03803304c422a63aaf38a40914fbb809d625a39c461"
+    "logoHash": "8926a7bc9572fbc38319d019f3cd92f6eeaca99d2f7ca57358b5771856721a98"
   }
 ]

package/verify-logo-hash.js

@@ -13,6 +13,42 @@ function verifyLogoHash(bytes, expectedHash) {
   return crypto.timingSafeEqual(digest, expected);
 }
 
+function delay(ms) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms);
+  });
+}
+
+function readRetryCount(value) {
+  if (typeof value !== "number" || !Number.isFinite(value)) return 0;
+  const count = Math.floor(value);
+  return count > 0 ? count : 0;
+}
+
+function readRetryDelay(value) {
+  if (typeof value !== "number" || !Number.isFinite(value) || value < 0) return 500;
+  return value;
+}
+
+function isRetryableStatus(status) {
+  return status === 403 || status === 408 || status === 429 || (status >= 500 && status <= 599);
+}
+
+function callerAborted(options) {
+  return !!(options && options.signal && options.signal.aborted);
+}
+
+async function backoff(options, attempt, status) {
+  const retries = readRetryCount(options && options.retries);
+  const retryDelay = readRetryDelay(options && options.retryDelay);
+  const wait = retryDelay * 2 ** (attempt - 1);
+  const onRetry = options && options.onRetry;
+  if (typeof onRetry === "function") {
+    await onRetry({ attempt, retries, status, delay: wait });
+  }
+  if (wait > 0) await delay(wait);
+}
+
 async function fetchLogo(entry, options) {
   if (!entry || typeof entry.logoURL !== "string" || entry.logoURL.trim() === "") {
     throw new Error("logoURL is required");
@@ -21,29 +57,62 @@ async function fetchLogo(entry, options) {
     throw new Error("logoHash must be a lowercase SHA-256 hex digest");
   }
   const fetchImpl = (options && options.fetch) || fetch;
-  const signal = options && options.signal ? options.signal : AbortSignal.timeout(30000);
-  let response;
-  try {
-    response = await fetchImpl(entry.logoURL, {
-      redirect: "follow",
-      headers: { accept: "application/octet-stream" },
-      signal,
-    });
-  } catch (error) {
-    const message = error && error.message ? error.message : String(error);
-    throw new Error("Could not fetch logo: " + message);
-  }
-  if (!response || !response.ok) {
-    const status = response && response.status ? response.status : "request failed";
-    throw new Error("Could not fetch logo: HTTP " + status);
-  }
-  const bytes = new Uint8Array(await response.arrayBuffer());
-  if (bytes.byteLength > 256 * 1024) {
-    throw new Error("Could not fetch logo: response exceeds 256KB");
-  }
-  if (!verifyLogoHash(bytes, entry.logoHash)) {
-    throw new Error("logo hash mismatch");
+  const retries = readRetryCount(options && options.retries);
+  let attempt = 0;
+  for (;;) {
+    const signal = options && options.signal ? options.signal : AbortSignal.timeout(30000);
+    let response;
+    try {
+      response = await fetchImpl(entry.logoURL, {
+        redirect: "follow",
+        headers: { accept: "application/octet-stream" },
+        signal,
+      });
+    } catch (error) {
+      if (!callerAborted(options) && attempt < retries) {
+        attempt += 1;
+        await backoff(options, attempt, "network");
+        continue;
+      }
+      const message = error && error.message ? error.message : String(error);
+      throw new Error("Could not fetch logo: " + message);
+    }
+    if (!response || !response.ok) {
+      const status = response && typeof response.status === "number" ? response.status : 0;
+      if (response && typeof response.arrayBuffer === "function") {
+        try {
+          await response.arrayBuffer();
+        } catch (drainError) {
+          void drainError;
+        }
+      }
+      if (isRetryableStatus(status) && attempt < retries && !callerAborted(options)) {
+        attempt += 1;
+        await backoff(options, attempt, status);
+        continue;
+      }
+      const label = status ? status : "request failed";
+      throw new Error("Could not fetch logo: HTTP " + label);
+    }
+    let bytes;
+    try {
+      bytes = new Uint8Array(await response.arrayBuffer());
+    } catch (error) {
+      if (!callerAborted(options) && attempt < retries) {
+        attempt += 1;
+        await backoff(options, attempt, "network");
+        continue;
+      }
+      const message = error && error.message ? error.message : String(error);
+      throw new Error("Could not fetch logo: " + message);
+    }
+    if (bytes.byteLength > 256 * 1024) {
+      throw new Error("Could not fetch logo: response exceeds 256KB");
+    }
+    if (!verifyLogoHash(bytes, entry.logoHash)) {
+      throw new Error("logo hash mismatch");
+    }
+    return bytes;
   }
-  return bytes;
 }
 module.exports = { verifyLogoHash, fetchLogo };

package/fetch-logos.js

@@ -1,193 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-// @bifrostwallet/assets fetch-logos — generated file, do not edit.
-// Downloads logo files for this package version. Each catalog entry's logoHash
-// is the trust anchor. Bytes are the decoded response body (content-encoding removed).
-// Accept is application/octet-stream so the CDN is not asked to convert the image.
-
-const fs = require("node:fs");
-const path = require("node:path");
-const { fetchLogo, verifyLogoHash } = require("./verify-logo-hash.js");
-
-const DEFAULT_LOGO_BASE_URL = "https://cdn.jsdelivr.net/gh/bifrostwallet/assets@1.3.0/data/";
-const USAGE = [
-  "Usage: fetch-logos <dir>",
-  "",
-  "Download this package version's logos into <dir>.",
-  "Paths stay relative to data/ (providers/, tokens/, contracts/, dapps/).",
-  "Each file is checked against the logoHash on its catalog entry.",
-  "A missing hash or a hash mismatch does not write that file, and the command exits non-zero.",
-  "Do not upload the directory when the command fails.",
-  "",
-  "Upload <dir> to any static host. createAssets baseURL is optional.",
-  "Omit it to use jsDelivr at this release tag:",
-  "https://cdn.jsdelivr.net/gh/bifrostwallet/assets@1.3.0/data/",
-  "Or set baseURL to the public URL where you uploaded that directory.",
-  "Example: https://assets.example.com/",
-  "Run fetch-logos again when you bump the package version.",
-].join("\n");
-
-function readJson(filePath) {
-  return JSON.parse(fs.readFileSync(filePath, "utf8"));
-}
-
-function walkJsonArrays(dir, visit) {
-  if (!fs.existsSync(dir)) return;
-  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
-    const fullPath = path.join(dir, entry.name);
-    if (entry.isDirectory()) {
-      walkJsonArrays(fullPath, visit);
-      continue;
-    }
-    if (!entry.name.endsWith(".json")) continue;
-    if (entry.name === "package.json" || entry.name === "signatures.json") {
-      continue;
-    }
-    const parsed = readJson(fullPath);
-    if (!Array.isArray(parsed)) continue;
-    for (const item of parsed) {
-      if (item && typeof item === "object" && typeof item.logoURL === "string") {
-        visit(item, path.relative(dir, fullPath));
-      }
-    }
-  }
-}
-
-function isSafeLogoPath(value) {
-  if (!value || value.startsWith("/") || value.includes("..") || value.includes("\\")) return false;
-  if (/^[a-z][a-z0-9+.-]*:/i.test(value)) return false;
-  return /^(providers|tokens|contracts|dapps)\/[A-Za-z0-9._@/-]+$/.test(value);
-}
-
-function loadAnchors(packageRoot) {
-  const entries = new Map();
-  const failures = [];
-  walkJsonArrays(packageRoot, (item) => {
-    const logoPath = item.logoURL;
-    const logoHash = item.logoHash;
-    if (!isSafeLogoPath(logoPath)) {
-      failures.push(String(logoPath) + ": invalid logo path");
-      return;
-    }
-    if (typeof logoHash !== "string" || !/^[0-9a-f]{64}$/.test(logoHash)) {
-      failures.push(logoPath + ": missing logoHash");
-      entries.set(logoPath, null);
-      return;
-    }
-    const existing = entries.get(logoPath);
-    if (existing !== undefined && existing !== logoHash) {
-      failures.push(logoPath + ": logoHash conflict");
-      entries.set(logoPath, null);
-      return;
-    }
-    if (existing === undefined) entries.set(logoPath, logoHash);
-  });
-  return { entries, failures };
-}
-
-function destinationFor(destDir, logoPath) {
-  const root = path.resolve(destDir);
-  const target = path.resolve(root, logoPath);
-  const relative = path.relative(root, target);
-  if (relative.startsWith("..") || path.isAbsolute(relative)) {
-    throw new Error("logo path escapes destination");
-  }
-  return target;
-}
-
-async function mapPool(items, limit, fn) {
-  const queue = items.slice();
-  const workers = [];
-  const count = Math.min(limit, queue.length);
-  for (let i = 0; i < count; i += 1) {
-    workers.push(
-      (async () => {
-        while (queue.length > 0) {
-          const item = queue.shift();
-          await fn(item);
-        }
-      })(),
-    );
-  }
-  await Promise.all(workers);
-}
-
-async function fetchLogos(options) {
-  if (!options || typeof options.destDir !== "string" || options.destDir.trim() === "") {
-    throw new Error("destDir is required");
-  }
-  const packageRoot = options.packageRoot || __dirname;
-  const supplied = typeof options.baseURL === "string" ? options.baseURL.trim() : "";
-  const baseURL = (supplied || DEFAULT_LOGO_BASE_URL).replace(/\/?$/, "/");
-  const fetchImpl = options.fetch || fetch;
-  const loaded = loadAnchors(packageRoot);
-  const failures = loaded.failures.slice();
-  const written = [];
-  const jobs = [];
-  for (const [logoPath, logoHash] of loaded.entries) {
-    if (typeof logoHash !== "string") continue;
-    jobs.push({ logoPath, logoHash });
-  }
-  await mapPool(jobs, 8, async (job) => {
-    try {
-      const bytes = await fetchLogo(
-        { logoURL: baseURL + job.logoPath, logoHash: job.logoHash },
-        { fetch: fetchImpl },
-      );
-      const target = destinationFor(options.destDir, job.logoPath);
-      fs.mkdirSync(path.dirname(target), { recursive: true });
-      const partial = target + ".partial";
-      fs.writeFileSync(partial, bytes);
-      fs.renameSync(partial, target);
-      written.push(job.logoPath);
-    } catch (error) {
-      const message = error && error.message ? error.message : String(error);
-      failures.push(job.logoPath + ": " + message);
-    }
-  });
-  return { written, failures };
-}
-
-async function runCli(argv, deps) {
-  const args = Array.isArray(argv) ? argv.slice() : [];
-  const extra = deps || {};
-  if (args.includes("--help") || args.includes("-h")) {
-    console.info(USAGE);
-    return 0;
-  }
-  if (args[0] === "fetch-logos") args.shift();
-  if (args.length !== 1) {
-    console.error(USAGE);
-    return 1;
-  }
-  const result = await fetchLogos({
-    destDir: args[0],
-    packageRoot: extra.packageRoot,
-    baseURL: extra.baseURL,
-    fetch: extra.fetch,
-  });
-  for (const failure of result.failures) console.error(failure);
-  if (result.failures.length > 0) {
-    console.error(
-      "fetch-logos failed for " +
-        result.failures.length +
-        " logo(s). Those files were not written. Do not upload this directory.",
-    );
-    return 1;
-  }
-  console.info("Wrote " + result.written.length + " logo(s) to " + args[0]);
-  return 0;
-}
-
-if (require.main === module) {
-  runCli(process.argv.slice(2))
-    .then((code) => {
-      process.exitCode = code;
-    })
-    .catch((error) => {
-      console.error(error && error.message ? error.message : error);
-      process.exitCode = 1;
-    });
-}
-
-module.exports = { fetchLogos, fetchLogo, runCli, verifyLogoHash };