@boostxyz/sdk 0.0.0-alpha.9 → 1.1.0-alpha.22

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 (257) 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 +11 -11
  5. package/dist/Actions/ContractAction.d.ts.map +1 -1
  6. package/dist/Actions/ERC721MintAction.d.ts +14 -14
  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 +171 -41
  11. package/dist/Actions/EventAction.d.ts.map +1 -1
  12. package/dist/Actions/EventAction.js +15 -392
  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.d.ts +6 -4
  17. package/dist/AllowLists/AllowList.d.ts.map +1 -1
  18. package/dist/AllowLists/AllowList.js +45 -23
  19. package/dist/AllowLists/AllowList.js.map +1 -1
  20. package/dist/AllowLists/OpenAllowList.d.ts +423 -0
  21. package/dist/AllowLists/OpenAllowList.d.ts.map +1 -0
  22. package/dist/AllowLists/SimpleAllowList.cjs +1 -1
  23. package/dist/AllowLists/SimpleAllowList.cjs.map +1 -1
  24. package/dist/AllowLists/SimpleAllowList.d.ts +92 -37
  25. package/dist/AllowLists/SimpleAllowList.d.ts.map +1 -1
  26. package/dist/AllowLists/SimpleAllowList.js +55 -71
  27. package/dist/AllowLists/SimpleAllowList.js.map +1 -1
  28. package/dist/AllowLists/SimpleDenyList.cjs +1 -1
  29. package/dist/AllowLists/SimpleDenyList.cjs.map +1 -1
  30. package/dist/AllowLists/SimpleDenyList.d.ts +203 -11
  31. package/dist/AllowLists/SimpleDenyList.d.ts.map +1 -1
  32. package/dist/AllowLists/SimpleDenyList.js +11 -112
  33. package/dist/AllowLists/SimpleDenyList.js.map +1 -1
  34. package/dist/Auth/PassthroughAuth.cjs +1 -1
  35. package/dist/Auth/PassthroughAuth.js +1 -1
  36. package/dist/Boost.cjs +1 -1
  37. package/dist/Boost.cjs.map +1 -1
  38. package/dist/Boost.d.ts +20 -21
  39. package/dist/Boost.d.ts.map +1 -1
  40. package/dist/Boost.js +43 -57
  41. package/dist/Boost.js.map +1 -1
  42. package/dist/BoostCore-BVZExPPu.js +1462 -0
  43. package/dist/BoostCore-BVZExPPu.js.map +1 -0
  44. package/dist/BoostCore-D-E-cnGI.cjs +3 -0
  45. package/dist/BoostCore-D-E-cnGI.cjs.map +1 -0
  46. package/dist/BoostCore.cjs +1 -2
  47. package/dist/BoostCore.cjs.map +1 -1
  48. package/dist/BoostCore.d.ts +748 -77
  49. package/dist/BoostCore.d.ts.map +1 -1
  50. package/dist/BoostCore.js +29 -1150
  51. package/dist/BoostCore.js.map +1 -1
  52. package/dist/BoostRegistry.cjs +1 -1
  53. package/dist/BoostRegistry.cjs.map +1 -1
  54. package/dist/BoostRegistry.d.ts +80 -25
  55. package/dist/BoostRegistry.d.ts.map +1 -1
  56. package/dist/BoostRegistry.js +165 -83
  57. package/dist/BoostRegistry.js.map +1 -1
  58. package/dist/Budgets/Budget.cjs +1 -1
  59. package/dist/Budgets/Budget.cjs.map +1 -1
  60. package/dist/Budgets/Budget.d.ts.map +1 -1
  61. package/dist/Budgets/Budget.js +2 -2
  62. package/dist/Budgets/Budget.js.map +1 -1
  63. package/dist/Budgets/ManagedBudget.cjs +1 -1
  64. package/dist/Budgets/ManagedBudget.cjs.map +1 -1
  65. package/dist/Budgets/ManagedBudget.d.ts +75 -193
  66. package/dist/Budgets/ManagedBudget.d.ts.map +1 -1
  67. package/dist/Budgets/ManagedBudget.js +80 -298
  68. package/dist/Budgets/ManagedBudget.js.map +1 -1
  69. package/dist/Budgets/VestingBudget.d.ts +223 -89
  70. package/dist/Budgets/VestingBudget.d.ts.map +1 -1
  71. package/dist/Deployable/Contract.cjs +1 -1
  72. package/dist/Deployable/Contract.cjs.map +1 -1
  73. package/dist/Deployable/Contract.d.ts +4 -5
  74. package/dist/Deployable/Contract.d.ts.map +1 -1
  75. package/dist/Deployable/Contract.js +5 -7
  76. package/dist/Deployable/Contract.js.map +1 -1
  77. package/dist/Deployable/Deployable.cjs.map +1 -1
  78. package/dist/Deployable/Deployable.d.ts +1 -1
  79. package/dist/Deployable/Deployable.d.ts.map +1 -1
  80. package/dist/Deployable/Deployable.js +3 -5
  81. package/dist/Deployable/Deployable.js.map +1 -1
  82. package/dist/Deployable/DeployableTarget.cjs +1 -1
  83. package/dist/Deployable/DeployableTarget.cjs.map +1 -1
  84. package/dist/Deployable/DeployableTarget.d.ts +13 -13
  85. package/dist/Deployable/DeployableTarget.d.ts.map +1 -1
  86. package/dist/Deployable/DeployableTarget.js +28 -25
  87. package/dist/Deployable/DeployableTarget.js.map +1 -1
  88. package/dist/Deployable/DeployableTargetWithRBAC.cjs +2 -0
  89. package/dist/Deployable/DeployableTargetWithRBAC.cjs.map +1 -0
  90. package/dist/Deployable/DeployableTargetWithRBAC.d.ts +179 -0
  91. package/dist/Deployable/DeployableTargetWithRBAC.d.ts.map +1 -0
  92. package/dist/Deployable/DeployableTargetWithRBAC.js +222 -0
  93. package/dist/Deployable/DeployableTargetWithRBAC.js.map +1 -0
  94. package/dist/EventAction-BZt5cjbe.cjs +2 -0
  95. package/dist/EventAction-BZt5cjbe.cjs.map +1 -0
  96. package/dist/EventAction-C_-hJXWm.js +1541 -0
  97. package/dist/EventAction-C_-hJXWm.js.map +1 -0
  98. package/dist/Incentive-BhHaK3PZ.cjs +2 -0
  99. package/dist/Incentive-BhHaK3PZ.cjs.map +1 -0
  100. package/dist/Incentive-Cqg1w6wD.js +312 -0
  101. package/dist/Incentive-Cqg1w6wD.js.map +1 -0
  102. package/dist/Incentives/AllowListIncentive.cjs +1 -1
  103. package/dist/Incentives/AllowListIncentive.cjs.map +1 -1
  104. package/dist/Incentives/AllowListIncentive.d.ts +38 -16
  105. package/dist/Incentives/AllowListIncentive.d.ts.map +1 -1
  106. package/dist/Incentives/AllowListIncentive.js +42 -29
  107. package/dist/Incentives/AllowListIncentive.js.map +1 -1
  108. package/dist/Incentives/CGDAIncentive.cjs +1 -1
  109. package/dist/Incentives/CGDAIncentive.cjs.map +1 -1
  110. package/dist/Incentives/CGDAIncentive.d.ts +234 -21
  111. package/dist/Incentives/CGDAIncentive.d.ts.map +1 -1
  112. package/dist/Incentives/CGDAIncentive.js +45 -32
  113. package/dist/Incentives/CGDAIncentive.js.map +1 -1
  114. package/dist/Incentives/ERC1155Incentive.d.ts +224 -37
  115. package/dist/Incentives/ERC1155Incentive.d.ts.map +1 -1
  116. package/dist/Incentives/ERC20Incentive.cjs +1 -1
  117. package/dist/Incentives/ERC20Incentive.cjs.map +1 -1
  118. package/dist/Incentives/ERC20Incentive.d.ts +230 -29
  119. package/dist/Incentives/ERC20Incentive.d.ts.map +1 -1
  120. package/dist/Incentives/ERC20Incentive.js +56 -43
  121. package/dist/Incentives/ERC20Incentive.js.map +1 -1
  122. package/dist/{Budgets/SimpleBudget.d.ts → Incentives/ERC20VariableCriteriaIncentive.d.ts} +335 -440
  123. package/dist/Incentives/ERC20VariableCriteriaIncentive.d.ts.map +1 -0
  124. package/dist/Incentives/ERC20VariableIncentive.d.ts +231 -29
  125. package/dist/Incentives/ERC20VariableIncentive.d.ts.map +1 -1
  126. package/dist/Incentives/Incentive.cjs +1 -1
  127. package/dist/Incentives/Incentive.cjs.map +1 -1
  128. package/dist/Incentives/Incentive.d.ts +4 -4
  129. package/dist/Incentives/Incentive.d.ts.map +1 -1
  130. package/dist/Incentives/Incentive.js +16 -296
  131. package/dist/Incentives/Incentive.js.map +1 -1
  132. package/dist/Incentives/PointsIncentive.cjs +1 -1
  133. package/dist/Incentives/PointsIncentive.cjs.map +1 -1
  134. package/dist/Incentives/PointsIncentive.d.ts +40 -18
  135. package/dist/Incentives/PointsIncentive.d.ts.map +1 -1
  136. package/dist/Incentives/PointsIncentive.js +37 -24
  137. package/dist/Incentives/PointsIncentive.js.map +1 -1
  138. package/dist/SimpleDenyList-BUR17Tt1.cjs +2 -0
  139. package/dist/SimpleDenyList-BUR17Tt1.cjs.map +1 -0
  140. package/dist/SimpleDenyList-CGaWjuld.js +132 -0
  141. package/dist/SimpleDenyList-CGaWjuld.js.map +1 -0
  142. package/dist/Validators/SignerValidator.cjs +1 -1
  143. package/dist/Validators/SignerValidator.cjs.map +1 -1
  144. package/dist/Validators/SignerValidator.d.ts +16 -16
  145. package/dist/Validators/SignerValidator.d.ts.map +1 -1
  146. package/dist/Validators/SignerValidator.js +30 -27
  147. package/dist/Validators/SignerValidator.js.map +1 -1
  148. package/dist/Validators/Validator.cjs +1 -1
  149. package/dist/Validators/Validator.cjs.map +1 -1
  150. package/dist/Validators/Validator.d.ts +1 -1
  151. package/dist/Validators/Validator.js +2 -2
  152. package/dist/Validators/Validator.js.map +1 -1
  153. package/dist/claiming.cjs.map +1 -1
  154. package/dist/claiming.d.ts +1 -1
  155. package/dist/claiming.js.map +1 -1
  156. package/dist/componentInterfaces-BBCFkrZv.js +14 -0
  157. package/dist/componentInterfaces-BBCFkrZv.js.map +1 -0
  158. package/dist/componentInterfaces-DRI_dQ-P.cjs +2 -0
  159. package/dist/componentInterfaces-DRI_dQ-P.cjs.map +1 -0
  160. package/dist/deployments-DVXioW2i.cjs +2 -0
  161. package/dist/deployments-DVXioW2i.cjs.map +1 -0
  162. package/dist/deployments-oykLv3_Z.js +43 -0
  163. package/dist/deployments-oykLv3_Z.js.map +1 -0
  164. package/dist/deployments.json +44 -0
  165. package/dist/errors.cjs +1 -1
  166. package/dist/errors.cjs.map +1 -1
  167. package/dist/errors.d.ts +256 -20
  168. package/dist/errors.d.ts.map +1 -1
  169. package/dist/errors.js +183 -26
  170. package/dist/errors.js.map +1 -1
  171. package/dist/{generated-57_Kffpz.js → generated-CKt2yCQd.js} +3613 -1869
  172. package/dist/generated-CKt2yCQd.js.map +1 -0
  173. package/dist/generated-CyTNlOwM.cjs +3 -0
  174. package/dist/generated-CyTNlOwM.cjs.map +1 -0
  175. package/dist/index.cjs +1 -1
  176. package/dist/index.d.ts +5 -0
  177. package/dist/index.d.ts.map +1 -1
  178. package/dist/index.js +142 -108
  179. package/dist/index.js.map +1 -1
  180. package/dist/transfers.cjs.map +1 -1
  181. package/dist/transfers.d.ts +1 -1
  182. package/dist/transfers.js.map +1 -1
  183. package/dist/utils.cjs +1 -1
  184. package/dist/utils.cjs.map +1 -1
  185. package/dist/utils.d.ts +26 -12
  186. package/dist/utils.d.ts.map +1 -1
  187. package/dist/utils.js +38 -23
  188. package/dist/utils.js.map +1 -1
  189. package/package.json +20 -10
  190. package/src/Actions/Action.test.ts +14 -13
  191. package/src/Actions/ContractAction.test.ts +10 -10
  192. package/src/Actions/ContractAction.ts +11 -12
  193. package/src/Actions/ERC721MintAction.test.ts +6 -6
  194. package/src/Actions/ERC721MintAction.ts +14 -15
  195. package/src/Actions/EventAction.test.ts +729 -109
  196. package/src/Actions/EventAction.ts +542 -84
  197. package/src/AllowLists/AllowList.test.ts +7 -7
  198. package/src/AllowLists/AllowList.ts +5 -3
  199. package/src/AllowLists/OpenAllowList.test.ts +40 -0
  200. package/src/AllowLists/OpenAllowList.ts +45 -0
  201. package/src/AllowLists/SimpleAllowList.test.ts +4 -4
  202. package/src/AllowLists/SimpleAllowList.ts +39 -61
  203. package/src/AllowLists/SimpleDenyList.test.ts +4 -4
  204. package/src/AllowLists/SimpleDenyList.ts +40 -17
  205. package/src/Auth/PassthroughAuth.test.ts +1 -1
  206. package/src/Boost.ts +21 -24
  207. package/src/BoostCore.test.ts +323 -268
  208. package/src/BoostCore.ts +396 -219
  209. package/src/BoostRegistry.test.ts +53 -0
  210. package/src/BoostRegistry.ts +161 -40
  211. package/src/Budgets/Budget.test.ts +2 -2
  212. package/src/Budgets/Budget.ts +1 -2
  213. package/src/Budgets/ManagedBudget.test.ts +82 -19
  214. package/src/Budgets/ManagedBudget.ts +48 -310
  215. package/src/Budgets/VestingBudget.test.ts +7 -7
  216. package/src/Budgets/VestingBudget.ts +34 -106
  217. package/src/Deployable/Contract.ts +4 -5
  218. package/src/Deployable/Deployable.ts +1 -1
  219. package/src/Deployable/DeployableTarget.ts +30 -19
  220. package/src/Deployable/DeployableTargetWithRBAC.ts +323 -0
  221. package/src/Incentives/AllowListIncentive.test.ts +5 -5
  222. package/src/Incentives/AllowListIncentive.ts +29 -15
  223. package/src/Incentives/CGDAIncentive.test.ts +9 -6
  224. package/src/Incentives/CGDAIncentive.ts +38 -18
  225. package/src/Incentives/ERC1155Incentive.test.ts +3 -3
  226. package/src/Incentives/ERC1155Incentive.ts +28 -29
  227. package/src/Incentives/ERC20Incentive.test.ts +9 -6
  228. package/src/Incentives/ERC20Incentive.ts +46 -26
  229. package/src/Incentives/ERC20VariableCriteriaIncentive.test.ts +184 -0
  230. package/src/Incentives/ERC20VariableCriteriaIncentive.ts +324 -0
  231. package/src/Incentives/ERC20VariableIncentive.test.ts +8 -11
  232. package/src/Incentives/ERC20VariableIncentive.ts +49 -26
  233. package/src/Incentives/Incentive.test.ts +4 -1
  234. package/src/Incentives/Incentive.ts +7 -6
  235. package/src/Incentives/PointsIncentive.test.ts +24 -25
  236. package/src/Incentives/PointsIncentive.ts +31 -17
  237. package/src/Validators/SignerValidator.test.ts +6 -6
  238. package/src/Validators/SignerValidator.ts +19 -17
  239. package/src/Validators/Validator.test.ts +2 -2
  240. package/src/Validators/Validator.ts +1 -1
  241. package/src/claiming.ts +1 -1
  242. package/src/errors.ts +345 -21
  243. package/src/index.test.ts +118 -36
  244. package/src/index.ts +5 -0
  245. package/src/transfers.ts +1 -1
  246. package/src/utils.test.ts +2 -2
  247. package/src/utils.ts +61 -12
  248. package/dist/Budgets/SimpleBudget.d.ts.map +0 -1
  249. package/dist/componentInterfaces-CKCBwG16.cjs +0 -2
  250. package/dist/componentInterfaces-CKCBwG16.cjs.map +0 -1
  251. package/dist/componentInterfaces-DYkaxBda.js +0 -13
  252. package/dist/componentInterfaces-DYkaxBda.js.map +0 -1
  253. package/dist/generated-57_Kffpz.js.map +0 -1
  254. package/dist/generated-wKBNvm48.cjs +0 -3
  255. package/dist/generated-wKBNvm48.cjs.map +0 -1
  256. package/src/Budgets/SimpleBudget.test.ts +0 -152
  257. package/src/Budgets/SimpleBudget.ts +0 -564
