@temporalabs/treasury 0.1.0 → 0.1.2

package/dist/registry.d.ts

@@ -1,4 +1,5 @@
 import { type Registry, type VaultEntry } from "./registry-schema.js";
+import { type ChainKey, type SupportedChainId } from "./client.js";
 /** Parses and validates the shipped registry. Throws on any schema violation — a registry that does not parse is not a registry. */
 export declare function loadRegistry(): Registry;
 /**
@@ -11,14 +12,36 @@ export declare function loadRegistry(): Registry;
 export declare function __setRegistryForTests(r: Registry | undefined): void;
 export declare function listVaults(): VaultEntry[];
 export declare function getVault(symbol: string): VaultEntry;
+/** The chain used when a caller names neither a chain nor a vault: `EARN.defaultChain`. */
+export declare function defaultChainId(): SupportedChainId;
 /**
- * The vault the tools use when the caller names none: `EARN.defaultVault` (config/earn.ts — the
- * toggle), which the registry must also mark `isDefault` (the measurement; the schema guarantees exactly
- * one and that it is open). A disagreement between the two is refused, never resolved silently.
+ * The chains a caller can name: every supported chain with at least one vault in the registry, the
+ * default chain first. A chain this client supports and the registry has no vault on is not
+ * offered — there is nothing to do there.
  */
-export declare function defaultVault(): VaultEntry;
-/** Resolves an optional ticker to a vault: the named one, or the default. */
-export declare function resolveVault(symbol?: string): VaultEntry;
+export declare function offeredChains(): {
+    key: ChainKey;
+    chainId: SupportedChainId;
+    name: string;
+}[];
+/**
+ * The vault the tools use on a chain when the caller names none: `EARN.defaultVaultByChain`
+ * (config/earn.ts — the toggle), which the registry must also mark `isDefault` (the measurement; the
+ * schema guarantees exactly one per chain and that it is open or whitelist-gated). A disagreement
+ * between the two is refused, never resolved silently. With no argument: the default chain's.
+ */
+export declare function defaultVault(chainId?: SupportedChainId): VaultEntry;
+/**
+ * Resolves an optional ticker and an optional chain to ONE vault:
+ *
+ *   neither      the default chain's default vault
+ *   chain only   that chain's default vault
+ *   vault only   that vault, on whatever chain it is on
+ *   both         that vault, and it must be on that chain — a disagreement is REFUSED, never
+ *                resolved by picking one, because the two answers are different contracts on
+ *                different chains and the caller meant exactly one of them.
+ */
+export declare function resolveVault(symbol?: string, chain?: string): VaultEntry;
 /**
  * The vaults this client can put money into: ACTIVE, on an ERC-4626 chassis, and MEASURED open.
  * This is the rule, not a list — the count moves as vaults are provisioned, gated, or retired.

package/dist/registry.js

@@ -1,15 +1,25 @@
-import { readFileSync } from "node:fs";
-import { fileURLToPath } from "node:url";
+import { readFileSync, realpathSync } from "node:fs";
+import { fileURLToPath, pathToFileURL } from "node:url";
 import { registrySchema, erc4626Chassis } from "./registry-schema.js";
 import { EARN } from "./config/earn.js";
-const REGISTRY_URL = new URL("../registry/vaults.json", import.meta.url);
+import { CHAIN_INFO, chainIdForKey, supportedChainIds } from "./client.js";
+// From this file's real path, not a symlink's: see PACKAGE_JSON_URL in version.ts.
+const REGISTRY_URL = new URL("../registry/vaults.json", pathToFileURL(realpathSync(fileURLToPath(import.meta.url))));
 let cached;
 /** Parses and validates the shipped registry. Throws on any schema violation — a registry that does not parse is not a registry. */
 export function loadRegistry() {
     if (cached)
         return cached;
     const raw = JSON.parse(readFileSync(fileURLToPath(REGISTRY_URL), "utf8"));
-    cached = registrySchema.parse(raw);
+    const parsed = registrySchema.parse(raw);
+    // The schema holds one default per chain THAT HAS A VAULT, so it cannot see a registry with no
+    // vault on the default chain at all — and then the discovery call itself is what fails, with an
+    // error about a chain nobody asked for. Refuse the file here, where the cause can be named.
+    const chainId = defaultChainId();
+    if (!parsed.vaults.some((v) => v.chainId === chainId)) {
+        throw new Error(`the registry has no vault on ${CHAIN_INFO[chainId].name}, which config/earn.ts names as the default chain; add one or change defaultChain`);
+    }
+    cached = parsed;
     return cached;
 }
 /**
@@ -35,22 +45,76 @@ export function getVault(symbol) {
     }
     return v;
 }
+/** The chain used when a caller names neither a chain nor a vault: `EARN.defaultChain`. */
+export function defaultChainId() {
+    const id = chainIdForKey(EARN.defaultChain);
+    if (id === undefined)
+        throw new Error(`config/earn.ts names "${EARN.defaultChain}" as the default chain, which this client does not support`);
+    return id;
+}
 /**
- * The vault the tools use when the caller names none: `EARN.defaultVault` (config/earn.ts — the
- * toggle), which the registry must also mark `isDefault` (the measurement; the schema guarantees exactly
- * one and that it is open). A disagreement between the two is refused, never resolved silently.
+ * The chains a caller can name: every supported chain with at least one vault in the registry, the
+ * default chain first. A chain this client supports and the registry has no vault on is not
+ * offered — there is nothing to do there.
  */
