@avaprotocol/protocols 0.2.0 → 0.4.0

package/dist/tokens/base-sepolia.json

@@ -0,0 +1,26 @@
+[
+  {
+    "id": "0xe4ab69c077896252fafbd49efd26b5d171a32410",
+    "name": "Chainlink",
+    "symbol": "LINK",
+    "decimals": 18
+  },
+  {
+    "id": "0x036cbd53842c5426634e7929541ec2318f3dcf7e",
+    "name": "USD Coin",
+    "symbol": "USDC",
+    "decimals": 6
+  },
+  {
+    "id": "0xce8565457cca0fc7542608a2c78610ed7bc66c8c",
+    "name": "Tether USD",
+    "symbol": "USDT",
+    "decimals": 6
+  },
+  {
+    "id": "0x4200000000000000000000000000000000000006",
+    "name": "Wrapped Ether",
+    "symbol": "WETH",
+    "decimals": 18
+  }
+]

package/dist/tokens/base.json

@@ -0,0 +1,140 @@
+[
+  {
+    "id": "0x63706e401c06ac8513145b7687a14804d17f814b",
+    "name": "Aave",
+    "symbol": "AAVE",
+    "decimals": 18
+  },
+  {
+    "id": "0x940181a94a35a4569e4529a3cdfb74e38fd98631",
+    "name": "Aerodrome",
+    "symbol": "AERO",
+    "decimals": 18
+  },
+  {
+    "id": "0xeb466342c4d449bc9f53a865d5cb90586f405215",
+    "name": "Axelar Wrapped USDC",
+    "symbol": "axlUSDC",
+    "decimals": 6
+  },
+  {
+    "id": "0x7c6b91d9be155a6db01f749217d76ff02a7227f2",
+    "name": "Balancer",
+    "symbol": "BAL",
+    "decimals": 18
+  },
+  {
+    "id": "0x532f27101965dd16442e59d40670faf5ebb142e4",
+    "name": "Brett",
+    "symbol": "BRETT",
+    "decimals": 18
+  },
+  {
+    "id": "0xcbb7c0000ab88b473b1f5afd9ef808440eed33bf",
+    "name": "Coinbase Wrapped BTC",
+    "symbol": "cbBTC",
+    "decimals": 8
+  },
+  {
+    "id": "0x2ae3f1ec7f1f5012cfeab0185bfc7aa3cf0dec22",
+    "name": "Coinbase Wrapped Staked ETH",
+    "symbol": "cbETH",
+    "decimals": 18
+  },
+  {
+    "id": "0x50c5725949a6f0c72e6c4a641f24049a917db0cb",
+    "name": "Dai",
+    "symbol": "DAI",
+    "decimals": 18
+  },
+  {
+    "id": "0x4ed4e862860bed51a9570b96d89af5e1b0efefed",
+    "name": "Degen",
+    "symbol": "DEGEN",
+    "decimals": 18
+  },
+  {
+    "id": "0x88fb150bdc53a65fe94dea0c9ba0a6daf8c6e196",
+    "name": "Chainlink",
+    "symbol": "LINK",
+    "decimals": 18
+  },
+  {
+    "id": "0xbaa5cc21fd487b8fcc2f632f3f4e8d37262a0842",
+    "name": "Morpho Token",
+    "symbol": "MORPHO",
+    "decimals": 18
+  },
+  {
+    "id": "0xb6fe221fe9eef5aba221c348ba20a1bf5e73624c",
+    "name": "Rocket Pool ETH",
+    "symbol": "rETH",
+    "decimals": 18
+  },
+  {
+    "id": "0xab36452dbac151be02b16ca17d8919826072f64a",
+    "name": "Reserve Rights",
+    "symbol": "RSR",
+    "decimals": 18
+  },
+  {
+    "id": "0xac1bd2486aaf3b5c0fc3fd868558b082a531b2b4",
+    "name": "Toshi",
+    "symbol": "TOSHI",
+    "decimals": 18
+  },
+  {
+    "id": "0xc3de830ea07524a0761646a6a4e4be0e114a3c83",
+    "name": "Uniswap",
+    "symbol": "UNI",
+    "decimals": 18
+  },
+  {
+    "id": "0xd9aaec86b65d86f6a7b5b1b0c42ffa531710b6ca",
+    "name": "USD Base Coin",
+    "symbol": "USDbC",
+    "decimals": 6
+  },
+  {
+    "id": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
+    "name": "USD Coin",
+    "symbol": "USDC",
+    "decimals": 6
+  },
+  {
+    "id": "0xfde4c96c8593536e31f229ea8f37b2ada2699bb2",
+    "name": "Bridged Tether USD",
+    "symbol": "USDT",
+    "decimals": 6
+  },
+  {
+    "id": "0x0b3e328455c4059eeb9e3f84b5543f74e24e7e1b",
+    "name": "Virtual Protocol",
+    "symbol": "VIRTUAL",
+    "decimals": 18
+  },
+  {
+    "id": "0xa88594d404727625a9437c3f886c7643872296ae",
+    "name": "WELL",
+    "symbol": "WELL",
+    "decimals": 18
+  },
+  {
+    "id": "0x4200000000000000000000000000000000000006",
+    "name": "Wrapped Ether",
+    "symbol": "WETH",
+    "decimals": 18
+  },
+  {
+    "id": "0xc1cba3fcea344f92d9239c08c0568f6f2f0ee452",
+    "name": "Wrapped liquid staked Ether 2.0",
+    "symbol": "wstETH",
+    "decimals": 18
+  },
+  {
+    "id": "0x9eaf8c1e34f05a589eda6bafdf391cf6ad3cb239",
+    "name": "yearn.finance",
+    "symbol": "YFI",
+    "decimals": 18
+  }
+]

