@usewhisk/cctp 0.0.0 → 0.1.0

package/dist/abi.d.cts

@@ -0,0 +1,401 @@
+/**
+ * `TokenMessengerV2` ABI (relevant subset).
+ *
+ * Source: github.com/circlefin/evm-cctp-contracts (v2 abis).
+ * Only the functions and events Whisk actually calls are included.
+ */
+declare const tokenMessengerV2Abi: readonly [{
+    readonly type: "function";
+    readonly name: "depositForBurn";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly name: "destinationDomain";
+        readonly type: "uint32";
+    }, {
+        readonly name: "mintRecipient";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "burnToken";
+        readonly type: "address";
+    }, {
+        readonly name: "destinationCaller";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "maxFee";
+        readonly type: "uint256";
+    }, {
+        readonly name: "minFinalityThreshold";
+        readonly type: "uint32";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "function";
+    readonly name: "depositForBurnWithHook";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly name: "destinationDomain";
+        readonly type: "uint32";
+    }, {
+        readonly name: "mintRecipient";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "burnToken";
+        readonly type: "address";
+    }, {
+        readonly name: "destinationCaller";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "maxFee";
+        readonly type: "uint256";
+    }, {
+        readonly name: "minFinalityThreshold";
+        readonly type: "uint32";
+    }, {
+        readonly name: "hookData";
+        readonly type: "bytes";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "event";
+    readonly name: "DepositForBurn";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "burnToken";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+        readonly indexed: false;
+    }, {
+        readonly name: "depositor";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "mintRecipient";
+        readonly type: "bytes32";
+        readonly indexed: false;
+    }, {
+        readonly name: "destinationDomain";
+        readonly type: "uint32";
+        readonly indexed: false;
+    }, {
+        readonly name: "destinationTokenMessenger";
+        readonly type: "bytes32";
+        readonly indexed: false;
+    }, {
+        readonly name: "destinationCaller";
+        readonly type: "bytes32";
+        readonly indexed: false;
+    }, {
+        readonly name: "maxFee";
+        readonly type: "uint256";
+        readonly indexed: false;
+    }, {
+        readonly name: "minFinalityThreshold";
+        readonly type: "uint32";
+        readonly indexed: false;
+    }, {
+        readonly name: "hookData";
+        readonly type: "bytes";
+        readonly indexed: false;
+    }];
+}];
+
+/**
+ * The subset of `MessageTransmitterV2` Whisk uses: `receiveMessage` for
+ * manual recovery, `usedNonces` to check whether a message was minted, and
+ * the `MessageReceived` and `MessageSent` events.
+ */
+declare const messageTransmitterV2Abi: readonly [{
+    readonly type: "function";
+    readonly name: "receiveMessage";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "message";
+        readonly type: "bytes";
+    }, {
+        readonly name: "attestation";
+        readonly type: "bytes";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "success";
+        readonly type: "bool";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "usedNonces";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "nonce";
+        readonly type: "bytes32";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "isUsed";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "event";
+    readonly name: "MessageReceived";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "caller";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "sourceDomain";
+        readonly type: "uint32";
+        readonly indexed: true;
+    }, {
+        readonly name: "nonce";
+        readonly type: "bytes32";
+        readonly indexed: true;
+    }, {
+        readonly name: "sender";
+        readonly type: "bytes32";
+        readonly indexed: false;
+    }, {
+        readonly name: "finalityThresholdExecuted";
+        readonly type: "uint32";
+        readonly indexed: false;
+    }, {
+        readonly name: "messageBody";
+        readonly type: "bytes";
+        readonly indexed: false;
+    }];
+}, {
+    readonly type: "event";
+    readonly name: "MessageSent";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "message";
+        readonly type: "bytes";
+        readonly indexed: false;
+    }];
+}];
+
+/**
+ * The parts of the USDC (FiatTokenV2) ABI that Whisk needs.
+ *
+ * Read: balanceOf, allowance, decimals, nonces, DOMAIN_SEPARATOR.
+ * Write: approve, transfer, permit (EIP-2612).
+ */
+declare const usdcAbi: readonly [{
+    readonly type: "function";
+    readonly name: "balanceOf";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "balance";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "allowance";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "remaining";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "decimals";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "approve";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "transfer";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "nonces";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "DOMAIN_SEPARATOR";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "permit";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }, {
+        readonly name: "v";
+        readonly type: "uint8";
+    }, {
+        readonly name: "r";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly type: "bytes32";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "event";
+    readonly name: "Transfer";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+        readonly indexed: false;
+    }];
+}, {
+    readonly type: "event";
+    readonly name: "Approval";
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+        readonly indexed: true;
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+        readonly indexed: false;
+    }];
+}];
+
+/**
+ * The parts of Circle's `TokenMessengerWithFees` that Whisk calls, from the ABI
+ * in Circle's contract interface reference. Only the `bytes signedQuote`
+ * overload of each burn is listed, so encoding never has to pick between them.
+ */
+declare const tokenMessengerWithFeesAbi: readonly [{
+    readonly type: "function";
+    readonly name: "depositForBurnWithFees";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly name: "destinationDomain";
+        readonly type: "uint32";
+    }, {
+        readonly name: "mintRecipient";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "burnToken";
+        readonly type: "address";
+    }, {
+        readonly name: "destinationCaller";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "claim";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "signedQuote";
+            readonly type: "bytes";
+        }, {
+            readonly name: "refundAddress";
+            readonly type: "address";
+        }];
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "function";
+    readonly name: "getFee";
+    readonly stateMutability: "pure";
+    readonly inputs: readonly [{
+        readonly name: "signedQuote";
+        readonly type: "bytes";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "totalFee";
+        readonly type: "uint256";
+    }, {
+        readonly name: "feeToken";
+        readonly type: "address";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "tokenMessenger";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+    }];
+}];
+
+export { messageTransmitterV2Abi, tokenMessengerV2Abi, tokenMessengerWithFeesAbi, usdcAbi };