@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,560 @@
1
+ import { cgdaIncentiveAbi } 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 CGDAIncentivePayload, type CGDAParameters, type ClaimPayload, type GenericLog, type ReadParams, RegistryType, type WriteParams } from '../utils';
6
+ export { cgdaIncentiveAbi };
7
+ export type { CGDAIncentivePayload };
8
+ /**
9
+ * A generic `viem.Log` event with support for `CGDAIncentive` event types.
10
+ *
11
+ * @export
12
+ * @typedef {CGDAIncentiveLog}
13
+ * @template {ContractEventName<typeof cgdaIncentiveAbi>} [event=ContractEventName<
14
+ * typeof cgdaIncentiveAbi
15
+ * >]
16
+ */
17
+ export type CGDAIncentiveLog<event extends ContractEventName<typeof cgdaIncentiveAbi> = ContractEventName<typeof cgdaIncentiveAbi>> = GenericLog<typeof cgdaIncentiveAbi, event>;
18
+ /**
19
+ * Continuous Gradual Dutch Auction Incentive.
20
+ * An CGDA incentive implementation with reward amounts adjusting dynamically based on claim volume.
21
+ *
22
+ * @export
23
+ * @class CGDAIncentive
24
+ * @typedef {CGDAIncentive}
25
+ * @extends {DeployableTarget<CGDAIncentivePayload>}
26
+ */
27
+ export declare class CGDAIncentive extends DeployableTarget<CGDAIncentivePayload, typeof cgdaIncentiveAbi> {
28
+ readonly abi: readonly [{
29
+ readonly type: "constructor";
30
+ readonly inputs: readonly [];
31
+ readonly stateMutability: "nonpayable";
32
+ }, {
33
+ readonly type: "error";
34
+ readonly inputs: readonly [];
35
+ readonly name: "AlreadyInitialized";
36
+ }, {
37
+ readonly type: "error";
38
+ readonly inputs: readonly [];
39
+ readonly name: "ClaimFailed";
40
+ }, {
41
+ readonly type: "error";
42
+ readonly inputs: readonly [];
43
+ readonly name: "CloneAlreadyInitialized";
44
+ }, {
45
+ readonly type: "error";
46
+ readonly inputs: readonly [];
47
+ readonly name: "InitializerNotImplemented";
48
+ }, {
49
+ readonly type: "error";
50
+ readonly inputs: readonly [{
51
+ readonly name: "asset";
52
+ readonly internalType: "address";
53
+ readonly type: "address";
54
+ }, {
55
+ readonly name: "available";
56
+ readonly internalType: "uint256";
57
+ readonly type: "uint256";
58
+ }, {
59
+ readonly name: "required";
60
+ readonly internalType: "uint256";
61
+ readonly type: "uint256";
62
+ }];
63
+ readonly name: "InsufficientFunds";
64
+ }, {
65
+ readonly type: "error";
66
+ readonly inputs: readonly [];
67
+ readonly name: "InvalidInitialization";
68
+ }, {
69
+ readonly type: "error";
70
+ readonly inputs: readonly [];
71
+ readonly name: "InvalidInitialization";
72
+ }, {
73
+ readonly type: "error";
74
+ readonly inputs: readonly [];
75
+ readonly name: "InvalidInitializationData";
76
+ }, {
77
+ readonly type: "error";
78
+ readonly inputs: readonly [];
79
+ readonly name: "NewOwnerIsZeroAddress";
80
+ }, {
81
+ readonly type: "error";
82
+ readonly inputs: readonly [];
83
+ readonly name: "NoHandoverRequest";
84
+ }, {
85
+ readonly type: "error";
86
+ readonly inputs: readonly [];
87
+ readonly name: "NotClaimable";
88
+ }, {
89
+ readonly type: "error";
90
+ readonly inputs: readonly [];
91
+ readonly name: "NotInitializing";
92
+ }, {
93
+ readonly type: "error";
94
+ readonly inputs: readonly [];
95
+ readonly name: "Unauthorized";
96
+ }, {
97
+ readonly type: "event";
98
+ readonly anonymous: false;
99
+ readonly inputs: readonly [{
100
+ readonly name: "recipient";
101
+ readonly internalType: "address";
102
+ readonly type: "address";
103
+ readonly indexed: true;
104
+ }, {
105
+ readonly name: "data";
106
+ readonly internalType: "bytes";
107
+ readonly type: "bytes";
108
+ readonly indexed: false;
109
+ }];
110
+ readonly name: "Claimed";
111
+ }, {
112
+ readonly type: "event";
113
+ readonly anonymous: false;
114
+ readonly inputs: readonly [{
115
+ readonly name: "version";
116
+ readonly internalType: "uint64";
117
+ readonly type: "uint64";
118
+ readonly indexed: false;
119
+ }];
120
+ readonly name: "Initialized";
121
+ }, {
122
+ readonly type: "event";
123
+ readonly anonymous: false;
124
+ readonly inputs: readonly [{
125
+ readonly name: "pendingOwner";
126
+ readonly internalType: "address";
127
+ readonly type: "address";
128
+ readonly indexed: true;
129
+ }];
130
+ readonly name: "OwnershipHandoverCanceled";
131
+ }, {
132
+ readonly type: "event";
133
+ readonly anonymous: false;
134
+ readonly inputs: readonly [{
135
+ readonly name: "pendingOwner";
136
+ readonly internalType: "address";
137
+ readonly type: "address";
138
+ readonly indexed: true;
139
+ }];
140
+ readonly name: "OwnershipHandoverRequested";
141
+ }, {
142
+ readonly type: "event";
143
+ readonly anonymous: false;
144
+ readonly inputs: readonly [{
145
+ readonly name: "oldOwner";
146
+ readonly internalType: "address";
147
+ readonly type: "address";
148
+ readonly indexed: true;
149
+ }, {
150
+ readonly name: "newOwner";
151
+ readonly internalType: "address";
152
+ readonly type: "address";
153
+ readonly indexed: true;
154
+ }];
155
+ readonly name: "OwnershipTransferred";
156
+ }, {
157
+ readonly type: "function";
158
+ readonly inputs: readonly [];
159
+ readonly name: "asset";
160
+ readonly outputs: readonly [{
161
+ readonly name: "";
162
+ readonly internalType: "address";
163
+ readonly type: "address";
164
+ }];
165
+ readonly stateMutability: "view";
166
+ }, {
167
+ readonly type: "function";
168
+ readonly inputs: readonly [];
169
+ readonly name: "cancelOwnershipHandover";
170
+ readonly outputs: readonly [];
171
+ readonly stateMutability: "payable";
172
+ }, {
173
+ readonly type: "function";
174
+ readonly inputs: readonly [];
175
+ readonly name: "cgdaParams";
176
+ readonly outputs: readonly [{
177
+ readonly name: "rewardDecay";
178
+ readonly internalType: "uint256";
179
+ readonly type: "uint256";
180
+ }, {
181
+ readonly name: "rewardBoost";
182
+ readonly internalType: "uint256";
183
+ readonly type: "uint256";
184
+ }, {
185
+ readonly name: "lastClaimTime";
186
+ readonly internalType: "uint256";
187
+ readonly type: "uint256";
188
+ }, {
189
+ readonly name: "currentReward";
190
+ readonly internalType: "uint256";
191
+ readonly type: "uint256";
192
+ }];
193
+ readonly stateMutability: "view";
194
+ }, {
195
+ readonly type: "function";
196
+ readonly inputs: readonly [{
197
+ readonly name: "claimTarget";
198
+ readonly internalType: "address";
199
+ readonly type: "address";
200
+ }, {
201
+ readonly name: "";
202
+ readonly internalType: "bytes";
203
+ readonly type: "bytes";
204
+ }];
205
+ readonly name: "claim";
206
+ readonly outputs: readonly [{
207
+ readonly name: "";
208
+ readonly internalType: "bool";
209
+ readonly type: "bool";
210
+ }];
211
+ readonly stateMutability: "nonpayable";
212
+ }, {
213
+ readonly type: "function";
214
+ readonly inputs: readonly [{
215
+ readonly name: "";
216
+ readonly internalType: "address";
217
+ readonly type: "address";
218
+ }];
219
+ readonly name: "claimed";
220
+ readonly outputs: readonly [{
221
+ readonly name: "";
222
+ readonly internalType: "bool";
223
+ readonly type: "bool";
224
+ }];
225
+ readonly stateMutability: "view";
226
+ }, {
227
+ readonly type: "function";
228
+ readonly inputs: readonly [];
229
+ readonly name: "claims";
230
+ readonly outputs: readonly [{
231
+ readonly name: "";
232
+ readonly internalType: "uint256";
233
+ readonly type: "uint256";
234
+ }];
235
+ readonly stateMutability: "view";
236
+ }, {
237
+ readonly type: "function";
238
+ readonly inputs: readonly [{
239
+ readonly name: "data_";
240
+ readonly internalType: "bytes";
241
+ readonly type: "bytes";
242
+ }];
243
+ readonly name: "clawback";
244
+ readonly outputs: readonly [{
245
+ readonly name: "";
246
+ readonly internalType: "bool";
247
+ readonly type: "bool";
248
+ }];
249
+ readonly stateMutability: "nonpayable";
250
+ }, {
251
+ readonly type: "function";
252
+ readonly inputs: readonly [{
253
+ readonly name: "pendingOwner";
254
+ readonly internalType: "address";
255
+ readonly type: "address";
256
+ }];
257
+ readonly name: "completeOwnershipHandover";
258
+ readonly outputs: readonly [];
259
+ readonly stateMutability: "payable";
260
+ }, {
261
+ readonly type: "function";
262
+ readonly inputs: readonly [];
263
+ readonly name: "currentReward";
264
+ readonly outputs: readonly [{
265
+ readonly name: "";
266
+ readonly internalType: "uint256";
267
+ readonly type: "uint256";
268
+ }];
269
+ readonly stateMutability: "view";
270
+ }, {
271
+ readonly type: "function";
272
+ readonly inputs: readonly [];
273
+ readonly name: "getComponentInterface";
274
+ readonly outputs: readonly [{
275
+ readonly name: "";
276
+ readonly internalType: "bytes4";
277
+ readonly type: "bytes4";
278
+ }];
279
+ readonly stateMutability: "pure";
280
+ }, {
281
+ readonly type: "function";
282
+ readonly inputs: readonly [{
283
+ readonly name: "data_";
284
+ readonly internalType: "bytes";
285
+ readonly type: "bytes";
286
+ }];
287
+ readonly name: "initialize";
288
+ readonly outputs: readonly [];
289
+ readonly stateMutability: "nonpayable";
290
+ }, {
291
+ readonly type: "function";
292
+ readonly inputs: readonly [{
293
+ readonly name: "claimTarget";
294
+ readonly internalType: "address";
295
+ readonly type: "address";
296
+ }, {
297
+ readonly name: "";
298
+ readonly internalType: "bytes";
299
+ readonly type: "bytes";
300
+ }];
301
+ readonly name: "isClaimable";
302
+ readonly outputs: readonly [{
303
+ readonly name: "";
304
+ readonly internalType: "bool";
305
+ readonly type: "bool";
306
+ }];
307
+ readonly stateMutability: "view";
308
+ }, {
309
+ readonly type: "function";
310
+ readonly inputs: readonly [];
311
+ readonly name: "owner";
312
+ readonly outputs: readonly [{
313
+ readonly name: "result";
314
+ readonly internalType: "address";
315
+ readonly type: "address";
316
+ }];
317
+ readonly stateMutability: "view";
318
+ }, {
319
+ readonly type: "function";
320
+ readonly inputs: readonly [{
321
+ readonly name: "pendingOwner";
322
+ readonly internalType: "address";
323
+ readonly type: "address";
324
+ }];
325
+ readonly name: "ownershipHandoverExpiresAt";
326
+ readonly outputs: readonly [{
327
+ readonly name: "result";
328
+ readonly internalType: "uint256";
329
+ readonly type: "uint256";
330
+ }];
331
+ readonly stateMutability: "view";
332
+ }, {
333
+ readonly type: "function";
334
+ readonly inputs: readonly [{
335
+ readonly name: "data_";
336
+ readonly internalType: "bytes";
337
+ readonly type: "bytes";
338
+ }];
339
+ readonly name: "preflight";
340
+ readonly outputs: readonly [{
341
+ readonly name: "";
342
+ readonly internalType: "bytes";
343
+ readonly type: "bytes";
344
+ }];
345
+ readonly stateMutability: "view";
346
+ }, {
347
+ readonly type: "function";
348
+ readonly inputs: readonly [];
349
+ readonly name: "renounceOwnership";
350
+ readonly outputs: readonly [];
351
+ readonly stateMutability: "payable";
352
+ }, {
353
+ readonly type: "function";
354
+ readonly inputs: readonly [];
355
+ readonly name: "requestOwnershipHandover";
356
+ readonly outputs: readonly [];
357
+ readonly stateMutability: "payable";
358
+ }, {
359
+ readonly type: "function";
360
+ readonly inputs: readonly [];
361
+ readonly name: "reward";
362
+ readonly outputs: readonly [{
363
+ readonly name: "";
364
+ readonly internalType: "uint256";
365
+ readonly type: "uint256";
366
+ }];
367
+ readonly stateMutability: "view";
368
+ }, {
369
+ readonly type: "function";
370
+ readonly inputs: readonly [{
371
+ readonly name: "interfaceId";
372
+ readonly internalType: "bytes4";
373
+ readonly type: "bytes4";
374
+ }];
375
+ readonly name: "supportsInterface";
376
+ readonly outputs: readonly [{
377
+ readonly name: "";
378
+ readonly internalType: "bool";
379
+ readonly type: "bool";
380
+ }];
381
+ readonly stateMutability: "view";
382
+ }, {
383
+ readonly type: "function";
384
+ readonly inputs: readonly [];
385
+ readonly name: "totalBudget";
386
+ readonly outputs: readonly [{
387
+ readonly name: "";
388
+ readonly internalType: "uint256";
389
+ readonly type: "uint256";
390
+ }];
391
+ readonly stateMutability: "view";
392
+ }, {
393
+ readonly type: "function";
394
+ readonly inputs: readonly [{
395
+ readonly name: "newOwner";
396
+ readonly internalType: "address";
397
+ readonly type: "address";
398
+ }];
399
+ readonly name: "transferOwnership";
400
+ readonly outputs: readonly [];
401
+ readonly stateMutability: "payable";
402
+ }];
403
+ /**
404
+ * @inheritdoc
405
+ *
406
+ * @public
407
+ * @static
408
+ * @type {Address}
409
+ */
410
+ static base: Address;
411
+ /**
412
+ * @inheritdoc
413
+ *
414
+ * @public
415
+ * @static
416
+ * @type {RegistryType}
417
+ */
418
+ static registryType: RegistryType;
419
+ /**
420
+ * The incentive's owner.
421
+ *
422
+ * @public
423
+ * @async
424
+ * @param {?ReadParams<typeof cgdaIncentiveAbi, 'owner'>} [params]
425
+ * @returns {unknown}
426
+ */
427
+ owner(params?: ReadParams<typeof cgdaIncentiveAbi, 'owner'>): Promise<`0x${string}`>;
428
+ /**
429
+ * The number of claims that have been made
430
+ *
431
+ * @public
432
+ * @async
433
+ * @param {?ReadParams<typeof cgdaIncentiveAbi, 'claims'>} [params]
434
+ * @returns {Promise<bigint>}
435
+ */
436
+ claims(params?: ReadParams<typeof cgdaIncentiveAbi, 'claims'>): Promise<bigint>;
437
+ /**
438
+ * The reward amount issued for each claim
439
+ *
440
+ * @public
441
+ * @async
442
+ * @param {?ReadParams<typeof allowListIncentiveAbi, 'reward'>} [params]
443
+ * @returns {Promise<bigint>}
444
+ */
445
+ reward(params?: ReadParams<typeof cgdaIncentiveAbi, 'reward'>): Promise<bigint>;
446
+ /**
447
+ * Get the claim status for a user
448
+ *
449
+ * @public
450
+ * @async
451
+ * @param {Address} address
452
+ * @param {?ReadParams<typeof cgdaIncentiveAbi, 'claimed'>} [params]
453
+ * @returns {Promise<boolean>}
454
+ */
455
+ claimed(address: Address, params?: ReadParams<typeof cgdaIncentiveAbi, 'claimed'>): Promise<boolean>;
456
+ /**
457
+ * The CGDA-like token used for the incentive
458
+ *
459
+ * @public
460
+ * @async
461
+ * @param {?ReadParams<typeof cgdaIncentiveAbi, 'asset'>} [params]
462
+ * @returns {unknown}
463
+ */
464
+ asset(params?: ReadParams<typeof cgdaIncentiveAbi, 'asset'>): Promise<`0x${string}`>;
465
+ /**
466
+ * The configuration parameters for the CGDAIncentive
467
+ *
468
+ * @public
469
+ * @async
470
+ * @param {?ReadParams<typeof cgdaIncentiveAbi, 'cgdaParams'>} [params]
471
+ * @returns {Promise<CGDAParameters>}
472
+ */
473
+ cgdaParams(params?: ReadParams<typeof cgdaIncentiveAbi, 'cgdaParams'>): Promise<CGDAParameters>;
474
+ /**
475
+ * The total budget of the incentive
476
+ *
477
+ * @public
478
+ * @async
479
+ * @param {?ReadParams<typeof cgdaIncentiveAbi, 'totalBudget'>} [params]
480
+ * @returns {Promise<bigint>}
481
+ */
482
+ totalBudget(params?: ReadParams<typeof cgdaIncentiveAbi, 'totalBudget'>): Promise<bigint>;
483
+ /**
484
+ * Claim the incentive
485
+ *
486
+ * @public
487
+ * @async
488
+ * @param {ClaimPayload} payload
489
+ * @param {?WriteParams<typeof cgdaIncentiveAbi, 'claim'>} [params]
490
+ * @returns {Promise<boolean>} - Returns true if successfully claimed
491
+ */
492
+ claim(payload: ClaimPayload, params?: WriteParams<typeof cgdaIncentiveAbi, 'claim'>): Promise<boolean>;
493
+ /**
494
+ * Claim the incentive
495
+ *
496
+ * @public
497
+ * @async
498
+ * @param {ClaimPayload} payload
499
+ * @param {?WriteParams<typeof cgdaIncentiveAbi, 'claim'>} [params]
500
+ * @returns {Promise<boolean>} - Returns true if successfully claimed
501
+ */
502
+ claimRaw(payload: ClaimPayload, params?: WriteParams<typeof cgdaIncentiveAbi, 'claim'>): Promise<{
503
+ hash: `0x${string}`;
504
+ result: boolean;
505
+ }>;
506
+ /**
507
+ * Clawback assets from the incentive
508
+ *
509
+ * @public
510
+ * @async
511
+ * @param {ClaimPayload} payload
512
+ * @param {?WriteParams<typeof cgdaIncentiveAbi, 'clawback'>} [params]
513
+ * @returns {Promise<boolean>} - True if the assets were successfully clawbacked
514
+ */
515
+ clawback(payload: ClaimPayload, params?: WriteParams<typeof cgdaIncentiveAbi, 'clawback'>): Promise<boolean>;
516
+ /**
517
+ * Clawback assets from the incentive
518
+ *
519
+ * @public
520
+ * @async
521
+ * @param {ClaimPayload} payload
522
+ * @param {?WriteParams<typeof cgdaIncentiveAbi, 'clawback'>} [params]
523
+ * @returns {Promise<boolean>} - True if the assets were successfully clawbacked
524
+ */
525
+ clawbackRaw(payload: ClaimPayload, params?: WriteParams<typeof cgdaIncentiveAbi, 'clawback'>): Promise<{
526
+ hash: `0x${string}`;
527
+ result: boolean;
528
+ }>;
529
+ /**
530
+ * Check if an incentive is claimable
531
+ *
532
+ * @public
533
+ * @async
534
+ * @param {ClaimPayload} payload
535
+ * @param {?ReadParams<typeof cgdaIncentiveAbi, 'isClaimable'>} [params]
536
+ * @returns {Promise<boolean>} - True if the incentive is claimable based on the data payload
537
+ */
538
+ isClaimable(payload: ClaimPayload, params?: ReadParams<typeof cgdaIncentiveAbi, 'isClaimable'>): Promise<boolean>;
539
+ /**
540
+ * Calculates the current reward based on the time since the last claim.
541
+ * The reward is calculated based on the time since the last claim, the available budget, and the reward parameters. It increases linearly over time in the absence of claims, with each hour adding `rewardBoost` to the current reward, up to the available budget.
542
+ * For example, if there is one claim in the first hour, then no claims for three hours, the claimable reward would be `initialReward - rewardDecay + (rewardBoost * 3)`
543
+ *
544
+ * @public
545
+ * @async
546
+ * @param {?ReadParams<typeof cgdaIncentiveAbi, 'currentReward'>} [params]
547
+ * @returns {Promise<bigint>} - The current reward
548
+ */
549
+ currentReward(params?: ReadParams<typeof cgdaIncentiveAbi, 'currentReward'>): Promise<bigint>;
550
+ /**
551
+ * @inheritdoc
552
+ *
553
+ * @public
554
+ * @param {?CGDAIncentivePayload} [_payload]
555
+ * @param {?DeployableOptions} [_options]
556
+ * @returns {GenericDeployableParams}
557
+ */
558
+ buildParameters(_payload?: CGDAIncentivePayload, _options?: DeployableOptions): GenericDeployableParams;
559
+ }
560
+ //# sourceMappingURL=CGDAIncentive.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CGDAIncentive.d.ts","sourceRoot":"","sources":["../../src/Incentives/CGDAIncentive.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAcjB,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,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,YAAY,EACZ,KAAK,WAAW,EAGjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAC5B,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAErC;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAC1B,KAAK,SAAS,iBAAiB,CAAC,OAAO,gBAAgB,CAAC,GAAG,iBAAiB,CAC1E,OAAO,gBAAgB,CACxB,IACC,UAAU,CAAC,OAAO,gBAAgB,EAAE,KAAK,CAAC,CAAC;AAE/C;;;;;;;;GAQG;AACH,qBAAa,aAAc,SAAQ,gBAAgB,CACjD,oBAAoB,EACpB,OAAO,gBAAgB,CACxB;IACC,SAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAoB;IAChD;;;;;;OAMG;IACH,OAAuB,IAAI,EAAE,OAAO,CACR;IAC5B;;;;;;OAMG;IACH,OAAuB,YAAY,EAAE,YAAY,CAA0B;IAE3E;;;;;;;OAOG;IACU,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IASxE;;;;;;;OAOG;IACU,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,QAAQ,CAAC;IAS1E;;;;;;;OAOG;IACU,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,QAAQ,CAAC;IAS1E;;;;;;;;OAQG;IACU,OAAO,CAClB,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,SAAS,CAAC;IAUzD;;;;;;;OAOG;IACU,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IAQxE;;;;;;;OAOG;IACU,UAAU,CACrB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,YAAY,CAAC,GACzD,OAAO,CAAC,cAAc,CAAC;IAe1B;;;;;;;OAOG;IACU,WAAW,CACtB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,aAAa,CAAC;IAS7D;;;;;;;;OAQG;IACU,KAAK,CAChB,OAAO,EAAE,YAAY,EACrB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;IAKxD;;;;;;;;OAQG;IACU,QAAQ,CACnB,OAAO,EAAE,YAAY,EACrB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,OAAO,CAAC;;;;IAaxD;;;;;;;;OAQG;IACU,QAAQ,CACnB,OAAO,EAAE,YAAY,EACrB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;IAK3D;;;;;;;;OAQG;IACU,WAAW,CACtB,OAAO,EAAE,YAAY,EACrB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,gBAAgB,EAAE,UAAU,CAAC;;;;IAgB3D;;;;;;;;OAQG;IACU,WAAW,CACtB,OAAO,EAAE,YAAY,EACrB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,aAAa,CAAC;IAU7D;;;;;;;;;OASG;IACU,aAAa,CACxB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,gBAAgB,EAAE,eAAe,CAAC;IAS/D;;;;;;;OAOG;IACa,eAAe,CAC7B,QAAQ,CAAC,EAAE,oBAAoB,EAC/B,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;CAY3B"}