@eco-incorp/sauce 0.99.3 → 0.99.5

package/sdk/src/protocols/eco-routes/info.ts

@@ -0,0 +1,14 @@
+import type { ProtocolInfo } from "../../core/types.js";
+
+export const protocolInfo: ProtocolInfo = {
+  name: "Eco Routes",
+  slug: "eco-routes",
+  description:
+    "Eco's cross-chain intent protocol. A Portal publishes an intent, escrows its reward in a per-intent vault, and pays a solver who fulfills the route on the destination chain; a prover carries the proof of that fulfillment back. This is the layer Sauce intents are built on.",
+  website: "https://eco.com",
+  github: "https://github.com/eco/eco-routes",
+  npm: "@eco-foundation/routes-ts",
+  category: "infrastructure",
+  chains: [],
+  audited: true,
+};

package/sdk/src/protocols/eco-routes/lookup.ts

@@ -0,0 +1,215 @@
+/**
+ * Where eco-routes is deployed, for every generation and environment it has been deployed in.
+ *
+ * The addresses come from `addresses.generated.ts`, vendored from `@eco-foundation/routes-ts` at a
+ * pinned version and digest (see `scripts/sync-eco-routes-addresses.mjs`). This module is the part
+ * an application calls: it turns a chain and a choice of deployment into an address, or into an
+ * error that says which of the two was the problem.
+ *
+ * TWO AXES, because two things vary independently.
+ *
+ *  - **Generation.** `v3` is the current one: a single `Portal` that publishes, escrows and
+ *    fulfills. `v2` is the previous one, with separate `IntentSource` and `Inbox` contracts and a
+ *    different ABI. Both are addressable here. Only `v3` can be *built for* by this SDK's intent
+ *    machinery, and asking for `v2` there fails with that sentence rather than with a type error
+ *    three layers down.
+ *  - **Environment.** `default` is production. `staging` is Eco's own staging deployment, a
+ *    different set of addresses on the same chains.
+ *
+ * An absent role means no deployment, not a zero address: the generator drops zero cells precisely
+ * so that a lookup cannot hand back an address that is not one.
+ */
+import { getContractAddress, type Hex } from "viem";
+
+import type { CanonicalChain } from "../../chains/canonical.js";
+import { requireChain, type ChainRef } from "../../chains/canonical.js";
+import { ECO_ROUTES_ADDRESSES } from "./addresses.generated.js";
+
+export type EcoRoutesGeneration = keyof typeof ECO_ROUTES_ADDRESSES;
+export type EcoRoutesEnvironment = "default" | "staging";
+
+/** The current generation, and the one the intent machinery builds for. */
+export const ECO_ROUTES_DEFAULT_GENERATION: EcoRoutesGeneration = "v3";
+export const ECO_ROUTES_DEFAULT_ENVIRONMENT: EcoRoutesEnvironment = "default";
+
+export interface EcoRoutesSelector {
+  readonly generation?: EcoRoutesGeneration;
+  readonly environment?: EcoRoutesEnvironment;
+}
+
+/** Every generation this SDK carries addresses for, with the published version each came from. */
+export function ecoRoutesGenerations(): readonly {
+  readonly generation: EcoRoutesGeneration;
+  readonly version: string;
+  readonly sha256: string;
+  readonly summary: string;
+  readonly roles: readonly string[];
+}[] {
+  return Object.entries(ECO_ROUTES_ADDRESSES).map(([generation, record]) => ({
+    generation: generation as EcoRoutesGeneration,
+    version: record.version,
+    sha256: record.sha256,
+    summary: record.summary,
+    roles: record.roles,
+  }));
+}
+
+function chainIdOf(chain: ChainRef | CanonicalChain): { id: string; slug: string } {
+  const canonical = requireChain(chain as ChainRef);
+  return { id: String(canonical.id), slug: canonical.slug };
+}
+
+function select(selector: EcoRoutesSelector | undefined): {
+  generation: EcoRoutesGeneration;
+  environment: EcoRoutesEnvironment;
+} {
+  return {
+    generation: selector?.generation ?? ECO_ROUTES_DEFAULT_GENERATION,
+    environment: selector?.environment ?? ECO_ROUTES_DEFAULT_ENVIRONMENT,
+  };
+}
+
+/** Every role deployed on `chain` for the selected generation and environment, or `undefined` when
+ *  eco-routes is not deployed there at all. */
+export function ecoRoutesDeployment(
+  chain: ChainRef | CanonicalChain,
+  selector?: EcoRoutesSelector,
+): Readonly<Record<string, Hex>> | undefined {
+  const { generation, environment } = select(selector);
+  const { id } = chainIdOf(chain);
+
+  return (
+    ECO_ROUTES_ADDRESSES[generation].chains as Record<
+      string,
+      Record<string, Record<string, Hex>> | undefined
+    >
+  )[id]?.[environment];
+}
+
+function requireRole(
+  chain: ChainRef | CanonicalChain,
+  role: string,
+  selector: EcoRoutesSelector | undefined,
+): Hex {
+  const { generation, environment } = select(selector);
+  const { id, slug } = chainIdOf(chain);
+  const deployment = ecoRoutesDeployment(chain, selector);
+  const where = `eco-routes ${generation}${environment === "default" ? "" : `/${environment}`}`;
+
+  if (deployment === undefined) {
+    const deployed = Object.keys(ECO_ROUTES_ADDRESSES[generation].chains).join(", ");
+    throw new Error(
+      `${where} is not deployed on ${slug} (chain ${id}). Deployed on: ${deployed}. Pass an explicit ` +
+        `address if you are targeting a deployment this SDK does not carry.`,
+    );
+  }
+  const address = deployment[role];
+  if (address === undefined) {
+    const present = Object.keys(deployment).join(", ") || "nothing";
+    throw new Error(
+      `${where} on ${slug} (chain ${id}) has no ${role}. It has: ${present}. Choose a different ` +
+        `${role === "Portal" ? "chain" : "prover"}, or pass an explicit address.`,
+    );
+  }
+  return address;
+}
+
+/** The Portal on `chain` — where an intent is published, funded and fulfilled. `v3` only; the `v2`
+ *  generation has `IntentSource`/`Inbox` instead, and says so. */
+export function ecoRoutesPortal(
+  chain: ChainRef | CanonicalChain,
+  selector?: EcoRoutesSelector,
+): Hex {
+  const { generation } = select(selector);
+  if (generation !== "v3") {
+    throw new Error(
+      `eco-routes ${generation} has no Portal — that generation deploys IntentSource and Inbox ` +
+        `separately. Use \`ecoRoutesContract(chain, "IntentSource", { generation })\` to address it, ` +
+        `or build against the default v3 generation.`,
+    );
+  }
+  return requireRole(chain, "Portal", selector);
+}
+
+/** Any role by name, for a generation whose roles this SDK does not model individually. */
+export function ecoRoutesContract(
+  chain: ChainRef | CanonicalChain,
+  role: string,
+  selector?: EcoRoutesSelector,
+): Hex {
+  return requireRole(chain, role, selector);
+}
+
+/**
+ * The Portal's Executor on `chain` — the contract that runs a fulfilled intent's route calls, and
+ * therefore the owner a Pot must have for those calls to be allowed to cook it.
+ *
+ * DERIVED, not looked up: `Inbox`'s constructor does `executor = new Executor()`, and `Portal`'s
+ * inheritance creates a `Vault` first, so the Executor is the Portal's SECOND `CREATE`. That makes
+ * it a pure function of the Portal address, which this registry already has.
+ *
+ * `eco-routes-executor.e2e.test.ts` deploys the real Portal and checks this against the `executor()`
+ * it reports, which is what keeps the nonce honest if that constructor ever changes.
+ */
+export const ECO_ROUTES_EXECUTOR_NONCE = 2n;
+
+export function ecoRoutesExecutor(
+  chain: ChainRef | CanonicalChain,
+  selector?: EcoRoutesSelector,
+): Hex {
+  return ecoRoutesExecutorOf(ecoRoutesPortal(chain, selector));
+}
+
+/**
+ * The Executor of a given Portal, which need not be one this registry carries.
+ *
+ * The intent machinery derives from THIS rather than from the chain whenever a caller names the
+ * Portal: a route recording one Portal is executed by that Portal's Executor, so a Pot derived
+ * from any other Portal's would reject the cook with `NotOwner()`.
+ */
+export function ecoRoutesExecutorOf(portal: Hex): Hex {
+  return getContractAddress({ from: portal, nonce: ECO_ROUTES_EXECUTOR_NONCE, opcode: "CREATE" });
+}
+
+/**
+ * The prover to record in a reward for a `source` -> `destination` route.
+ *
+ * A prover is a pair property, not a chain property: the reward names a prover on the SOURCE chain,
+ * and it can only carry a proof back from a destination where the matching prover is also deployed.
+ * So this picks the first prover both sides have, in a fixed preference order, and says what it
+ * looked at when they have none in common.
+ */
+export const ECO_ROUTES_PROVER_PREFERENCE = [
+  "HyperProver",
+  "LayerZeroProver",
+  "MetaProver",
+  "PolymerProver",
+] as const;
+
+export function ecoRoutesProver(
+  source: ChainRef | CanonicalChain,
+  destination: ChainRef | CanonicalChain,
+  selector?: EcoRoutesSelector,
+): Hex {
+  const here = ecoRoutesDeployment(source, selector);
+  const there = ecoRoutesDeployment(destination, selector);
+  const { generation, environment } = select(selector);
+  const where = `eco-routes ${generation}${environment === "default" ? "" : `/${environment}`}`;
+
+  if (here === undefined || there === undefined) {
+    // Reuse the deployment-level diagnostic, which names which side is missing.
+    requireRole(here === undefined ? source : destination, "Portal", selector);
+  }
+  for (const prover of ECO_ROUTES_PROVER_PREFERENCE) {
+    if (here?.[prover] !== undefined && there?.[prover] !== undefined) return here[prover]!;
+  }
+  const sourceSlug = chainIdOf(source).slug;
+  const destinationSlug = chainIdOf(destination).slug;
+  throw new Error(
+    `${where} has no prover deployed on both ${sourceSlug} and ${destinationSlug}. ` +
+      `${sourceSlug} has: ${Object.keys(here ?? {}).join(", ") || "none"}; ` +
+      `${destinationSlug} has: ${Object.keys(there ?? {}).join(", ") || "none"}. ` +
+      `A reward's prover must be able to carry a proof back from the destination, so pass one ` +
+      `explicitly only if you have verified that it can.`,
+  );
+}

