@boostxyz/sdk 0.0.0-alpha.16 → 0.0.0-alpha.18

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 (223) hide show
  1. package/dist/Actions/Action.cjs +1 -1
  2. package/dist/Actions/Action.cjs.map +1 -1
  3. package/dist/Actions/Action.js +7 -7
  4. package/dist/Actions/ContractAction.d.ts +9 -9
  5. package/dist/Actions/ContractAction.d.ts.map +1 -1
  6. package/dist/Actions/ERC721MintAction.d.ts +12 -12
  7. package/dist/Actions/ERC721MintAction.d.ts.map +1 -1
  8. package/dist/Actions/EventAction.cjs +1 -1
  9. package/dist/Actions/EventAction.cjs.map +1 -1
  10. package/dist/Actions/EventAction.d.ts +32 -49
  11. package/dist/Actions/EventAction.d.ts.map +1 -1
  12. package/dist/Actions/EventAction.js +13 -779
  13. package/dist/Actions/EventAction.js.map +1 -1
  14. package/dist/AllowLists/AllowList.cjs +1 -1
  15. package/dist/AllowLists/AllowList.cjs.map +1 -1
  16. package/dist/AllowLists/AllowList.js +3 -3
  17. package/dist/AllowLists/OpenAllowList.d.ts +183 -0
  18. package/dist/AllowLists/OpenAllowList.d.ts.map +1 -1
  19. package/dist/AllowLists/SimpleAllowList.cjs +1 -1
  20. package/dist/AllowLists/SimpleAllowList.cjs.map +1 -1
  21. package/dist/AllowLists/SimpleAllowList.d.ts +82 -36
  22. package/dist/AllowLists/SimpleAllowList.d.ts.map +1 -1
  23. package/dist/AllowLists/SimpleAllowList.js +44 -80
  24. package/dist/AllowLists/SimpleAllowList.js.map +1 -1
  25. package/dist/AllowLists/SimpleDenyList.cjs +1 -1
  26. package/dist/AllowLists/SimpleDenyList.d.ts +192 -9
  27. package/dist/AllowLists/SimpleDenyList.d.ts.map +1 -1
  28. package/dist/AllowLists/SimpleDenyList.js +5 -5
  29. package/dist/Auth/PassthroughAuth.cjs +1 -1
  30. package/dist/Auth/PassthroughAuth.js +1 -1
  31. package/dist/Boost.cjs.map +1 -1
  32. package/dist/Boost.d.ts +18 -0
  33. package/dist/Boost.d.ts.map +1 -1
  34. package/dist/Boost.js.map +1 -1
  35. package/dist/BoostCore-BiPwp6SR.cjs +3 -0
  36. package/dist/BoostCore-BiPwp6SR.cjs.map +1 -0
  37. package/dist/BoostCore-C00iqvks.js +1477 -0
  38. package/dist/BoostCore-C00iqvks.js.map +1 -0
  39. package/dist/BoostCore.cjs +1 -2
  40. package/dist/BoostCore.cjs.map +1 -1
  41. package/dist/BoostCore.d.ts +80 -35
  42. package/dist/BoostCore.d.ts.map +1 -1
  43. package/dist/BoostCore.js +29 -1273
  44. package/dist/BoostCore.js.map +1 -1
  45. package/dist/BoostRegistry.cjs +1 -1
  46. package/dist/BoostRegistry.cjs.map +1 -1
  47. package/dist/BoostRegistry.d.ts +18 -18
  48. package/dist/BoostRegistry.js +36 -36
  49. package/dist/BoostRegistry.js.map +1 -1
  50. package/dist/Budgets/Budget.cjs +1 -1
  51. package/dist/Budgets/Budget.cjs.map +1 -1
  52. package/dist/Budgets/Budget.d.ts.map +1 -1
  53. package/dist/Budgets/Budget.js +2 -2
  54. package/dist/Budgets/Budget.js.map +1 -1
  55. package/dist/Budgets/ManagedBudget.cjs +1 -1
  56. package/dist/Budgets/ManagedBudget.cjs.map +1 -1
  57. package/dist/Budgets/ManagedBudget.d.ts +24 -174
  58. package/dist/Budgets/ManagedBudget.d.ts.map +1 -1
  59. package/dist/Budgets/ManagedBudget.js +76 -298
  60. package/dist/Budgets/ManagedBudget.js.map +1 -1
  61. package/dist/Budgets/VestingBudget.d.ts +181 -77
  62. package/dist/Budgets/VestingBudget.d.ts.map +1 -1
  63. package/dist/Deployable/Contract.cjs +1 -1
  64. package/dist/Deployable/Contract.cjs.map +1 -1
  65. package/dist/Deployable/Contract.d.ts +4 -5
  66. package/dist/Deployable/Contract.d.ts.map +1 -1
  67. package/dist/Deployable/Contract.js +4 -5
  68. package/dist/Deployable/Contract.js.map +1 -1
  69. package/dist/Deployable/Deployable.cjs.map +1 -1
  70. package/dist/Deployable/Deployable.d.ts +1 -1
  71. package/dist/Deployable/Deployable.js +1 -1
  72. package/dist/Deployable/Deployable.js.map +1 -1
  73. package/dist/Deployable/DeployableTarget.cjs +1 -1
  74. package/dist/Deployable/DeployableTarget.cjs.map +1 -1
  75. package/dist/Deployable/DeployableTarget.d.ts +5 -5
  76. package/dist/Deployable/DeployableTarget.js +10 -10
  77. package/dist/Deployable/DeployableTarget.js.map +1 -1
  78. package/dist/Deployable/DeployableTargetWithRBAC.cjs +2 -0
  79. package/dist/Deployable/DeployableTargetWithRBAC.cjs.map +1 -0
  80. package/dist/Deployable/DeployableTargetWithRBAC.d.ts +179 -0
  81. package/dist/Deployable/DeployableTargetWithRBAC.d.ts.map +1 -0
  82. package/dist/Deployable/DeployableTargetWithRBAC.js +222 -0
  83. package/dist/Deployable/DeployableTargetWithRBAC.js.map +1 -0
  84. package/dist/EventAction-BO5WI_5s.js +1355 -0
  85. package/dist/EventAction-BO5WI_5s.js.map +1 -0
  86. package/dist/EventAction-DBDRaG4A.cjs +2 -0
  87. package/dist/EventAction-DBDRaG4A.cjs.map +1 -0
  88. package/dist/{Incentive-CtuAJAjG.js → Incentive-CF7kaz_9.js} +67 -68
  89. package/dist/Incentive-CF7kaz_9.js.map +1 -0
  90. package/dist/{Incentive-CqX3fYEd.cjs → Incentive-Djnzseoj.cjs} +2 -2
  91. package/dist/Incentive-Djnzseoj.cjs.map +1 -0
  92. package/dist/Incentives/AllowListIncentive.cjs +1 -1
  93. package/dist/Incentives/AllowListIncentive.cjs.map +1 -1
  94. package/dist/Incentives/AllowListIncentive.d.ts +12 -12
  95. package/dist/Incentives/AllowListIncentive.js +26 -26
  96. package/dist/Incentives/AllowListIncentive.js.map +1 -1
  97. package/dist/Incentives/CGDAIncentive.cjs +1 -1
  98. package/dist/Incentives/CGDAIncentive.cjs.map +1 -1
  99. package/dist/Incentives/CGDAIncentive.d.ts +15 -15
  100. package/dist/Incentives/CGDAIncentive.js +25 -25
  101. package/dist/Incentives/CGDAIncentive.js.map +1 -1
  102. package/dist/Incentives/ERC1155Incentive.d.ts +30 -30
  103. package/dist/Incentives/ERC20Incentive.cjs +1 -1
  104. package/dist/Incentives/ERC20Incentive.cjs.map +1 -1
  105. package/dist/Incentives/ERC20Incentive.d.ts +23 -23
  106. package/dist/Incentives/ERC20Incentive.js +45 -45
  107. package/dist/Incentives/ERC20Incentive.js.map +1 -1
  108. package/dist/Incentives/ERC20VariableCriteriaIncentive.d.ts +523 -0
  109. package/dist/Incentives/ERC20VariableCriteriaIncentive.d.ts.map +1 -0
  110. package/dist/Incentives/ERC20VariableIncentive.d.ts +19 -19
  111. package/dist/Incentives/Incentive.cjs +1 -1
  112. package/dist/Incentives/Incentive.d.ts +3 -3
  113. package/dist/Incentives/Incentive.d.ts.map +1 -1
  114. package/dist/Incentives/Incentive.js +3 -3
  115. package/dist/Incentives/PointsIncentive.cjs +1 -1
  116. package/dist/Incentives/PointsIncentive.cjs.map +1 -1
  117. package/dist/Incentives/PointsIncentive.d.ts +14 -14
  118. package/dist/Incentives/PointsIncentive.js +20 -20
  119. package/dist/Incentives/PointsIncentive.js.map +1 -1
  120. package/dist/SimpleDenyList-BwfNjRsg.cjs +2 -0
  121. package/dist/SimpleDenyList-BwfNjRsg.cjs.map +1 -0
  122. package/dist/SimpleDenyList-D9i4rw_F.js +132 -0
  123. package/dist/SimpleDenyList-D9i4rw_F.js.map +1 -0
  124. package/dist/Validators/SignerValidator.cjs +1 -1
  125. package/dist/Validators/SignerValidator.cjs.map +1 -1
  126. package/dist/Validators/SignerValidator.d.ts +14 -14
  127. package/dist/Validators/SignerValidator.js +25 -25
  128. package/dist/Validators/SignerValidator.js.map +1 -1
  129. package/dist/Validators/Validator.cjs +1 -1
  130. package/dist/Validators/Validator.cjs.map +1 -1
  131. package/dist/Validators/Validator.d.ts +1 -1
  132. package/dist/Validators/Validator.js +6 -6
  133. package/dist/Validators/Validator.js.map +1 -1
  134. package/dist/claiming.cjs.map +1 -1
  135. package/dist/claiming.d.ts +1 -1
  136. package/dist/claiming.js.map +1 -1
  137. package/dist/componentInterfaces-D09mhzxO.cjs +2 -0
  138. package/dist/componentInterfaces-D09mhzxO.cjs.map +1 -0
  139. package/dist/componentInterfaces-RXBMI5yH.js +14 -0
  140. package/dist/componentInterfaces-RXBMI5yH.js.map +1 -0
  141. package/dist/deployments-BM42vImE.js +43 -0
  142. package/dist/deployments-BM42vImE.js.map +1 -0
  143. package/dist/deployments-CMdF5uEC.cjs +2 -0
  144. package/dist/deployments-CMdF5uEC.cjs.map +1 -0
  145. package/dist/deployments.json +15 -12
  146. package/dist/errors.cjs +1 -1
  147. package/dist/errors.cjs.map +1 -1
  148. package/dist/errors.d.ts +132 -0
  149. package/dist/errors.d.ts.map +1 -1
  150. package/dist/errors.js +122 -36
  151. package/dist/errors.js.map +1 -1
  152. package/dist/generated-B0tk-c9b.cjs +3 -0
  153. package/dist/generated-B0tk-c9b.cjs.map +1 -0
  154. package/dist/{generated-DLMdMwD1.js → generated-B8VWObPa.js} +2350 -1290
  155. package/dist/generated-B8VWObPa.js.map +1 -0
  156. package/dist/index.cjs +1 -1
  157. package/dist/index.d.ts +2 -0
  158. package/dist/index.d.ts.map +1 -1
  159. package/dist/index.js +134 -122
  160. package/dist/index.js.map +1 -1
  161. package/dist/transfers.cjs.map +1 -1
  162. package/dist/transfers.d.ts +1 -1
  163. package/dist/transfers.js.map +1 -1
  164. package/dist/utils.cjs.map +1 -1
  165. package/dist/utils.d.ts +1 -1
  166. package/dist/utils.js.map +1 -1
  167. package/package.json +12 -5
  168. package/src/Actions/ContractAction.ts +9 -10
  169. package/src/Actions/ERC721MintAction.ts +12 -13
  170. package/src/Actions/EventAction.test.ts +182 -53
  171. package/src/Actions/EventAction.ts +128 -107
  172. package/src/AllowLists/SimpleAllowList.ts +14 -59
  173. package/src/AllowLists/SimpleDenyList.ts +12 -9
  174. package/src/Boost.ts +19 -0
  175. package/src/BoostCore.test.ts +117 -1
  176. package/src/BoostCore.ts +113 -54
  177. package/src/BoostRegistry.ts +18 -18
  178. package/src/Budgets/Budget.ts +1 -2
  179. package/src/Budgets/ManagedBudget.ts +21 -295
  180. package/src/Budgets/VestingBudget.ts +26 -97
  181. package/src/Deployable/Contract.ts +4 -5
  182. package/src/Deployable/Deployable.ts +1 -1
  183. package/src/Deployable/DeployableTarget.ts +5 -5
  184. package/src/Deployable/DeployableTargetWithRBAC.ts +323 -0
  185. package/src/Incentives/AllowListIncentive.ts +12 -12
  186. package/src/Incentives/CGDAIncentive.ts +15 -15
  187. package/src/Incentives/ERC1155Incentive.ts +26 -26
  188. package/src/Incentives/ERC20Incentive.ts +23 -23
  189. package/src/Incentives/ERC20VariableCriteriaIncentive.test.ts +184 -0
  190. package/src/Incentives/ERC20VariableCriteriaIncentive.ts +309 -0
  191. package/src/Incentives/ERC20VariableIncentive.ts +19 -19
  192. package/src/Incentives/Incentive.ts +6 -5
  193. package/src/Incentives/PointsIncentive.test.ts +21 -21
  194. package/src/Incentives/PointsIncentive.ts +14 -14
  195. package/src/Validators/SignerValidator.ts +14 -14
  196. package/src/Validators/Validator.ts +1 -1
  197. package/src/claiming.ts +1 -1
  198. package/src/errors.ts +165 -0
  199. package/src/index.test.ts +3 -4
  200. package/src/index.ts +2 -0
  201. package/src/transfers.ts +1 -1
  202. package/src/utils.ts +1 -1
  203. package/dist/Budgets/SimpleBudget.d.ts +0 -824
  204. package/dist/Budgets/SimpleBudget.d.ts.map +0 -1
  205. package/dist/Incentive-CqX3fYEd.cjs.map +0 -1
  206. package/dist/Incentive-CtuAJAjG.js.map +0 -1
  207. package/dist/SimpleDenyList-9UIxZZKP.cjs +0 -2
  208. package/dist/SimpleDenyList-9UIxZZKP.cjs.map +0 -1
  209. package/dist/SimpleDenyList-DGPNc7ov.js +0 -132
  210. package/dist/SimpleDenyList-DGPNc7ov.js.map +0 -1
  211. package/dist/componentInterfaces-CKCBwG16.cjs +0 -2
  212. package/dist/componentInterfaces-CKCBwG16.cjs.map +0 -1
  213. package/dist/componentInterfaces-Cmg8tUxq.js +0 -13
  214. package/dist/componentInterfaces-Cmg8tUxq.js.map +0 -1
  215. package/dist/deployments-BvFcK_eR.js +0 -40
  216. package/dist/deployments-BvFcK_eR.js.map +0 -1
  217. package/dist/deployments-Ho4PnGCS.cjs +0 -2
  218. package/dist/deployments-Ho4PnGCS.cjs.map +0 -1
  219. package/dist/generated-BLg7yPgI.cjs +0 -3
  220. package/dist/generated-BLg7yPgI.cjs.map +0 -1
  221. package/dist/generated-DLMdMwD1.js.map +0 -1
  222. package/src/Budgets/SimpleBudget.test.ts +0 -152
  223. package/src/Budgets/SimpleBudget.ts +0 -563
