@eco-incorp/sauce 0.99.5 → 0.99.7

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

@@ -13,6 +13,15 @@
  * `route` crosses as `bytes` on every entry point, never as a tuple. That is not a style choice:
  * for a Solana destination the route is Borsh rather than ABI, so handing the Portal a pre-encoded
  * blob is the only way its `routeHash` matches the one the SDK computed. See `routes/portal.ts`.
+ *
+ * EVENTS AND ERRORS are the deployed Portal's (eco-routes 2.12.0), as its verified source declares
+ * them: the intent lifecycle events, with each parameter's `indexed` exactly as emitted (a wrong
+ * flag decodes no log at all — `IntentFunded` indexes nothing, `IntentFulfilled` indexes both of
+ * its parameters), and every custom error the runtime code of every listed deployment can revert
+ * with, so a revert such as `InsufficientFunds(intentHash)` or Arc's
+ * `RewardTokensNotUnique(token)` decodes by name. Left out: the ERC-7683 `Open`/`OrderFilled`
+ * events and errors only a constructor throws. `registry-abi.test.ts` checks every one against the
+ * deployed code and the verified ABI, and decodes a real log of each event it has one of.
  */
 
 export const PortalABI = [
@@ -508,120 +517,989 @@ export const PortalABI = [
     ],
   },
   {
-    type: "event",
-    name: "IntentPublished",
+    type: "function",
+    name: "fulfillAndProve",
+    stateMutability: "payable",
     inputs: [
       {
         name: "intentHash",
         type: "bytes32",
-        indexed: true,
       },
       {
-        name: "destination",
+        name: "route",
+        type: "tuple",
+        components: [
+          {
+            name: "salt",
+            type: "bytes32",
+          },
+          {
+            name: "deadline",
+            type: "uint64",
+          },
+          {
+            name: "portal",
+            type: "address",
+          },
+          {
+            name: "nativeAmount",
+            type: "uint256",
+          },
+          {
+            name: "tokens",
+            type: "tuple[]",
+            components: [
+              {
+                name: "token",
+                type: "address",
+              },
+              {
+                name: "amount",
+                type: "uint256",
+              },
+            ],
+          },
+          {
+            name: "calls",
+            type: "tuple[]",
+            components: [
+              {
+                name: "target",
+                type: "address",
+              },
+              {
+                name: "data",
+                type: "bytes",
+              },
+              {
+                name: "value",
+                type: "uint256",
+              },
+            ],
+          },
+        ],
+      },
+      {
+        name: "rewardHash",
+        type: "bytes32",
+      },
+      {
+        name: "claimant",
+        type: "bytes32",
+      },
+      {
+        name: "prover",
+        type: "address",
+      },
+      {
+        name: "sourceChainDomainID",
         type: "uint64",
-        indexed: false,
       },
       {
-        name: "route",
+        name: "data",
         type: "bytes",
-        indexed: false,
       },
+    ],
+    outputs: [
       {
-        name: "creator",
-        type: "address",
-        indexed: true,
+        name: "",
+        type: "bytes[]",
       },
+    ],
+  },
+  {
+    type: "function",
+    name: "prove",
+    stateMutability: "payable",
+    inputs: [
       {
         name: "prover",
         type: "address",
-        indexed: true,
       },
       {
-        name: "rewardDeadline",
+        name: "sourceChainDomainID",
         type: "uint64",
-        indexed: false,
       },
       {
-        name: "rewardNativeAmount",
-        type: "uint256",
-        indexed: false,
+        name: "intentHashes",
+        type: "bytes32[]",
       },
       {
-        name: "rewardTokens",
-        indexed: false,
-        type: "tuple[]",
+        name: "data",
+        type: "bytes",
+      },
+    ],
+    outputs: [],
+  },
+  {
+    type: "function",
+    name: "withdraw",
+    stateMutability: "nonpayable",
+    inputs: [
+      {
+        name: "destination",
+        type: "uint64",
+      },
+      {
+        name: "routeHash",
+        type: "bytes32",
+      },
+      {
+        name: "reward",
+        type: "tuple",
         components: [
           {
-            name: "token",
+            name: "deadline",
+            type: "uint64",
+          },
+          {
+            name: "creator",
             type: "address",
           },
           {
-            name: "amount",
+            name: "prover",
+            type: "address",
+          },
+          {
+            name: "nativeAmount",
             type: "uint256",
           },
+          {
+            name: "tokens",
+            type: "tuple[]",
+            components: [
+              {
+                name: "token",
+                type: "address",
+              },
+              {
+                name: "amount",
+                type: "uint256",
+              },
+            ],
+          },
         ],
       },
     ],
+    outputs: [],
   },
   {
-    type: "event",
-    name: "IntentFunded",
+    type: "function",
+    name: "batchWithdraw",
+    stateMutability: "nonpayable",
     inputs: [
       {
-        name: "intentHash",
-        type: "bytes32",
-        indexed: true,
+        name: "destinations",
+        type: "uint64[]",
       },
       {
-        name: "funder",
-        type: "address",
-        indexed: true,
+        name: "routeHashes",
+        type: "bytes32[]",
       },
       {
-        name: "complete",
-        type: "bool",
-        indexed: false,
+        name: "rewards",
+        type: "tuple[]",
+        components: [
+          {
+            name: "deadline",
+            type: "uint64",
+          },
+          {
+            name: "creator",
+            type: "address",
+          },
+          {
+            name: "prover",
+            type: "address",
+          },
+          {
+            name: "nativeAmount",
+            type: "uint256",
+          },
+          {
+            name: "tokens",
+            type: "tuple[]",
+            components: [
+              {
+                name: "token",
+                type: "address",
+              },
+              {
+                name: "amount",
+                type: "uint256",
+              },
+            ],
+          },
+        ],
       },
     ],
+    outputs: [],
   },
   {
-    type: "event",
-    name: "IntentFulfilled",
+    type: "function",
+    name: "refund",
+    stateMutability: "nonpayable",
     inputs: [
       {
-        name: "intentHash",
-        type: "bytes32",
-        indexed: true,
+        name: "destination",
+        type: "uint64",
       },
       {
-        name: "claimant",
+        name: "routeHash",
         type: "bytes32",
-        indexed: false,
+      },
+      {
+        name: "reward",
+        type: "tuple",
+        components: [
+          {
+            name: "deadline",
+            type: "uint64",
+          },
+          {
+            name: "creator",
+            type: "address",
+          },
+          {
+            name: "prover",
+            type: "address",
+          },
+          {
+            name: "nativeAmount",
+            type: "uint256",
+          },
+          {
+            name: "tokens",
+            type: "tuple[]",
+            components: [
+              {
+                name: "token",
+                type: "address",
+              },
+              {
+                name: "amount",
+                type: "uint256",
+              },
+            ],
+          },
+        ],
       },
     ],
+    outputs: [],
   },