@@ -1,24 +1,32 @@
1
1
  import { boostCoreAbi, type iAuthAbi } from '@boostxyz/evm';
2
+ import { type GetTransactionReceiptParameters } from '@wagmi/core';
2
3
  import { type Address, type ContractEventName, type Hex } from 'viem';
3
4
  import { type Action } from './Actions/Action';
4
5
  import { EventAction, type EventActionPayload } from './Actions/EventAction';
5
6
  import { type AllowList } from './AllowLists/AllowList';
7
+ import { OpenAllowList } from './AllowLists/OpenAllowList';
6
8
  import { SimpleAllowList, type SimpleAllowListPayload } from './AllowLists/SimpleAllowList';
7
9
  import { SimpleDenyList, type SimpleDenyListPayload } from './AllowLists/SimpleDenyList';
8
10
  import { type Auth, PassthroughAuth } from './Auth/Auth';
9
- import { Boost } from './Boost';
11
+ import { Boost, type RawBoost } from './Boost';
10
12
  import { type Budget } from './Budgets/Budget';
11
13
  import { ManagedBudget, type ManagedBudgetPayload } from './Budgets/ManagedBudget';
12
14
  import { Deployable, type DeployableOptions, type DeployablePayloadOrAddress, type GenericDeployableParams } from './Deployable/Deployable';