package/sdk/src/protocols/eigenlayer/DelegationManagerABI.json

@@ -25,7 +25,7 @@
         },
         {
           "name": "approverSalt",
-          "type": "uint256"
+          "type": "bytes32"
         }
       ],
       "outputs": []
@@ -43,7 +43,7 @@
       "outputs": [
         {
           "name": "withdrawalRoots",
-          "type": "uint256[]"
+          "type": "bytes32[]"
         }
       ]
     },

package/sdk/src/protocols/eigenlayer/StrategyManagerABI.json

@@ -26,7 +26,7 @@
       ]
     },
     {
-      "name": "stakerStrategyShares",
+      "name": "stakerDepositShares",
       "type": "function",
       "stateMutability": "view",
       "inputs": [
@@ -41,7 +41,7 @@
       ],
       "outputs": [
         {
-          "name": "",
+          "name": "shares",
           "type": "uint256"
         }
       ]

package/sdk/src/protocols/eigenlayer/abis.ts

@@ -11,14 +11,15 @@ export const StrategyManagerABI = [
     outputs: [{ name: "shares", type: "uint256" }],
   },
   {
-    name: "stakerStrategyShares",
+    // Renamed from `stakerStrategyShares` in the slashing upgrade; the old name no longer exists.
+    name: "stakerDepositShares",
     type: "function",
     stateMutability: "view",
     inputs: [
       { name: "staker", type: "address" },
       { name: "strategy", type: "address" },
     ],
-    outputs: [{ name: "", type: "uint256" }],
+    outputs: [{ name: "shares", type: "uint256" }],
   },
 ] as const;
 
