CheapGM: add revenue adapter (v2) — treasury net inflow, multi-chain

fees/CheapGM/index.ts

@@ -0,0 +1,313 @@
+import { Adapter, FetchOptions } from "../../adapters/types";
+import { CHAIN } from "../../helpers/chains";
+
+const TREASURY = "0x21ad6ef3979638d8e73747f22b92c4aade145d82".toLowerCase();
+const start = "2025-08-11";
+
+
+const COUNTERS: Record<string, string[]> = {
+
+  [CHAIN.BASE]: [
+    "0x8fc7aa44971a7b111017fc435ef6daf10bf1b887",
+    "0x8ccd9c0a9c084412416a85fd748c7f1e9b86442d",
+  ],
+  [CHAIN.LINEA]: [
+    "0xc11ee6c94a86e18481d9206c29ecdd3b40c59898",
+    "0x0246d65ba41da3db6db55e489146eb25ca3634e5",
+  ],
+  [CHAIN.SCROLL]: [
+    "0x064dacc2f126f036d77cd4b8887efedb2f5201fe",
+    "0x53092f84ef2460d8517f011f7722125758de5aa2",
+  ],
+  [CHAIN.MANTLE]: [
+    "0xc11ee6c94a86e18481d9206c29ecdd3b40c59898",
+    "0x0246d65ba41da3db6db55e489146eb25ca3634e5",
+  ],
+  [CHAIN.CRONOS]: [
+    "0xc11ee6c94a86e18481d9206c29ecdd3b40c59898",
+    "0x0246d65ba41da3db6db55e489146eb25ca3634e5",
+  ],
+  [CHAIN.CELO]: [
+    "0xc11ee6c94a86e18481d9206c29ecdd3b40c59898",
+    "0x0246d65ba41da3db6db55e489146eb25ca3634e5",
+  ],
+  [CHAIN.BSC]: [
+    "0xc11ee6c94a86e18481d9206c29ecdd3b40c59898",
+    "0x0246d65ba41da3db6db55e489146eb25ca3634e5",
+  ],
+  [CHAIN.ABSTRACT]: [
+    "0xe94158b16cd46b190f74a2ccbff7fdecf0da8bf4",
+    "0xefb45cd4cff4d11d4b029659e618daacd8d18f3",
+  ],
+  [CHAIN.KLAYTN]: [ 
+    "0x5fcea004bc26308bc91d8599dba4a271c57cba85",
+    "0x72fe6c968d0da46f45e65923330a262a1f75963c",
+  ],
+  [CHAIN.BERACHAIN]: [
+    "0x2522bfee6451f7a1f64e3ab287d8cf46c173601f",
+    "0x9cad0d6a8927cb0757f435b8e5ecb6b095862596",
+  ],
+  [CHAIN.OPTIMISM]: [
+    "0xc11ee6c94a86e18481d9206c29ecdd3b40c59898",
+    "0x0246d65ba41da3db6db55e489146eb25ca3634e5",
+  ],
+  [CHAIN.UNICHAIN]: [
+    "0x30efc910a135d73016a788fdd9a9e8b022dea208",
+    "0xff4e5275f5b1b69e94773fa4134be4c752c42705",
+  ],
+  [CHAIN.INK]: [
+    "0x3033d7ded400547d6442c55159da5c61f2721633",
+    "0x63c489d31a2c3de0638360931f47ff066282473f",
+  ],
+  [CHAIN.SONEIUM]: [
+    "0x6baaa0653e53f92e11316973bfc1fc8291fc6f58",
+    "0xdefe1db2713ba0c51334343dca576bd5f4e793b2",
+  ],
+  [CHAIN.BOB]: [
+    "0xc11ee6c94a86e18481d9206c29ecdd3b40c59898",
+    "0x0246d65ba41da3db6db55e489146eb25ca3634e5",
+  ],
+  [CHAIN.PLUME_MAINNET]: [
+    "0x86683f28df33adcd1cadc815855102c1685731fc",
+    "0x6e126d13a5451780401804f55cec3686192d29f7",
+  ],
+  [CHAIN.CONFLUX]: [
+    "0x649617c710776c6ac41be36eda94929654a685a7",
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+  ],
+  [CHAIN.LISK]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.ZIRCUIT]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.METIS]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.ARBITRUM]: [
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+    "0x6c8de6c102a844b885291d1ce1cafdacf0a553d8",
+  ],
+  [CHAIN.AVAX]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.SONIC]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.XDAI]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.TAIKO]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.APECHAIN]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.BLAST]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.ANCIENT8]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.BTNX]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.ZORA]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.XLAYER]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.MORPH]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.MANTA]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.CORE]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.REDSTONE]: [
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+  ],
+  [CHAIN.CRONOS]: [
+    "0xc11ee6c94a86e18481d9206c29ecdd3b40c59898",
+    "0x0246d65ba41da3db6db55e489146eb25ca3634e5",
+  ],
+  [CHAIN.XAI]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+  [CHAIN.POLYGON_ZKEVM]: [
+    "0xf617d89a811a39f06f5271f89db346a0ae297f71",
+    "0x2f96d7dd813b8e17071188791b78ea3fab5c109c",
+  ],
+};
+
+
+const abis = {
+  GMSent: "event GMSent(address indexed sender, address indexed referral)",
+  fee: "function fee() view returns (uint256)",
+  referralFees: "function referralFees() view returns (uint256)",
+};
+
+
+function pick(...keys: string[]) {
+  for (const k of keys) {
+    const v = (CHAIN as any)[k];
+    if (typeof v === "string" && v.length) return v;
+  }
+  return undefined;
+}
+function toBig(v: any): bigint {
+  try {
+    if (v == null) return 0n;
+    if (typeof v === "bigint") return v;
+    if (typeof v === "number") return BigInt(Math.trunc(v));
+    if (typeof v === "string") return v.startsWith("0x") ? BigInt(v) : BigInt(v);
+  } catch {}
+  return 0n;
+}
+
+
+async function computeGrossByLogs(opts: FetchOptions, chainSlug: string): Promise<bigint> {
+  const counters = COUNTERS[chainSlug];
+  if (!counters?.length) return 0n;
+
+  const from_block = (opts as any).fromBlock;
+  const to_block = (opts as any).toBlock;
+  const BASIS = 10000n;
+  let total = 0n;
+
+  for (const counter of counters) {
+    const logs = (await opts.getLogs({
+      target: counter,
+      fromBlock: from_block,
+      toBlock: to_block,
+      eventAbi: abis.GMSent,
+      entireLog: true,
+    }).catch(() => [])) as any[];
+
+    if (!logs.length) continue;
+
+    const [feeWei, refBpRaw] = await Promise.all([
+      (opts as any).api.call({ target: counter, abi: abis.fee, block: to_block }).catch(() => 0),
+      (opts as any).api.call({ target: counter, abi: abis.referralFees, block: to_block }).catch(() => 0),
+    ]);
+    const fee = toBig(feeWei);
+    const refBP = toBig(refBpRaw);
+
+    let withRef = 0n, noRef = 0n;
+    for (const e of logs) {
+      const ref = e?.args?.referral ?? e?.args?.[1] ?? "0x0000000000000000000000000000000000000000";
+      const isZero = typeof ref === "string" ? /^0x0{40}$/i.test(ref) : (!ref);
+      if (isZero) noRef += 1n; else withRef += 1n;
+    }
+    const perWithRef = fee * (BASIS - refBP) / BASIS;
+    total += fee * noRef + perWithRef * withRef;
+  }
+  return total > 0n ? total : 0n;
+}
+
+
+async function computeNetByBalance(opts: FetchOptions): Promise<bigint> {
+  try {
+    const [balStart, balEnd] = await Promise.all([
+      opts.getBalance({ target: TREASURY, block: (opts as any).fromBlock }),
+      opts.getBalance({ target: TREASURY, block: (opts as any).toBlock }),
+    ]);
+    const delta = toBig(balEnd) - toBig(balStart);
+    return delta > 0n ? delta : 0n;
+  } catch { return 0n; }
+}
+
+
+const CANDIDATE_SLUGS = [
+  pick('ETHEREUM'), pick('BASE'), pick('OPTIMISM'), pick('ARBITRUM'),
+  pick('BSC'), pick('POLYGON'), pick('AVAX'),
+  pick('SCROLL'), pick('MANTLE'), pick('LINEA'),
+  pick('BERACHAIN'),
+  pick('CORE','COREDAO'),
+  pick('REDSTONE'),
+  pick('UNICHAIN'),
+  pick('INK'),
+  pick('SONEIUM'),
+  pick('PLUME_MAINNET','PLUME'),
+  pick('ZORA'),
+  pick('BLAST'),
+  pick('MODE'),
+  pick('METIS'),
+  pick('RONIN'),
+  pick('XDAI','GNOSIS'),
+  pick('CELO'),
+  pick('CONFLUX'),
+  pick('LISK'),
+  pick('APECHAIN'),
+  pick('XLAYER','X_LAYER'),
+  pick('BTNX','BOTANIX'),
+  pick('BOB'),
+  pick('ABSTRACT'),
+  pick('ZIRCUIT'),
+  pick('MORPH'),
+  pick('MANTA','MANTA_PACIFIC'),
+  pick('ANCIENT8'),
+  pick('KLAYTN','KAIA'),
+  pick('CRONOS'),
+  pick('XAI'),
+  pick('WORLDCHAIN','WORLD_CHAIN'),
+  pick('SONIC'),
+  pick('TAIKO'),
+  pick('POLYGON_ZKEVM'),
+].filter(Boolean) as string[];
+
+
+function buildFetch(chainSlug: string) {
+  return async (opts: FetchOptions) => {
+    const dailyFees = opts.createBalances();
+
+
+    let gross = 0n;
+    try { gross = await computeGrossByLogs(opts, chainSlug); } catch {}
+    if (gross > 0n) {
+      dailyFees.addGasToken(gross);
+      return { dailyFees, dailyRevenue: dailyFees };
+    }
+
+
+    const net = await computeNetByBalance(opts);
+    if (net > 0n) dailyFees.addGasToken(net);
+    return { dailyFees, dailyRevenue: dailyFees };
+  };
+}
+
+const adapter: Adapter = {
+  version: 2,
+  adapter: Object.fromEntries(
+    CANDIDATE_SLUGS.map((slug) => [slug, { fetch: buildFetch(slug), start }]),
+  ),
+  methodology: {
+    Fees:
+      "Sum of per-tx fees from GMCounter logs: if referral is set — fee × (1 − referralFees/BPS), otherwise full fee.",
+    Revenue:
+      "Assumes all fees accrue to protocol treasury. If no GMCounter address provided for a chain, fallback is treasury net inflow (Δbalance) for that chain/day.",
+  },
+};
+
+export default adapter;