@@ -0,0 +1,523 @@
1
+ import { erc20VariableCriteriaIncentiveAbi } from '@boostxyz/evm';
2
+ import { type Address, type Hex } from 'viem';
3
+ import { SignatureType } from '../Actions/EventAction';
4
+ import type { DeployableOptions, GenericDeployableParams } from '../Deployable/Deployable';
5
+ import { DeployableTarget } from '../Deployable/DeployableTarget';
6
+ import type { ReadParams } from '../utils';
7
+ export interface ERC20VariableCriteriaIncentivePayload {
8
+ /**
9
+ * The address of the incentivized asset.
10
+ *
11
+ * @type {Address}
12
+ */
13
+ asset: Address;
14
+ /**
15
+ * The amount of the asset to distribute as reward.
16
+ *
17
+ * @type {bigint}
18
+ */
19
+ reward: bigint;
20
+ /**
21
+ * The total spending limit of the asset that will be distributed.
22
+ *
23
+ * @type {bigint}
24
+ */
25
+ limit: bigint;
26
+ /**
27
+ * The criteria for the incentive that determines how the reward is distributed.
28
+ *
29
+ * @type {IncentiveCriteria}
30
+ */
31
+ criteria: IncentiveCriteria;
32
+ }
33
+ export interface IncentiveCriteria {
34
+ /**
35
+ * The type of criteria used, either function signature or event signature.
36
+ *
37
+ * @type {SignatureType}
38
+ */
39
+ criteriaType: SignatureType;
40
+ /**
41
+ * The function or event signature used for criteria matching.
42
+ *
43
+ * @type {Hex}
44
+ */
45
+ signature: Hex;
46
+ /**
47
+ * The index of the field from where the scalar value is extracted.
48
+ *
49
+ * @type {number}
50
+ */
51
+ fieldIndex: number;
52
+ /**
53
+ * The address of the contract where the event/function is called/emitted.
54
+ *
55
+ * @type {Address}
56
+ */
57
+ targetContract: Address;
58
+ }
59
+ export interface ReadIncentiveCriteriaParams extends ReadParams<typeof erc20VariableCriteriaIncentiveAbi, 'getIncentiveCriteria'> {
60
+ }
61
+ export interface GetIncentiveScalarParams {
62
+ hash: Hex;
63
+ }
64
+ /**
65
+ * Extended ERC20 Variable Criteria Incentive class that fetches incentive criteria and scalar
66
+ */
67
+ export declare class ERC20VariableCriteriaIncentive extends DeployableTarget<ERC20VariableCriteriaIncentivePayload, typeof erc20VariableCriteriaIncentiveAbi> {
68
+ readonly abi: readonly [{
69
+ readonly type: "error";
70
+ readonly inputs: readonly [];
71
+ readonly name: "AlreadyInitialized";
72
+ }, {
73
+ readonly type: "error";
74
+ readonly inputs: readonly [];
75
+ readonly name: "ClaimFailed";
76
+ }, {
77
+ readonly type: "error";
78
+ readonly inputs: readonly [];
79
+ readonly name: "CloneAlreadyInitialized";
80
+ }, {
81
+ readonly type: "error";
82
+ readonly inputs: readonly [];
83
+ readonly name: "InitializerNotImplemented";
84
+ }, {
85
+ readonly type: "error";
86
+ readonly inputs: readonly [{
87
+ readonly name: "asset";
88
+ readonly internalType: "address";
89
+ readonly type: "address";
90
+ }, {
91
+ readonly name: "available";
92
+ readonly internalType: "uint256";
93
+ readonly type: "uint256";
94
+ }, {
95
+ readonly name: "required";
96
+ readonly internalType: "uint256";
97
+ readonly type: "uint256";
98
+ }];
99
+ readonly name: "InsufficientFunds";
100
+ }, {
101
+ readonly type: "error";
102
+ readonly inputs: readonly [];
103
+ readonly name: "InvalidInitialization";
104
+ }, {
105
+ readonly type: "error";
106
+ readonly inputs: readonly [];
107
+ readonly name: "InvalidInitialization";
108
+ }, {
109
+ readonly type: "error";
110
+ readonly inputs: readonly [];
111
+ readonly name: "InvalidInitializationData";
112
+ }, {
113
+ readonly type: "error";
114
+ readonly inputs: readonly [];
115
+ readonly name: "NewOwnerIsZeroAddress";
116
+ }, {
117
+ readonly type: "error";
118
+ readonly inputs: readonly [];
119
+ readonly name: "NoHandoverRequest";
120
+ }, {
121
+ readonly type: "error";
122
+ readonly inputs: readonly [];
123
+ readonly name: "NotClaimable";
124
+ }, {
125
+ readonly type: "error";
126
+ readonly inputs: readonly [];
127
+ readonly name: "NotInitializing";
128
+ }, {
129
+ readonly type: "error";
130
+ readonly inputs: readonly [];
131
+ readonly name: "Unauthorized";
132
+ }, {
133
+ readonly type: "event";
134
+ readonly anonymous: false;
135
+ readonly inputs: readonly [{
136
+ readonly name: "recipient";
137
+ readonly internalType: "address";
138
+ readonly type: "address";
139
+ readonly indexed: true;
140
+ }, {
141
+ readonly name: "data";
142
+ readonly internalType: "bytes";
143
+ readonly type: "bytes";
144
+ readonly indexed: false;
145
+ }];
146
+ readonly name: "Claimed";
147
+ }, {
148
+ readonly type: "event";
149
+ readonly anonymous: false;
150
+ readonly inputs: readonly [{
151
+ readonly name: "version";
152
+ readonly internalType: "uint64";
153
+ readonly type: "uint64";
154
+ readonly indexed: false;
155
+ }];
156
+ readonly name: "Initialized";
157
+ }, {
158
+ readonly type: "event";
159
+ readonly anonymous: false;
160
+ readonly inputs: readonly [{
161
+ readonly name: "pendingOwner";
162
+ readonly internalType: "address";
163
+ readonly type: "address";
164
+ readonly indexed: true;
165
+ }];
166
+ readonly name: "OwnershipHandoverCanceled";
167
+ }, {
168
+ readonly type: "event";
169
+ readonly anonymous: false;
170
+ readonly inputs: readonly [{
171
+ readonly name: "pendingOwner";
172
+ readonly internalType: "address";
173
+ readonly type: "address";
174
+ readonly indexed: true;
175
+ }];
176
+ readonly name: "OwnershipHandoverRequested";
177
+ }, {
178
+ readonly type: "event";
179
+ readonly anonymous: false;
180
+ readonly inputs: readonly [{
181
+ readonly name: "oldOwner";
182
+ readonly internalType: "address";
183
+ readonly type: "address";
184
+ readonly indexed: true;
185
+ }, {
186
+ readonly name: "newOwner";
187
+ readonly internalType: "address";
188
+ readonly type: "address";
189
+ readonly indexed: true;
190
+ }];
191
+ readonly name: "OwnershipTransferred";
192
+ }, {
193
+ readonly type: "function";
194
+ readonly inputs: readonly [];
195
+ readonly name: "asset";
196
+ readonly outputs: readonly [{
197
+ readonly name: "";
198
+ readonly internalType: "address";
199
+ readonly type: "address";
200
+ }];
201
+ readonly stateMutability: "view";
202
+ }, {
203
+ readonly type: "function";
204
+ readonly inputs: readonly [];
205
+ readonly name: "cancelOwnershipHandover";
206
+ readonly outputs: readonly [];
207
+ readonly stateMutability: "payable";
208
+ }, {
209
+ readonly type: "function";
210
+ readonly inputs: readonly [{
211
+ readonly name: "claimTarget";
212
+ readonly internalType: "address";
213
+ readonly type: "address";
214
+ }, {
215
+ readonly name: "data_";
216
+ readonly internalType: "bytes";
217
+ readonly type: "bytes";
218
+ }];
219
+ readonly name: "claim";
220
+ readonly outputs: readonly [{
221
+ readonly name: "";
222
+ readonly internalType: "bool";
223
+ readonly type: "bool";
224
+ }];
225
+ readonly stateMutability: "nonpayable";
226
+ }, {
227
+ readonly type: "function";
228
+ readonly inputs: readonly [{
229
+ readonly name: "";
230
+ readonly internalType: "address";
231
+ readonly type: "address";
232
+ }];
233
+ readonly name: "claimed";
234
+ readonly outputs: readonly [{
235
+ readonly name: "";
236
+ readonly internalType: "bool";
237
+ readonly type: "bool";
238
+ }];
239
+ readonly stateMutability: "view";
240
+ }, {
241
+ readonly type: "function";
242
+ readonly inputs: readonly [];
243
+ readonly name: "claims";
244
+ readonly outputs: readonly [{
245
+ readonly name: "";
246
+ readonly internalType: "uint256";
247
+ readonly type: "uint256";
248
+ }];
249
+ readonly stateMutability: "view";
250
+ }, {
251
+ readonly type: "function";
252
+ readonly inputs: readonly [{
253
+ readonly name: "data_";
254
+ readonly internalType: "bytes";
255
+ readonly type: "bytes";
256
+ }];
257
+ readonly name: "clawback";
258
+ readonly outputs: readonly [{
259
+ readonly name: "";
260
+ readonly internalType: "bool";
261
+ readonly type: "bool";
262
+ }];
263
+ readonly stateMutability: "nonpayable";
264
+ }, {
265
+ readonly type: "function";
266
+ readonly inputs: readonly [{
267
+ readonly name: "pendingOwner";
268
+ readonly internalType: "address";
269
+ readonly type: "address";
270
+ }];
271
+ readonly name: "completeOwnershipHandover";
272
+ readonly outputs: readonly [];
273
+ readonly stateMutability: "payable";
274
+ }, {
275
+ readonly type: "function";
276
+ readonly inputs: readonly [];
277
+ readonly name: "currentReward";
278
+ readonly outputs: readonly [{
279
+ readonly name: "";
280
+ readonly internalType: "uint256";
281
+ readonly type: "uint256";
282
+ }];
283
+ readonly stateMutability: "view";
284
+ }, {
285
+ readonly type: "function";
286
+ readonly inputs: readonly [];
287
+ readonly name: "getComponentInterface";
288
+ readonly outputs: readonly [{
289
+ readonly name: "";
290
+ readonly internalType: "bytes4";
291
+ readonly type: "bytes4";
292
+ }];
293
+ readonly stateMutability: "pure";
294
+ }, {
295
+ readonly type: "function";
296
+ readonly inputs: readonly [];
297
+ readonly name: "getIncentiveCriteria";
298
+ readonly outputs: readonly [{
299
+ readonly name: "";
300
+ readonly internalType: "struct ERC20VariableCriteriaIncentive.IncentiveCriteria";
301
+ readonly type: "tuple";
302
+ readonly components: readonly [{
303
+ readonly name: "criteriaType";
304
+ readonly internalType: "enum SignatureType";
305
+ readonly type: "uint8";
306
+ }, {
307
+ readonly name: "signature";
308
+ readonly internalType: "bytes32";
309
+ readonly type: "bytes32";
310
+ }, {
311
+ readonly name: "fieldIndex";
312
+ readonly internalType: "uint8";
313
+ readonly type: "uint8";
314
+ }, {
315
+ readonly name: "targetContract";
316
+ readonly internalType: "address";
317
+ readonly type: "address";
318
+ }];
319
+ }];
320
+ readonly stateMutability: "view";
321
+ }, {
322
+ readonly type: "function";
323
+ readonly inputs: readonly [];
324
+ readonly name: "incentiveCriteria";
325
+ readonly outputs: readonly [{
326
+ readonly name: "criteriaType";
327
+ readonly internalType: "enum SignatureType";
328
+ readonly type: "uint8";
329
+ }, {
330
+ readonly name: "signature";
331
+ readonly internalType: "bytes32";
332
+ readonly type: "bytes32";
333
+ }, {
334
+ readonly name: "fieldIndex";
335
+ readonly internalType: "uint8";
336
+ readonly type: "uint8";
337
+ }, {
338
+ readonly name: "targetContract";
339
+ readonly internalType: "address";
340
+ readonly type: "address";
341
+ }];
342
+ readonly stateMutability: "view";
343
+ }, {
344
+ readonly type: "function";
345
+ readonly inputs: readonly [{
346
+ readonly name: "data_";
347
+ readonly internalType: "bytes";
348
+ readonly type: "bytes";
349
+ }];
350
+ readonly name: "initialize";
351
+ readonly outputs: readonly [];
352
+ readonly stateMutability: "nonpayable";
353
+ }, {
354
+ readonly type: "function";
355
+ readonly inputs: readonly [{
356
+ readonly name: "claimTarget";
357
+ readonly internalType: "address";
358
+ readonly type: "address";
359
+ }, {
360
+ readonly name: "";
361
+ readonly internalType: "bytes";
362
+ readonly type: "bytes";
363
+ }];
364
+ readonly name: "isClaimable";
365
+ readonly outputs: readonly [{
366
+ readonly name: "";
367
+ readonly internalType: "bool";
368
+ readonly type: "bool";
369
+ }];
370
+ readonly stateMutability: "view";
371
+ }, {
372
+ readonly type: "function";
373
+ readonly inputs: readonly [];
374
+ readonly name: "limit";
375
+ readonly outputs: readonly [{
376
+ readonly name: "";
377
+ readonly internalType: "uint256";
378
+ readonly type: "uint256";
379
+ }];
380
+ readonly stateMutability: "view";
381
+ }, {
382
+ readonly type: "function";
383
+ readonly inputs: readonly [];
384
+ readonly name: "owner";
385
+ readonly outputs: readonly [{
386
+ readonly name: "result";
387
+ readonly internalType: "address";
388
+ readonly type: "address";
389
+ }];
390
+ readonly stateMutability: "view";
391
+ }, {
392
+ readonly type: "function";
393
+ readonly inputs: readonly [{
394
+ readonly name: "pendingOwner";
395
+ readonly internalType: "address";
396
+ readonly type: "address";
397
+ }];
398
+ readonly name: "ownershipHandoverExpiresAt";
399
+ readonly outputs: readonly [{
400
+ readonly name: "result";
401
+ readonly internalType: "uint256";
402
+ readonly type: "uint256";
403
+ }];
404
+ readonly stateMutability: "view";
405
+ }, {
406
+ readonly type: "function";
407
+ readonly inputs: readonly [{
408
+ readonly name: "data_";
409
+ readonly internalType: "bytes";
410
+ readonly type: "bytes";
411
+ }];
412
+ readonly name: "preflight";
413
+ readonly outputs: readonly [{
414
+ readonly name: "budgetData";
415
+ readonly internalType: "bytes";
416
+ readonly type: "bytes";
417
+ }];
418
+ readonly stateMutability: "view";
419
+ }, {
420
+ readonly type: "function";
421
+ readonly inputs: readonly [];
422
+ readonly name: "renounceOwnership";
423
+ readonly outputs: readonly [];
424
+ readonly stateMutability: "payable";
425
+ }, {
426
+ readonly type: "function";
427
+ readonly inputs: readonly [];
428
+ readonly name: "requestOwnershipHandover";
429
+ readonly outputs: readonly [];
430
+ readonly stateMutability: "payable";
431
+ }, {
432
+ readonly type: "function";
433
+ readonly inputs: readonly [];
434
+ readonly name: "reward";
435
+ readonly outputs: readonly [{
436
+ readonly name: "";
437
+ readonly internalType: "uint256";
438
+ readonly type: "uint256";
439
+ }];
440
+ readonly stateMutability: "view";
441
+ }, {
442
+ readonly type: "function";
443
+ readonly inputs: readonly [{
444
+ readonly name: "interfaceId";
445
+ readonly internalType: "bytes4";
446
+ readonly type: "bytes4";
447
+ }];
448
+ readonly name: "supportsInterface";
449
+ readonly outputs: readonly [{
450
+ readonly name: "";
451
+ readonly internalType: "bool";
452
+ readonly type: "bool";
453
+ }];
454
+ readonly stateMutability: "view";
455
+ }, {
456
+ readonly type: "function";
457
+ readonly inputs: readonly [];
458
+ readonly name: "totalClaimed";
459
+ readonly outputs: readonly [{
460
+ readonly name: "";
461
+ readonly internalType: "uint256";
462
+ readonly type: "uint256";
463
+ }];
464
+ readonly stateMutability: "view";
465
+ }, {
466
+ readonly type: "function";
467
+ readonly inputs: readonly [{
468
+ readonly name: "newOwner";
469
+ readonly internalType: "address";
470
+ readonly type: "address";
471
+ }];
472
+ readonly name: "transferOwnership";
473
+ readonly outputs: readonly [];
474
+ readonly stateMutability: "payable";
475
+ }];
476
+ /**
477
+ * @inheritdoc
478
+ *
479
+ * @public
480
+ * @static
481
+ * @type {Record<number, Address>}
482
+ */
483
+ static bases: Record<number, Address>;
484
+ /**
485
+ *Functions from the ERC20VariableIncentive contract
486
+ */
487
+ /**
488
+ * Fetches the IncentiveCriteria struct from the contract
489
+ *
490
+ * @returns {Promise<IncentiveCriteria>} Incentive criteria structure
491
+ * @throws {IncentiveCriteriaNotFoundError}
492
+ */
493
+ getIncentiveCriteria(): Promise<IncentiveCriteria>;
494
+ /**
495
+ * Fetches the incentive scalar from a transaction hash
496
+ *
497
+ * @param {GetIncentiveScalarParams} params
498
+ * @returns {Promise<bigint>}
499
+ * @throws {InvalidCriteriaTypeError | NoMatchingLogsError | DecodedArgsError}
500
+ */
501
+ getIncentiveScalar({ hash, }: GetIncentiveScalarParams): Promise<bigint>;
502
+ /**
503
+ * @inheritdoc
504
+ *
505
+ * @public
506
+ * @param {?ERC20VariableCriteriaIncentivePayload} [_payload]
507
+ * @param {?DeployableOptions} [_options]
508
+ * @returns {GenericDeployableParams}
509
+ */
510
+ buildParameters(_payload?: ERC20VariableCriteriaIncentivePayload, _options?: DeployableOptions): GenericDeployableParams;
511
+ }
512
+ /**
513
+ *
514
+ *
515
+ * @param {InitPayloadExtended} param0
516
+ * @param {Address} param0.asset - The address of the ERC20 asset to incentivize.
517
+ * @param {bigint} param0.reward - The reward amount to distribute per action.
518
+ * @param {bigint} param0.limit - The total limit of the asset distribution.
519
+ * @param {IncentiveCriteria} param0.criteria - The incentive criteria for reward distribution.
520
+ * @returns {Hex}
521
+ */
522
+ export declare function prepareERC20VariableCriteriaIncentivePayload({ asset, reward, limit, criteria, }: ERC20VariableCriteriaIncentivePayload): `0x${string}`;
523
+ //# sourceMappingURL=ERC20VariableCriteriaIncentive.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ERC20VariableCriteriaIncentive.d.ts","sourceRoot":"","sources":["../../src/Incentives/ERC20VariableCriteriaIncentive.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EAElC,MAAM,eAAe,CAAC;AAKvB,OAAO,EAGL,KAAK,OAAO,EACZ,KAAK,GAAG,EAKT,MAAM,MAAM,CAAC;AAEd,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAQlE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAG3C,MAAM,WAAW,qCAAqC;IACpD;;;;OAIG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,QAAQ,EAAE,iBAAiB,CAAC;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,YAAY,EAAE,aAAa,CAAC;IAC5B;;;;OAIG;IACH,SAAS,EAAE,GAAG,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,2BACf,SAAQ,UAAU,CAChB,OAAO,iCAAiC,EACxC,sBAAsB,CACvB;CAAG;AAEN,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,GAAG,CAAC;CACX;AAED;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,gBAAgB,CAClE,qCAAqC,EACrC,OAAO,iCAAiC,CACzC;IACC,SAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAqC;IACjE;;;;;;OAMG;IACH,OAAuB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEnD;IAEF;;OAEG;IAEH;;;;;OAKG;IACU,oBAAoB,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAgB/D;;;;;;OAMG;IACU,kBAAkB,CAAC,EAC9B,IAAI,GACL,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC;IA8E7C;;;;;;;OAOG;IACa,eAAe,CAC7B,QAAQ,CAAC,EAAE,qCAAqC,EAChD,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;CAY3B;AAED;;;;;;;;;GASG;AACH,wBAAgB,4CAA4C,CAAC,EAC3D,KAAK,EACL,MAAM,EACN,KAAK,EACL,QAAQ,GACT,EAAE,qCAAqC,iBAqCvC"}
@@ -435,8 +435,8 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
435
435
  *