@@ -37,7 +38,7 @@ export const DelegationManagerABI = [
           { name: "expiry", type: "uint256" },
         ],
       },
-      { name: "approverSalt", type: "uint256" },
+      { name: "approverSalt", type: "bytes32" },
     ],
     outputs: [],
   },
@@ -46,7 +47,7 @@ export const DelegationManagerABI = [
     type: "function",
     stateMutability: "nonpayable",
     inputs: [{ name: "staker", type: "address" }],
-    outputs: [{ name: "withdrawalRoots", type: "uint256[]" }],
+    outputs: [{ name: "withdrawalRoots", type: "bytes32[]" }],
   },
   {
     name: "isDelegated",

package/sdk/src/protocols/ens/ENSRegistryABI.json

@@ -7,7 +7,7 @@
       "inputs": [
         {
           "name": "node",
-          "type": "uint256"
+          "type": "bytes32"
         }
       ],
       "outputs": [
@@ -24,7 +24,7 @@
       "inputs": [
         {
           "name": "node",
-          "type": "uint256"
+          "type": "bytes32"
         }
       ],
       "outputs": [
@@ -41,7 +41,7 @@
       "inputs": [
         {
           "name": "node",
-          "type": "uint256"
+          "type": "bytes32"
         },
         {
           "name": "owner",
@@ -57,7 +57,7 @@
       "inputs": [
         {
           "name": "node",
-          "type": "uint256"
+          "type": "bytes32"
         },
         {
           "name": "resolver",

package/sdk/src/protocols/ens/abis.ts

@@ -3,14 +3,14 @@ export const ENSRegistryABI = [
     name: "owner",
     type: "function",
     stateMutability: "view",
-    inputs: [{ name: "node", type: "uint256" }],
+    inputs: [{ name: "node", type: "bytes32" }],
     outputs: [{ name: "", type: "address" }],
   },
   {
     name: "resolver",
     type: "function",
     stateMutability: "view",
-    inputs: [{ name: "node", type: "uint256" }],
+    inputs: [{ name: "node", type: "bytes32" }],
     outputs: [{ name: "", type: "address" }],
   },
   {
@@ -18,7 +18,7 @@ export const ENSRegistryABI = [
     type: "function",
     stateMutability: "nonpayable",
     inputs: [
-      { name: "node", type: "uint256" },
+      { name: "node", type: "bytes32" },
       { name: "owner", type: "address" },
     ],
     outputs: [],
@@ -28,7 +28,7 @@ export const ENSRegistryABI = [
     type: "function",
     stateMutability: "nonpayable",
     inputs: [
-      { name: "node", type: "uint256" },
+      { name: "node", type: "bytes32" },
       { name: "resolver", type: "address" },
     ],
     outputs: [],

package/sdk/src/protocols/etherfi/WeETHABI.json

@@ -52,7 +52,7 @@
       ]
     },
     {
-      "name": "getWeETHByEETH",
+      "name": "getWeETHByeETH",
       "type": "function",
       "stateMutability": "view",
       "inputs": [

package/sdk/src/protocols/etherfi/abis.ts

@@ -31,7 +31,8 @@ export const WeETHABI = [
     outputs: [{ name: "", type: "uint256" }],
   },
   {
-    name: "getWeETHByEETH",
+    // Lower-case "e" in the deployed name: `getWeETHByEETH` would be a different selector.
+    name: "getWeETHByeETH",
     type: "function",
     stateMutability: "view",
     inputs: [{ name: "_eETHAmount", type: "uint256" }],

package/sdk/src/protocols/euler-v2/EVCABI.json

@@ -3,7 +3,7 @@
     {
       "name": "enableCollateral",
       "type": "function",
-      "stateMutability": "nonpayable",
+      "stateMutability": "payable",
       "inputs": [
         {
           "name": "account",
@@ -19,7 +19,7 @@
     {
       "name": "enableController",
       "type": "function",
-      "stateMutability": "nonpayable",
+      "stateMutability": "payable",
       "inputs": [
         {
           "name": "account",

package/sdk/src/protocols/euler-v2/abis.ts

@@ -57,7 +57,7 @@ export const EVCABI = [
   {
     name: "enableCollateral",
     type: "function",
-    stateMutability: "nonpayable",
+    stateMutability: "payable",
     inputs: [
       { name: "account", type: "address" },
       { name: "vault", type: "address" },
@@ -67,7 +67,7 @@ export const EVCABI = [
   {
     name: "enableController",
     type: "function",
-    stateMutability: "nonpayable",
+    stateMutability: "payable",
     inputs: [
       { name: "account", type: "address" },
       { name: "vault", type: "address" },

package/sdk/src/protocols/fluid/FluidLendingABI.json

@@ -6,15 +6,11 @@
       "stateMutability": "nonpayable",
       "inputs": [
         {
-          "name": "token",
-          "type": "address"
-        },
-        {
-          "name": "amount",
+          "name": "assets",
           "type": "uint256"
         },
         {
-          "name": "to",
+          "name": "receiver",
           "type": "address"
         }
       ],
@@ -31,72 +27,59 @@
       "stateMutability": "nonpayable",
       "inputs": [
         {
-          "name": "token",
-          "type": "address"
+          "name": "assets",
+          "type": "uint256"
         },
         {
-          "name": "amount",
-          "type": "uint256"
+          "name": "receiver",
+          "type": "address"
         },
         {
-          "name": "to",
+          "name": "owner",
           "type": "address"
         }
       ],
       "outputs": [
         {
-          "name": "actualAmount",
+          "name": "shares",
           "type": "uint256"
         }
       ]
     },
     {
-      "name": "borrow",
+      "name": "redeem",
       "type": "function",
       "stateMutability": "nonpayable",
       "inputs": [
         {
-          "name": "token",
-          "type": "address"
+          "name": "shares",
+          "type": "uint256"
         },
         {
-          "name": "amount",
-          "type": "uint256"
+          "name": "receiver",
+          "type": "address"
         },
         {
-          "name": "to",
+          "name": "owner",
           "type": "address"
         }
       ],
       "outputs": [
         {
-          "name": "actualAmount",
+          "name": "assets",
           "type": "uint256"
         }
       ]
     },
     {
-      "name": "repay",
+      "name": "asset",
       "type": "function",
-      "stateMutability": "nonpayable",
-      "inputs": [
-        {
-          "name": "token",
-          "type": "address"
-        },
-        {
-          "name": "amount",
-          "type": "uint256"
-        },
-        {
-          "name": "onBehalfOf",
-          "type": "address"
-        }
-      ],
+      "stateMutability": "view",
+      "inputs": [],
       "outputs": [
         {
-          "name": "actualAmount",
-          "type": "uint256"
+          "name": "",
+          "type": "address"
         }
       ]
     }

package/sdk/src/protocols/fluid/FluidVaultABI.json

@@ -0,0 +1,41 @@
+{
+  "abi": [
+    {
+      "name": "operate",
+      "type": "function",
+      "stateMutability": "payable",
+      "inputs": [
+        {
+          "name": "nftId",
+          "type": "uint256"
+        },
+        {
+          "name": "newCol",
+          "type": "int256"
+        },
+        {
+          "name": "newDebt",
+          "type": "int256"
+        },
+        {
+          "name": "to",
+          "type": "address"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256"
+        },
+        {
+          "name": "",
+          "type": "int256"
+        },
+        {
+          "name": "",
+          "type": "int256"
+        }
+      ]
+    }
+  ]
+}

package/sdk/src/protocols/fluid/abis.ts

@@ -1,12 +1,16 @@
+// Fluid has no deposit/borrow entry point on the Liquidity layer (`liquidity` in addresses.ts):
+// its only user-level function, `operate`, is restricted to Fluid's own protocols. Users lend
+// through fTokens (ERC-4626 vaults over the Liquidity layer) and borrow through Vaults.
+
+/** An fToken, e.g. fUSDC: ERC-4626 lending over the Liquidity layer. */
 export const FluidLendingABI = [
   {
     name: "deposit",
     type: "function",
     stateMutability: "nonpayable",
     inputs: [
-      { name: "token", type: "address" },
-      { name: "amount", type: "uint256" },
-      { name: "to", type: "address" },
+      { name: "assets", type: "uint256" },
+      { name: "receiver", type: "address" },
     ],
     outputs: [{ name: "shares", type: "uint256" }],
   },
@@ -15,32 +19,51 @@ export const FluidLendingABI = [
     type: "function",
     stateMutability: "nonpayable",
     inputs: [
-      { name: "token", type: "address" },
-      { name: "amount", type: "uint256" },
-      { name: "to", type: "address" },
+      { name: "assets", type: "uint256" },
+      { name: "receiver", type: "address" },
+      { name: "owner", type: "address" },
     ],
-    outputs: [{ name: "actualAmount", type: "uint256" }],
+    outputs: [{ name: "shares", type: "uint256" }],
   },
   {
-    name: "borrow",
+    name: "redeem",
     type: "function",
     stateMutability: "nonpayable",
     inputs: [
-      { name: "token", type: "address" },
-      { name: "amount", type: "uint256" },
-      { name: "to", type: "address" },
+      { name: "shares", type: "uint256" },
+      { name: "receiver", type: "address" },
+      { name: "owner", type: "address" },
     ],
-    outputs: [{ name: "actualAmount", type: "uint256" }],
+    outputs: [{ name: "assets", type: "uint256" }],
   },
   {
-    name: "repay",
+    name: "asset",
     type: "function",
-    stateMutability: "nonpayable",
+    stateMutability: "view",
+    inputs: [],
+    outputs: [{ name: "", type: "address" }],
+  },
+] as const;
+
+/**
+ * A Fluid Vault (e.g. VaultT1): one `operate` call moves collateral and debt of a position NFT.
+ * Positive deltas deposit/borrow, negative ones withdraw/repay; `nftId` 0 opens a new position.
+ */
+export const FluidVaultABI = [
+  {
+    name: "operate",
+    type: "function",
+    stateMutability: "payable",
     inputs: [
-      { name: "token", type: "address" },
-      { name: "amount", type: "uint256" },
-      { name: "onBehalfOf", type: "address" },
+      { name: "nftId", type: "uint256" },
+      { name: "newCol", type: "int256" },
+      { name: "newDebt", type: "int256" },
+      { name: "to", type: "address" },
+    ],
+    outputs: [
+      { name: "", type: "uint256" },
+      { name: "", type: "int256" },
+      { name: "", type: "int256" },
     ],
-    outputs: [{ name: "actualAmount", type: "uint256" }],
   },
 ] as const;