eth-twc-sdk-js 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/README.md +29 -0
  2. package/dist/abi.cjs +286 -0
  3. package/dist/abi.d.cts +419 -0
  4. package/dist/abi.d.ts +419 -0
  5. package/dist/abi.js +259 -0
  6. package/dist/config.cjs +41 -0
  7. package/dist/config.d.cts +14 -0
  8. package/dist/config.d.ts +14 -0
  9. package/dist/config.js +11 -0
  10. package/dist/selfTransfer/batch/index.cjs +373 -0
  11. package/dist/selfTransfer/batch/index.d.cts +24 -0
  12. package/dist/selfTransfer/batch/index.d.ts +24 -0
  13. package/dist/selfTransfer/batch/index.js +345 -0
  14. package/dist/selfTransfer/single/index.cjs +360 -0
  15. package/dist/selfTransfer/single/index.d.cts +20 -0
  16. package/dist/selfTransfer/single/index.d.ts +20 -0
  17. package/dist/selfTransfer/single/index.js +332 -0
  18. package/dist/selfTransfer/unified/index.cjs +372 -0
  19. package/dist/selfTransfer/unified/index.d.cts +24 -0
  20. package/dist/selfTransfer/unified/index.d.ts +24 -0
  21. package/dist/selfTransfer/unified/index.js +344 -0
  22. package/dist/signatureTransfer/batch/index.cjs +545 -0
  23. package/dist/signatureTransfer/batch/index.d.cts +100 -0
  24. package/dist/signatureTransfer/batch/index.d.ts +100 -0
  25. package/dist/signatureTransfer/batch/index.js +514 -0
  26. package/dist/signatureTransfer/cancelAuthorization/index.cjs +491 -0
  27. package/dist/signatureTransfer/cancelAuthorization/index.d.cts +49 -0
  28. package/dist/signatureTransfer/cancelAuthorization/index.d.ts +49 -0
  29. package/dist/signatureTransfer/cancelAuthorization/index.js +460 -0
  30. package/dist/signatureTransfer/single/index.cjs +528 -0
  31. package/dist/signatureTransfer/single/index.d.cts +84 -0
  32. package/dist/signatureTransfer/single/index.d.ts +84 -0
  33. package/dist/signatureTransfer/single/index.js +497 -0
  34. package/dist/signatureTransfer/unified/index.cjs +541 -0
  35. package/dist/signatureTransfer/unified/index.d.cts +95 -0
  36. package/dist/signatureTransfer/unified/index.d.ts +95 -0
  37. package/dist/signatureTransfer/unified/index.js +510 -0
  38. package/dist/types/transferDetail.cjs +62 -0
  39. package/dist/types/transferDetail.d.cts +15 -0
  40. package/dist/types/transferDetail.d.ts +15 -0
  41. package/dist/types/transferDetail.js +36 -0
  42. package/dist/types/utils.cjs +52 -0
  43. package/dist/types/utils.d.cts +12 -0
  44. package/dist/types/utils.d.ts +12 -0
  45. package/dist/types/utils.js +23 -0
  46. package/dist/utils.cjs +123 -0
  47. package/dist/utils.d.cts +21 -0
  48. package/dist/utils.d.ts +21 -0
  49. package/dist/utils.js +90 -0
  50. package/dist/verify.cjs +366 -0
  51. package/dist/verify.d.cts +433 -0
  52. package/dist/verify.d.ts +433 -0
  53. package/dist/verify.js +339 -0
  54. package/package.json +100 -0