436
436
  * @public
437
437
  * @async
438
- * @param {?ReadParams<typeof erc20VariableIncentiveAbi, 'owner'>} [params]
439
- * @returns {unknown}
438
+ * @param {?ReadParams} [params]
439
+ * @returns {Promise<Address>}
440
440
  */
441
441
  owner(params?: ReadParams<typeof erc20VariableIncentiveAbi, 'owner'>): Promise<`0x${string}`>;
442
442
  /**
@@ -444,7 +444,7 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
444
444
  *
445
445
  * @public
446
446
  * @async
447
- * @param {?ReadParams<typeof erc20VariableIncentiveAbi, 'totalClaimed'>} [params]
447
+ * @param {?ReadParams} [params]
448
448
  * @returns {Promise<bigint>}
449
449
  */
450
450
  totalClaimed(params?: ReadParams<typeof erc20VariableIncentiveAbi, 'totalClaimed'>): Promise<bigint>;
@@ -453,7 +453,7 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
453
453
  *
454
454
  * @public
455
455
  * @async
456
- * @param {?ReadParams<typeof erc20VariableIncentiveAbi, 'currentReward'>} [params]
456
+ * @param {?ReadParams} [params]
457
457
  * @returns {Promise<bigint>} - The current reward
458
458
  */
459
459
  currentReward(params?: ReadParams<typeof erc20VariableIncentiveAbi, 'currentReward'>): Promise<bigint>;
