@boostxyz/sdk 0.0.0-alpha.2

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 (117) hide show
  1. package/LICENSE +674 -0
  2. package/README.md +7 -0
  3. package/dist/Actions/Action.cjs +1 -0
  4. package/dist/Actions/Action.d.ts +31 -0
  5. package/dist/Actions/Action.d.ts.map +1 -0
  6. package/dist/Actions/Action.js +27 -0
  7. package/dist/Actions/ContractAction.d.ts +327 -0
  8. package/dist/Actions/ContractAction.d.ts.map +1 -0
  9. package/dist/Actions/ERC721MintAction.d.ts +486 -0
  10. package/dist/Actions/ERC721MintAction.d.ts.map +1 -0
  11. package/dist/Actions/EventAction.cjs +1 -0
  12. package/dist/Actions/EventAction.d.ts +433 -0
  13. package/dist/Actions/EventAction.d.ts.map +1 -0
  14. package/dist/Actions/EventAction.js +211 -0
  15. package/dist/AllowLists/AllowList.cjs +1 -0
  16. package/dist/AllowLists/AllowList.d.ts +33 -0
  17. package/dist/AllowLists/AllowList.d.ts.map +1 -0
  18. package/dist/AllowLists/AllowList.js +28 -0
  19. package/dist/AllowLists/SimpleAllowList.cjs +1 -0
  20. package/dist/AllowLists/SimpleAllowList.d.ts +452 -0
  21. package/dist/AllowLists/SimpleAllowList.d.ts.map +1 -0
  22. package/dist/AllowLists/SimpleAllowList.js +138 -0
  23. package/dist/AllowLists/SimpleDenyList.cjs +1 -0
  24. package/dist/AllowLists/SimpleDenyList.d.ts +306 -0
  25. package/dist/AllowLists/SimpleDenyList.d.ts.map +1 -0
  26. package/dist/AllowLists/SimpleDenyList.js +202 -0
  27. package/dist/Auth/Auth.cjs +1 -0
  28. package/dist/Auth/Auth.d.ts +10 -0
  29. package/dist/Auth/Auth.d.ts.map +1 -0
  30. package/dist/Auth/Auth.js +4 -0
  31. package/dist/Auth/PassthroughAuth.cjs +1 -0
  32. package/dist/Auth/PassthroughAuth.d.ts +51 -0
  33. package/dist/Auth/PassthroughAuth.d.ts.map +1 -0
  34. package/dist/Auth/PassthroughAuth.js +38 -0
  35. package/dist/Boost.cjs +1 -0
  36. package/dist/Boost.d.ts +142 -0
  37. package/dist/Boost.d.ts.map +1 -0
  38. package/dist/Boost.js +15 -0
  39. package/dist/BoostCore.cjs +2 -0
  40. package/dist/BoostCore.d.ts +460 -0
  41. package/dist/BoostCore.d.ts.map +1 -0
  42. package/dist/BoostCore.js +1105 -0
  43. package/dist/BoostRegistry.cjs +1 -0
  44. package/dist/BoostRegistry.d.ts +229 -0
  45. package/dist/BoostRegistry.d.ts.map +1 -0
  46. package/dist/BoostRegistry.js +250 -0
  47. package/dist/Budgets/Budget.cjs +1 -0
  48. package/dist/Budgets/Budget.d.ts +31 -0
  49. package/dist/Budgets/Budget.d.ts.map +1 -0
  50. package/dist/Budgets/Budget.js +27 -0
  51. package/dist/Budgets/ManagedBudget.cjs +1 -0
  52. package/dist/Budgets/ManagedBudget.d.ts +1065 -0
  53. package/dist/Budgets/ManagedBudget.d.ts.map +1 -0
  54. package/dist/Budgets/ManagedBudget.js +498 -0
  55. package/dist/Budgets/SimpleBudget.d.ts +793 -0
  56. package/dist/Budgets/SimpleBudget.d.ts.map +1 -0
  57. package/dist/Budgets/VestingBudget.d.ts +726 -0
  58. package/dist/Budgets/VestingBudget.d.ts.map +1 -0
  59. package/dist/Deployable/Contract.cjs +1 -0
  60. package/dist/Deployable/Contract.d.ts +125 -0
  61. package/dist/Deployable/Contract.d.ts.map +1 -0
  62. package/dist/Deployable/Contract.js +149 -0
  63. package/dist/Deployable/Deployable.cjs +1 -0
  64. package/dist/Deployable/Deployable.d.ts +155 -0
  65. package/dist/Deployable/Deployable.d.ts.map +1 -0
  66. package/dist/Deployable/Deployable.js +124 -0
  67. package/dist/Deployable/DeployableTarget.cjs +1 -0
  68. package/dist/Deployable/DeployableTarget.d.ts +115 -0
  69. package/dist/Deployable/DeployableTarget.d.ts.map +1 -0
  70. package/dist/Deployable/DeployableTarget.js +128 -0
  71. package/dist/Incentives/AllowListIncentive.cjs +1 -0
  72. package/dist/Incentives/AllowListIncentive.d.ts +483 -0
  73. package/dist/Incentives/AllowListIncentive.d.ts.map +1 -0
  74. package/dist/Incentives/AllowListIncentive.js +188 -0
  75. package/dist/Incentives/CGDAIncentive.cjs +1 -0
  76. package/dist/Incentives/CGDAIncentive.d.ts +560 -0
  77. package/dist/Incentives/CGDAIncentive.d.ts.map +1 -0
  78. package/dist/Incentives/CGDAIncentive.js +249 -0
  79. package/dist/Incentives/ERC1155Incentive.d.ts +652 -0
  80. package/dist/Incentives/ERC1155Incentive.d.ts.map +1 -0
  81. package/dist/Incentives/ERC20Incentive.cjs +1 -0
  82. package/dist/Incentives/ERC20Incentive.d.ts +622 -0
  83. package/dist/Incentives/ERC20Incentive.d.ts.map +1 -0
  84. package/dist/Incentives/ERC20Incentive.js +292 -0
  85. package/dist/Incentives/ERC20VariableIncentive.d.ts +545 -0
  86. package/dist/Incentives/ERC20VariableIncentive.d.ts.map +1 -0
  87. package/dist/Incentives/Incentive.cjs +1 -0
  88. package/dist/Incentives/Incentive.d.ts +39 -0
  89. package/dist/Incentives/Incentive.d.ts.map +1 -0
  90. package/dist/Incentives/Incentive.js +280 -0
  91. package/dist/Incentives/PointsIncentive.cjs +1 -0
  92. package/dist/Incentives/PointsIncentive.d.ts +615 -0
  93. package/dist/Incentives/PointsIncentive.d.ts.map +1 -0
  94. package/dist/Incentives/PointsIncentive.js +197 -0
  95. package/dist/Validators/SignerValidator.cjs +1 -0
  96. package/dist/Validators/SignerValidator.d.ts +452 -0
  97. package/dist/Validators/SignerValidator.d.ts.map +1 -0
  98. package/dist/Validators/SignerValidator.js +167 -0
  99. package/dist/Validators/Validator.cjs +1 -0
  100. package/dist/Validators/Validator.d.ts +31 -0
  101. package/dist/Validators/Validator.d.ts.map +1 -0
  102. package/dist/Validators/Validator.js +25 -0
  103. package/dist/errors.cjs +1 -0
  104. package/dist/errors.d.ts +257 -0
  105. package/dist/errors.d.ts.map +1 -0
  106. package/dist/errors.js +161 -0
  107. package/dist/generated-BaaleHW-.cjs +2 -0
  108. package/dist/generated-x_abr3Yv.js +6228 -0
  109. package/dist/index.cjs +1 -0
  110. package/dist/index.d.ts +29 -0
  111. package/dist/index.d.ts.map +1 -0
  112. package/dist/index.js +1355 -0
  113. package/dist/utils.cjs +1 -0
  114. package/dist/utils.d.ts +1454 -0
  115. package/dist/utils.d.ts.map +1 -0
  116. package/dist/utils.js +643 -0
  117. package/package.json +197 -0
