@getcofund/protocol 0.0.0-stage → 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 (129) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +414 -2
  3. package/dist/btc/index.d.ts +12 -0
  4. package/dist/btc/index.js +13 -0
  5. package/dist/btc/psbt.d.ts +121 -0
  6. package/dist/btc/psbt.js +377 -0
  7. package/dist/btc/reader.d.ts +42 -0
  8. package/dist/btc/reader.js +85 -0
  9. package/dist/btc/select.d.ts +48 -0
  10. package/dist/btc/select.js +59 -0
  11. package/dist/btc/spend-rules.d.ts +24 -0
  12. package/dist/btc/spend-rules.js +43 -0
  13. package/dist/btc/spend.d.ts +136 -0
  14. package/dist/btc/spend.js +180 -0
  15. package/dist/btc/types.d.ts +65 -0
  16. package/dist/btc/types.js +62 -0
  17. package/dist/btc/vault/bip341-nums.d.ts +35 -0
  18. package/dist/btc/vault/bip341-nums.js +121 -0
  19. package/dist/btc/vault/build.d.ts +5 -0
  20. package/dist/btc/vault/build.js +136 -0
  21. package/dist/btc/vault/canonical-order.d.ts +10 -0
  22. package/dist/btc/vault/canonical-order.js +18 -0
  23. package/dist/btc/vault/from-contract-id.d.ts +9 -0
  24. package/dist/btc/vault/from-contract-id.js +74 -0
  25. package/dist/btc/vault/helpers.d.ts +73 -0
  26. package/dist/btc/vault/helpers.js +129 -0
  27. package/dist/btc/vault/index.d.ts +21 -0
  28. package/dist/btc/vault/index.js +21 -0
  29. package/dist/btc/vault/limits.d.ts +9 -0
  30. package/dist/btc/vault/limits.js +9 -0
  31. package/dist/btc/vault/participant-order.d.ts +69 -0
  32. package/dist/btc/vault/participant-order.js +135 -0
  33. package/dist/btc/vault/script.d.ts +13 -0
  34. package/dist/btc/vault/script.js +39 -0
  35. package/dist/btc/vault/spend.d.ts +63 -0
  36. package/dist/btc/vault/spend.js +93 -0
  37. package/dist/btc/vault/tx-size.d.ts +66 -0
  38. package/dist/btc/vault/tx-size.js +71 -0
  39. package/dist/btc/vault/types.d.ts +49 -0
  40. package/dist/btc/vault/types.js +1 -0
  41. package/dist/btc/vault/vault-policy.d.ts +109 -0
  42. package/dist/btc/vault/vault-policy.js +213 -0
  43. package/dist/btc/vault/vaultContractUtil.d.ts +80 -0
  44. package/dist/btc/vault/vaultContractUtil.js +87 -0
  45. package/dist/btc/vault/xpub.d.ts +28 -0
  46. package/dist/btc/vault/xpub.js +41 -0
  47. package/dist/btc/witness.d.ts +101 -0
  48. package/dist/btc/witness.js +439 -0
  49. package/dist/btc-policies/activation.d.ts +76 -0
  50. package/dist/btc-policies/activation.js +153 -0
  51. package/dist/btc-policies/index.d.ts +7 -0
  52. package/dist/btc-policies/index.js +8 -0
  53. package/dist/btc-policies/policy.d.ts +55 -0
  54. package/dist/btc-policies/policy.js +210 -0
  55. package/dist/evm/abis/index.d.ts +10 -0
  56. package/dist/evm/abis/index.js +11 -0
  57. package/dist/evm/abis/policies.d.ts +279 -0
  58. package/dist/evm/abis/policies.js +363 -0
  59. package/dist/evm/abis/sponsor-guard.d.ts +201 -0
  60. package/dist/evm/abis/sponsor-guard.js +263 -0
  61. package/dist/evm/abis/state.d.ts +989 -0
  62. package/dist/evm/abis/state.js +1290 -0
  63. package/dist/evm/abis/users.d.ts +408 -0
  64. package/dist/evm/abis/users.js +532 -0
  65. package/dist/evm/abis/vault-factory.d.ts +92 -0
  66. package/dist/evm/abis/vault-factory.js +126 -0
  67. package/dist/evm/abis/vault.d.ts +343 -0
  68. package/dist/evm/abis/vault.js +444 -0
  69. package/dist/evm/address.d.ts +2 -0
  70. package/dist/evm/address.js +4 -0
  71. package/dist/evm/calls/common.d.ts +30 -0
  72. package/dist/evm/calls/common.js +51 -0
  73. package/dist/evm/calls/index.d.ts +11 -0
  74. package/dist/evm/calls/index.js +4 -0
  75. package/dist/evm/calls/policies.d.ts +25 -0
  76. package/dist/evm/calls/policies.js +173 -0
  77. package/dist/evm/calls/users.d.ts +61 -0
  78. package/dist/evm/calls/users.js +353 -0
  79. package/dist/evm/calls/vault.d.ts +25 -0
  80. package/dist/evm/calls/vault.js +184 -0
  81. package/dist/evm/chain.d.ts +74 -0
  82. package/dist/evm/chain.js +48 -0
  83. package/dist/evm/company-name.d.ts +46 -0
  84. package/dist/evm/company-name.js +64 -0
  85. package/dist/evm/deployment.d.ts +47 -0
  86. package/dist/evm/deployment.js +110 -0
  87. package/dist/evm/eip712.d.ts +271 -0
  88. package/dist/evm/eip712.js +224 -0
  89. package/dist/evm/index.d.ts +20 -0
  90. package/dist/evm/index.js +21 -0
  91. package/dist/evm/reads.d.ts +64 -0
  92. package/dist/evm/reads.js +131 -0
  93. package/dist/evm/signatures.d.ts +57 -0
  94. package/dist/evm/signatures.js +105 -0
  95. package/dist/evm/simulate/balances.d.ts +76 -0
  96. package/dist/evm/simulate/balances.js +201 -0
  97. package/dist/evm/simulate/describe.d.ts +79 -0
  98. package/dist/evm/simulate/describe.js +188 -0
  99. package/dist/evm/simulate/index.d.ts +12 -0
  100. package/dist/evm/simulate/index.js +13 -0
  101. package/dist/evm/simulate/own-node.d.ts +62 -0
  102. package/dist/evm/simulate/own-node.js +122 -0
  103. package/dist/evm/simulate/request.d.ts +86 -0
  104. package/dist/evm/simulate/request.js +235 -0
  105. package/dist/evm/simulate/revert.d.ts +29 -0
  106. package/dist/evm/simulate/revert.js +192 -0
  107. package/dist/evm/simulate/run.d.ts +51 -0
  108. package/dist/evm/simulate/run.js +214 -0
  109. package/dist/evm/stocks/decode-stock-swap.d.ts +32 -0
  110. package/dist/evm/stocks/decode-stock-swap.js +79 -0
  111. package/dist/evm/stocks/encode-swap.d.ts +45 -0
  112. package/dist/evm/stocks/encode-swap.js +45 -0
  113. package/dist/evm/stocks/index.d.ts +9 -0
  114. package/dist/evm/stocks/index.js +10 -0
  115. package/dist/evm/stocks/quote.d.ts +19 -0
  116. package/dist/evm/stocks/quote.js +46 -0
  117. package/dist/evm/stocks/stock-pools.d.ts +61 -0
  118. package/dist/evm/stocks/stock-pools.js +179 -0
  119. package/dist/evm/submitters.d.ts +32 -0
  120. package/dist/evm/submitters.js +105 -0
  121. package/dist/evm/types.d.ts +146 -0
  122. package/dist/evm/types.js +128 -0
  123. package/dist/keys/index.d.ts +6 -0
  124. package/dist/keys/index.js +7 -0
  125. package/dist/keys/keys.d.ts +63 -0
  126. package/dist/keys/keys.js +80 -0
  127. package/dist/keys/xpub-ownership.d.ts +10 -0
  128. package/dist/keys/xpub-ownership.js +13 -0
  129. package/package.json +60 -3