13
15
  import { AllowListIncentive, type AllowListIncentivePayload } from './Incentives/AllowListIncentive';
14
16
  import { CGDAIncentive, type CGDAIncentivePayload } from './Incentives/CGDAIncentive';
15
17
  import { ERC20Incentive, type ERC20IncentivePayload } from './Incentives/ERC20Incentive';
18
+ import { ERC20VariableCriteriaIncentive, type ERC20VariableCriteriaIncentivePayload } from './Incentives/ERC20VariableCriteriaIncentive';
16
19
  import type { ERC20VariableIncentivePayload } from './Incentives/ERC20VariableIncentive';
17
20
  import { ERC20VariableIncentive, type Incentive } from './Incentives/Incentive';
18
21
  import { PointsIncentive, type PointsIncentivePayload } from './Incentives/PointsIncentive';
19
22
  import { SignerValidator, type SignerValidatorPayload } from './Validators/SignerValidator';
20
23
  import { type Validator } from './Validators/Validator';
21
- import type { GenericLog, ReadParams, WriteParams } from './utils';
24
+ import { type GenericLog, type ReadParams, type WriteParams } from './utils';
25
+ /**
26
+ * The ABI of the BoostCore contract, if needed for low level operations
27
+ *
28
+ * @type {typeof boostCoreAbi}
29
+ */
22
30
  export { boostCoreAbi };
23
31
  /**
24
32
  * The fee (in wei) required to claim each incentive, must be provided for the `claimIncentive` transaction
@@ -27,12 +35,18 @@ export { boostCoreAbi };
27
35
  */
28
36
  export declare const BOOST_CORE_CLAIM_FEE: bigint;
29
37
  /**
30
- * The fixed address for the deployed Boost Core.
31
- * By default, `new BoostCore` will use this address if not otherwise provided.
38
+ * The address of the deployed BoostCore instance. In prerelease mode, this will be its sepolia address
32
39
  *
33
40
  * @type {Address}
34
41
  */
35
- export declare const BOOST_CORE_ADDRESS: Address;
42
+ export declare const BOOST_CORE_ADDRESS: `0x${string}`;
43
+ /**
44
+ * The fixed addresses for the deployed Boost Core.
45
+ * By default, `new BoostCore` will use the address deployed to the currently connected chain, or `BOOST_CORE_ADDRESS` if not provided.
46
+ *
47
+ * @type {Record<number, Address>}
48
+ */
49
+ export declare const BOOST_CORE_ADDRESSES: Record<number, Address>;
36
50
  /**
37
51
  * A generic `viem.Log` event with support for `BoostCore` event types.
38
52
  *
@@ -97,11 +111,10 @@ export type BoostCoreConfig = BoostCoreDeployedOptions | BoostCoreOptionsWithPay
97
111
  export type CreateBoostPayload = {
98
112
  budget: Budget;
99
113
  action: Action;
100
- validator: Validator;
114
+ validator?: Validator;
101
115
  allowList: AllowList;
102
116
  incentives: Array<Incentive>;
103
117
  protocolFee?: bigint;
104
- referralFee?: bigint;
105
118
  maxParticipants?: bigint;
106
119
  owner?: Address;
107
120
  };
@@ -117,6 +130,22 @@ export declare class BoostCore extends Deployable<[
117
130
  Address,
118
131
  Address
119
132
  ], typeof boostCoreAbi> {
133
+ /**
134
+ * A static property representing a map of stringified chain ID's to the address of the deployed implementation on chain
135
+ *
136
+ * @static
137
+ * @readonly
138
+ * @type {Record<string, Address>}
139
+ */
140
+ static readonly addresses: Record<number, Address>;
141
+ /**
142
+ * A getter that will return Boost core's static addresses by numerical chain ID
143
+ *
144
+ * @public
145
+ * @readonly
146
+ * @type {Record<number, Address>}
147
+ */
148
+ get addresses(): Record<number, Address>;
120
149
  /**
121
150
  * Creates an instance of BoostCore.
122
151
  *
@@ -133,10 +162,637 @@ export declare class BoostCore extends Deployable<[
133
162
  * @public
134
163
  * @async
135
164
  * @param {CreateBoostPayload} _boostPayload
136
- * @param {?DeployableOptions} [_options]
137
- * @returns {Boost}
165
+ * @param {?DeployableOptions} [_params]
166
+ * @returns {Promise<Boost>}
138
167
  */