@@ -462,7 +462,7 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
462
462
  *
463
463
  * @public
464
464
  * @async
465
- * @param {?ReadParams<typeof erc20VariableIncentiveAbi, 'claims'>} [params]
465
+ * @param {?ReadParams} [params]
466
466
  * @returns {Promise<bigint>}
467
467
  */
468
468
  claims(params?: ReadParams<typeof erc20VariableIncentiveAbi, 'claims'>): Promise<bigint>;
@@ -472,7 +472,7 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
472
472
  * @public
473
473
  * @async
474
474
  * @param {Address} address
475
- * @param {?ReadParams<typeof erc20VariableIncentiveAbi, 'claimed'>} [params]
475
+ * @param {?ReadParams} [params]
476
476
  * @returns {Promise<boolean>}
477
477
  */
478
478
  claimed(address: Address, params?: ReadParams<typeof erc20VariableIncentiveAbi, 'claimed'>): Promise<boolean>;
@@ -481,7 +481,7 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
481
481
  *
482
482
  * @public
483
483
  * @async
484
- * @param {?ReadParams<typeof erc20VariableIncentiveAbi, 'asset'>} [params]
484
+ * @param {?ReadParams} [params]
485
485
  * @returns {Promise<Address>}
486
486
  */
487
487
  asset(params?: ReadParams<typeof erc20VariableIncentiveAbi, 'asset'>): Promise<`0x${string}`>;
