eth-twc-sdk-js 0.1.0

package/dist/verify.js

@@ -0,0 +1,339 @@
+// verify.ts
+import { type as type2 } from "arktype";
+import { parseEventLogs } from "viem";
+
+// ../contracts/abi/generated.ts
+var transferWithCommitmentAbi = [
+  {
+    type: "constructor",
+    inputs: [
+      { name: "name", internalType: "string", type: "string" },
+      { name: "version", internalType: "string", type: "string" }
+    ],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    inputs: [],
+    name: "BATCH_TRANSFER_WITH_COMMIT_TYPEHASH",
+    outputs: [{ name: "", internalType: "bytes32", type: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    inputs: [],
+    name: "CANCEL_AUTHORIZATION_TYPEHASH",
+    outputs: [{ name: "", internalType: "bytes32", type: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    inputs: [],
+    name: "TRANSFER_WITH_COMMIT_TYPEHASH",
+    outputs: [{ name: "", internalType: "bytes32", type: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    inputs: [],
+    name: "UNI_COMMIT_TRANSFER_TYPEHASH",
+    outputs: [{ name: "", internalType: "bytes32", type: "bytes32" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    inputs: [
+      { name: "authorizer", internalType: "address", type: "address" },
+      { name: "commitment", internalType: "bytes32", type: "bytes32" },
+      { name: "signature", internalType: "bytes", type: "bytes" }
+    ],
+    name: "cancelAuthorization",
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    inputs: [
+      { name: "payer", internalType: "address", type: "address" },
+      { name: "commitment", internalType: "bytes32", type: "bytes32" }
+    ],
+    name: "commitmentState",
+    outputs: [{ name: "", internalType: "bool", type: "bool" }],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    inputs: [],
+    name: "eip712Domain",
+    outputs: [
+      { name: "fields", internalType: "bytes1", type: "bytes1" },
+      { name: "name", internalType: "string", type: "string" },
+      { name: "version", internalType: "string", type: "string" },
+      { name: "chainId", internalType: "uint256", type: "uint256" },
+      { name: "verifyingContract", internalType: "address", type: "address" },
+      { name: "salt", internalType: "bytes32", type: "bytes32" },
+      { name: "extensions", internalType: "uint256[]", type: "uint256[]" }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    inputs: [
+      { name: "token", internalType: "address", type: "address" },
+      { name: "to", internalType: "address", type: "address" },
+      { name: "value", internalType: "uint256", type: "uint256" },
+      { name: "commitment", internalType: "bytes32", type: "bytes32" }
+    ],
+    name: "transfer",
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    inputs: [
+      {
+        name: "details",
+        internalType: "struct TransferDetail[]",
+        type: "tuple[]",
+        components: [
+          { name: "to", internalType: "address", type: "address" },
+          { name: "token", internalType: "address", type: "address" },
+          { name: "value", internalType: "uint256", type: "uint256" }
+        ]
+      },
+      { name: "commitment", internalType: "bytes32", type: "bytes32" }
+    ],
+    name: "transfer",
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    inputs: [
+      {
+        name: "details",
+        internalType: "struct CommittedTransferDetail[]",
+        type: "tuple[]",
+        components: [
+          { name: "to", internalType: "address", type: "address" },
+          { name: "token", internalType: "address", type: "address" },
+          { name: "value", internalType: "uint256", type: "uint256" },
+          { name: "commitment", internalType: "bytes32", type: "bytes32" }
+        ]
+      }
+    ],
+    name: "transfer",
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    inputs: [
+      { name: "from", internalType: "address", type: "address" },
+      {
+        name: "details",
+        internalType: "struct TransferDetail[]",
+        type: "tuple[]",
+        components: [
+          { name: "to", internalType: "address", type: "address" },
+          { name: "token", internalType: "address", type: "address" },
+          { name: "value", internalType: "uint256", type: "uint256" }
+        ]
+      },
+      { name: "validAfter", internalType: "uint256", type: "uint256" },
+      { name: "validBefore", internalType: "uint256", type: "uint256" },
+      { name: "commitment", internalType: "bytes32", type: "bytes32" },
+      { name: "signature", internalType: "bytes", type: "bytes" }
+    ],
+    name: "transferWithAuthorization",
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    inputs: [
+      { name: "from", internalType: "address", type: "address" },
+      {
+        name: "details",
+        internalType: "struct CommittedTransferDetail[]",
+        type: "tuple[]",
+        components: [
+          { name: "to", internalType: "address", type: "address" },
+          { name: "token", internalType: "address", type: "address" },
+          { name: "value", internalType: "uint256", type: "uint256" },
+          { name: "commitment", internalType: "bytes32", type: "bytes32" }
+        ]
+      },
+      { name: "validAfter", internalType: "uint256", type: "uint256" },
+      { name: "validBefore", internalType: "uint256", type: "uint256" },
+      { name: "batchCommitment", internalType: "bytes32", type: "bytes32" },
+      { name: "signature", internalType: "bytes", type: "bytes" }
+    ],
+    name: "transferWithAuthorization",
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    inputs: [
+      { name: "from", internalType: "address", type: "address" },
+      { name: "to", internalType: "address", type: "address" },
+      { name: "token", internalType: "address", type: "address" },
+      { name: "value", internalType: "uint256", type: "uint256" },
+      { name: "validAfter", internalType: "uint256", type: "uint256" },
+      { name: "validBefore", internalType: "uint256", type: "uint256" },
+      { name: "commitment", internalType: "bytes32", type: "bytes32" },
+      { name: "signature", internalType: "bytes", type: "bytes" }
+    ],
+    name: "transferWithAuthorization",
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "event",
+    anonymous: false,
+    inputs: [
+      {
+        name: "payer",
+        internalType: "address",
+        type: "address",
+        indexed: true
+      },
+      {
+        name: "commitment",
+        internalType: "bytes32",
+        type: "bytes32",
+        indexed: true
+      }
+    ],
+    name: "CommitmentUsed"
+  },
+  { type: "event", anonymous: false, inputs: [], name: "EIP712DomainChanged" },
+  {
+    type: "event",
+    anonymous: false,
+    inputs: [
+      { name: "from", internalType: "address", type: "address", indexed: true },
+      { name: "to", internalType: "address", type: "address", indexed: true },
+      {
+        name: "token",
+        internalType: "address",
+        type: "address",
+        indexed: true
+      },
+      {
+        name: "value",
+        internalType: "uint256",
+        type: "uint256",
+        indexed: false
+      },
+      {
+        name: "commitment",
+        internalType: "bytes32",
+        type: "bytes32",
+        indexed: false
+      }
+    ],
+    name: "TransferWithCommitmentSent"
+  },
+  {
+    type: "error",
+    inputs: [
+      { name: "token", internalType: "address", type: "address" },
+      { name: "from", internalType: "address", type: "address" },
+      { name: "value", internalType: "uint256", type: "uint256" }
+    ],
+    name: "AllowanceNotEnough"
+  },
+  { type: "error", inputs: [], name: "InvalidShortString" },
+  { type: "error", inputs: [], name: "ReentrancyGuardReentrantCall" },
+  {
+    type: "error",
+    inputs: [{ name: "token", internalType: "address", type: "address" }],
+    name: "SafeERC20FailedOperation"
+  },
+  {
+    type: "error",
+    inputs: [{ name: "str", internalType: "string", type: "string" }],
+    name: "StringTooLong"
+  }
+];
+
+// twcConstants.ts
+var transferWithCommitmentAddress = "0x5C260DD537A9c23Bbd42493e59F3CeA7da2DbC71";
+
+// types/utils.ts
+import { type } from "arktype";
+var UINT256_MAX = (1n << 256n) - 1n;
+var uint256 = type("bigint").filter(
+  (v, ctx) => v <= UINT256_MAX && v >= 0n ? true : ctx.reject(`must be: 0n <= value <= ${UINT256_MAX}`)
+);
+var reBytes32 = /^0x[0-9a-fA-F]{64}$/;
+var reBytes = /^0x[0-9a-fA-F]+$/;
+var reAddress = /^0x[0-9a-fA-F]{40}$/;
+var bytes32 = type("string").narrow(
+  (s) => reBytes32.test(s)
+);
+var bytes = type("string").narrow((s) => reBytes.test(s));
+var address = type("string").narrow(
+  (s) => reAddress.test(s)
+);
+
+// utils.ts
+async function assertTransferContractDeployed(publicClient, contractAddress = transferWithCommitmentAddress) {
+  const code = await publicClient.getCode({ address: contractAddress });
+  if (code === void 0 || code === "0x") {
+    throw new Error(
+      `TransferWithCommitment is not deployed at ${contractAddress} on this chain (no contract code). Deploy with CREATE2 (see contracts/TWC_CREATE2.md) or switch network.`
+    );
+  }
+}
+
+// verify.ts
+var verifyArgsSchema = type2({
+  from: address,
+  token: address,
+  to: address,
+  value: uint256,
+  commitment: bytes32
+});
+var getTransferWithCommitmentSentEventLogs = async (publicClient, hash) => {
+  await assertTransferContractDeployed(publicClient);
+  const receipt = await publicClient.getTransactionReceipt({ hash });
+  const logs = parseEventLogs({
+    abi: transferWithCommitmentAbi,
+    eventName: "TransferWithCommitmentSent",
+    logs: receipt.logs
+  });
+  return logs.filter(
+    (log) => log.address.toLowerCase() === transferWithCommitmentAddress.toLowerCase()
+  );
+};
+var verify = async (publicClient, hash, args) => {
+  verifyArgsSchema.assert(args);
+  await assertTransferContractDeployed(publicClient);
+  const receipt = await publicClient.getTransactionReceipt({ hash });
+  const logs = parseEventLogs({
+    abi: transferWithCommitmentAbi,
+    eventName: "TransferWithCommitmentSent",
+    args: {
+      from: args.from,
+      token: args.token,
+      to: args.to,
+      value: args.value,
+      commitment: args.commitment
+    },
+    logs: receipt.logs
+  });
+  const fromOurContract = logs.filter(
+    (log) => log.address.toLowerCase() === transferWithCommitmentAddress.toLowerCase()
+  );
+  if (fromOurContract.length === 0) {
+    throw new Error("TransferWithCommitmentSent event not found");
+  }
+};
+export {
+  getTransferWithCommitmentSentEventLogs,
+  verify,
+  verifyArgsSchema
+};

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "eth-twc-sdk-js",
+  "version": "0.1.0",
+  "type": "module",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "bunx tsup",
+    "prepublishOnly": "bun run build",
+    "test": "bun test test/unit/config.test.ts test/unit/utils.test.ts test/unit/verify.test.ts && bun test --preload ./test/unit/preload.ts test/unit/sign.test.ts test/unit/selfTransfer.test.ts test/unit/signatureTransfer.test.ts",
+    "test:integration": "bash ../scripts/test-sdk-js-integration.sh"
+  },
+  "devDependencies": {
+    "@types/bun": "1.3.11",
+    "prettier": "^3.8.1",
+    "tsup": "^8.5.1",
+    "typescript": "5.9.3"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "arktype": "^2.2.0",
+    "viem": "^2.47.6"
+  },
+  "exports": {
+    "./abi": {
+      "types": "./dist/abi.d.ts",
+      "import": "./dist/abi.js",
+      "require": "./dist/abi.cjs"
+    },
+    "./config": {
+      "types": "./dist/config.d.ts",
+      "import": "./dist/config.js",
+      "require": "./dist/config.cjs"
+    },
+    "./verify": {
+      "types": "./dist/verify.d.ts",
+      "import": "./dist/verify.js",
+      "require": "./dist/verify.cjs"
+    },
+    "./utils": {
+      "types": "./dist/utils.d.ts",
+      "import": "./dist/utils.js",
+      "require": "./dist/utils.cjs"
+    },
+    "./types/utils": {
+      "types": "./dist/types/utils.d.ts",
+      "import": "./dist/types/utils.js",
+      "require": "./dist/types/utils.cjs"
+    },
+    "./types/transferDetail": {
+      "types": "./dist/types/transferDetail.d.ts",
+      "import": "./dist/types/transferDetail.js",
+      "require": "./dist/types/transferDetail.cjs"
+    },
+    "./selfTransfer/single": {
+      "types": "./dist/selfTransfer/single/index.d.ts",
+      "import": "./dist/selfTransfer/single/index.js",
+      "require": "./dist/selfTransfer/single/index.cjs"
+    },
+    "./selfTransfer/batch": {
+      "types": "./dist/selfTransfer/batch/index.d.ts",
+      "import": "./dist/selfTransfer/batch/index.js",
+      "require": "./dist/selfTransfer/batch/index.cjs"
+    },
+    "./selfTransfer/unified": {
+      "types": "./dist/selfTransfer/unified/index.d.ts",
+      "import": "./dist/selfTransfer/unified/index.js",
+      "require": "./dist/selfTransfer/unified/index.cjs"
+    },
+    "./signatureTransfer/single": {
+      "types": "./dist/signatureTransfer/single/index.d.ts",
+      "import": "./dist/signatureTransfer/single/index.js",
+      "require": "./dist/signatureTransfer/single/index.cjs"
+    },
+    "./signatureTransfer/batch": {
+      "types": "./dist/signatureTransfer/batch/index.d.ts",
+      "import": "./dist/signatureTransfer/batch/index.js",
+      "require": "./dist/signatureTransfer/batch/index.cjs"
+    },
+    "./signatureTransfer/unified": {
+      "types": "./dist/signatureTransfer/unified/index.d.ts",
+      "import": "./dist/signatureTransfer/unified/index.js",
+      "require": "./dist/signatureTransfer/unified/index.cjs"
+    },
+    "./signatureTransfer/cancelAuthorization": {
+      "types": "./dist/signatureTransfer/cancelAuthorization/index.d.ts",
+      "import": "./dist/signatureTransfer/cancelAuthorization/index.js",
+      "require": "./dist/signatureTransfer/cancelAuthorization/index.cjs"
+    }
+  }
+}