-] as const;
-
-export const ProverABI = [
   {
     type: "function",
-    name: "provenIntents",
-    stateMutability: "view",
+    name: "refundTo",
+    stateMutability: "nonpayable",
     inputs: [
       {
-        name: "intentHash",
+        name: "destination",
+        type: "uint64",
+      },
+      {
+        name: "routeHash",
         type: "bytes32",
       },
-    ],
-    outputs: [
       {
-        name: "",
+        name: "reward",
         type: "tuple",
         components: [
           {
-            name: "claimant",
-            type: "address",
-          },
+            name: "deadline",
+            type: "uint64",
+          },
+          {
+            name: "creator",
+            type: "address",
+          },
+          {
+            name: "prover",
+            type: "address",
+          },
+          {
+            name: "nativeAmount",
+            type: "uint256",
+          },
+          {
+            name: "tokens",
+            type: "tuple[]",
+            components: [
+              {
+                name: "token",
+                type: "address",
+              },
+              {
+                name: "amount",
+                type: "uint256",
+              },
+            ],
+          },
+        ],
+      },
+      {
+        name: "refundee",
+        type: "address",
+      },
+    ],
+    outputs: [],
+  },
+  {
+    type: "function",
+    name: "cancel",
+    stateMutability: "nonpayable",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+      },
+      {
+        name: "route",
+        type: "tuple",
+        components: [
+          {
+            name: "salt",
+            type: "bytes32",
+          },
+          {
+            name: "deadline",
+            type: "uint64",
+          },
+          {
+            name: "portal",
+            type: "address",
+          },
+          {
+            name: "nativeAmount",
+            type: "uint256",
+          },
+          {
+            name: "tokens",
+            type: "tuple[]",
+            components: [
+              {
+                name: "token",
+                type: "address",
+              },
+              {
+                name: "amount",
+                type: "uint256",
+              },
+            ],
+          },
+          {
+            name: "calls",
+            type: "tuple[]",
+            components: [
+              {
+                name: "target",
+                type: "address",
+              },
+              {
+                name: "data",
+                type: "bytes",
+              },
+              {
+                name: "value",
+                type: "uint256",
+              },
+            ],
+          },
+        ],
+      },
+      {
+        name: "rewardHash",
+        type: "bytes32",
+      },
+    ],
+    outputs: [],
+  },
+  {
+    type: "function",
+    name: "cancelAndProve",
+    stateMutability: "payable",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+      },
+      {
+        name: "route",
+        type: "tuple",
+        components: [
+          {
+            name: "salt",
+            type: "bytes32",
+          },
+          {
+            name: "deadline",
+            type: "uint64",
+          },
+          {
+            name: "portal",
+            type: "address",
+          },
+          {
+            name: "nativeAmount",
+            type: "uint256",
+          },
+          {
+            name: "tokens",
+            type: "tuple[]",
+            components: [
+              {
+                name: "token",
+                type: "address",
+              },
+              {
+                name: "amount",
+                type: "uint256",
+              },
+            ],
+          },
+          {
+            name: "calls",
+            type: "tuple[]",
+            components: [
+              {
+                name: "target",
+                type: "address",
+              },
+              {
+                name: "data",
+                type: "bytes",
+              },
+              {
+                name: "value",
+                type: "uint256",
+              },
+            ],
+          },
+        ],
+      },
+      {
+        name: "rewardHash",
+        type: "bytes32",
+      },
+      {
+        name: "prover",
+        type: "address",
+      },
+      {
+        name: "sourceChainDomainID",
+        type: "uint64",
+      },
+      {
+        name: "data",
+        type: "bytes",
+      },
+    ],
+    outputs: [],
+  },
+  {
+    type: "function",
+    name: "version",
+    stateMutability: "pure",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "string",
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentPublished",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: true,
+      },
+      {
+        name: "destination",
+        type: "uint64",
+        indexed: false,
+      },
+      {
+        name: "route",
+        type: "bytes",
+        indexed: false,
+      },
+      {
+        name: "creator",
+        type: "address",
+        indexed: true,
+      },
+      {
+        name: "prover",
+        type: "address",
+        indexed: true,
+      },
+      {
+        name: "rewardDeadline",
+        type: "uint64",
+        indexed: false,
+      },
+      {
+        name: "rewardNativeAmount",
+        type: "uint256",
+        indexed: false,
+      },
+      {
+        name: "rewardTokens",
+        type: "tuple[]",
+        indexed: false,
+        components: [
+          {
+            name: "token",
+            type: "address",
+          },
+          {
+            name: "amount",
+            type: "uint256",
+          },
+        ],
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentFunded",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: false,
+      },
+      {
+        name: "funder",
+        type: "address",
+        indexed: false,
+      },
+      {
+        name: "complete",
+        type: "bool",
+        indexed: false,
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentFulfilled",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: true,
+      },
+      {
+        name: "claimant",
+        type: "bytes32",
+        indexed: true,
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentProven",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: true,
+      },
+      {
+        name: "claimant",
+        type: "bytes32",
+        indexed: true,
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentWithdrawn",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: false,
+      },
+      {
+        name: "claimant",
+        type: "address",
+        indexed: true,
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentRefunded",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: false,
+      },
+      {
+        name: "refundee",
+        type: "address",
+        indexed: true,
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentTokenRecovered",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: false,
+      },
+      {
+        name: "refundee",
+        type: "address",
+        indexed: true,
+      },
+      {
+        name: "token",
+        type: "address",
+        indexed: true,
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentCancelled",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: true,
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "AddressEmptyCode",
+    inputs: [
+      {
+        name: "target",
+        type: "address",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "ArrayLengthMismatch",
+    inputs: [],
+  },
+  {
+    type: "error",
+    name: "CancelledIntent",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "FailedInnerCall",
+    inputs: [],
+  },
+  {
+    type: "error",
+    name: "InsufficientFunds",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InsufficientNativeAmount",
+    inputs: [
+      {
+        name: "sent",
+        type: "uint256",
+      },
+      {
+        name: "required",
+        type: "uint256",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "IntentAlreadyExists",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "IntentAlreadyFulfilled",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "IntentExpired",
+    inputs: [],
+  },
+  {
+    type: "error",
+    name: "IntentNotClaimed",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "IntentNotFulfilled",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InvalidClaimant",
+    inputs: [],
+  },
+  {
+    type: "error",
+    name: "InvalidCreatorBinding",
+    inputs: [
+      {
+        name: "user",
+        type: "address",
+      },
+      {
+        name: "creator",
+        type: "address",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InvalidHash",
+    inputs: [
+      {
+        name: "expectedHash",
+        type: "bytes32",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InvalidOriginChainId",
+    inputs: [
+      {
+        name: "expected",
+        type: "uint256",
+      },
+      {
+        name: "actual",
+        type: "uint256",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InvalidOriginSettler",
+    inputs: [
+      {
+        name: "expected",
+        type: "address",
+      },
+      {
+        name: "actual",
+        type: "address",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InvalidPortal",
+    inputs: [
+      {
+        name: "portal",
+        type: "address",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InvalidRecoverToken",
+    inputs: [
+      {
+        name: "token",
+        type: "address",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InvalidShortString",
+    inputs: [],
+  },
+  {
+    type: "error",
+    name: "InvalidSignature",
+    inputs: [],
+  },
+  {
+    type: "error",
+    name: "InvalidStatusForFunding",
+    inputs: [
+      {
+        name: "status",
+        type: "uint8",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InvalidStatusForRefund",
+    inputs: [
+      {
+        name: "status",
+        type: "uint8",
+      },
+      {
+        name: "currentTime",
+        type: "uint256",
+      },
+      {
+        name: "deadline",
+        type: "uint256",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InvalidStatusForWithdrawal",
+    inputs: [
+      {
+        name: "status",
+        type: "uint8",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "NotCreatorCaller",
+    inputs: [
+      {
+        name: "caller",
+        type: "address",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "OpenDeadlinePassed",
+    inputs: [],
+  },
+  {
+    type: "error",
+    name: "ReentrancyGuardReentrantCall",
+    inputs: [],
+  },
+  {
+    type: "error",
+    name: "ReservedClaimant",
+    inputs: [],
+  },
+  {
+    type: "error",
+    name: "RewardTokensNotUnique",
+    inputs: [
+      {
+        name: "token",
+        type: "address",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "RouteNotExpired",
+    inputs: [
+      {
+        name: "deadline",
+        type: "uint64",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "SafeERC20FailedOperation",
+    inputs: [
+      {
+        name: "token",
+        type: "address",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "TypeSignatureMismatch",
+    inputs: [],
+  },
+  {
+    type: "error",
+    name: "ZeroClaimant",
+    inputs: [],
+  },
+] as const;
+
+/**
+ * What every eco-routes prover shares (`IProver`): the proof a source chain reads, the events it
+ * announces a proof by, its kind (`getProofType`), its Portal and the senders it trusts — and what
+ * a MESSAGE-BRIDGE prover adds (`MessageBridgeProver`: Hyperlane's `HyperProver`, `MetaProver`,
+ * `LayerZeroProver`): the fee the destination Portal's `prove` forwards to it, quoted for one
+ * message (`fetchFee(sourceChainDomainID, encodedProofs, data)`), and its refusal of a smaller one
+ * (`InsufficientFee`). Polymer's prover takes no fee, its proof relayed off-chain, so it has
+ * neither (`targets.json` exempts its deployments).
+ */
+export const ProverABI = [
+  {
+    type: "function",
+    name: "provenIntents",
+    stateMutability: "view",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+      },
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "tuple",
+        components: [
+          {
+            name: "claimant",
+            type: "address",
+          },
           {
             name: "destination",
             type: "uint64",
@@ -630,4 +1508,135 @@ export const ProverABI = [
       },
     ],
   },
+  {
+    type: "function",
+    name: "getProofType",
+    stateMutability: "pure",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "string",
+      },
+    ],
+  },
+  {
+    type: "function",
+    name: "version",
+    stateMutability: "pure",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "string",
+      },
+    ],
+  },
+  {
+    type: "function",
+    name: "PORTAL",
+    stateMutability: "view",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+      },
+    ],
+  },
+  {
+    type: "function",
+    name: "isWhitelisted",
+    stateMutability: "view",
+    inputs: [
+      {
+        name: "addr",
+        type: "bytes32",
+      },
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "bool",
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentProven",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: true,
+      },
+      {
+        name: "claimant",
+        type: "address",
+        indexed: true,
+      },
+      {
+        name: "destination",
+        type: "uint64",
+        indexed: false,
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentProofInvalidated",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: true,
+      },
+    ],
+  },
+  {
+    type: "event",
+    name: "IntentAlreadyProven",
+    inputs: [
+      {
+        name: "intentHash",
+        type: "bytes32",
+        indexed: false,
+      },
+    ],
+  },
+  {
+    type: "function",
+    name: "fetchFee",
+    stateMutability: "view",
+    inputs: [
+      {
+        name: "domainID",
+        type: "uint64",
+      },
+      {
+        name: "encodedProofs",
+        type: "bytes",
+      },
+      {
+        name: "data",
+        type: "bytes",
+      },
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "uint256",
+      },
+    ],
+  },
+  {
+    type: "error",
+    name: "InsufficientFee",
+    inputs: [
+      {
+        name: "requiredFee",
+        type: "uint256",
+      },
+    ],
+  },
 ] as const;