@@ -490,7 +490,7 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
490
490
  *
491
491
  * @public
492
492
  * @async
493
- * @param {?ReadParams<typeof erc20VariableIncentiveAbi, 'reward'>} [params]
493
+ * @param {?ReadParams} [params]
494
494
  * @returns {Promise<bigint>}
495
495
  */
496
496
  reward(params?: ReadParams<typeof erc20VariableIncentiveAbi, 'reward'>): Promise<bigint>;
@@ -499,8 +499,8 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
499
499
  *
500
500
  * @public
501
501
  * @async
502
- * @param {?ReadParams<typeof erc20VariableIncentiveAbi, 'limit'>} [params]
503
- * @returns {unknown}
502
+ * @param {?ReadParams} [params]
503
+ * @returns {Promise<bigint>}
504
504
  */
505
505
  limit(params?: ReadParams<typeof erc20VariableIncentiveAbi, 'limit'>): Promise<bigint>;
506
506
  /**
@@ -509,7 +509,7 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
509
509
  * @public
510
510
  * @async
511
511
  * @param {ClaimPayload} payload
512
- * @param {?WriteParams<typeof erc20VariableIncentiveAbi, 'claim'>} [params]
512
+ * @param {?WriteParams} [params]
513
513
  * @returns {Promise<boolean>} - Returns true if successfully claimed
514
514
  */
