eth-twc-sdk-js 0.1.0

package/README.md

@@ -0,0 +1,29 @@
+# eth-twc-sdk-js
+
+`TransferWithCommitment` 向けの TypeScript / JavaScript SDK（viem ベース）。
+
+## インストール
+
+```bash
+bun add eth-twc-sdk-js
+```
+
+## 開発
+
+```bash
+bun install
+bun run build
+```
+
+サブパス import（例: `eth-twc-sdk-js/signatureTransfer/single`、`eth-twc-sdk-js/selfTransfer/single`）を利用する。ルートの一括エントリはない。
+
+利用者向けの操作例・API 一覧は **[docs](https://bunsan-pay.github.io/TransferWithCommitment/sdk-js)** を参照。
+
+## 設定
+
+- **`config.transferWithCommitmentAddress`** — CREATE2 **決定論アドレス**（`twcConstants.ts` / `contracts/TWC_CREATE2.md` と一致）。接続チェーンでこのアドレスに **コントラクトが無い**場合、`eth_getCode` により署名・送信・検証前に失敗します。wagmi の `chains` に載せる `chain` 定義は **アプリ側で** `viem/chains` 等から選んでください（SDK はチェーン allowlist を持ちません）。
+
+## セキュリティ・限界（オフチェーン検証）
+
+- **`verify`** はレシート上の `TransferWithCommitmentSent` が **`args` と一致し**、かつ **`config` のコントラクトから発火したログ**であることを確認する。**`getTransferWithCommitmentSentEventLogs`** は当該コントラクト由来のログだけを返す（ハッシュのみ分かる場合の列挙用）。いずれも RPC から取得したレシートに依存する。悪意ある RPC、チェーンの取り違え、未確定ブロック／リオーグはこの SDK 単体では防げない。必要に応じて信頼できるエンドポイントや確定数を運用で担保すること。
+- 詳細な型・前提はリポジトリ内の `SPEC.md` を参照。

package/dist/abi.cjs

@@ -0,0 +1,286 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// abi.ts
+var abi_exports = {};
+__export(abi_exports, {
+  transferWithCommitmentAbi: () => transferWithCommitmentAbi
+});
+module.exports = __toCommonJS(abi_exports);
+
+// ../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"
+  }
+];
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  transferWithCommitmentAbi
+});