@@ -0,0 +1,532 @@
1
+ // Generated from the Foundry artifact `out/CFHelpersUsersv1.sol/CFHelpersUsersv1.json`
2
+ // of cofund-solidity. Do not hand-edit: re-run
3
+ // `packages/protocol/scripts/gen-evm-abis.mjs` against a `forge build` of
4
+ // the contracts instead.
5
+ export const usersAbi = [
6
+ {
7
+ type: "constructor",
8
+ inputs: [
9
+ {
10
+ name: "_stateContract",
11
+ type: "address",
12
+ internalType: "address",
13
+ },
14
+ ],
15
+ stateMutability: "nonpayable",
16
+ },
17
+ {
18
+ type: "function",
19
+ name: "COMPLETE_ONBOARDING_TYPEHASH",
20
+ inputs: [],
21
+ outputs: [
22
+ {
23
+ name: "",
24
+ type: "bytes32",
25
+ internalType: "bytes32",
26
+ },
27
+ ],
28
+ stateMutability: "view",
29
+ },
30
+ {
31
+ type: "function",
32
+ name: "INVITE_TYPEHASH",
33
+ inputs: [],
34
+ outputs: [
35
+ {
36
+ name: "",
37
+ type: "bytes32",
38
+ internalType: "bytes32",
39
+ },
40
+ ],
41
+ stateMutability: "view",
42
+ },
43
+ {
44
+ type: "function",
45
+ name: "MAX_INVITE_LIFETIME",
46
+ inputs: [],
47
+ outputs: [
48
+ {
49
+ name: "",
50
+ type: "uint256",
51
+ internalType: "uint256",
52
+ },
53
+ ],
54
+ stateMutability: "view",
55
+ },
56
+ {
57
+ type: "function",
58
+ name: "REMOVE_TYPEHASH",
59
+ inputs: [],
60
+ outputs: [
61
+ {
62
+ name: "",
63
+ type: "bytes32",
64
+ internalType: "bytes32",
65
+ },
66
+ ],
67
+ stateMutability: "view",
68
+ },
69
+ {
70
+ type: "function",
71
+ name: "ROTATE_TYPEHASH",
72
+ inputs: [],
73
+ outputs: [
74
+ {
75
+ name: "",
76
+ type: "bytes32",
77
+ internalType: "bytes32",
78
+ },
79
+ ],
80
+ stateMutability: "view",
81
+ },
82
+ {
83
+ type: "function",
84
+ name: "addUser",
85
+ inputs: [
86
+ {
87
+ name: "args",
88
+ type: "tuple",
89
+ internalType: "struct CFHelpersUsersv1.AddUserArgs",
90
+ components: [
91
+ {
92
+ name: "clientId",
93
+ type: "bytes32",
94
+ internalType: "bytes32",
95
+ },
96
+ {
97
+ name: "company",
98
+ type: "string",
99
+ internalType: "string",
100
+ },
101
+ {
102
+ name: "callerId",
103
+ type: "string",
104
+ internalType: "string",
105
+ },
106
+ {
107
+ name: "userId",
108
+ type: "string",
109
+ internalType: "string",
110
+ },
111
+ {
112
+ name: "isAdmin",
113
+ type: "bool",
114
+ internalType: "bool",
115
+ },
116
+ {
117
+ name: "userPosition",
118
+ type: "string",
119
+ internalType: "string",
120
+ },
121
+ {
122
+ name: "expiresAt",
123
+ type: "uint256",
124
+ internalType: "uint256",
125
+ },
126
+ {
127
+ name: "authId",
128
+ type: "string",
129
+ internalType: "string",
130
+ },
131
+ ],
132
+ },
133
+ {
134
+ name: "adminSignature",
135
+ type: "bytes",
136
+ internalType: "bytes",
137
+ },
138
+ {
139
+ name: "adminCoSignatures",
140
+ type: "bytes[]",
141
+ internalType: "bytes[]",
142
+ },
143
+ {
144
+ name: "invitee",
145
+ type: "address",
146
+ internalType: "address",
147
+ },
148
+ {
149
+ name: "inviteeSignature",
150
+ type: "bytes",
151
+ internalType: "bytes",
152
+ },
153
+ ],
154
+ outputs: [
155
+ {
156
+ name: "",
157
+ type: "bool",
158
+ internalType: "bool",
159
+ },
160
+ ],
161
+ stateMutability: "nonpayable",
162
+ },
163
+ {
164
+ type: "function",
165
+ name: "completeOnboarding",
166
+ inputs: [
167
+ {
168
+ name: "clientId",
169
+ type: "bytes32",
170
+ internalType: "bytes32",
171
+ },
172
+ {
173
+ name: "company",
174
+ type: "string",
175
+ internalType: "string",
176
+ },
177
+ {
178
+ name: "authId",
179
+ type: "string",
180
+ internalType: "string",
181
+ },
182
+ {
183
+ name: "adminSignature",
184
+ type: "bytes",
185
+ internalType: "bytes",
186
+ },
187
+ ],
188
+ outputs: [
189
+ {
190
+ name: "",
191
+ type: "bool",
192
+ internalType: "bool",
193
+ },
194
+ ],
195
+ stateMutability: "nonpayable",
196
+ },
197
+ {
198
+ type: "function",
199
+ name: "completeOnboardingDigest",
200
+ inputs: [
201
+ {
202
+ name: "company",
203
+ type: "string",
204
+ internalType: "string",
205
+ },
206
+ {
207
+ name: "authId",
208
+ type: "string",
209
+ internalType: "string",
210
+ },
211
+ ],
212
+ outputs: [
213
+ {
214
+ name: "",
215
+ type: "bytes32",
216
+ internalType: "bytes32",
217
+ },
218
+ ],
219
+ stateMutability: "view",
220
+ },
221
+ {
222
+ type: "function",
223
+ name: "createClient",
224
+ inputs: [
225
+ {
226
+ name: "clientId",
227
+ type: "bytes32",
228
+ internalType: "bytes32",
229
+ },
230
+ {
231
+ name: "company",
232
+ type: "string",
233
+ internalType: "string",
234
+ },
235
+ {
236
+ name: "adminId",
237
+ type: "string",
238
+ internalType: "string",
239
+ },
240
+ {
241
+ name: "founder",
242
+ type: "address",
243
+ internalType: "address",
244
+ },
245
+ {
246
+ name: "clientTier",
247
+ type: "string",
248
+ internalType: "string",
249
+ },
250
+ {
251
+ name: "expiresAt",
252
+ type: "uint256",
253
+ internalType: "uint256",
254
+ },
255
+ {
256
+ name: "authId",
257
+ type: "string",
258
+ internalType: "string",
259
+ },
260
+ {
261
+ name: "founderSignature",
262
+ type: "bytes",
263
+ internalType: "bytes",
264
+ },
265
+ ],
266
+ outputs: [
267
+ {
268
+ name: "",
269
+ type: "bool",
270
+ internalType: "bool",
271
+ },
272
+ ],
273
+ stateMutability: "nonpayable",
274
+ },
275
+ {
276
+ type: "function",
277
+ name: "eip712Domain",
278
+ inputs: [],
279
+ outputs: [
280
+ {
281
+ name: "fields",
282
+ type: "bytes1",
283
+ internalType: "bytes1",
284
+ },
285
+ {
286
+ name: "name",
287
+ type: "string",
288
+ internalType: "string",
289
+ },
290
+ {
291
+ name: "version",
292
+ type: "string",
293
+ internalType: "string",
294
+ },
295
+ {
296
+ name: "chainId",
297
+ type: "uint256",
298
+ internalType: "uint256",
299
+ },
300
+ {
301
+ name: "verifyingContract",
302
+ type: "address",
303
+ internalType: "address",
304
+ },
305
+ {
306
+ name: "salt",
307
+ type: "bytes32",
308
+ internalType: "bytes32",
309
+ },
310
+ {
311
+ name: "extensions",
312
+ type: "uint256[]",
313
+ internalType: "uint256[]",
314
+ },
315
+ ],
316
+ stateMutability: "view",
317
+ },
318
+ {
319
+ type: "function",
320
+ name: "inviteDigest",
321
+ inputs: [
322
+ {
323
+ name: "company",
324
+ type: "string",
325
+ internalType: "string",
326
+ },
327
+ {
328
+ name: "callerId",
329
+ type: "string",
330
+ internalType: "string",
331
+ },
332
+ {
333
+ name: "userId",
334
+ type: "string",
335
+ internalType: "string",
336
+ },
337
+ {
338
+ name: "userIsAdmin",
339
+ type: "bool",
340
+ internalType: "bool",
341
+ },
342
+ {
343
+ name: "userPosition",
344
+ type: "string",
345
+ internalType: "string",
346
+ },
347
+ {
348
+ name: "expiresAt",
349
+ type: "uint256",
350
+ internalType: "uint256",
351
+ },
352
+ {
353
+ name: "authId",
354
+ type: "string",
355
+ internalType: "string",
356
+ },
357
+ ],
358
+ outputs: [
359
+ {
360
+ name: "",
361
+ type: "bytes32",
362
+ internalType: "bytes32",
363
+ },
364
+ ],
365
+ stateMutability: "view",
366
+ },
367
+ {
368
+ type: "function",
369
+ name: "removeUser",
370
+ inputs: [
371
+ {
372
+ name: "clientId",
373
+ type: "bytes32",
374
+ internalType: "bytes32",
375
+ },
376
+ {
377
+ name: "company",
378
+ type: "string",
379
+ internalType: "string",
380
+ },
381
+ {
382
+ name: "removedUserId",
383
+ type: "string",
384
+ internalType: "string",
385
+ },
386
+ {
387
+ name: "authId",
388
+ type: "string",
389
+ internalType: "string",
390
+ },
391
+ {
392
+ name: "signatures",
393
+ type: "bytes[]",
394
+ internalType: "bytes[]",
395
+ },
396
+ ],
397
+ outputs: [
398
+ {
399
+ name: "",
400
+ type: "bool",
401
+ internalType: "bool",
402
+ },
403
+ ],
404
+ stateMutability: "nonpayable",
405
+ },
406
+ {
407
+ type: "function",
408
+ name: "requiredAdminInviteSignatures",
409
+ inputs: [
410
+ {
411
+ name: "clientId",
412
+ type: "bytes32",
413
+ internalType: "bytes32",
414
+ },
415
+ ],
416
+ outputs: [
417
+ {
418
+ name: "",
419
+ type: "uint256",
420
+ internalType: "uint256",
421
+ },
422
+ ],
423
+ stateMutability: "view",
424
+ },
425
+ {
426
+ type: "function",
427
+ name: "rotateUser",
428
+ inputs: [
429
+ {
430
+ name: "clientId",
431
+ type: "bytes32",
432
+ internalType: "bytes32",
433
+ },
434
+ {
435
+ name: "company",
436
+ type: "string",
437
+ internalType: "string",
438
+ },
439
+ {
440
+ name: "userId",
441
+ type: "string",
442
+ internalType: "string",
443
+ },
444
+ {
445
+ name: "newAddress",
446
+ type: "address",
447
+ internalType: "address",
448
+ },
449
+ {
450
+ name: "authId",
451
+ type: "string",
452
+ internalType: "string",
453
+ },
454
+ {
455
+ name: "currentKeySignature",
456
+ type: "bytes",
457
+ internalType: "bytes",
458
+ },
459
+ {
460
+ name: "newKeySignature",
461
+ type: "bytes",
462
+ internalType: "bytes",
463
+ },
464
+ {
465
+ name: "adminSignatures",
466
+ type: "bytes[]",
467
+ internalType: "bytes[]",
468
+ },
469
+ ],
470
+ outputs: [
471
+ {
472
+ name: "",
473
+ type: "bool",
474
+ internalType: "bool",
475
+ },
476
+ ],
477
+ stateMutability: "nonpayable",
478
+ },
479
+ {
480
+ type: "function",
481
+ name: "stateContract",
482
+ inputs: [],
483
+ outputs: [
484
+ {
485
+ name: "",
486
+ type: "address",
487
+ internalType: "contract ICofundHelperState",
488
+ },
489
+ ],
490
+ stateMutability: "view",
491
+ },
492
+ {
493
+ type: "error",
494
+ name: "InactiveSigner",
495
+ inputs: [],
496
+ },
497
+ {
498
+ type: "error",
499
+ name: "InvalidCompany",
500
+ inputs: [],
501
+ },
502
+ {
503
+ type: "error",
504
+ name: "InvalidParams",
505
+ inputs: [],
506
+ },
507
+ {
508
+ type: "error",
509
+ name: "InvalidSignature",
510
+ inputs: [],
511
+ },
512
+ {
513
+ type: "error",
514
+ name: "InvalidSigner",
515
+ inputs: [],
516
+ },
517
+ {
518
+ type: "error",
519
+ name: "InviteExpired",
520
+ inputs: [],
521
+ },
522
+ {
523
+ type: "error",
524
+ name: "ThresholdNotMet",
525
+ inputs: [],
526
+ },
527
+ {
528
+ type: "error",
529
+ name: "UnauthorizedCaller",
530
+ inputs: [],
531
+ },
532
+ ];
@@ -0,0 +1,92 @@
1
+ export declare const vaultFactoryAbi: readonly [{
2
+ readonly type: "constructor";
3
+ readonly inputs: readonly [{
4
+ readonly name: "_state";
5
+ readonly type: "address";
6
+ readonly internalType: "address";
7
+ }];
8
+ readonly stateMutability: "nonpayable";
9
+ }, {
10
+ readonly type: "function";
11
+ readonly name: "createVault";
12
+ readonly inputs: readonly [{
13
+ readonly name: "clientId";
14
+ readonly type: "bytes32";
15
+ readonly internalType: "bytes32";
16
+ }];
17
+ readonly outputs: readonly [{
18
+ readonly name: "vault";
19
+ readonly type: "address";
20
+ readonly internalType: "address";
21
+ }];
22
+ readonly stateMutability: "nonpayable";
23
+ }, {
24
+ readonly type: "function";
25
+ readonly name: "predictVault";
26
+ readonly inputs: readonly [{
27
+ readonly name: "clientId";
28
+ readonly type: "bytes32";
29
+ readonly internalType: "bytes32";
30
+ }];
31
+ readonly outputs: readonly [{
32
+ readonly name: "";
33
+ readonly type: "address";
34
+ readonly internalType: "address";
35
+ }];
36
+ readonly stateMutability: "view";
37
+ }, {
38
+ readonly type: "function";
39
+ readonly name: "state";
40
+ readonly inputs: readonly [];
41
+ readonly outputs: readonly [{
42
+ readonly name: "";
43
+ readonly type: "address";
44
+ readonly internalType: "address";
45
+ }];
46
+ readonly stateMutability: "view";
47
+ }, {
48
+ readonly type: "function";
49
+ readonly name: "template";
50
+ readonly inputs: readonly [];
51
+ readonly outputs: readonly [{
52
+ readonly name: "";
53
+ readonly type: "address";
54
+ readonly internalType: "address";
55
+ }];
56
+ readonly stateMutability: "view";
57
+ }, {
58
+ readonly type: "event";
59
+ readonly name: "VaultCreated";
60
+ readonly inputs: readonly [{
61
+ readonly name: "clientId";
62
+ readonly type: "bytes32";
63
+ readonly indexed: true;
64
+ readonly internalType: "bytes32";
65
+ }, {
66
+ readonly name: "vault";
67
+ readonly type: "address";
68
+ readonly indexed: false;
69
+ readonly internalType: "address";
70
+ }];
71
+ readonly anonymous: false;
72
+ }, {
73
+ readonly type: "error";
74
+ readonly name: "FailedDeployment";
75
+ readonly inputs: readonly [];
76
+ }, {
77
+ readonly type: "error";
78
+ readonly name: "InsufficientBalance";
79
+ readonly inputs: readonly [{
80
+ readonly name: "balance";
81
+ readonly type: "uint256";
82
+ readonly internalType: "uint256";
83
+ }, {
84
+ readonly name: "needed";
85
+ readonly type: "uint256";
86
+ readonly internalType: "uint256";
87
+ }];
88
+ }, {
89
+ readonly type: "error";
90
+ readonly name: "UnauthorizedCaller";
91
+ readonly inputs: readonly [];
92
+ }];