@@ -0,0 +1,497 @@
1
+ // twcConstants.ts
2
+ var EIP712_DOMAIN_NAME = "TransferWithCommitment";
3
+ var EIP712_DOMAIN_VERSION = "1";
4
+ var transferWithCommitmentAddress = "0x5C260DD537A9c23Bbd42493e59F3CeA7da2DbC71";
5
+
6
+ // utils.ts
7
+ var chainIdToBig = (id) => typeof id === "bigint" ? id : BigInt(id);
8
+ var assertPublicWalletSameChain = (publicClient, wallet) => {
9
+ const publicId = publicClient.chain?.id;
10
+ const walletId = wallet.chain?.id;
11
+ if (publicId === void 0 || walletId === void 0) {
12
+ throw new Error(
13
+ "Chain is not set on public client and/or wallet client"
14
+ );
15
+ }
16
+ if (publicId !== walletId) {
17
+ throw new Error(
18
+ `PublicClient and WalletClient chain mismatch: ${publicId} vs ${walletId}`
19
+ );
20
+ }
21
+ };
22
+ async function assertTransferContractDeployed(publicClient, contractAddress = transferWithCommitmentAddress) {
23
+ const code = await publicClient.getCode({ address: contractAddress });
24
+ if (code === void 0 || code === "0x") {
25
+ throw new Error(
26
+ `TransferWithCommitment is not deployed at ${contractAddress} on this chain (no contract code). Deploy with CREATE2 (see contracts/TWC_CREATE2.md) or switch network.`
27
+ );
28
+ }
29
+ }
30
+ function assertEip712DomainFromContractMatchesExpected(publicClient, eip712) {
31
+ const chainId = publicClient.chain?.id;
32
+ if (chainId === void 0) {
33
+ throw new Error("Chain is not set on public client");
34
+ }
35
+ const d = eip712.domain;
36
+ if (d.name !== EIP712_DOMAIN_NAME) {
37
+ throw new Error(
38
+ `Unexpected EIP-712 domain name: expected "${EIP712_DOMAIN_NAME}", got "${String(d.name)}"`
39
+ );
40
+ }
41
+ if (d.version !== EIP712_DOMAIN_VERSION) {
42
+ throw new Error(
43
+ `Unexpected EIP-712 domain version: expected "${EIP712_DOMAIN_VERSION}", got "${String(d.version)}"`
44
+ );
45
+ }
46
+ const vc = d.verifyingContract;
47
+ if (vc === void 0 || vc.toLowerCase() !== transferWithCommitmentAddress.toLowerCase()) {
48
+ throw new Error(
49
+ `Unexpected EIP-712 verifyingContract: expected ${transferWithCommitmentAddress}, got ${String(vc)}`
50
+ );
51
+ }
52
+ if (d.chainId !== void 0 && chainIdToBig(d.chainId) !== BigInt(chainId)) {
53
+ throw new Error(
54
+ `EIP-712 domain.chainId (${d.chainId}) does not match public client chain id (${chainId})`
55
+ );
56
+ }
57
+ }
58
+ var assertSignerMatchesEip712Role = (signer, messageAddress, role) => {
59
+ if (signer.toLowerCase() !== messageAddress.toLowerCase()) {
60
+ throw new Error(
61
+ `Signer account (${signer}) does not match EIP-712 message ${role} (${messageAddress})`
62
+ );
63
+ }
64
+ };
65
+ var assertSignedDomainMatchesClientAndConfig = (publicClient, domain, configuredContract) => {
66
+ const publicId = publicClient.chain?.id;
67
+ if (publicId === void 0) {
68
+ throw new Error("Chain is not set on public client");
69
+ }
70
+ if (chainIdToBig(domain.chainId) !== BigInt(publicId)) {
71
+ throw new Error(
72
+ `Signed data domain.chainId (${domain.chainId}) does not match client chain id (${publicId})`
73
+ );
74
+ }
75
+ if (domain.verifyingContract.toLowerCase() !== configuredContract.toLowerCase()) {
76
+ throw new Error(
77
+ `Signed data domain.verifyingContract (${domain.verifyingContract}) does not match transferWithCommitmentAddress (${configuredContract})`
78
+ );
79
+ }
80
+ };
81
+
82
+ // signatureTransfer/shared/domain.ts
83
+ var ZERO_SALT = "0x0000000000000000000000000000000000000000000000000000000000000000";
84
+ function domainForTypedDataSign(raw) {
85
+ if (raw.salt !== void 0 && typeof raw.salt === "string" && raw.salt.toLowerCase() === ZERO_SALT) {
86
+ const { salt: _s, ...rest } = raw;
87
+ return rest;
88
+ }
89
+ return raw;
90
+ }
91
+
92
+ // signatureTransfer/single/eip712Types.ts
93
+ var eip712Types = {
94
+ TransferWithCommit: [
95
+ { name: "from", type: "address" },
96
+ { name: "to", type: "address" },
97
+ { name: "token", type: "address" },
98
+ { name: "executor", type: "address" },
99
+ { name: "value", type: "uint256" },
100
+ { name: "validAfter", type: "uint256" },
101
+ { name: "validBefore", type: "uint256" },
102
+ { name: "commitment", type: "bytes32" }
103
+ ]
104
+ };
105
+
106
+ // signatureTransfer/single/types.ts
107
+ import { type as type3 } from "arktype";
108
+
109
+ // types/utils.ts
110
+ import { type } from "arktype";
111
+ var UINT256_MAX = (1n << 256n) - 1n;
112
+ var uint256 = type("bigint").filter(
113
+ (v, ctx) => v <= UINT256_MAX && v >= 0n ? true : ctx.reject(`must be: 0n <= value <= ${UINT256_MAX}`)
114
+ );
115
+ var reBytes32 = /^0x[0-9a-fA-F]{64}$/;
116
+ var reBytes = /^0x[0-9a-fA-F]+$/;
117
+ var reAddress = /^0x[0-9a-fA-F]{40}$/;
118
+ var bytes32 = type("string").narrow(
119
+ (s) => reBytes32.test(s)
120
+ );
121
+ var bytes = type("string").narrow((s) => reBytes.test(s));
122
+ var address = type("string").narrow(
123
+ (s) => reAddress.test(s)
124
+ );
125
+
126
+ // signatureTransfer/shared/signedDomain.ts
127
+ import { type as type2 } from "arktype";
128
+ var chainIdAsDomain = type2("number").or(uint256);
129
+ var signedDomainSchema = type2({
130
+ name: type2("string"),
131
+ version: type2("string"),
132
+ chainId: chainIdAsDomain,
133
+ verifyingContract: address,
134
+ salt: bytes32.optional()
135
+ });
136
+
137
+ // signatureTransfer/single/types.ts
138
+ var argsSchema = type3({
139
+ from: address,
140
+ to: address,
141
+ token: address,
142
+ executor: address,
143
+ value: uint256,
144
+ validAfter: uint256.default(0n),
145
+ validBefore: uint256.default(UINT256_MAX),
146
+ commitment: bytes32
147
+ }).narrow((v) => v.validAfter <= v.validBefore);
148
+ var signedSingleSchema = type3({
149
+ domain: signedDomainSchema,
150
+ from: address,
151
+ to: address,
152
+ token: address,
153
+ value: uint256,
154
+ validAfter: uint256,
155
+ validBefore: uint256,
156
+ commitment: bytes32,
157
+ signature: bytes
158
+ }).narrow((v) => v.validAfter <= v.validBefore);
159
+ var signedDataSchema = signedSingleSchema;
160
+
161
+ // signatureTransfer/single/sign.ts
162
+ var sign = async (publicClient, wallet, account, args) => {
163
+ assertPublicWalletSameChain(publicClient, wallet);
164
+ const a = argsSchema.assert(args);
165
+ assertSignerMatchesEip712Role(account, a.from, "from");
166
+ await assertTransferContractDeployed(publicClient);
167
+ const rawEip712 = await publicClient.getEip712Domain({
168
+ address: transferWithCommitmentAddress
169
+ });
170
+ assertEip712DomainFromContractMatchesExpected(publicClient, rawEip712);
171
+ const domain = domainForTypedDataSign(rawEip712.domain);
172
+ const signature = await wallet.signTypedData({
173
+ account,
174
+ domain,
175
+ types: eip712Types,
176
+ primaryType: "TransferWithCommit",
177
+ message: {
178
+ from: a.from,
179
+ to: a.to,
180
+ token: a.token,
181
+ executor: a.executor,
182
+ value: a.value,
183
+ validAfter: a.validAfter,
184
+ validBefore: a.validBefore,
185
+ commitment: a.commitment
186
+ }
187
+ });
188
+ return {
189
+ domain,
190
+ from: a.from,
191
+ to: a.to,
192
+ token: a.token,
193
+ value: a.value,
194
+ commitment: a.commitment,
195
+ validAfter: a.validAfter,
196
+ validBefore: a.validBefore,
197
+ signature
198
+ };
199
+ };
200
+
201
+ // ../contracts/abi/generated.ts
202
+ var transferWithCommitmentAbi = [
203
+ {
204
+ type: "constructor",
205
+ inputs: [
206
+ { name: "name", internalType: "string", type: "string" },
207
+ { name: "version", internalType: "string", type: "string" }
208
+ ],
209
+ stateMutability: "nonpayable"
210
+ },
211
+ {
212
+ type: "function",
213
+ inputs: [],
214
+ name: "BATCH_TRANSFER_WITH_COMMIT_TYPEHASH",
215
+ outputs: [{ name: "", internalType: "bytes32", type: "bytes32" }],
216
+ stateMutability: "view"
217
+ },
218
+ {
219
+ type: "function",
220
+ inputs: [],
221
+ name: "CANCEL_AUTHORIZATION_TYPEHASH",
222
+ outputs: [{ name: "", internalType: "bytes32", type: "bytes32" }],
223
+ stateMutability: "view"
224
+ },
225
+ {
226
+ type: "function",
227
+ inputs: [],
228
+ name: "TRANSFER_WITH_COMMIT_TYPEHASH",
229
+ outputs: [{ name: "", internalType: "bytes32", type: "bytes32" }],
230
+ stateMutability: "view"
231
+ },
232
+ {
233
+ type: "function",
234
+ inputs: [],
235
+ name: "UNI_COMMIT_TRANSFER_TYPEHASH",
236
+ outputs: [{ name: "", internalType: "bytes32", type: "bytes32" }],
237
+ stateMutability: "view"
238
+ },
239
+ {
240
+ type: "function",
241
+ inputs: [
242
+ { name: "authorizer", internalType: "address", type: "address" },
243
+ { name: "commitment", internalType: "bytes32", type: "bytes32" },
244
+ { name: "signature", internalType: "bytes", type: "bytes" }
245
+ ],
246
+ name: "cancelAuthorization",
247
+ outputs: [],
248
+ stateMutability: "nonpayable"
249
+ },
250
+ {
251
+ type: "function",
252
+ inputs: [
253
+ { name: "payer", internalType: "address", type: "address" },
254
+ { name: "commitment", internalType: "bytes32", type: "bytes32" }
255
+ ],
256
+ name: "commitmentState",
257
+ outputs: [{ name: "", internalType: "bool", type: "bool" }],
258
+ stateMutability: "view"
259
+ },
260
+ {
261
+ type: "function",
262
+ inputs: [],
263
+ name: "eip712Domain",
264
+ outputs: [
265
+ { name: "fields", internalType: "bytes1", type: "bytes1" },
266
+ { name: "name", internalType: "string", type: "string" },
267
+ { name: "version", internalType: "string", type: "string" },
268
+ { name: "chainId", internalType: "uint256", type: "uint256" },
269
+ { name: "verifyingContract", internalType: "address", type: "address" },
270
+ { name: "salt", internalType: "bytes32", type: "bytes32" },
271
+ { name: "extensions", internalType: "uint256[]", type: "uint256[]" }
272
+ ],
273
+ stateMutability: "view"
274
+ },
275
+ {
276
+ type: "function",
277
+ inputs: [
278
+ { name: "token", internalType: "address", type: "address" },
279
+ { name: "to", internalType: "address", type: "address" },
280
+ { name: "value", internalType: "uint256", type: "uint256" },
281
+ { name: "commitment", internalType: "bytes32", type: "bytes32" }
282
+ ],
283
+ name: "transfer",
284
+ outputs: [],
285
+ stateMutability: "nonpayable"
286
+ },
287
+ {
288
+ type: "function",
289
+ inputs: [
290
+ {
291
+ name: "details",
292
+ internalType: "struct TransferDetail[]",
293
+ type: "tuple[]",
294
+ components: [
295
+ { name: "to", internalType: "address", type: "address" },
296
+ { name: "token", internalType: "address", type: "address" },
297
+ { name: "value", internalType: "uint256", type: "uint256" }
298
+ ]
299
+ },
300
+ { name: "commitment", internalType: "bytes32", type: "bytes32" }
301
+ ],
302
+ name: "transfer",
303
+ outputs: [],
304
+ stateMutability: "nonpayable"
305
+ },
306
+ {
307
+ type: "function",
308
+ inputs: [
309
+ {
310
+ name: "details",
311
+ internalType: "struct CommittedTransferDetail[]",
312
+ type: "tuple[]",
313
+ components: [
314
+ { name: "to", internalType: "address", type: "address" },
315
+ { name: "token", internalType: "address", type: "address" },
316
+ { name: "value", internalType: "uint256", type: "uint256" },
317
+ { name: "commitment", internalType: "bytes32", type: "bytes32" }
318
+ ]
319
+ }
320
+ ],
321
+ name: "transfer",
322
+ outputs: [],
323
+ stateMutability: "nonpayable"
324
+ },
325
+ {
326
+ type: "function",
327
+ inputs: [
328
+ { name: "from", internalType: "address", type: "address" },
329
+ {
330
+ name: "details",
331
+ internalType: "struct TransferDetail[]",
332
+ type: "tuple[]",
333
+ components: [
334
+ { name: "to", internalType: "address", type: "address" },
335
+ { name: "token", internalType: "address", type: "address" },
336
+ { name: "value", internalType: "uint256", type: "uint256" }
337
+ ]
338
+ },
339
+ { name: "validAfter", internalType: "uint256", type: "uint256" },
340
+ { name: "validBefore", internalType: "uint256", type: "uint256" },
341
+ { name: "commitment", internalType: "bytes32", type: "bytes32" },
342
+ { name: "signature", internalType: "bytes", type: "bytes" }
343
+ ],
344
+ name: "transferWithAuthorization",
345
+ outputs: [],
346
+ stateMutability: "nonpayable"
347
+ },
348
+ {
349
+ type: "function",
350
+ inputs: [
351
+ { name: "from", internalType: "address", type: "address" },
352
+ {
353
+ name: "details",
354
+ internalType: "struct CommittedTransferDetail[]",
355
+ type: "tuple[]",
356
+ components: [
357
+ { name: "to", internalType: "address", type: "address" },
358
+ { name: "token", internalType: "address", type: "address" },
359
+ { name: "value", internalType: "uint256", type: "uint256" },
360
+ { name: "commitment", internalType: "bytes32", type: "bytes32" }
361
+ ]
362
+ },
363
+ { name: "validAfter", internalType: "uint256", type: "uint256" },
364
+ { name: "validBefore", internalType: "uint256", type: "uint256" },
365
+ { name: "batchCommitment", internalType: "bytes32", type: "bytes32" },
366
+ { name: "signature", internalType: "bytes", type: "bytes" }
367
+ ],
368
+ name: "transferWithAuthorization",
369
+ outputs: [],
370
+ stateMutability: "nonpayable"
371
+ },
372
+ {
373
+ type: "function",
374
+ inputs: [
375
+ { name: "from", internalType: "address", type: "address" },
376
+ { name: "to", internalType: "address", type: "address" },
377
+ { name: "token", internalType: "address", type: "address" },
378
+ { name: "value", internalType: "uint256", type: "uint256" },
379
+ { name: "validAfter", internalType: "uint256", type: "uint256" },
380
+ { name: "validBefore", internalType: "uint256", type: "uint256" },
381
+ { name: "commitment", internalType: "bytes32", type: "bytes32" },
382
+ { name: "signature", internalType: "bytes", type: "bytes" }
383
+ ],
384
+ name: "transferWithAuthorization",
385
+ outputs: [],
386
+ stateMutability: "nonpayable"
387
+ },
388
+ {
389
+ type: "event",
390
+ anonymous: false,
391
+ inputs: [
392
+ {
393
+ name: "payer",
394
+ internalType: "address",
395
+ type: "address",
396
+ indexed: true
397
+ },
398
+ {
399
+ name: "commitment",
400
+ internalType: "bytes32",
401
+ type: "bytes32",
402
+ indexed: true
403
+ }
404
+ ],
405
+ name: "CommitmentUsed"
406
+ },
407
+ { type: "event", anonymous: false, inputs: [], name: "EIP712DomainChanged" },
408
+ {
409
+ type: "event",
410
+ anonymous: false,
411
+ inputs: [
412
+ { name: "from", internalType: "address", type: "address", indexed: true },
413
+ { name: "to", internalType: "address", type: "address", indexed: true },
414
+ {
415
+ name: "token",
416
+ internalType: "address",
417
+ type: "address",
418
+ indexed: true
419
+ },
420
+ {
421
+ name: "value",
422
+ internalType: "uint256",
423
+ type: "uint256",
424
+ indexed: false
425
+ },
426
+ {
427
+ name: "commitment",
428
+ internalType: "bytes32",
429
+ type: "bytes32",
430
+ indexed: false
431
+ }
432
+ ],
433
+ name: "TransferWithCommitmentSent"
434
+ },
435
+ {
436
+ type: "error",
437
+ inputs: [
438
+ { name: "token", internalType: "address", type: "address" },
439
+ { name: "from", internalType: "address", type: "address" },
440
+ { name: "value", internalType: "uint256", type: "uint256" }
441
+ ],
442
+ name: "AllowanceNotEnough"
443
+ },
444
+ { type: "error", inputs: [], name: "InvalidShortString" },
445
+ { type: "error", inputs: [], name: "ReentrancyGuardReentrantCall" },
446
+ {
447
+ type: "error",
448
+ inputs: [{ name: "token", internalType: "address", type: "address" }],
449
+ name: "SafeERC20FailedOperation"
450
+ },
451
+ {
452
+ type: "error",
453
+ inputs: [{ name: "str", internalType: "string", type: "string" }],
454
+ name: "StringTooLong"
455
+ }
456
+ ];
457
+
458
+ // signatureTransfer/shared/context.ts
459
+ async function assertSignatureTransferContext(publicClient, wallet, signedData) {
460
+ assertPublicWalletSameChain(publicClient, wallet);
461
+ await assertTransferContractDeployed(publicClient, transferWithCommitmentAddress);
462
+ assertSignedDomainMatchesClientAndConfig(
463
+ publicClient,
464
+ signedData.domain,
465
+ transferWithCommitmentAddress
466
+ );
467
+ }
468
+
469
+ // signatureTransfer/single/sendTx.ts
470
+ var sendTx = async (publicClient, wallet, account, signedData) => {
471
+ await assertSignatureTransferContext(publicClient, wallet, signedData);
472
+ const { request } = await publicClient.simulateContract({
473
+ address: transferWithCommitmentAddress,
474
+ abi: transferWithCommitmentAbi,
475
+ functionName: "transferWithAuthorization",
476
+ args: [
477
+ signedData.from,
478
+ signedData.to,
479
+ signedData.token,
480
+ signedData.value,
481
+ signedData.validAfter,
482
+ signedData.validBefore,
483
+ signedData.commitment,
484
+ signedData.signature
485
+ ],
486
+ account
487
+ });
488
+ const hash = await wallet.writeContract(request);
489
+ return hash;
490
+ };
491
+ export {
492
+ argsSchema,
493
+ eip712Types,
494
+ sendTx,
495
+ sign,
496
+ signedDataSchema
497
+ };