package/dist/tokens/bnb-mainnet.json

@@ -0,0 +1,14 @@
+[
+  {
+    "id": "0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d",
+    "name": "Binance-Peg USD Coin",
+    "symbol": "USDC",
+    "decimals": 18
+  },
+  {
+    "id": "0x55d398326f99059ff775485246999027b3197955",
+    "name": "Binance-Peg Tether USD",
+    "symbol": "USDT",
+    "decimals": 18
+  }
+]

package/dist/tokens/ethereum.json

@@ -0,0 +1,182 @@
+[
+  {
+    "id": "0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9",
+    "name": "Aave",
+    "symbol": "AAVE",
+    "decimals": 18
+  },
+  {
+    "id": "0xb50721bcf8d664c30412cfbc6cf7a15145234ad1",
+    "name": "Arbitrum",
+    "symbol": "ARB",
+    "decimals": 18
+  },
+  {
+    "id": "0xc00e94cb662c3520282e6f5717214004a7f26888",
+    "name": "Compound",
+    "symbol": "COMP",
+    "decimals": 18
+  },
+  {
+    "id": "0xd533a949740bb3306d119cc777fa900ba034cd52",
+    "name": "Curve DAO Token",
+    "symbol": "CRV",
+    "decimals": 18
+  },
+  {
+    "id": "0x6b175474e89094c44da98b954eedeac495271d0f",
+    "name": "Dai",
+    "symbol": "DAI",
+    "decimals": 18
+  },
+  {
+    "id": "0x92d6c1e31e14520e676a687f0a93788b716beff5",
+    "name": "dYdX",
+    "symbol": "DYDX",
+    "decimals": 18
+  },
+  {
+    "id": "0xec53bf9167f50cdeb3ae105f56099aaab9061f83",
+    "name": "Eigen",
+    "symbol": "EIGEN",
+    "decimals": 18
+  },
+  {
+    "id": "0x57e114b691db790c35207b2e685d4a43181e6061",
+    "name": "ENA",
+    "symbol": "ENA",
+    "decimals": 18
+  },
+  {
+    "id": "0xc18360217d8f7ab5e7c516566761ea12ce7f9d72",
+    "name": "Ethereum Name Service",
+    "symbol": "ENS",
+    "decimals": 18
+  },
+  {
+    "id": "0xaea46a60368a7bd060eec7df8cba43b7ef41ad85",
+    "name": "Fetch.ai",
+    "symbol": "FET",
+    "decimals": 18
+  },
+  {
+    "id": "0x853d955acef822db058eb8505911ed77f175b99e",
+    "name": "Frax",
+    "symbol": "FRAX",
+    "decimals": 18
+  },
+  {
+    "id": "0xc944e90c64b2c07662a292be6244bdf05cda44a7",
+    "name": "The Graph",
+    "symbol": "GRT",
+    "decimals": 18
+  },
+  {
+    "id": "0x5a98fcbea516cf06857215779fd812ca3bef1b32",
+    "name": "Lido DAO",
+    "symbol": "LDO",
+    "decimals": 18
+  },
+  {
+    "id": "0x514910771af9ca656af840dff83e8264ecf986ca",
+    "name": "Chainlink",
+    "symbol": "LINK",
+    "decimals": 18
+  },
+  {
+    "id": "0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2",
+    "name": "Maker",
+    "symbol": "MKR",
+    "decimals": 18
+  },
+  {
+    "id": "0x45804880de22913dafe09f4980848ece6ecbaf78",
+    "name": "PAX Gold",
+    "symbol": "PAXG",
+    "decimals": 18
+  },
+  {
+    "id": "0x808507121b80c02388fad14726482e061b8da827",
+    "name": "Pendle",
+    "symbol": "PENDLE",
+    "decimals": 18
+  },
+  {
+    "id": "0x6982508145454ce325ddbe47a25d4ec3d2311933",
+    "name": "Pepe",
+    "symbol": "PEPE",
+    "decimals": 18
+  },
+  {
+    "id": "0x6c3ea9036406852006290770bedfcaba0e23a0e8",
+    "name": "PayPal USD",
+    "symbol": "PYUSD",
+    "decimals": 6
+  },
+  {
+    "id": "0x6de037ef9ad2725eb40118bb1702ebb27e4aeb24",
+    "name": "Render Token",
+    "symbol": "RNDR",
+    "decimals": 18
+  },
+  {
+    "id": "0xd33526068d116ce69f19a9ee46f0bd304f21a51f",
+    "name": "Rocket Pool",
+    "symbol": "RPL",
+    "decimals": 18
+  },
+  {
+    "id": "0x95ad61b0a150d79219dcf64e1e6cc01f0b64c4ce",
+    "name": "SHIBA INU",
+    "symbol": "SHIB",
+    "decimals": 18
+  },
+  {
+    "id": "0xc011a73ee8576fb46f5e1c5751ca3b9fe0af2a6f",
+    "name": "Synthetix",
+    "symbol": "SNX",
+    "decimals": 18
+  },
+  {
+    "id": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84",
+    "name": "stETH",
+    "symbol": "stETH",
+    "decimals": 18
+  },
+  {
+    "id": "0x1f9840a85d5af5bf1d1762f925bdaddc4201f984",
+    "name": "Uniswap",
+    "symbol": "UNI",
+    "decimals": 18
+  },
+  {
+    "id": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+    "name": "USD Coin",
+    "symbol": "USDC",
+    "decimals": 6
+  },
+  {
+    "id": "0xdac17f958d2ee523a2206206994597c13d831ec7",
+    "name": "Tether",
+    "symbol": "USDT",
+    "decimals": 6
+  },
+  {
+    "id": "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599",
+    "name": "Wrapped BTC",
+    "symbol": "WBTC",
+    "decimals": 8
+  },
+  {
+    "id": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
+    "name": "WETH",
+    "symbol": "WETH",
+    "decimals": 18
+  },
+  {
+    "id": "0x7f39c581f595b53c5cb19bd0b3f8da6c935e2ca0",
+    "name": "Wrapped liquid staked Ether 2.0",
+    "symbol": "wstETH",
+    "decimals": 18
+  }
+]