@@ -0,0 +1,615 @@
1
+ import { pointsIncentiveAbi } from '@boostxyz/evm';
2
+ import type { Address, ContractEventName } from 'viem';
3
+ import type { DeployableOptions, GenericDeployableParams } from '../Deployable/Deployable';
4
+ import { DeployableTarget } from '../Deployable/DeployableTarget';
5
+ import { type ClaimPayload, type GenericLog, type PointsIncentivePayload, type ReadParams, RegistryType, type WriteParams } from '../utils';
6
+ export { pointsIncentiveAbi };
7
+ export type { PointsIncentivePayload };
8
+ /**
9
+ * A generic `viem.Log` event with support for `PointsIncentive` event types.
10
+ *
11
+ * @export
12
+ * @typedef {PointsIncentiveLog}
13
+ * @template {ContractEventName<
14
+ * typeof pointsIncentiveAbi
15
+ * >} [event=ContractEventName<typeof pointsIncentiveAbi>]
16
+ */
17
+ export type PointsIncentiveLog<event extends ContractEventName<typeof pointsIncentiveAbi> = ContractEventName<typeof pointsIncentiveAbi>> = GenericLog<typeof pointsIncentiveAbi, event>;
18
+ /**
19
+ * A simple on-chain points incentive implementation that allows claiming of soulbound tokens.
20
+ *
21
+ * In order for any claim to be successful:
22
+ * - The claimer must not have already claimed the incentive; and
23
+ * - The maximum number of claims must not have been reached; and
24
+ * - This contract must be authorized to operate the points contract's issuance function
25
+ *
26
+ * @export
27
+ * @class PointsIncentive
28
+ * @typedef {PointsIncentive}
29
+ * @extends {DeployableTarget<PointsIncentivePayload>}
30
+ */
31
+ export declare class PointsIncentive extends DeployableTarget<PointsIncentivePayload, typeof pointsIncentiveAbi> {
32
+ readonly abi: readonly [{
33
+ readonly type: "constructor";
34
+ readonly inputs: readonly [];
35
+ readonly stateMutability: "nonpayable";
36
+ }, {
37
+ readonly type: "error";
38
+ readonly inputs: readonly [];
39
+ readonly name: "AlreadyInitialized";
40
+ }, {
41
+ readonly type: "error";
42
+ readonly inputs: readonly [];
43
+ readonly name: "ClaimFailed";
44
+ }, {
45
+ readonly type: "error";
46
+ readonly inputs: readonly [];
47
+ readonly name: "CloneAlreadyInitialized";
48
+ }, {
49
+ readonly type: "error";
50
+ readonly inputs: readonly [];
51
+ readonly name: "InitializerNotImplemented";
52
+ }, {
53
+ readonly type: "error";
54
+ readonly inputs: readonly [];
55
+ readonly name: "InvalidInitialization";
56
+ }, {
57
+ readonly type: "error";
58
+ readonly inputs: readonly [];
59
+ readonly name: "InvalidInitialization";
60
+ }, {
61
+ readonly type: "error";
62
+ readonly inputs: readonly [];
63
+ readonly name: "InvalidInitializationData";
64
+ }, {
65
+ readonly type: "error";
66
+ readonly inputs: readonly [];
67
+ readonly name: "NewOwnerIsZeroAddress";
68
+ }, {
69
+ readonly type: "error";
70
+ readonly inputs: readonly [];
71
+ readonly name: "NoHandoverRequest";
72
+ }, {
73
+ readonly type: "error";
74
+ readonly inputs: readonly [];
75
+ readonly name: "NotClaimable";
76
+ }, {
77
+ readonly type: "error";
78
+ readonly inputs: readonly [];
79
+ readonly name: "NotImplemented";
80
+ }, {
81
+ readonly type: "error";
82
+ readonly inputs: readonly [];
83
+ readonly name: "NotInitializing";
84
+ }, {
85
+ readonly type: "error";
86
+ readonly inputs: readonly [];
87
+ readonly name: "Unauthorized";
88
+ }, {
89
+ readonly type: "error";
90
+ readonly inputs: readonly [];
91
+ readonly name: "Unauthorized";
92
+ }, {
93
+ readonly type: "event";
94
+ readonly anonymous: false;
95
+ readonly inputs: readonly [{
96
+ readonly name: "recipient";
97
+ readonly internalType: "address";
98
+ readonly type: "address";
99
+ readonly indexed: true;
100
+ }, {
101
+ readonly name: "data";
102
+ readonly internalType: "bytes";
103
+ readonly type: "bytes";
104
+ readonly indexed: false;
105
+ }];
106
+ readonly name: "Claimed";
107
+ }, {
108
+ readonly type: "event";
109
+ readonly anonymous: false;
110
+ readonly inputs: readonly [{
111
+ readonly name: "version";
112
+ readonly internalType: "uint64";
113
+ readonly type: "uint64";
114
+ readonly indexed: false;
115
+ }];
116
+ readonly name: "Initialized";
117
+ }, {
118
+ readonly type: "event";
119
+ readonly anonymous: false;
120
+ readonly inputs: readonly [{
121
+ readonly name: "pendingOwner";
122
+ readonly internalType: "address";
123
+ readonly type: "address";
124
+ readonly indexed: true;
125
+ }];
126
+ readonly name: "OwnershipHandoverCanceled";
127
+ }, {
128
+ readonly type: "event";
129
+ readonly anonymous: false;
130
+ readonly inputs: readonly [{
131
+ readonly name: "pendingOwner";
132
+ readonly internalType: "address";
133
+ readonly type: "address";
134
+ readonly indexed: true;
135
+ }];
136
+ readonly name: "OwnershipHandoverRequested";
137
+ }, {
138
+ readonly type: "event";
139
+ readonly anonymous: false;
140
+ readonly inputs: readonly [{
141
+ readonly name: "oldOwner";
142
+ readonly internalType: "address";
143
+ readonly type: "address";
144
+ readonly indexed: true;
145
+ }, {
146
+ readonly name: "newOwner";
147
+ readonly internalType: "address";
148
+ readonly type: "address";
149
+ readonly indexed: true;
150
+ }];
151
+ readonly name: "OwnershipTransferred";
152
+ }, {
153
+ readonly type: "event";
154
+ readonly anonymous: false;
155
+ readonly inputs: readonly [{
156
+ readonly name: "user";
157
+ readonly internalType: "address";
158
+ readonly type: "address";
159
+ readonly indexed: true;
160
+ }, {
161
+ readonly name: "roles";
162
+ readonly internalType: "uint256";
163
+ readonly type: "uint256";
164
+ readonly indexed: true;
165
+ }];
166
+ readonly name: "RolesUpdated";
167
+ }, {
168
+ readonly type: "function";
169
+ readonly inputs: readonly [];
170
+ readonly name: "cancelOwnershipHandover";
171
+ readonly outputs: readonly [];
172
+ readonly stateMutability: "payable";
173
+ }, {
174
+ readonly type: "function";
175
+ readonly inputs: readonly [{
176
+ readonly name: "claimTarget";
177
+ readonly internalType: "address";
178
+ readonly type: "address";
179
+ }, {
180
+ readonly name: "";
181
+ readonly internalType: "bytes";
182
+ readonly type: "bytes";
183
+ }];
184
+ readonly name: "claim";
185
+ readonly outputs: readonly [{
186
+ readonly name: "";
187
+ readonly internalType: "bool";
188
+ readonly type: "bool";
189
+ }];
190
+ readonly stateMutability: "nonpayable";
191
+ }, {
192
+ readonly type: "function";
193
+ readonly inputs: readonly [{
194
+ readonly name: "";
195
+ readonly internalType: "address";
196
+ readonly type: "address";
197
+ }];
198
+ readonly name: "claimed";
199
+ readonly outputs: readonly [{
200
+ readonly name: "";
201
+ readonly internalType: "bool";
202
+ readonly type: "bool";
203
+ }];
204
+ readonly stateMutability: "view";
205
+ }, {
206
+ readonly type: "function";
207
+ readonly inputs: readonly [];
208
+ readonly name: "claims";
209
+ readonly outputs: readonly [{
210
+ readonly name: "";
211
+ readonly internalType: "uint256";
212
+ readonly type: "uint256";
213
+ }];
214
+ readonly stateMutability: "view";
215
+ }, {
216
+ readonly type: "function";
217
+ readonly inputs: readonly [{
218
+ readonly name: "";
219
+ readonly internalType: "bytes";
220
+ readonly type: "bytes";
221
+ }];
222
+ readonly name: "clawback";
223
+ readonly outputs: readonly [{
224
+ readonly name: "";
225
+ readonly internalType: "bool";
226
+ readonly type: "bool";
227
+ }];
228
+ readonly stateMutability: "pure";
229
+ }, {
230
+ readonly type: "function";
231
+ readonly inputs: readonly [{
232
+ readonly name: "pendingOwner";
233
+ readonly internalType: "address";
234
+ readonly type: "address";
235
+ }];
236
+ readonly name: "completeOwnershipHandover";
237
+ readonly outputs: readonly [];
238
+ readonly stateMutability: "payable";
239
+ }, {
240
+ readonly type: "function";
241
+ readonly inputs: readonly [];
242
+ readonly name: "currentReward";
243
+ readonly outputs: readonly [{
244
+ readonly name: "";
245
+ readonly internalType: "uint256";
246
+ readonly type: "uint256";
247
+ }];
248
+ readonly stateMutability: "view";
249
+ }, {
250
+ readonly type: "function";
251
+ readonly inputs: readonly [];
252
+ readonly name: "getComponentInterface";
253
+ readonly outputs: readonly [{
254
+ readonly name: "";
255
+ readonly internalType: "bytes4";
256
+ readonly type: "bytes4";
257
+ }];
258
+ readonly stateMutability: "pure";
259
+ }, {
260
+ readonly type: "function";
261
+ readonly inputs: readonly [{
262
+ readonly name: "user";
263
+ readonly internalType: "address";
264
+ readonly type: "address";
265
+ }, {
266
+ readonly name: "roles";
267
+ readonly internalType: "uint256";
268
+ readonly type: "uint256";
269
+ }];
270
+ readonly name: "grantRoles";
271
+ readonly outputs: readonly [];
272
+ readonly stateMutability: "payable";
273
+ }, {
274
+ readonly type: "function";
275
+ readonly inputs: readonly [{
276
+ readonly name: "user";
277
+ readonly internalType: "address";
278
+ readonly type: "address";
279
+ }, {
280
+ readonly name: "roles";
281
+ readonly internalType: "uint256";
282
+ readonly type: "uint256";
283
+ }];
284
+ readonly name: "hasAllRoles";
285
+ readonly outputs: readonly [{
286
+ readonly name: "";
287
+ readonly internalType: "bool";
288
+ readonly type: "bool";
289
+ }];
290
+ readonly stateMutability: "view";
291
+ }, {
292
+ readonly type: "function";
293
+ readonly inputs: readonly [{
294
+ readonly name: "user";
295
+ readonly internalType: "address";
296
+ readonly type: "address";
297
+ }, {
298
+ readonly name: "roles";
299
+ readonly internalType: "uint256";
300
+ readonly type: "uint256";
301
+ }];
302
+ readonly name: "hasAnyRole";
303
+ readonly outputs: readonly [{
304
+ readonly name: "";
305
+ readonly internalType: "bool";
306
+ readonly type: "bool";
307
+ }];
308
+ readonly stateMutability: "view";
309
+ }, {
310
+ readonly type: "function";
311
+ readonly inputs: readonly [{
312
+ readonly name: "data_";
313
+ readonly internalType: "bytes";
314
+ readonly type: "bytes";
315
+ }];
316
+ readonly name: "initialize";
317
+ readonly outputs: readonly [];
318
+ readonly stateMutability: "nonpayable";
319
+ }, {
320
+ readonly type: "function";
321
+ readonly inputs: readonly [{
322
+ readonly name: "claimTarget";
323
+ readonly internalType: "address";
324
+ readonly type: "address";
325
+ }, {
326
+ readonly name: "";
327
+ readonly internalType: "bytes";
328
+ readonly type: "bytes";
329
+ }];
330
+ readonly name: "isClaimable";
331
+ readonly outputs: readonly [{
332
+ readonly name: "";
333
+ readonly internalType: "bool";
334
+ readonly type: "bool";
335
+ }];
336
+ readonly stateMutability: "view";
337
+ }, {
338
+ readonly type: "function";
339
+ readonly inputs: readonly [];
340
+ readonly name: "limit";
341
+ readonly outputs: readonly [{
342
+ readonly name: "";
343
+ readonly internalType: "uint256";
344
+ readonly type: "uint256";
345
+ }];
346
+ readonly stateMutability: "view";
347
+ }, {
348
+ readonly type: "function";
349
+ readonly inputs: readonly [];
350
+ readonly name: "owner";
351
+ readonly outputs: readonly [{
352
+ readonly name: "result";
353
+ readonly internalType: "address";
354
+ readonly type: "address";
355
+ }];
356
+ readonly stateMutability: "view";
357
+ }, {
358
+ readonly type: "function";
359
+ readonly inputs: readonly [{
360
+ readonly name: "pendingOwner";
361
+ readonly internalType: "address";
362
+ readonly type: "address";
363
+ }];
364
+ readonly name: "ownershipHandoverExpiresAt";
365
+ readonly outputs: readonly [{
366
+ readonly name: "result";
367
+ readonly internalType: "uint256";
368
+ readonly type: "uint256";
369
+ }];
370
+ readonly stateMutability: "view";
371
+ }, {
372
+ readonly type: "function";
373
+ readonly inputs: readonly [{
374
+ readonly name: "";
375
+ readonly internalType: "bytes";
376
+ readonly type: "bytes";
377
+ }];
378
+ readonly name: "preflight";
379
+ readonly outputs: readonly [{
380
+ readonly name: "budgetData";
381
+ readonly internalType: "bytes";
382
+ readonly type: "bytes";
383
+ }];
384
+ readonly stateMutability: "pure";
385
+ }, {
386
+ readonly type: "function";
387
+ readonly inputs: readonly [];
388
+ readonly name: "renounceOwnership";
389
+ readonly outputs: readonly [];
390
+ readonly stateMutability: "payable";
391
+ }, {
392
+ readonly type: "function";
393
+ readonly inputs: readonly [{
394
+ readonly name: "roles";
395
+ readonly internalType: "uint256";
396
+ readonly type: "uint256";
397
+ }];
398
+ readonly name: "renounceRoles";
399
+ readonly outputs: readonly [];
400
+ readonly stateMutability: "payable";
401
+ }, {
402
+ readonly type: "function";
403
+ readonly inputs: readonly [];
404
+ readonly name: "requestOwnershipHandover";
405
+ readonly outputs: readonly [];
406
+ readonly stateMutability: "payable";
407
+ }, {
408
+ readonly type: "function";
409
+ readonly inputs: readonly [{
410
+ readonly name: "user";
411
+ readonly internalType: "address";
412
+ readonly type: "address";
413
+ }, {
414
+ readonly name: "roles";
415
+ readonly internalType: "uint256";
416
+ readonly type: "uint256";
417
+ }];
418
+ readonly name: "revokeRoles";
419
+ readonly outputs: readonly [];
420
+ readonly stateMutability: "payable";
421
+ }, {
422
+ readonly type: "function";
423
+ readonly inputs: readonly [];
424
+ readonly name: "reward";
425
+ readonly outputs: readonly [{
426
+ readonly name: "";
427
+ readonly internalType: "uint256";
428
+ readonly type: "uint256";
429
+ }];
430
+ readonly stateMutability: "view";
431
+ }, {
432
+ readonly type: "function";
433
+ readonly inputs: readonly [{
434
+ readonly name: "user";
435
+ readonly internalType: "address";
436
+ readonly type: "address";
437
+ }];
438
+ readonly name: "rolesOf";
439
+ readonly outputs: readonly [{
440
+ readonly name: "roles";
441
+ readonly internalType: "uint256";
442
+ readonly type: "uint256";
443
+ }];
444
+ readonly stateMutability: "view";
445
+ }, {
446
+ readonly type: "function";
447
+ readonly inputs: readonly [];
448
+ readonly name: "selector";
449
+ readonly outputs: readonly [{
450
+ readonly name: "";
451
+ readonly internalType: "bytes4";
452
+ readonly type: "bytes4";
453
+ }];
454
+ readonly stateMutability: "view";
455
+ }, {
456
+ readonly type: "function";
457
+ readonly inputs: readonly [{
458
+ readonly name: "interfaceId";
459
+ readonly internalType: "bytes4";
460
+ readonly type: "bytes4";
461
+ }];
462
+ readonly name: "supportsInterface";
463
+ readonly outputs: readonly [{
464
+ readonly name: "";
465
+ readonly internalType: "bool";
466
+ readonly type: "bool";
467
+ }];
468
+ readonly stateMutability: "view";
469
+ }, {
470
+ readonly type: "function";
471
+ readonly inputs: readonly [{
472
+ readonly name: "newOwner";
473
+ readonly internalType: "address";
474
+ readonly type: "address";
475
+ }];
476
+ readonly name: "transferOwnership";
477
+ readonly outputs: readonly [];
478
+ readonly stateMutability: "payable";
479
+ }, {
480
+ readonly type: "function";
481
+ readonly inputs: readonly [];
482
+ readonly name: "venue";
483
+ readonly outputs: readonly [{
484
+ readonly name: "";
485
+ readonly internalType: "address";
486
+ readonly type: "address";
487
+ }];
488
+ readonly stateMutability: "view";
489
+ }];
490
+ /**
491
+ * @inheritdoc
492
+ *
493
+ * @public
494
+ * @static
495
+ * @type {Address}
496
+ */
497
+ static base: Address;
498
+ /**
499
+ * @inheritdoc
500
+ *
501
+ * @public
502
+ * @static
503
+ * @type {RegistryType}
504
+ */
505
+ static registryType: RegistryType;
506
+ /**
507
+ * The number of claims that have been made
508
+ *
509
+ * @public
510
+ * @async
511
+ * @param {?ReadParams<typeof erc20IncentiveAbi, 'claims'>} [params]
512
+ * @returns {Promise<bigint>}
513
+ */
514
+ claims(params?: ReadParams<typeof pointsIncentiveAbi, 'claims'>): Promise<bigint>;
515
+ /**
516
+ * The current reward
517
+ *
518
+ * @public
519
+ * @async
520
+ * @param {?ReadParams<typeof erc20IncentiveAbi, 'currentReward'>} [params]
521
+ * @returns {Promise<bigint>} - The current reward
522
+ */
523
+ currentReward(params?: ReadParams<typeof pointsIncentiveAbi, 'currentReward'>): Promise<bigint>;
524
+ /**
525
+ * The reward amount issued for each claim
526
+ *
527
+ * @public
528
+ * @async
529
+ * @param {?ReadParams<typeof pointsIncentiveAbi, 'reward'>} [params]
530
+ * @returns {unknown}
531
+ */
532
+ reward(params?: ReadParams<typeof pointsIncentiveAbi, 'reward'>): Promise<bigint>;
533
+ /**
534
+ * A mapping of address to claim status
535
+ *
536
+ * @public
537
+ * @async
538
+ * @param {Address} address
539
+ * @param {?ReadParams<typeof pointsIncentiveAbi, 'claimed'>} [params]
540
+ * @returns {unknown}
541
+ */
542
+ claimed(address: Address, params?: ReadParams<typeof pointsIncentiveAbi, 'claimed'>): Promise<boolean>;
543
+ /**
544
+ * The address of the points contract
545
+ *
546
+ * @public
547
+ * @async
548
+ * @param {?ReadParams<typeof pointsIncentiveAbi, 'venue'>} [params]
549
+ * @returns {unknown}
550
+ */
551
+ venue(params?: ReadParams<typeof pointsIncentiveAbi, 'venue'>): Promise<`0x${string}`>;
552
+ /**
553
+ * The maximum number of claims that can be made (one per address)
554
+ *
555
+ * @public
556
+ * @async
557
+ * @param {?ReadParams<typeof pointsIncentiveAbi, 'limit'>} [params]
558
+ * @returns {Promise<bigint>}
559
+ */
560
+ limit(params?: ReadParams<typeof pointsIncentiveAbi, 'limit'>): Promise<bigint>;
561
+ /**
562
+ * The selector for the issuance function on the points contract
563
+ *
564
+ * @public
565
+ * @async
566
+ * @param {?ReadParams<typeof pointsIncentiveAbi, 'selector'>} [params]
567
+ * @returns {Promise<Hex>}
568
+ */
569
+ selector(params?: ReadParams<typeof pointsIncentiveAbi, 'selector'>): Promise<`0x${string}`>;
570
+ /**
571
+ * Claim the incentive
572
+ *
573
+ * @public
574
+ * @async
575
+ * @param {ClaimPayload} payload
576
+ * @param {?WriteParams<typeof pointsIncentiveAbi, 'claim'>} [params]
577
+ * @returns {Promise<boolean>} - True if the incentive was successfully claimed
578
+ */
579
+ claim(payload: ClaimPayload, params?: WriteParams<typeof pointsIncentiveAbi, 'claim'>): Promise<boolean>;
580
+ /**
581
+ * Claim the incentive
582
+ *
583
+ * @public
584
+ * @async
585
+ * @param {ClaimPayload} payload
586
+ * @param {?WriteParams<typeof pointsIncentiveAbi, 'claim'>} [params]
587
+ * @returns {Promise<boolean>} - True if the incentive was successfully claimed
588
+ */
589
+ claimRaw(payload: ClaimPayload, params?: WriteParams<typeof pointsIncentiveAbi, 'claim'>): Promise<{
590
+ hash: `0x${string}`;
591
+ result: boolean;
592
+ }>;
593
+ /**
594
+ * Check if an incentive is claimable.
595
+ * For the POOL strategy, the `bytes data` portion of the payload ignored.
596
+ * The recipient must not have already claimed the incentive.
597
+ *
598
+ * @public
599
+ * @async
600
+ * @param {ClaimPayload} payload
601
+ * @param {?ReadParams<typeof pointsIncentiveAbi, 'isClaimable'>} [params]
602
+ * @returns {Promise<boolean>} - True if the incentive is claimable based on the data payload
603
+ */
604
+ isClaimable(payload: ClaimPayload, params?: ReadParams<typeof pointsIncentiveAbi, 'isClaimable'>): Promise<boolean>;
605
+ /**
606
+ * @inheritdoc
607
+ *
608
+ * @public
609
+ * @param {?PointsIncentivePayload} [_payload]
610
+ * @param {?DeployableOptions} [_options]
611
+ * @returns {GenericDeployableParams}
612
+ */
613
+ buildParameters(_payload?: PointsIncentivePayload, _options?: DeployableOptions): GenericDeployableParams;
614
+ }
615
+ //# sourceMappingURL=PointsIncentive.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PointsIncentive.d.ts","sourceRoot":"","sources":["../../src/Incentives/PointsIncentive.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAWnB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAO,MAAM,MAAM,CAAC;AAC5D,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,YAAY,EACZ,KAAK,WAAW,EAGjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,kBAAkB,EAAE,CAAC;AAC9B,YAAY,EAAE,sBAAsB,EAAE,CAAC;AAEvC;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,CAC5B,KAAK,SAAS,iBAAiB,CAC7B,OAAO,kBAAkB,CAC1B,GAAG,iBAAiB,CAAC,OAAO,kBAAkB,CAAC,IAC9C,UAAU,CAAC,OAAO,kBAAkB,EAAE,KAAK,CAAC,CAAC;AAEjD;;;;;;;;;;;;GAYG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB,CACnD,sBAAsB,EACtB,OAAO,kBAAkB,CAC1B;IACC,SAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAsB;IAClD;;;;;;OAMG;IACH,OAAuB,IAAI,EAAE,OAAO,CACN;IAC9B;;;;;;OAMG;IACH,OAAuB,YAAY,EAAE,YAAY,CAA0B;IAE3E;;;;;;;OAOG;IACU,MAAM,CACjB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,QAAQ,CAAC;IAU1D;;;;;;;OAOG;IACU,aAAa,CACxB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,eAAe,CAAC;IAUjE;;;;;;;OAOG;IACU,MAAM,CACjB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,QAAQ,CAAC;IAU1D;;;;;;;;OAQG;IACU,OAAO,CAClB,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,SAAS,CAAC;IAU3D;;;;;;;OAOG;IACU,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,OAAO,CAAC;IAQ1E;;;;;;;OAOG;IACU,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,OAAO,CAAC;IAQ1E;;;;;;;OAOG;IACU,QAAQ,CACnB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,UAAU,CAAC;IAS5D;;;;;;;;OAQG;IACU,KAAK,CAChB,OAAO,EAAE,YAAY,EACrB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,OAAO,CAAC;IAK1D;;;;;;;;OAQG;IACU,QAAQ,CACnB,OAAO,EAAE,YAAY,EACrB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,OAAO,CAAC;;;;IAgB1D;;;;;;;;;;OAUG;IACU,WAAW,CACtB,OAAO,EAAE,YAAY,EACrB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,aAAa,CAAC;IAU/D;;;;;;;OAOG;IACa,eAAe,CAC7B,QAAQ,CAAC,EAAE,sBAAsB,EACjC,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;CAY3B"}