@mento-protocol/config 0.1.0

package/dist/thresholds.js

@@ -0,0 +1,33 @@
+// Canonical deviation thresholds shared by every TS package in this monorepo.
+// Pure data — no runtime deps — so it's safe to import from indexer handlers,
+// the metrics-bridge probe, and the dashboard alike.
+//
+// IMPORTANT: alerts/rules/main.tf and alerts/rules/rules-fpmms.tf hard-code
+// these same numbers as HCL literals (1.01 for the OK/WARN boundary, 1.05 for
+// the WARN/CRITICAL boundary). HCL can't import TS exports, so any change here
+// must be mirrored there manually. `scripts/check-deviation-threshold-drift.mjs`
+// enforces that mirror.
+/**
+ * OK/WARN boundary. A pool is considered "within tolerance" while
+ * `priceDifference / rebalanceThreshold ≤ DEVIATION_TOLERANCE_RATIO`.
+ * Strict `>` flips the pool to WARN (or above).
+ *
+ * Mirrors `DEVIATION_TOLERANCE_NUM / DEVIATION_TOLERANCE_DEN` in
+ * `indexer-envio/src/pool/health.ts`; `test/deviationThresholdSharedConfigSync.test.ts`
+ * enforces numeric parity and `test/healthStatusParity.test.ts` enforces
+ * behavioral parity with the dashboard's `computeHealthStatus`.
+ */
+export const DEVIATION_TOLERANCE_RATIO = 1.01;
+/**
+ * WARN/CRITICAL magnitude boundary. A pool past `DEVIATION_TOLERANCE_RATIO`
+ * stays WARN until `priceDifference / rebalanceThreshold > DEVIATION_CRITICAL_RATIO`
+ * AND the breach has outlived `DEVIATION_BREACH_GRACE_SECONDS`. Below this
+ * magnitude, duration alone never escalates a breach to CRITICAL.
+ *
+ * Mirrors `DEVIATION_CRITICAL_NUM / DEVIATION_CRITICAL_DEN` in
+ * `indexer-envio/src/pool/health.ts`; `test/deviationThresholdSharedConfigSync.test.ts`
+ * enforces numeric parity and `test/healthStatusParity.test.ts` enforces
+ * behavioral parity. Also gates the metrics-bridge rebalance-reason probe so
+ * the annotation only attaches to alerts that can actually fire.
+ */
+export const DEVIATION_CRITICAL_RATIO = 1.05;

package/dist/tokens.d.ts

@@ -0,0 +1,15 @@
+export interface ContractEntry {
+    chainId: number;
+    namespace: string;
+    address: string;
+    rawName: string;
+    canonicalName: string;
+    type: "token" | "pool" | "contract";
+    decimals?: number;
+}
+export declare function contractEntries(chainId?: number): ContractEntry[];
+export declare function tokenSymbol(chainId: number, address: string | null): string | null;
+export declare function poolName(chainId: number, token0: string | null, token1: string | null): string | null;
+export declare function chainTokenSymbols(chainId: number): Record<string, string>;
+export declare function chainAddressLabels(chainId: number): Record<string, string>;
+//# sourceMappingURL=tokens.d.ts.map

package/dist/tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAiBA,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAgED,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,aAAa,EAAE,CAGjE;AAED,wBAAgB,WAAW,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GAAG,IAAI,GACrB,MAAM,GAAG,IAAI,CAGf;AAMD,wBAAgB,QAAQ,CACtB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,MAAM,EAAE,MAAM,GAAG,IAAI,GACpB,MAAM,GAAG,IAAI,CAMf;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQzE;AAID,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAM1E"}

package/dist/tokens.js