515
515
  protected claim(payload: ClaimPayload, params?: WriteParams<typeof erc20VariableIncentiveAbi, 'claim'>): Promise<boolean>;
@@ -519,8 +519,8 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
519
519
  * @public
520
520
  * @async
521
521
  * @param {ClaimPayload} payload
522
- * @param {?WriteParams<typeof erc20VariableIncentiveAbi, 'claim'>} [params]
523
- * @returns {Promise<boolean>} - Returns true if successfully claimed
522
+ * @param {?WriteParams} [params]
523
+ * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - Returns true if successfully claimed
524
524
  */
525
525
  protected claimRaw(payload: ClaimPayload, params?: WriteParams<typeof erc20VariableIncentiveAbi, 'claim'>): Promise<{
526
526
  hash: `0x${string}`;
@@ -532,7 +532,7 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
532
532
  * @public
533
533
  * @async
534
534
  * @param {ClaimPayload} payload
535
- * @param {?WriteParams<typeof erc20VariableIncentiveAbi, 'clawback'>} [params]
535
+ * @param {?WriteParams} [params]
536
536
  * @returns {Promise<boolean>} - True if the assets were successfully clawbacked
537
537
  */
538
538
  clawback(payload: ClaimPayload, params?: WriteParams<typeof erc20VariableIncentiveAbi, 'clawback'>): Promise<boolean>;
@@ -542,8 +542,8 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
542
542
  * @public
543
543
  * @async
544
544
  * @param {ClaimPayload} payload
545
- * @param {?WriteParams<typeof erc20VariableIncentiveAbi, 'clawback'>} [params]
546
- * @returns {Promise<boolean>} - True if the assets were successfully clawbacked
545
+ * @param {?WriteParams} [params]
546
+ * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if the assets were successfully clawbacked
547
547
  */
548
548
  clawbackRaw(payload: ClaimPayload, params?: WriteParams<typeof erc20VariableIncentiveAbi, 'clawback'>): Promise<{
549
549
  hash: `0x${string}`;
@@ -555,8 +555,8 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
555
555
  * @public
556
556
  * @async
557
557
  * @param {ClaimPayload} payload
558
- * @param {?ReadParams<typeof erc20VariableIncentiveAbi, 'isClaimable'>} [params]
559
- * @returns {unknown} = True if the incentive is claimable based on the data payload
558
+ * @param {?ReadParams} [params]
559
+ * @returns {Promise<boolean>} = True if the incentive is claimable based on the data payload
560
560
  */
561
561
  isClaimable(payload: ClaimPayload, params?: ReadParams<typeof erc20VariableIncentiveAbi, 'isClaimable'>): Promise<boolean>;
562
562
  /**
@@ -576,7 +576,7 @@ export declare class ERC20VariableIncentive extends DeployableTarget<ERC20Variab
576
576
  * @param {Address} param0.asset - The address of the incentivized asset.
577
577
  * @param {bigint} param0.reward - The amount of the asset to distribute.
578
578
  * @param {bigint} param0.limit - How many times can this incentive be claimed.
579
- * @returns {*}
579
+ * @returns {Hex}
580
580
  */
581
581
  export declare function prepareERC20VariableIncentivePayload({ asset, reward, limit, }: ERC20VariableIncentivePayload): `0x${string}`;
582
582
  //# sourceMappingURL=ERC20VariableIncentive.d.ts.map
@@ -1,2 +1,2 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});require("../generated-BLg7yPgI.cjs");require("../componentInterfaces-CKCBwG16.cjs");require("@wagmi/core");require("../errors.cjs");const n=require("./AllowListIncentive.cjs"),i=require("./CGDAIncentive.cjs"),t=require("./ERC20Incentive.cjs"),e=require("../Incentive-CqX3fYEd.cjs"),r=require("./PointsIncentive.cjs");exports.AllowListIncentive=n.AllowListIncentive;exports.CGDAIncentive=i.CGDAIncentive;exports.ERC20Incentive=t.ERC20Incentive;exports.ERC20VariableIncentive=e.ERC20VariableIncentive;exports.IncentiveByComponentInterface=e.IncentiveByComponentInterface;exports.incentiveFromAddress=e.incentiveFromAddress;exports.PointsIncentive=r.PointsIncentive;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});require("../generated-B0tk-c9b.cjs");require("../componentInterfaces-D09mhzxO.cjs");require("@wagmi/core");require("../errors.cjs");const n=require("./AllowListIncentive.cjs"),i=require("./CGDAIncentive.cjs"),t=require("./ERC20Incentive.cjs"),e=require("../Incentive-Djnzseoj.cjs"),r=require("./PointsIncentive.cjs");exports.AllowListIncentive=n.AllowListIncentive;exports.CGDAIncentive=i.CGDAIncentive;exports.ERC20Incentive=t.ERC20Incentive;exports.ERC20VariableIncentive=e.ERC20VariableIncentive;exports.IncentiveByComponentInterface=e.IncentiveByComponentInterface;exports.incentiveFromAddress=e.incentiveFromAddress;exports.PointsIncentive=r.PointsIncentive;
2
2
  //# sourceMappingURL=Incentive.cjs.map