package/dist/tokens/index.d.ts

@@ -0,0 +1,55 @@
+import { type TokenByChain, type TokenChainEntry } from "./types";
+export type { TokenByChain, TokenChainEntry, TokenLinks } from "./types";
+/**
+ * Symbol → per-chain entry. The outer object is frozen at module
+ * load, so the symbol set is immutable. The inner per-chain maps
+ * (e.g. `Tokens.USDC`) are NOT deep-frozen — callers must treat
+ * them as logically read-only. The shallow freeze is the right
+ * tradeoff: deep-freezing the chain maps + their entries on every
+ * import would add overhead for a guarantee no consumer has asked
+ * for. Add a deep-freeze pass here if a real misuse case emerges.
+ *
+ * Symbol keys preserve the casing used by the token's canonical
+ * branding as published by upstream catalogs. Most symbols are
+ * uppercase (USDC, WETH, AAVE) but mixed-case tickers exist where
+ * the project explicitly brands that way (stETH, wstETH, axlUSDC,
+ * cbBTC, USDbC, rETH, sUSDe). The catalog is intentionally NOT
+ * case-insensitive at this level — `Tokens.usdc` is `undefined`,
+ * not USDC — so callers needing fuzzy lookup should normalize at
+ * their own boundary or use `lookupToken(chainId, address)` which
+ * lookups by address (case-insensitive on address, but symbol-
+ * agnostic).
+ */
+export declare const Tokens: Readonly<Record<string, TokenByChain>>;
+/**
+ * Reverse lookup: given a contract address, find the token entry plus
+ * its symbol. Address matching is case-insensitive so callers can pass
+ * checksum or lowercase without normalizing upstream.
+ *
+ * Resolution strategy:
+ *   1. When `chainId` is provided, prefer a match registered for that
+ *      chain.
+ *   2. If no chain-specific match (or no chainId), scan every chain
+ *      for the address. Necessary when the caller's chain context
+ *      diverges from where the address actually lives — happens in
+ *      multi-chain dev gateways where the workflow targets one chain
+ *      but the runtime is bound to a different one. The fallback is
+ *      best-effort: the same 20-byte address is reachable on every
+ *      EVM chain, so the scan only happens to be correct because the
+ *      catalog only ships well-known canonical tokens whose contract
+ *      addresses (mainnet USDC, OP-stack WETH predeploys, etc.) don't
+ *      collide across chains in practice. Callers should still pass
+ *      the right chainId when they have it.
+ *
+ * Returns `undefined` when no chain in the catalog carries the
+ * address, or when the address is missing/falsy.
+ *
+ * Typical use: aggregator payloads ship `tokenSymbol="UNKNOWN"` for
+ * tokens whose chain-specific RPC enrichment failed; consumers fall
+ * through to `lookupToken(chainId, contractAddress)` and recover the
+ * symbol + decimals from this catalog.
+ */
+export declare function lookupToken(chainId: number | undefined, address: string | undefined): (TokenChainEntry & {
+    symbol: string;
+}) | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/tokens/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/tokens/index.ts"],"names":[],"mappings":"AA6BA,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,eAAe,EAAE,MAAM,SAAS,CAAC;AAQlE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAqDzE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAwC,CAAC;AAEnG;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,CAAC,eAAe,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,SAAS,CAsBpD"}