-export function defaultVault() {
-    const v = getVault(EARN.defaultVault);
-    if (!v.isDefault) {
-        const marked = loadRegistry().vaults.find((x) => x.isDefault)?.symbol ?? "(none)";
-        throw new Error(`config/earn.ts names "${EARN.defaultVault}" as the default but the registry marks "${marked}"; change both or neither`);
+export function offeredChains() {
+    const present = new Set(loadRegistry().vaults.map((v) => v.chainId));
+    const first = defaultChainId();
+    return supportedChainIds
+        .filter((id) => present.has(id))
+        .sort((a, b) => (a === first ? -1 : b === first ? 1 : 0)) // stable: the rest keep `supportedChainIds` order
+        .map((id) => ({ key: CHAIN_INFO[id].key, chainId: id, name: CHAIN_INFO[id].name }));
+}
+/**
+ * The vault the tools use on a chain when the caller names none: `EARN.defaultVaultByChain`
+ * (config/earn.ts — the toggle), which the registry must also mark `isDefault` (the measurement; the
+ * schema guarantees exactly one per chain and that it is open or whitelist-gated). A disagreement
+ * between the two is refused, never resolved silently. With no argument: the default chain's.
+ */
+export function defaultVault(chainId = defaultChainId()) {
+    const key = CHAIN_INFO[chainId].key;
+    const named = EARN.defaultVaultByChain[key];
+    const marked = loadRegistry().vaults.find((x) => x.chainId === chainId && x.isDefault);
+    if (marked === undefined) {
+        throw new Error(`no vault is offered on ${CHAIN_INFO[chainId].name}; chains with a vault: ${offeredChains().map((c) => c.key).join(", ")}`);
     }
-    return v;
+    if (marked.symbol !== named) {
+        throw new Error(`config/earn.ts names "${named}" as the default on ${key} but the registry marks "${marked.symbol}"; change both or neither`);
+    }
+    return marked;
 }
-/** Resolves an optional ticker to a vault: the named one, or the default. */
-export function resolveVault(symbol) {
-    return symbol ? getVault(symbol) : defaultVault();
+/**
+ * Resolves an optional ticker and an optional chain to ONE vault:
+ *
+ *   neither      the default chain's default vault
+ *   chain only   that chain's default vault
+ *   vault only   that vault, on whatever chain it is on
+ *   both         that vault, and it must be on that chain — a disagreement is REFUSED, never
+ *                resolved by picking one, because the two answers are different contracts on
+ *                different chains and the caller meant exactly one of them.
+ */
+export function resolveVault(symbol, chain) {
+    let chainId;
+    // An EMPTY string is an omitted argument, for `chain` exactly as for `vault` (`!symbol` below):
+    // a host that sends "" for every optional it did not fill must get the default, not a refusal.
+    if (chain) {
+        chainId = chainIdForKey(chain);
+        const offered = offeredChains();
+        if (chainId === undefined || !offered.some((c) => c.chainId === chainId)) {
+            throw new Error(`unknown chain "${chain}"; chains with a vault: ${offered.map((c) => c.key).join(", ")}`);
+        }
+    }
+    if (!symbol)
+        return defaultVault(chainId);
+    const v = getVault(symbol);
+    if (chainId !== undefined && v.chainId !== chainId) {
+        const on = loadRegistry()
+            .vaults.filter((x) => x.chainId === chainId)
+            .map((x) => x.symbol)
+            .join(", ");
+        throw new Error(`vault "${symbol}" is on ${CHAIN_INFO[v.chainId].key}, not ${chain}. Name one or the other: drop \`chain\` to use ${symbol} on ${CHAIN_INFO[v.chainId].key}, or pick a vault on ${chain} (${on}).`);
+    }
+    return v;
 }
 /**
  * The vaults this client can put money into: ACTIVE, on an ERC-4626 chassis, and MEASURED open.

package/dist/registry.js.map

@@ -1 +1 @@
-{"version":3,"file":"registry.js","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,cAAc,EAAkC,MAAM,sBAAsB,CAAC;AACtG,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,yBAAyB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEzE,IAAI,MAA4B,CAAC;AAEjC,oIAAoI;AACpI,MAAM,UAAU,YAAY;IAC1B,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAY,CAAC;IACrF,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAAC,CAAuB;IAC3D,MAAM,GAAG,CAAC,CAAC;AACb,CAAC;AAED,MAAM,UAAU,UAAU;IACxB,OAAO,YAAY,EAAE,CAAC,MAAM,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAc;IACrC,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;IACjE,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,KAAK,GAAG,YAAY,EAAE;aACzB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;aAC3B,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,aAAa,KAAK,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACtC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;QACjB,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,MAAM,IAAI,QAAQ,CAAC;QAClF,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,CAAC,YAAY,4CAA4C,MAAM,2BAA2B,CAAC,CAAC;IAC3I,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,YAAY,CAAC,MAAe;IAC1C,OAAO,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB;IAC/B,OAAO,YAAY,EAAE,CAAC,MAAM,CAAC,MAAM,CACjC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,IAAI,CAC3D,CAAC;AACJ,CAAC"}
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAkC,MAAM,sBAAsB,CAAC;AACtG,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,iBAAiB,EAAwC,MAAM,aAAa,CAAC;AAEjH,mFAAmF;AACnF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,yBAAyB,EAAE,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAErH,IAAI,MAA4B,CAAC;AAEjC,oIAAoI;AACpI,MAAM,UAAU,YAAY;IAC1B,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAY,CAAC;IACrF,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzC,+FAA+F;IAC/F,gGAAgG;IAChG,4FAA4F;IAC5F,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,KAAK,CAAC,gCAAgC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,mFAAmF,CAAC,CAAC;IAC/J,CAAC;IACD,MAAM,GAAG,MAAM,CAAC;IAChB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAAC,CAAuB;IAC3D,MAAM,GAAG,CAAC,CAAC;AACb,CAAC;AAED,MAAM,UAAU,UAAU;IACxB,OAAO,YAAY,EAAE,CAAC,MAAM,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAc;IACrC,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;IACjE,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,KAAK,GAAG,YAAY,EAAE;aACzB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;aAC3B,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,aAAa,KAAK,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,cAAc;IAC5B,MAAM,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5C,IAAI,EAAE,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,CAAC,YAAY,4DAA4D,CAAC,CAAC;IAC9I,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,MAAM,KAAK,GAAG,cAAc,EAAE,CAAC;IAC/B,OAAO,iBAAiB;SACrB,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SAC/B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,kDAAkD;SAC3G,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AACxF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,UAA4B,cAAc,EAAE;IACvE,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC;IACpC,MAAM,KAAK,GAAW,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACpD,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC;IACvF,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,0BAA0B,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,0BAA0B,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9I,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,yBAAyB,KAAK,uBAAuB,GAAG,4BAA4B,MAAM,CAAC,MAAM,2BAA2B,CAAC,CAAC;IAChJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY,CAAC,MAAe,EAAE,KAAc;IAC1D,IAAI,OAAqC,CAAC;IAC1C,gGAAgG;IAChG,+FAA+F;IAC/F,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAChC,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,EAAE,CAAC;YACzE,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,2BAA2B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5G,CAAC;IACH,CAAC;IACD,IAAI,CAAC,MAAM;QAAE,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3B,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QACnD,MAAM,EAAE,GAAG,YAAY,EAAE;aACtB,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC;aAC3C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;aACpB,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,IAAI,KAAK,CACb,UAAU,MAAM,WAAW,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,KAAK,kDAAkD,MAAM,OAAO,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,wBAAwB,KAAK,KAAK,EAAE,IAAI,CACnM,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB;IAC/B,OAAO,YAAY,EAAE,CAAC,MAAM,CAAC,MAAM,CACjC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,IAAI,CAC3D,CAAC;AACJ,CAAC"}