@@ -0,0 +1,107 @@
+// Canonical token-symbol derivation from @mento-protocol/contracts.
+// `indexer-envio/src/feeToken.ts:buildKnownTokenMeta` is a deliberate mirror
+// with a stricter allowlist (`Mock*` exclusion + `decimals` required) — the
+// indexer can't import this package because Envio builds outside the pnpm
+// workspace. Keep the Spoke/StableToken rules in sync.
+import contractsData from "@mento-protocol/contracts/contracts.json" with { type: "json" };
+import namespaces from "../deployment-namespaces.json" with { type: "json" };
+const NAMESPACES = namespaces;
+const CONTRACTS = contractsData;
+// Monad NTT tokens are published as `USDmSpoke`, `EURmSpoke`, etc.; strip the
+// suffix on tokens only (implementation contracts like `StableTokenSpoke`
+// stay raw for the address book). Guard against `name === "Spoke"` so a
+// hypothetical malformed entry can't canonicalize to an empty symbol.
+function canonicalTokenSymbol(name) {
+    return name.length > 5 && name.endsWith("Spoke") ? name.slice(0, -5) : name;
+}
+// `StableToken*` are implementation contracts; they must not surface as
+// pool-token symbols. `Mock*` is deliberately kept — Sepolia MockERC20*
+// deployments ARE the real pool tokens there.
+function isInternalTokenName(name) {
+    return name.startsWith("StableToken");
+}
+function coerceType(raw) {
+    return raw === "token" || raw === "pool" ? raw : "contract";
+}
+const ALL_ENTRIES = (() => {
+    const out = [];
+    for (const [chainIdStr, perNamespace] of Object.entries(CONTRACTS)) {
+        const ns = NAMESPACES[chainIdStr];
+        if (!ns)
+            continue;
+        const entries = perNamespace[ns];
+        if (!entries)
+            continue;
+        const chainId = Number(chainIdStr);
+        for (const [rawName, info] of Object.entries(entries)) {
+            const type = coerceType(info.type);
+            const canonicalName = type === "token" ? canonicalTokenSymbol(rawName) : rawName;
+            out.push({
+                chainId,
+                namespace: ns,
+                address: info.address.toLowerCase(),
+                rawName,
+                canonicalName,
+                type,
+                ...(info.decimals !== undefined && { decimals: info.decimals }),
+            });
+        }
+    }
+    return out;
+})();
+const ENTRIES_BY_CHAIN = new Map();
+for (const e of ALL_ENTRIES) {
+    const list = ENTRIES_BY_CHAIN.get(e.chainId) ?? [];
+    list.push(e);
+    ENTRIES_BY_CHAIN.set(e.chainId, list);
+}
+const TOKEN_SYMBOL_INDEX = new Map();
+for (const e of ALL_ENTRIES) {
+    if (e.type !== "token")
+        continue;
+    if (isInternalTokenName(e.rawName))
+        continue;
+    TOKEN_SYMBOL_INDEX.set(`${e.chainId}:${e.address}`, e.canonicalName);
+}
+export function contractEntries(chainId) {
+    if (chainId === undefined)
+        return ALL_ENTRIES.slice();
+    return (ENTRIES_BY_CHAIN.get(chainId) ?? []).slice();
+}
+export function tokenSymbol(chainId, address) {
+    if (!address)
+        return null;
+    return TOKEN_SYMBOL_INDEX.get(`${chainId}:${address.toLowerCase()}`) ?? null;
+}
+const USDM_SYMBOL = "USDm";
+// Pool display name like "GBPm/USDm" with USDm always last. Returns null if
+// either leg cannot be resolved.
+export function poolName(chainId, token0, token1) {
+    const sym0 = tokenSymbol(chainId, token0);
+    const sym1 = tokenSymbol(chainId, token1);
+    if (!sym0 || !sym1)
+        return null;
+    if (sym0 === USDM_SYMBOL && sym1 !== USDM_SYMBOL)
+        return `${sym1}/${sym0}`;
+    return `${sym0}/${sym1}`;
+}
+export function chainTokenSymbols(chainId) {
+    const out = {};
+    for (const e of ENTRIES_BY_CHAIN.get(chainId) ?? []) {
+        if (e.type !== "token")
+            continue;
+        if (isInternalTokenName(e.rawName))
+            continue;
+        out[e.address] = e.canonicalName;
+    }
+    return out;
+}
+// Every entry for a chain (tokens + non-tokens) as address → name. Token
+// names canonicalized; implementation names kept raw for address-book use.
+export function chainAddressLabels(chainId) {
+    const out = {};
+    for (const e of ENTRIES_BY_CHAIN.get(chainId) ?? []) {
+        out[e.address] = e.canonicalName;
+    }
+    return out;
+}