139
- createBoost(_boostPayload: CreateBoostPayload, _options?: DeployableOptions): Promise<Boost>;
168
+ createBoost(_boostPayload: CreateBoostPayload, _params?: DeployableOptions & WriteParams<typeof boostCoreAbi, 'createBoost'>): Promise<Boost>;
169
+ /**
170
+ * Returns a simulated Boost creation.
171
+ *
172
+ * @public
173
+ * @async
174
+ * @param {CreateBoostPayload} _boostPayload
175
+ * @param {?DeployableOptions} [_params]
176
+ * @returns {Promise<SimulateContractReturnType>}
177
+ */
178
+ simulateCreateBoost(_boostPayload: CreateBoostPayload, _params?: DeployableOptions & WriteParams<typeof boostCoreAbi, 'createBoost'>): Promise<import("viem").SimulateContractReturnType<readonly [{
179
+ readonly type: "constructor";
180
+ readonly inputs: readonly [{
181
+ readonly name: "registry_";
182
+ readonly internalType: "contract BoostRegistry";
183
+ readonly type: "address";
184
+ }, {
185
+ readonly name: "protocolFeeReceiver_";
186
+ readonly internalType: "address";
187
+ readonly type: "address";
188
+ }];
189
+ readonly stateMutability: "nonpayable";
190
+ }, {
191
+ readonly type: "error";
192
+ readonly inputs: readonly [];
193
+ readonly name: "AlreadyInitialized";
194
+ }, {
195
+ readonly type: "error";
196
+ readonly inputs: readonly [{
197
+ readonly name: "caller";
198
+ readonly internalType: "address";
199
+ readonly type: "address";
200
+ }, {
201
+ readonly name: "data";
202
+ readonly internalType: "bytes";
203
+ readonly type: "bytes";
204
+ }];
205
+ readonly name: "ClaimFailed";
206
+ }, {
207
+ readonly type: "error";
208
+ readonly inputs: readonly [{
209
+ readonly name: "caller";
210
+ readonly internalType: "address";
211
+ readonly type: "address";
212
+ }, {
213
+ readonly name: "data";
214
+ readonly internalType: "bytes";
215
+ readonly type: "bytes";
216
+ }];
217
+ readonly name: "ClawbackFailed";
218
+ }, {
219
+ readonly type: "error";
220
+ readonly inputs: readonly [];
221
+ readonly name: "InvalidInitialization";
222
+ }, {
223
+ readonly type: "error";
224
+ readonly inputs: readonly [{
225
+ readonly name: "expectedInterface";
226
+ readonly internalType: "bytes4";
227
+ readonly type: "bytes4";
228
+ }, {
229
+ readonly name: "instance";
230
+ readonly internalType: "address";
231
+ readonly type: "address";
232
+ }];
233
+ readonly name: "InvalidInstance";
234
+ }, {
235
+ readonly type: "error";
236
+ readonly inputs: readonly [];
237
+ readonly name: "NewOwnerIsZeroAddress";
238
+ }, {
239
+ readonly type: "error";
240
+ readonly inputs: readonly [];
241
+ readonly name: "NoHandoverRequest";
242
+ }, {
243
+ readonly type: "error";
244
+ readonly inputs: readonly [];
245
+ readonly name: "NotImplemented";
246
+ }, {
247
+ readonly type: "error";
248
+ readonly inputs: readonly [];
249
+ readonly name: "Reentrancy";
250
+ }, {
251
+ readonly type: "error";
252
+ readonly inputs: readonly [];
253
+ readonly name: "Unauthorized";
254
+ }, {
255
+ readonly type: "error";
256
+ readonly inputs: readonly [];
257
+ readonly name: "Unauthorized";
258
+ }, {
259
+ readonly type: "event";
260
+ readonly anonymous: false;
261
+ readonly inputs: readonly [{
262
+ readonly name: "boostId";
263
+ readonly internalType: "uint256";
264
+ readonly type: "uint256";
265
+ readonly indexed: true;
266
+ }, {
267
+ readonly name: "incentiveId";
268
+ readonly internalType: "uint256";
269
+ readonly type: "uint256";
270
+ readonly indexed: true;
271
+ }, {
272
+ readonly name: "claimant";
273
+ readonly internalType: "address";
274
+ readonly type: "address";
275
+ readonly indexed: true;
276
+ }, {
277
+ readonly name: "referrer";
278
+ readonly internalType: "address";
279
+ readonly type: "address";
280
+ readonly indexed: false;
281
+ }, {
282
+ readonly name: "data";
283
+ readonly internalType: "bytes";
284
+ readonly type: "bytes";
285
+ readonly indexed: false;
286
+ }];
287
+ readonly name: "BoostClaimed";
288
+ }, {
289
+ readonly type: "event";
290
+ readonly anonymous: false;
291
+ readonly inputs: readonly [{
292
+ readonly name: "boostId";
293
+ readonly internalType: "uint256";
294
+ readonly type: "uint256";
295
+ readonly indexed: true;
296
+ }, {
297
+ readonly name: "owner";
298
+ readonly internalType: "address";
299
+ readonly type: "address";
300
+ readonly indexed: true;
301
+ }, {
302
+ readonly name: "action";
303
+ readonly internalType: "address";
304
+ readonly type: "address";
305
+ readonly indexed: true;
306
+ }, {
307
+ readonly name: "incentiveCount";
308
+ readonly internalType: "uint256";
309
+ readonly type: "uint256";
310
+ readonly indexed: false;
311
+ }, {
312
+ readonly name: "validator";
313
+ readonly internalType: "address";
314
+ readonly type: "address";
315
+ readonly indexed: false;
316
+ }, {
317
+ readonly name: "allowList";
318
+ readonly internalType: "address";
319
+ readonly type: "address";
320
+ readonly indexed: false;
321
+ }, {
322
+ readonly name: "budget";
323
+ readonly internalType: "address";
324
+ readonly type: "address";
325
+ readonly indexed: false;
326
+ }];
327
+ readonly name: "BoostCreated";
328
+ }, {
329
+ readonly type: "event";
330
+ readonly anonymous: false;
331
+ readonly inputs: readonly [{
332
+ readonly name: "pendingOwner";
333
+ readonly internalType: "address";
334
+ readonly type: "address";
335
+ readonly indexed: true;
336
+ }];
337
+ readonly name: "OwnershipHandoverCanceled";
338
+ }, {
339
+ readonly type: "event";
340
+ readonly anonymous: false;
341
+ readonly inputs: readonly [{
342
+ readonly name: "pendingOwner";
343
+ readonly internalType: "address";
344
+ readonly type: "address";
345
+ readonly indexed: true;
346
+ }];
347
+ readonly name: "OwnershipHandoverRequested";
348
+ }, {
349
+ readonly type: "event";
350
+ readonly anonymous: false;
351
+ readonly inputs: readonly [{
352
+ readonly name: "oldOwner";
353
+ readonly internalType: "address";
354
+ readonly type: "address";
355
+ readonly indexed: true;
356
+ }, {
357
+ readonly name: "newOwner";
358
+ readonly internalType: "address";
359
+ readonly type: "address";
360
+ readonly indexed: true;
361
+ }];
362
+ readonly name: "OwnershipTransferred";
363
+ }, {
364
+ readonly type: "event";
365
+ readonly anonymous: false;
366
+ readonly inputs: readonly [{
367
+ readonly name: "boostId";
368
+ readonly internalType: "uint256";
369
+ readonly type: "uint256";
370
+ readonly indexed: true;
371
+ }, {
372
+ readonly name: "incentiveId";
373
+ readonly internalType: "uint256";
374
+ readonly type: "uint256";
375
+ readonly indexed: true;
376
+ }, {
377
+ readonly name: "amount";
378
+ readonly internalType: "uint256";
379
+ readonly type: "uint256";
380
+ readonly indexed: false;
381
+ }, {
382
+ readonly name: "recipient";
383
+ readonly internalType: "address";
384
+ readonly type: "address";
385
+ readonly indexed: true;
386
+ }];
387
+ readonly name: "ProtocolFeesCollected";
388
+ }, {
389
+ readonly type: "function";
390
+ readonly inputs: readonly [];
391
+ readonly name: "FEE_DENOMINATOR";
392
+ readonly outputs: readonly [{
393
+ readonly name: "";
394
+ readonly internalType: "uint64";
395
+ readonly type: "uint64";
396
+ }];
397
+ readonly stateMutability: "view";
398
+ }, {
399
+ readonly type: "function";
400
+ readonly inputs: readonly [];
401
+ readonly name: "cancelOwnershipHandover";
402
+ readonly outputs: readonly [];
403
+ readonly stateMutability: "payable";
404
+ }, {
405
+ readonly type: "function";
406
+ readonly inputs: readonly [{
407
+ readonly name: "boostId_";
408
+ readonly internalType: "uint256";
409
+ readonly type: "uint256";
410
+ }, {
411
+ readonly name: "incentiveId_";
412
+ readonly internalType: "uint256";
413
+ readonly type: "uint256";
414
+ }, {
415
+ readonly name: "referrer_";
416
+ readonly internalType: "address";
417
+ readonly type: "address";
418
+ }, {
419
+ readonly name: "data_";
420
+ readonly internalType: "bytes";
421
+ readonly type: "bytes";
422
+ }];
423
+ readonly name: "claimIncentive";
424
+ readonly outputs: readonly [];
425
+ readonly stateMutability: "payable";
426
+ }, {
427
+ readonly type: "function";
428
+ readonly inputs: readonly [{
429
+ readonly name: "boostId_";
430
+ readonly internalType: "uint256";
431
+ readonly type: "uint256";
432
+ }, {
433
+ readonly name: "incentiveId_";
434
+ readonly internalType: "uint256";
435
+ readonly type: "uint256";
436
+ }, {
437
+ readonly name: "referrer_";
438
+ readonly internalType: "address";
439
+ readonly type: "address";
440
+ }, {
441
+ readonly name: "data_";
442
+ readonly internalType: "bytes";
443
+ readonly type: "bytes";
444
+ }, {
445
+ readonly name: "claimant";
446
+ readonly internalType: "address";
447
+ readonly type: "address";
448
+ }];
449
+ readonly name: "claimIncentiveFor";
450
+ readonly outputs: readonly [];
451
+ readonly stateMutability: "payable";
452
+ }, {
453
+ readonly type: "function";
454
+ readonly inputs: readonly [{
455
+ readonly name: "data_";
456
+ readonly internalType: "bytes";
457
+ readonly type: "bytes";
458
+ }, {
459
+ readonly name: "boostId";
460
+ readonly internalType: "uint256";
461
+ readonly type: "uint256";
462
+ }, {
463
+ readonly name: "incentiveId";
464
+ readonly internalType: "uint256";
465
+ readonly type: "uint256";
466
+ }];
467
+ readonly name: "clawback";
468
+ readonly outputs: readonly [{
469
+ readonly name: "";
470
+ readonly internalType: "uint256";
471
+ readonly type: "uint256";
472
+ }, {
473
+ readonly name: "";
474
+ readonly internalType: "address";
475
+ readonly type: "address";
476
+ }];
477
+ readonly stateMutability: "nonpayable";
478
+ }, {
479
+ readonly type: "function";
480
+ readonly inputs: readonly [{
481
+ readonly name: "pendingOwner";
482
+ readonly internalType: "address";
483
+ readonly type: "address";
484
+ }];
485
+ readonly name: "completeOwnershipHandover";
486
+ readonly outputs: readonly [];
487
+ readonly stateMutability: "payable";
488
+ }, {
489
+ readonly type: "function";
490
+ readonly inputs: readonly [{
491
+ readonly name: "data_";
492
+ readonly internalType: "bytes";
493
+ readonly type: "bytes";
494
+ }];
495
+ readonly name: "createBoost";
496
+ readonly outputs: readonly [{
497
+ readonly name: "";
498
+ readonly internalType: "struct BoostLib.Boost";
499
+ readonly type: "tuple";
500
+ readonly components: readonly [{
501
+ readonly name: "action";
502
+ readonly internalType: "contract AAction";
503
+ readonly type: "address";
504
+ }, {
505
+ readonly name: "validator";
506
+ readonly internalType: "contract AValidator";
507
+ readonly type: "address";
508
+ }, {
509
+ readonly name: "allowList";
510
+ readonly internalType: "contract AAllowList";
511
+ readonly type: "address";
512
+ }, {
513
+ readonly name: "budget";
514
+ readonly internalType: "contract ABudget";
515
+ readonly type: "address";
516
+ }, {
517
+ readonly name: "incentives";
518
+ readonly internalType: "contract AIncentive[]";
519
+ readonly type: "address[]";
520
+ }, {
521
+ readonly name: "protocolFee";
522
+ readonly internalType: "uint64";
523
+ readonly type: "uint64";
524
+ }, {
525
+ readonly name: "maxParticipants";
526
+ readonly internalType: "uint256";
527
+ readonly type: "uint256";
528
+ }, {
529
+ readonly name: "owner";
530
+ readonly internalType: "address";
531
+ readonly type: "address";
532
+ }];
533
+ }];
534
+ readonly stateMutability: "nonpayable";
535
+ }, {
536
+ readonly type: "function";
537
+ readonly inputs: readonly [];
538
+ readonly name: "createBoostAuth";
539
+ readonly outputs: readonly [{
540
+ readonly name: "";
541
+ readonly internalType: "contract IAuth";
542
+ readonly type: "address";
543
+ }];
544
+ readonly stateMutability: "view";
545
+ }, {
546
+ readonly type: "function";
547
+ readonly inputs: readonly [{
548
+ readonly name: "index";
549
+ readonly internalType: "uint256";
550
+ readonly type: "uint256";
551
+ }];
552
+ readonly name: "getBoost";
553
+ readonly outputs: readonly [{
554
+ readonly name: "";
555
+ readonly internalType: "struct BoostLib.Boost";
556
+ readonly type: "tuple";
557
+ readonly components: readonly [{
558
+ readonly name: "action";
559
+ readonly internalType: "contract AAction";
560
+ readonly type: "address";
561
+ }, {
562
+ readonly name: "validator";
563
+ readonly internalType: "contract AValidator";
564
+ readonly type: "address";
565
+ }, {
566
+ readonly name: "allowList";
567
+ readonly internalType: "contract AAllowList";
568
+ readonly type: "address";
569
+ }, {
570
+ readonly name: "budget";
571
+ readonly internalType: "contract ABudget";
572
+ readonly type: "address";
573
+ }, {
574
+ readonly name: "incentives";
575
+ readonly internalType: "contract AIncentive[]";
576
+ readonly type: "address[]";
577
+ }, {
578
+ readonly name: "protocolFee";
579
+ readonly internalType: "uint64";
580
+ readonly type: "uint64";
581
+ }, {
582
+ readonly name: "maxParticipants";
583
+ readonly internalType: "uint256";
584
+ readonly type: "uint256";
585
+ }, {
586
+ readonly name: "owner";
587
+ readonly internalType: "address";
588
+ readonly type: "address";
589
+ }];
590
+ }];
591
+ readonly stateMutability: "view";
592
+ }, {
593
+ readonly type: "function";
594
+ readonly inputs: readonly [];
595
+ readonly name: "getBoostCount";
596
+ readonly outputs: readonly [{
597
+ readonly name: "";
598
+ readonly internalType: "uint256";
599
+ readonly type: "uint256";
600
+ }];
601
+ readonly stateMutability: "view";
602
+ }, {
603
+ readonly type: "function";
604
+ readonly inputs: readonly [{
605
+ readonly name: "key";
606
+ readonly internalType: "bytes32";
607
+ readonly type: "bytes32";
608
+ }];
609
+ readonly name: "getIncentive";
610
+ readonly outputs: readonly [{
611
+ readonly name: "";
612
+ readonly internalType: "struct BoostCore.IncentiveDisbursalInfo";
613
+ readonly type: "tuple";
614
+ readonly components: readonly [{
615
+ readonly name: "assetType";
616
+ readonly internalType: "enum ABudget.AssetType";
617
+ readonly type: "uint8";
618
+ }, {
619
+ readonly name: "asset";
620
+ readonly internalType: "address";
621
+ readonly type: "address";
622
+ }, {
623
+ readonly name: "protocolFeesRemaining";
624
+ readonly internalType: "uint256";
625
+ readonly type: "uint256";
626
+ }, {
627
+ readonly name: "protocolFee";
628
+ readonly internalType: "uint256";
629
+ readonly type: "uint256";
630
+ }, {
631
+ readonly name: "tokenId";
632
+ readonly internalType: "uint256";
633
+ readonly type: "uint256";
634
+ }];
635
+ }];
636
+ readonly stateMutability: "view";
637
+ }, {
638
+ readonly type: "function";
639
+ readonly inputs: readonly [{
640
+ readonly name: "";
641
+ readonly internalType: "bytes32";
642
+ readonly type: "bytes32";
643
+ }];
644
+ readonly name: "incentives";
645
+ readonly outputs: readonly [{
646
+ readonly name: "assetType";
647
+ readonly internalType: "enum ABudget.AssetType";
648
+ readonly type: "uint8";
649
+ }, {
650
+ readonly name: "asset";
651
+ readonly internalType: "address";
652
+ readonly type: "address";
653
+ }, {
654
+ readonly name: "protocolFeesRemaining";
655
+ readonly internalType: "uint256";
656
+ readonly type: "uint256";
657
+ }, {
658
+ readonly name: "protocolFee";
659
+ readonly internalType: "uint256";
660
+ readonly type: "uint256";
661
+ }, {
662
+ readonly name: "tokenId";
663
+ readonly internalType: "uint256";
664
+ readonly type: "uint256";
665
+ }];
666
+ readonly stateMutability: "view";
667
+ }, {
668
+ readonly type: "function";
669
+ readonly inputs: readonly [];
670
+ readonly name: "owner";
671
+ readonly outputs: readonly [{
672
+ readonly name: "result";
673
+ readonly internalType: "address";
674
+ readonly type: "address";
675
+ }];
676
+ readonly stateMutability: "view";
677
+ }, {
678
+ readonly type: "function";
679
+ readonly inputs: readonly [{
680
+ readonly name: "pendingOwner";
681
+ readonly internalType: "address";
682
+ readonly type: "address";
683
+ }];
684
+ readonly name: "ownershipHandoverExpiresAt";
685
+ readonly outputs: readonly [{
686
+ readonly name: "result";
687
+ readonly internalType: "uint256";
688
+ readonly type: "uint256";
689
+ }];
690
+ readonly stateMutability: "view";
691
+ }, {
692
+ readonly type: "function";
693
+ readonly inputs: readonly [];
694
+ readonly name: "protocolFee";
695
+ readonly outputs: readonly [{
696
+ readonly name: "";
697
+ readonly internalType: "uint64";
698
+ readonly type: "uint64";
699
+ }];
700
+ readonly stateMutability: "view";
701
+ }, {
702
+ readonly type: "function";
703
+ readonly inputs: readonly [];
704
+ readonly name: "protocolFeeReceiver";
705
+ readonly outputs: readonly [{
706
+ readonly name: "";
707
+ readonly internalType: "address";
708
+ readonly type: "address";
709
+ }];
710
+ readonly stateMutability: "view";
711
+ }, {
712
+ readonly type: "function";
713
+ readonly inputs: readonly [];
714
+ readonly name: "registry";
715
+ readonly outputs: readonly [{
716
+ readonly name: "";
717
+ readonly internalType: "contract BoostRegistry";
718
+ readonly type: "address";
719
+ }];
720
+ readonly stateMutability: "view";
721
+ }, {
722
+ readonly type: "function";
723
+ readonly inputs: readonly [];
724
+ readonly name: "renounceOwnership";
725
+ readonly outputs: readonly [];
726
+ readonly stateMutability: "payable";
727
+ }, {
728
+ readonly type: "function";
729
+ readonly inputs: readonly [];
730
+ readonly name: "requestOwnershipHandover";
731
+ readonly outputs: readonly [];
732
+ readonly stateMutability: "payable";
733
+ }, {
734
+ readonly type: "function";
735
+ readonly inputs: readonly [{
736
+ readonly name: "auth_";
737
+ readonly internalType: "address";
738
+ readonly type: "address";
739
+ }];
740
+ readonly name: "setCreateBoostAuth";
741
+ readonly outputs: readonly [];
742
+ readonly stateMutability: "nonpayable";
743
+ }, {
744
+ readonly type: "function";
745
+ readonly inputs: readonly [{
746
+ readonly name: "protocolFee_";
747
+ readonly internalType: "uint64";
748
+ readonly type: "uint64";
749
+ }];
750
+ readonly name: "setProtocolFee";
751
+ readonly outputs: readonly [];
752
+ readonly stateMutability: "nonpayable";
753
+ }, {
754
+ readonly type: "function";
755
+ readonly inputs: readonly [{
756
+ readonly name: "protocolFeeReceiver_";
757
+ readonly internalType: "address";
758
+ readonly type: "address";
759
+ }];
760
+ readonly name: "setProtocolFeeReceiver";
761
+ readonly outputs: readonly [];
762
+ readonly stateMutability: "nonpayable";
763
+ }, {
764
+ readonly type: "function";
765
+ readonly inputs: readonly [{
766
+ readonly name: "boostId";
767
+ readonly internalType: "uint256";
768
+ readonly type: "uint256";
769
+ }, {
770
+ readonly name: "incentiveId";
771
+ readonly internalType: "uint256";
772
+ readonly type: "uint256";
773
+ }];
774
+ readonly name: "settleProtocolFees";
775
+ readonly outputs: readonly [];
776
+ readonly stateMutability: "nonpayable";
777
+ }, {
778
+ readonly type: "function";
779
+ readonly inputs: readonly [{
780
+ readonly name: "newOwner";
781
+ readonly internalType: "address";
782
+ readonly type: "address";
783
+ }];
784
+ readonly name: "transferOwnership";
785
+ readonly outputs: readonly [];
786
+ readonly stateMutability: "payable";
787
+ }], "createBoost", readonly [`0x${string}`], import("viem").Chain, import("viem").Account, import("viem").Chain> & {
788
+ chainId: number;
789
+ request: {
790
+ chainId?: undefined;
791
+ __mode: "prepared";
792
+ chain: import("viem").Chain;
793
+ };
794
+ }>;
795
+ private prepareCreateBoostPayload;
140
796
  /**
141
797
  * Claims one incentive from a given `Boost` by `boostId` and `incentiveId`
142
798
  *
@@ -146,8 +802,8 @@ export declare class BoostCore extends Deployable<[
146
802
  * @param {bigint} incentiveId
147
803
  * @param {Address} address
148
804
  * @param {Hex} data
149
- * @param {?WriteParams<typeof boostCoreAbi, 'claimIncentive'>} [params]
150
- * @returns {unknown}
805
+ * @param {?WriteParams} [params]
806
+ * @returns {Promise<void>}
151
807
  */