package/dist/tokens/sepolia.json

@@ -0,0 +1,38 @@
+[
+  {
+    "id": "0x3e622317f8c93f7328350cf0b56d9ed4c620c5d6",
+    "name": "Dai Stablecoin",
+    "symbol": "DAI",
+    "decimals": 18
+  },
+  {
+    "id": "0x779877a7b0d9e8603169ddbd7836e478b4624789",
+    "name": "ChainLink Token",
+    "symbol": "LINK",
+    "decimals": 18
+  },
+  {
+    "id": "0x1f9840a85d5af5bf1d1762f925bdaddc4201f984",
+    "name": "Uniswap",
+    "symbol": "UNI",
+    "decimals": 18
+  },
+  {
+    "id": "0x1c7d4b196cb0c7b01d743fbc6116a902379c7238",
+    "name": "USD Coin",
+    "symbol": "USDC",
+    "decimals": 6
+  },
+  {
+    "id": "0xaa8e23fb1079ea71e0a56f48a2aa51851d8433d0",
+    "name": "Tether USD",
+    "symbol": "USDT",
+    "decimals": 6
+  },
+  {
+    "id": "0xfff9976782d46cc05630d1f6ebab18b2324d6b14",
+    "name": "Wrapped Ether",
+    "symbol": "WETH",
+    "decimals": 18
+  }
+]