package/dist/units.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Convert a raw on-chain uint256 balance to a human-units number without
+ * losing precision when the raw value exceeds 2^53. `Number(bigint) /
+ * 10**decimals` truncates bits past 2^53, which for an 18-decimal token
+ * kicks in around 9M whole tokens — well within realistic supplies. We
+ * scale down in BigInt first so the Number cast is always safe.
+ *
+ * Fractional precision is capped at 6 digits (far more than the tooltip
+ * needs) to keep the final Number representation lossless. Mirrored
+ * historically across `metrics-bridge/src/rebalance-check.ts` and
+ * `ui-dashboard/src/lib/rebalance-check.ts` — kept here as the single
+ * source of truth so the alert annotation and the dashboard tooltip
+ * always agree on rendered units.
+ */
+export declare function toHumanUnits(raw: bigint, decimals: number): number;
+//# sourceMappingURL=units.d.ts.map

package/dist/units.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../src/units.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CASlE"}

package/dist/units.js

@@ -0,0 +1,25 @@
+/**
+ * Convert a raw on-chain uint256 balance to a human-units number without
+ * losing precision when the raw value exceeds 2^53. `Number(bigint) /
+ * 10**decimals` truncates bits past 2^53, which for an 18-decimal token
+ * kicks in around 9M whole tokens — well within realistic supplies. We
+ * scale down in BigInt first so the Number cast is always safe.
+ *
+ * Fractional precision is capped at 6 digits (far more than the tooltip
+ * needs) to keep the final Number representation lossless. Mirrored
+ * historically across `metrics-bridge/src/rebalance-check.ts` and
+ * `ui-dashboard/src/lib/rebalance-check.ts` — kept here as the single
+ * source of truth so the alert annotation and the dashboard tooltip
+ * always agree on rendered units.
+ */
+export function toHumanUnits(raw, decimals) {
+    if (decimals <= 0)
+        return Number(raw);
+    // BigInt(...) call form rather than `10n` literal — the ui-dashboard
+    // tsconfig targets ES2017, which doesn't emit BigInt literals.
+    const divisor = BigInt(10) ** BigInt(decimals);
+    const whole = raw / divisor;
+    const fractionScale = BigInt(1_000_000);
+    const fraction = ((raw % divisor) * fractionScale) / divisor;
+    return Number(whole) + Number(fraction) / Number(fractionScale);
+}

package/fx-calendar.json

@@ -0,0 +1,7 @@
+{
+  "fxCloseDay": 5,
+  "fxCloseHourUtc": 21,
+  "fxReopenDay": 0,
+  "fxReopenHourUtc": 23,
+  "anchorFri2100UnixSec": 1704488400
+}

package/oracle-reporters.json