152
808
  claimIncentive(boostId: bigint, incentiveId: bigint, address: Address, data: Hex, params?: WriteParams<typeof boostCoreAbi, 'claimIncentive'>): Promise<void>;
153
809
  /**
@@ -159,8 +815,8 @@ export declare class BoostCore extends Deployable<[
159
815
  * @param {bigint} incentiveId - The ID of the Incentive
160
816
  * @param {Address} referrer - The address of the referrer (if any)
161
817
  * @param {Hex} data- The data for the claim
162
- * @param {?WriteParams<typeof boostCoreAbi, 'claimIncentive'>} [params]
163
- * @returns {unknown}
818
+ * @param {?WriteParams} [params]
819
+ * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
164
820
  */
165
821
  claimIncentiveRaw(boostId: bigint, incentiveId: bigint, referrer: Address, data: Hex, params?: WriteParams<typeof boostCoreAbi, 'claimIncentive'>): Promise<{
166
822
  hash: `0x${string}`;
@@ -176,8 +832,8 @@ export declare class BoostCore extends Deployable<[
176
832
  * @param {Address} referrer
177
833
  * @param {Hex} data
178
834
  * @param {Address} claimant
179
- * @param {?WriteParams<typeof boostCoreAbi, 'claimIncentiveFor'>} [params]
180
- * @returns {unknown}
835
+ * @param {?WriteParams} [params]
836
+ * @returns {Promise<void>}
181
837
  */
182
838
  claimIncentiveFor(boostId: bigint, incentiveId: bigint, referrer: Address, data: Hex, claimant: Address, params?: WriteParams<typeof boostCoreAbi, 'claimIncentiveFor'>): Promise<void>;
183
839
  /**
@@ -190,8 +846,8 @@ export declare class BoostCore extends Deployable<[
190
846
  * @param {Address} referrer - The address of the referrer (if any)
191
847
  * @param {Hex} data - The data for the claim
192
848
  * @param {Address} claimant - The address of the user eligible for the incentive payout
193
- * @param {?WriteParams<typeof boostCoreAbi, 'claimIncentiveFor'>} [params]
194
- * @returns {unknown}
849
+ * @param {?WriteParams} [params]
850
+ * @returns {Promise<{ hash: Hex; result: void; }>}
195
851
  */
196
852
  claimIncentiveForRaw(boostId: bigint, incentiveId: bigint, referrer: Address, data: Hex, claimant: Address, params?: WriteParams<typeof boostCoreAbi, 'claimIncentiveFor'>): Promise<{
197
853
  hash: `0x${string}`;
@@ -202,29 +858,21 @@ export declare class BoostCore extends Deployable<[
202
858
  *
203
859
  * @public
204
860
  * @async
205
- * @param {bigint} id
206
- * @param {?ReadParams<typeof boostCoreAbi, 'getBoost'>} [params]
207
- * @returns {unknown}
861
+ * @param {bigint | string} id
862
+ * @param {?ReadParams} [params]
863
+ * @returns {Promise<RawBoost>}
864
+ * @throws {@link BoostNotFoundError}
208
865
  */
209
- readBoost(id: bigint, params?: ReadParams<typeof boostCoreAbi, 'getBoost'>): Promise<{
210
- action: `0x${string}`;
211
- validator: `0x${string}`;
212
- allowList: `0x${string}`;
213
- budget: `0x${string}`;
214
- incentives: readonly `0x${string}`[];
215
- protocolFee: bigint;
216
- referralFee: bigint;
217
- maxParticipants: bigint;
218
- owner: `0x${string}`;
219
- }>;
866
+ readBoost(_id: string | bigint, params?: ReadParams<typeof boostCoreAbi, 'getBoost'>): Promise<RawBoost>;
220
867
  /**
221
868
  * Get a Boost by index, will return a new {@link Boost} with correct target implementations instantiated, ie `(await core.getBoost(0n)).allowList instanceof SimpleAllowList` vs `SimpleDenyList`
222
869
  *
223
870
  * @public
224
871
  * @async
225
872
  * @param {(string | bigint)} _id
226
- * @param {?ReadParams<typeof boostCoreAbi, 'getBoost'>} [params]
227
- * @returns {unknown}
873
+ * @param {?ReadParams} [params]
874
+ * @returns {Promise<Boost>}
875
+ * @throws {@link BoostNotFoundError}
228
876
  */
229
877
  getBoost(_id: string | bigint, params?: ReadParams<typeof boostCoreAbi, 'getBoost'>): Promise<Boost>;
230
878
  /**
@@ -232,7 +880,7 @@ export declare class BoostCore extends Deployable<[
232
880
  *
233
881
  * @public
234
882
  * @async
235
- * @param {?ReadParams<typeof boostCoreAbi, 'getBoostCount'>} [params]
883
+ * @param {?ReadParams} [params]
236
884
  * @returns {Promise<bigint>}
237
885
  */
238
886
  getBoostCount(params?: ReadParams<typeof boostCoreAbi, 'getBoostCount'>): Promise<bigint>;
@@ -242,7 +890,7 @@ export declare class BoostCore extends Deployable<[
242
890
  * @public
243
891
  * @async
244
892
  * @param {Address} address
245
- * @param {?ReadParams<typeof boostCoreAbi, 'createBoostAuth'> &
893
+ * @param {?ReadParams &
246
894
  * ReadParams<typeof iAuthAbi, 'isAuthorized'>} [params]
247
895
  * @returns {Promise<boolean>}
248
896
  */
@@ -252,8 +900,8 @@ export declare class BoostCore extends Deployable<[
252
900
  *
253
901
  * @public
254
902
  * @async
255
- * @param {?ReadParams<typeof boostCoreAbi, 'createBoostAuth'>} [params]
256
- * @returns {unknown}
903
+ * @param {?ReadParams} [params]
904
+ * @returns {Promise<Address>}
257
905
  */
258
906
  createBoostAuth(params?: ReadParams<typeof boostCoreAbi, 'createBoostAuth'>): Promise<`0x${string}`>;
259
907
  /**
@@ -262,8 +910,8 @@ export declare class BoostCore extends Deployable<[
262
910
  * @public
263
911
  * @async
264
912
  * @param {Auth} auth
265
- * @param {?WriteParams<typeof boostCoreAbi, 'setCreateBoostAuth'>} [params]
266
- * @returns {unknown}
913
+ * @param {?WriteParams} [params]
914
+ * @returns {Promise<void>}
267
915
  */
268
916
  setCreateBoostAuth(auth: Auth, params?: WriteParams<typeof boostCoreAbi, 'setCreateBoostAuth'>): Promise<void>;
269
917
  /**
@@ -272,8 +920,8 @@ export declare class BoostCore extends Deployable<[
272
920
  * @public
273
921
  * @async
274
922
  * @param {Address} address
275
- * @param {?WriteParams<typeof boostCoreAbi, 'setCreateBoostAuth'>} [params]
276
- * @returns {unknown}
923
+ * @param {?WriteParams} [params]
924
+ * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
277
925
  */
278
926
  setCreateBoostAuthRaw(address: Address, params?: WriteParams<typeof boostCoreAbi, 'setCreateBoostAuth'>): Promise<{
279
927
  hash: `0x${string}`;
@@ -284,7 +932,7 @@ export declare class BoostCore extends Deployable<[
284
932
  *
285
933
  * @public
286
934
  * @async
287
- * @param {?ReadParams<typeof boostCoreAbi, 'protocolFee'>} [params]
935
+ * @param {?ReadParams} [params]
288
936
  * @returns {unknown}
289
937
  */
290
938
  protocolFee(params?: ReadParams<typeof boostCoreAbi, 'protocolFee'>): Promise<bigint>;
@@ -293,8 +941,8 @@ export declare class BoostCore extends Deployable<[
293
941
  *
294
942
  * @public
295
943
  * @async
296
- * @param {?ReadParams<typeof boostCoreAbi, 'protocolFeeReceiver'>} [params]
297
- * @returns {unknown}
944
+ * @param {?ReadParams} [params]
945
+ * @returns {Promise<Address>}
298
946
  */
299
947
  protocolFeeReceiver(params?: ReadParams<typeof boostCoreAbi, 'protocolFeeReceiver'>): Promise<`0x${string}`>;
300
948
  /**
@@ -303,8 +951,8 @@ export declare class BoostCore extends Deployable<[
303
951
  * @public
304
952
  * @async
305
953
  * @param {Address} address
306
- * @param {?WriteParams<typeof boostCoreAbi, 'setProtocolFeeReceiver'>} [params]
307
- * @returns {unknown}
954
+ * @param {?WriteParams} [params]
955
+ * @returns {Promise<void>}
308
956
  */
309
957
  setProcolFeeReceiver(address: Address, params?: WriteParams<typeof boostCoreAbi, 'setProtocolFeeReceiver'>): Promise<void>;
310
958
  /**
@@ -313,45 +961,43 @@ export declare class BoostCore extends Deployable<[
313
961
  * @public
314
962
  * @async
315
963
  * @param {Address} address
316
- * @param {?WriteParams<typeof boostCoreAbi, 'setProtocolFeeReceiver'>} [params]
317
- * @returns {unknown}
964
+ * @param {?WriteParams} [params]
965
+ * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
318
966
  */
319
967
  setProcolFeeReceiverRaw(address: Address, params?: WriteParams<typeof boostCoreAbi, 'setProtocolFeeReceiver'>): Promise<{
320
968
  hash: `0x${string}`;
321
969
  result: void;
322
970
  }>;
323
971
  /**
324
- * Get the claim fee.
972
+ * Retrieves the claim information from a transaction receipt.
325
973
  *
326
- * @public
327
- * @async
328
- * @param {?ReadParams<typeof boostCoreAbi, 'claimFee'>} [params]
329
- * @returns {unknown}
330
- */
331
- claimFee(params?: ReadParams<typeof boostCoreAbi, 'claimFee'>): Promise<bigint>;
332
- /**
333
- * Sets the claim fee.
974
+ * @param {GetTransactionReceiptParameters} params - The parameters required to get the transaction receipt.
975
+ * @returns {Promise<{ boostId: bigint, incentiveId: bigint, claimer: Address, amount: bigint } | undefined>} The claim information if found, undefined otherwise.
334
976
  *
335
- * @public
336
- * @async
337
- * @param {bigint} claimFee
338
- * @param {?WriteParams<typeof boostCoreAbi, 'setClaimFee'>} [params]
339
- * @returns {unknown}
340
- */
341
- setClaimFee(claimFee: bigint, params?: WriteParams<typeof boostCoreAbi, 'setClaimFee'>): Promise<void>;
342
- /**
343
- * Sets the claim fee.
977
+ * @description
978
+ * This method retrieves the transaction receipt using the provided parameters,
979
+ * then parses the logs to find the 'BoostClaimed' event.
980
+ * If found, it returns the arguments of the event, which include the boost ID,
981
+ * incentive ID, claimer address, and claimed amount.
344
982
  *
345
- * @public
346
- * @async
347
- * @param {bigint} claimFee
348
- * @param {?WriteParams<typeof boostCoreAbi, 'setClaimFee'>} [params]
349
- * @returns {unknown}
983
+ * @example
984
+ * ```ts
985
+ * const claimInfo = await boostCore.getClaimFromTransaction({
986
+ * hash: '0x...',
987
+ * chainId: 1
988
+ * });
989
+ * if (claimInfo) {
990
+ * console.log(`Boost ${claimInfo.boostId} claimed by ${claimInfo.claimer}`);
991
+ * }
992
+ * ```
350
993
  */
351
- setClaimFeeRaw(claimFee: bigint, params?: WriteParams<typeof boostCoreAbi, 'setClaimFee'>): Promise<{
352
- hash: `0x${string}`;
353
- result: void;
354
- }>;
994
+ getClaimFromTransaction(params: GetTransactionReceiptParameters): Promise<{
995
+ boostId: bigint;
996
+ incentiveId: bigint;
997
+ claimant: `0x${string}`;
998
+ referrer: `0x${string}`;
999
+ data: `0x${string}`;
1000
+ } | undefined>;
355
1001
  /**
356
1002
  * Bound {@link PassthroughAuth} constructor that reuses the same configuration as the Boost Core instance.
357
1003
  *
@@ -373,6 +1019,18 @@ export declare class BoostCore extends Deployable<[
373
1019
  * const action = new EventAction({ config: core._config, account: core._account }, '0x')
374
1020
  */
375
1021
  EventAction(options: DeployablePayloadOrAddress<EventActionPayload>, isBase?: boolean): EventAction;
1022
+ /**
1023
+ * Bound {@link OpenAllowList} constructor that reuses the same configuration as the Boost Core instance.
1024
+ *
1025
+ * @example
1026
+ * ```ts
1027
+ * const list = core.OpenAllowList('0x') // is roughly equivalent to
1028
+ * const list = new OpenAllowList({ config: core._config, account: core._account }, '0x')
1029
+ * ```
1030
+ * @param {?boolean} [isBase]
1031
+ * @returns {OpenAllowList}
1032
+ */
1033
+ OpenAllowList(isBase?: boolean): OpenAllowList;
376
1034
  /**
377
1035
  * Bound {@link SimpleAllowList} constructor that reuses the same configuration as the Boost Core instance.
378
1036
  *
@@ -398,7 +1056,7 @@ export declare class BoostCore extends Deployable<[
398
1056
  * @param {?boolean} [isBase]
399
1057
  * @returns {SimpleDenyList}
400
1058
  */
401
- SimpleDenyList(options: DeployablePayloadOrAddress<SimpleDenyListPayload>, isBase?: boolean): SimpleDenyList;
1059
+ SimpleDenyList(options: DeployablePayloadOrAddress<SimpleDenyListPayload>, isBase?: boolean): SimpleDenyList<SimpleDenyListPayload>;
402
1060
  /**
403
1061
  * Bound {@link ManagedBudget} constructor that reuses the same configuration as the Boost Core instance.
404
1062
  *
@@ -472,6 +1130,19 @@ export declare class BoostCore extends Deployable<[
472
1130
  * @returns {SignerValidator}
473
1131
  */
474
1132
  SignerValidator(options: DeployablePayloadOrAddress<SignerValidatorPayload>, isBase?: boolean): SignerValidator;
1133
+ /**
1134
+ * Bound {@link ERC20VariableCriteriaIncentive} constructor that reuses the same configuration as the Boost Core instance.
1135
+ *
1136
+ * @example
1137
+ * ```ts
1138
+ * const validator = core.ERC20VariableCrtieriaIncentive({ ... }) // is roughly equivalent to
1139
+ * const validator = new ERC20VariableCrtieriaIncentive({ config: core._config, account: core._account }, { ... })
1140
+ * ```
1141
+ * @param {DeployablePayloadOrAddress<ERC20VariableCrtieriaIncentivePayload>} options
1142
+ * @param {?boolean} [isBase]
1143
+ * @returns {ERC20VariableCrtieriaIncentive}
1144
+ * */
1145
+ ERC20VariableCriteriaIncentive(options: DeployablePayloadOrAddress<ERC20VariableCriteriaIncentivePayload>, isBase?: boolean): ERC20VariableCriteriaIncentive;
475
1146
  /**
476
1147
  * Bound {@link ERC20VariableIncentive} constructor that reuses the same configuration as the Boost Core instance.
477
1148
  *