package/dist/tokens/types.d.ts

@@ -0,0 +1,59 @@
+import { type ChainId } from "../chains";
+/**
+ * External reference links for a token. All fields optional — the
+ * catalog only records what's actually known per token. Add new keys
+ * here when adding a category we want to surface; consumers ignore
+ * unknown keys harmlessly.
+ *
+ * Keys follow the names used by upstream catalogs (Studio's
+ * `app/lib/erc20/*.json` in particular) so the port is mechanical.
+ * `x` is the renamed Twitter; we deliberately use the current name
+ * rather than carrying a `twitter` alias.
+ */
+export interface TokenLinks {
+    readonly github?: string;
+    readonly x?: string;
+    readonly coingecko?: string;
+    readonly coinmarketcap?: string;
+    readonly reddit?: string;
+    readonly blog?: string;
+    readonly whitepaper?: string;
+    readonly facebook?: string;
+    readonly discord?: string;
+    readonly telegram?: string;
+    readonly medium?: string;
+    readonly docs?: string;
+    readonly forum?: string;
+    readonly youtube?: string;
+}
+/**
+ * Per-chain token deployment record. `address` and `decimals` are
+ * required because they're the universal lookup primitives every
+ * consumer needs. All other fields are optional metadata.
+ *
+ * `name` is per-chain because some tokens use different display names
+ * on different deployments (e.g. AAVE's faucet-LINK on Sepolia is
+ * "ChainLink Token" vs. "Chainlink" on mainnet). When the chains
+ * agree, the same string is fine to repeat.
+ *
+ * `logoUrl` is a fully qualified URL — typically a GitHub Raw or CDN
+ * link. Studio renders local PNGs by resolving symbol+chain itself
+ * and ignores this field; backend consumers may surface the URL
+ * directly in summaries or skip it.
+ */
+export interface TokenChainEntry {
+    readonly address: `0x${string}`;
+    readonly decimals: number;
+    readonly name?: string;
+    readonly description?: string;
+    readonly website?: string;
+    readonly explorer?: string;
+    readonly logoUrl?: string;
+    readonly links?: TokenLinks;
+}
+/**
+ * Map of `ChainId → TokenChainEntry`. `Partial` because no token is
+ * deployed on every chain in the catalog.
+ */
+export type TokenByChain = Partial<Record<ChainId, TokenChainEntry>>;
+//# sourceMappingURL=types.d.ts.map

package/dist/tokens/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/tokens/types.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;;;;;;;;;GAUG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,OAAO,EAAE,KAAK,MAAM,EAAE,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avaprotocol/protocols",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Multi-chain catalog of DeFi protocol contract addresses, ABI fragments, and event topic hashes — covers AAVE V3, Uniswap V3, Chainlink, Lido, Morpho, and more.",
   "keywords": [
     "defi",
@@ -50,17 +50,25 @@
   "scripts": {
     "build:declarations": "tsc -p tsconfig.build.json",
     "build:js": "tsup src/index.ts --format cjs,esm --target es2020",
-    "build": "yarn clean:dist && yarn build:declarations && yarn build:js",
+    "build:tokens-sidecar": "tsx scripts/build-tokens-sidecar.ts",
+    "build": "yarn clean:dist && yarn build:declarations && yarn build:js && yarn build:tokens-sidecar",
+    "port:studio": "tsx scripts/port-from-studio.ts",
     "clean": "rm -rf node_modules dist tsconfig.tsbuildinfo",
     "clean:dist": "rm -rf dist tsconfig.tsbuildinfo",
     "test": "vitest",
     "test:run": "vitest run",
     "typecheck": "tsc --noEmit",
     "lint": "tsc --noEmit",
-    "prepublishOnly": "yarn build"
+    "prepublishOnly": "yarn build",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "yarn build && changeset publish"
   },
   "devDependencies": {
+    "@changesets/cli": "^2.31.0",
+    "ethers": "^6.16.0",
     "tsup": "^8.5.0",
+    "tsx": "^4.19.0",
     "typescript": "^5.5.4",
     "vitest": "^1.6.0"
   },