@@ -0,0 +1,123 @@
+{
+  "42220": {
+    "feeds": {
+      "0x0f61ba9c30ef7caee7e5cc1f96bffcb0f52ccd64": {
+        "pair": "CHF/USD",
+        "type": "CHAINLINK"
+      },
+      "0x26076b9702885d475ac8c3db3bd9f250dc5a318b": {
+        "pair": "EUR/USD",
+        "type": "CHAINLINK"
+      },
+      "0xa1a8003936862e7a15092a91898d69fa8bce290c": {
+        "pair": "USDC/USD",
+        "type": "CHAINLINK"
+      },
+      "0xfde35b45cbd2504fb5dc514f007bc2de27034274": {
+        "pair": "JPY/USD",
+        "chainlinkSlug": "jpy-usd-fx",
+        "type": "CHAINLINK"
+      },
+      "0xf4f9bbda9cd6841fcb9b1510f9269e2db42a6e3a": {
+        "pair": "EUR/USD",
+        "type": "CHAINLINK"
+      },
+      "0xf590b62f9cfcc6409075b1ecac8176fe25744b88": {
+        "pair": "GBP/USD",
+        "type": "CHAINLINK"
+      },
+      "0xe06c10c63377cd098b589c0b90314bfb55751558": {
+        "pair": "USDT/USD",
+        "type": "CHAINLINK"
+      }
+    },
+    "reporters": {
+      "0x1b904277b22ca598ef17b38f64de5f9c29cd31bd": {
+        "type": "CHAINLINK",
+        "name": "Chainlink CHF/USD"
+      },
+      "0x6490a3ffad86ca14ff84be380d5639fb8fbd311b": {
+        "type": "CHAINLINK",
+        "name": "Chainlink EUR/USD or USDC/USD"
+      },
+      "0x1327a32fa7e3a0c3c0a5828d4f3ff16ce9e13ee9": {
+        "type": "CHAINLINK",
+        "name": "Chainlink JPY/USD"
+      },
+      "0xc4918a76a7fdb113f2dfa9b162e875f271a2f7b8": {
+        "type": "CHAINLINK",
+        "name": "Chainlink EUR/USD"
+      },
+      "0x215d3ba962597defb38da439ed4db8e8a63e409a": {
+        "type": "CHAINLINK",
+        "name": "Chainlink GBP/USD"
+      },
+      "0x564dd5fec58e7103c2a6041b7dd1bb3074a4616b": {
+        "type": "CHAINLINK",
+        "name": "Chainlink USDT/USD"
+      }
+    }
+  },
+  "143": {
+    "feeds": {
+      "0xac414205651f4a62b614b6be9e5318a182c33eb0": {
+        "pair": "USDT/USD",
+        "type": "CHAINLINK"
+      },
+      "0xf47172ce00522cc7db02109634a92ce866a15fcc": {
+        "pair": "AUSD/USD",
+        "type": "CHAINLINK"
+      },
+      "0xec57482aa55e3ad026c315a0e4a692b776c318ca": {
+        "pair": "EUR/USD",
+        "type": "CHAINLINK"
+      },
+      "0xea4103a6a122fbe2cdb07a80d4d293be07bb29fa": {
+        "pair": "GBP/USD",
+        "type": "CHAINLINK"
+      },
+      "0x81a313ff894bfc6093d33b5514e34d7faa41b7ef": {
+        "pair": "USDC/USD",
+        "type": "CHAINLINK"
+      },
+      "0x2ee56be22d6af8c1b0ac97149b6f42d3b0bfb8c2": {
+        "pair": "CHF/USD",
+        "type": "CHAINLINK"
+      },
+      "0xb9addcd1d1ce7d49dbb540e2677f1c572bc8d195": {
+        "pair": "JPY/USD",
+        "type": "CHAINLINK"
+      }
+    },
+    "reporters": {
+      "0x0fb76625e4f43b8183d7c899df13024cbe030b0d": {
+        "type": "CHAINLINK",
+        "name": "ChainlinkRelayerV1USDTUSD"
+      },
+      "0x2604f6dafed5b6204868e15e89ca41c2d5f6d9c2": {
+        "type": "CHAINLINK",
+        "name": "ChainlinkRelayerV1AUSDUSD"
+      },
+      "0x1de9678363193412264911ebcc797c54da09ecbf": {
+        "type": "CHAINLINK",
+        "name": "ChainlinkRelayerV1EURUSD"
+      },
+      "0xdb8fc8c6daac8f73e21e9cc145440ab899d60e55": {
+        "type": "CHAINLINK",
+        "name": "ChainlinkRelayerV1GBPUSD"
+      },
+      "0xb1683db4d2d74e951c54314f1bca1e8fbb299fe2": {
+        "type": "CHAINLINK",
+        "name": "ChainlinkRelayerV1USDCUSD"
+      },
+      "0xf091f44a7b8cb8c57747275496fdb9957b3d0909": {
+        "type": "CHAINLINK",
+        "name": "ChainlinkRelayerV1CHFUSD"
+      },
+      "0x30fa361bd8315926e6ef4ceb88a353fab5a11f86": {
+        "type": "CHAINLINK",
+        "name": "ChainlinkRelayerV1JPYUSD"
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@mento-protocol/config",
+  "version": "0.1.0",
+  "private": false,
+  "type": "module",
+  "description": "Public Mento protocol metadata for chain IDs, deployment namespaces, token labels, FX calendars, thresholds, and shared ABIs.",
+  "license": "GPL-3.0-only",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mento-protocol/monitoring-monorepo",
+    "directory": "shared-config"
+  },
+  "files": [
+    "dist",
+    "deployment-namespaces.json",
+    "fx-calendar.json",
+    "chain-metadata.json",
+    "aggregators.json",
+    "oracle-reporters.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    "./deployment-namespaces.json": "./deployment-namespaces.json",
+    "./fx-calendar.json": "./fx-calendar.json",
+    "./chain-metadata.json": "./chain-metadata.json",
+    "./aggregators.json": "./aggregators.json",
+    "./oracle-reporters.json": "./oracle-reporters.json",
+    "./deployment-namespaces": {
+      "types": "./dist/deployment-namespaces.d.ts",
+      "default": "./dist/deployment-namespaces.js"
+    },
+    "./fx-calendar": {
+      "types": "./dist/fx-calendar.d.ts",
+      "default": "./dist/fx-calendar.js"
+    },
+    "./chains": {
+      "types": "./dist/chains.d.ts",
+      "default": "./dist/chains.js"
+    },
+    "./aggregators": {
+      "types": "./dist/aggregators.d.ts",
+      "default": "./dist/aggregators.js"
+    },
+    "./oracle-reporters": {
+      "types": "./dist/oracle-reporters.d.ts",
+      "default": "./dist/oracle-reporters.js"
+    },
+    "./tokens": {
+      "types": "./dist/tokens.d.ts",
+      "default": "./dist/tokens.js"
+    },
+    "./format": {
+      "types": "./dist/format.d.ts",
+      "default": "./dist/format.js"
+    },
+    "./rebalance-abi": {
+      "types": "./dist/rebalance-abi.d.ts",
+      "default": "./dist/rebalance-abi.js"
+    },
+    "./erc20-abi": {
+      "types": "./dist/erc20-abi.d.ts",
+      "default": "./dist/erc20-abi.js"
+    },
+    "./thresholds": {
+      "types": "./dist/thresholds.d.ts",
+      "default": "./dist/thresholds.js"
+    },
+    "./units": {
+      "types": "./dist/units.d.ts",
+      "default": "./dist/units.js"
+    },
+    "./protocol-fee": {
+      "types": "./dist/protocol-fee.d.ts",
+      "default": "./dist/protocol-fee.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "lint": "node ../scripts/eslint-baseline-diff.mjs check",
+    "lint:baseline:update": "node ../scripts/eslint-baseline-diff.mjs update",
+    "knip": "knip --config knip.json --no-progress",
+    "knip:report": "knip --config knip.json --no-exit-code --no-progress",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@mento-protocol/contracts": "0.8.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^24.10.1",
+    "@vitest/coverage-v8": "^4.1.0",
+    "eslint": "^10.0.2",
+    "eslint-plugin-sonarjs": "4.0.3",
+    "eslint-plugin-unused-imports": "^4.2.0",
+    "globals": "^17.4.0",
+    "knip": "6.12.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.56.1",
+    "vitest": "^4.1.0"
+  },
+  "engines": {
+    "node": ">=24"
+  }
+}