@ruban-labs/web-assets 0.1.0

package/README.md

@@ -0,0 +1,30 @@
+# @ruban-labs/web-assets
+
+Versioned local mirror of the public `supported_chains.json` consumed by Rabby
+Mobile, plus the corresponding chain-logo PNG files. It is deliberately a data
+package: consumers never need to call the upstream service at runtime.
+
+## Package contents
+
+- `@ruban-labs/web-assets/supported-chains.json` — the upstream chain payload,
+  preserved as JSON.
+- `@ruban-labs/web-assets/chain-assets.json` — a deterministic manifest that
+  maps each chain to its local PNG filename and SHA-256.
+- `assets/chains/<chain-name>.png` and
+  `assets/chains/<chain-name>-white.png` — the ordinary and white chain logo
+  files, named from the chain display name using lowercase URL-safe slugs.
+
+## Updating
+
+`npm run sync` fetches the public Debank chain list and all referenced PNG
+logos, validates them, and updates the local mirror only after a complete
+successful download. `npm run verify` checks the checked-in metadata and image
+hashes without network access.
+
+The GitHub Actions workflow runs daily. When the mirror changes, it bumps the
+patch version, commits the update, and publishes the matching package version
+using npm Trusted Publishing (GitHub Actions OIDC).
+
+The source metadata and logo URLs remain attributable to their upstream
+providers. Consumers are responsible for complying with any applicable
+upstream branding and content terms.