@boostxyz/sdk 0.0.0-alpha.17 → 0.0.0-alpha.19

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 (205) 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 +13 -13
  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 -962
  13. package/dist/Actions/EventAction.js.map +1 -1
  14. package/dist/AllowLists/AllowList.cjs +1 -1
  15. package/dist/AllowLists/AllowList.js +3 -3
  16. package/dist/AllowLists/SimpleAllowList.cjs +1 -1
  17. package/dist/AllowLists/SimpleAllowList.cjs.map +1 -1
  18. package/dist/AllowLists/SimpleAllowList.d.ts +5 -5
  19. package/dist/AllowLists/SimpleAllowList.js +24 -24
  20. package/dist/AllowLists/SimpleAllowList.js.map +1 -1
  21. package/dist/AllowLists/SimpleDenyList.cjs +1 -1
  22. package/dist/AllowLists/SimpleDenyList.d.ts +6 -6
  23. package/dist/AllowLists/SimpleDenyList.js +3 -3
  24. package/dist/Auth/PassthroughAuth.cjs +1 -1
  25. package/dist/Auth/PassthroughAuth.js +1 -1
  26. package/dist/Boost.cjs.map +1 -1
  27. package/dist/Boost.d.ts +18 -0
  28. package/dist/Boost.d.ts.map +1 -1
  29. package/dist/Boost.js.map +1 -1
  30. package/dist/BoostCore-BiPwp6SR.cjs +3 -0
  31. package/dist/BoostCore-BiPwp6SR.cjs.map +1 -0
  32. package/dist/BoostCore-kwoUw7YE.js +1477 -0
  33. package/dist/BoostCore-kwoUw7YE.js.map +1 -0
  34. package/dist/BoostCore.cjs +1 -2
  35. package/dist/BoostCore.cjs.map +1 -1
  36. package/dist/BoostCore.d.ts +86 -36
  37. package/dist/BoostCore.d.ts.map +1 -1
  38. package/dist/BoostCore.js +29 -1273
  39. package/dist/BoostCore.js.map +1 -1
  40. package/dist/BoostRegistry.cjs +1 -1
  41. package/dist/BoostRegistry.cjs.map +1 -1
  42. package/dist/BoostRegistry.d.ts +25 -19
  43. package/dist/BoostRegistry.d.ts.map +1 -1
  44. package/dist/BoostRegistry.js +30 -29
  45. package/dist/BoostRegistry.js.map +1 -1
  46. package/dist/Budgets/Budget.cjs +1 -1
  47. package/dist/Budgets/Budget.js +2 -2
  48. package/dist/Budgets/ManagedBudget.cjs +1 -1
  49. package/dist/Budgets/ManagedBudget.cjs.map +1 -1
  50. package/dist/Budgets/ManagedBudget.d.ts +18 -18
  51. package/dist/Budgets/ManagedBudget.js +48 -48
  52. package/dist/Budgets/ManagedBudget.js.map +1 -1
  53. package/dist/Budgets/VestingBudget.d.ts +23 -23
  54. package/dist/Deployable/Contract.cjs +1 -1
  55. package/dist/Deployable/Contract.cjs.map +1 -1
  56. package/dist/Deployable/Contract.d.ts +4 -5
  57. package/dist/Deployable/Contract.d.ts.map +1 -1
  58. package/dist/Deployable/Contract.js +4 -5
  59. package/dist/Deployable/Contract.js.map +1 -1
  60. package/dist/Deployable/Deployable.cjs.map +1 -1
  61. package/dist/Deployable/Deployable.d.ts +1 -1
  62. package/dist/Deployable/Deployable.js +1 -1
  63. package/dist/Deployable/Deployable.js.map +1 -1
  64. package/dist/Deployable/DeployableTarget.cjs +1 -1
  65. package/dist/Deployable/DeployableTarget.cjs.map +1 -1
  66. package/dist/Deployable/DeployableTarget.d.ts +5 -5
  67. package/dist/Deployable/DeployableTarget.js +6 -6
  68. package/dist/Deployable/DeployableTarget.js.map +1 -1
  69. package/dist/Deployable/DeployableTargetWithRBAC.cjs +1 -1
  70. package/dist/Deployable/DeployableTargetWithRBAC.cjs.map +1 -1
  71. package/dist/Deployable/DeployableTargetWithRBAC.d.ts +15 -15
  72. package/dist/Deployable/DeployableTargetWithRBAC.js +33 -33
  73. package/dist/Deployable/DeployableTargetWithRBAC.js.map +1 -1
  74. package/dist/EventAction-D5tnm00s.js +1355 -0
  75. package/dist/EventAction-D5tnm00s.js.map +1 -0
  76. package/dist/EventAction-DBDRaG4A.cjs +2 -0
  77. package/dist/EventAction-DBDRaG4A.cjs.map +1 -0
  78. package/dist/{Incentive-DJf-vdyL.js → Incentive-Bp8Sez7M.js} +61 -62
  79. package/dist/Incentive-Bp8Sez7M.js.map +1 -0
  80. package/dist/{Incentive-DNwROd1r.cjs → Incentive-Djnzseoj.cjs} +2 -2
  81. package/dist/Incentive-Djnzseoj.cjs.map +1 -0
  82. package/dist/Incentives/AllowListIncentive.cjs +1 -1
  83. package/dist/Incentives/AllowListIncentive.cjs.map +1 -1
  84. package/dist/Incentives/AllowListIncentive.d.ts +12 -12
  85. package/dist/Incentives/AllowListIncentive.js +19 -19
  86. package/dist/Incentives/AllowListIncentive.js.map +1 -1
  87. package/dist/Incentives/CGDAIncentive.cjs +1 -1
  88. package/dist/Incentives/CGDAIncentive.cjs.map +1 -1
  89. package/dist/Incentives/CGDAIncentive.d.ts +15 -15
  90. package/dist/Incentives/CGDAIncentive.js +18 -18
  91. package/dist/Incentives/CGDAIncentive.js.map +1 -1
  92. package/dist/Incentives/ERC1155Incentive.d.ts +30 -30
  93. package/dist/Incentives/ERC20Incentive.cjs +1 -1
  94. package/dist/Incentives/ERC20Incentive.cjs.map +1 -1
  95. package/dist/Incentives/ERC20Incentive.d.ts +23 -23
  96. package/dist/Incentives/ERC20Incentive.js +25 -25
  97. package/dist/Incentives/ERC20Incentive.js.map +1 -1
  98. package/dist/Incentives/ERC20VariableCriteriaIncentive.d.ts +523 -0
  99. package/dist/Incentives/ERC20VariableCriteriaIncentive.d.ts.map +1 -0
  100. package/dist/Incentives/ERC20VariableIncentive.d.ts +19 -19
  101. package/dist/Incentives/Incentive.cjs +1 -1
  102. package/dist/Incentives/Incentive.d.ts +3 -3
  103. package/dist/Incentives/Incentive.d.ts.map +1 -1
  104. package/dist/Incentives/Incentive.js +3 -3
  105. package/dist/Incentives/PointsIncentive.cjs +1 -1
  106. package/dist/Incentives/PointsIncentive.cjs.map +1 -1
  107. package/dist/Incentives/PointsIncentive.d.ts +14 -14
  108. package/dist/Incentives/PointsIncentive.js +21 -21
  109. package/dist/Incentives/PointsIncentive.js.map +1 -1
  110. package/dist/{SimpleDenyList-DMlUkmAn.cjs → SimpleDenyList-BwfNjRsg.cjs} +2 -2
  111. package/dist/SimpleDenyList-BwfNjRsg.cjs.map +1 -0
  112. package/dist/{SimpleDenyList-DvUvmOeE.js → SimpleDenyList-Cn5WpNn0.js} +9 -9
  113. package/dist/SimpleDenyList-Cn5WpNn0.js.map +1 -0
  114. package/dist/Validators/SignerValidator.cjs +1 -1
  115. package/dist/Validators/SignerValidator.cjs.map +1 -1
  116. package/dist/Validators/SignerValidator.d.ts +14 -14
  117. package/dist/Validators/SignerValidator.js +19 -19
  118. package/dist/Validators/SignerValidator.js.map +1 -1
  119. package/dist/Validators/Validator.cjs +1 -1
  120. package/dist/Validators/Validator.cjs.map +1 -1
  121. package/dist/Validators/Validator.d.ts +1 -1
  122. package/dist/Validators/Validator.js +6 -6
  123. package/dist/Validators/Validator.js.map +1 -1
  124. package/dist/claiming.cjs.map +1 -1
  125. package/dist/claiming.d.ts +1 -1
  126. package/dist/claiming.js.map +1 -1
  127. package/dist/componentInterfaces-D09mhzxO.cjs +2 -0
  128. package/dist/componentInterfaces-D09mhzxO.cjs.map +1 -0
  129. package/dist/componentInterfaces-RXBMI5yH.js +14 -0
  130. package/dist/componentInterfaces-RXBMI5yH.js.map +1 -0
  131. package/dist/deployments-BM42vImE.js +43 -0
  132. package/dist/deployments-BM42vImE.js.map +1 -0
  133. package/dist/deployments-CMdF5uEC.cjs +2 -0
  134. package/dist/deployments-CMdF5uEC.cjs.map +1 -0
  135. package/dist/deployments.json +15 -12
  136. package/dist/errors.cjs +1 -1
  137. package/dist/errors.cjs.map +1 -1
  138. package/dist/errors.d.ts +132 -0
  139. package/dist/errors.d.ts.map +1 -1
  140. package/dist/errors.js +122 -36
  141. package/dist/errors.js.map +1 -1
  142. package/dist/generated-B0tk-c9b.cjs +3 -0
  143. package/dist/generated-B0tk-c9b.cjs.map +1 -0
  144. package/dist/{generated-C_7Jx3YG.js → generated-B7VaSah4.js} +631 -343
  145. package/dist/generated-B7VaSah4.js.map +1 -0
  146. package/dist/index.cjs +1 -1
  147. package/dist/index.d.ts +1 -0
  148. package/dist/index.d.ts.map +1 -1
  149. package/dist/index.js +135 -126
  150. package/dist/transfers.cjs.map +1 -1
  151. package/dist/transfers.d.ts +1 -1
  152. package/dist/transfers.js.map +1 -1
  153. package/dist/utils.cjs.map +1 -1
  154. package/dist/utils.d.ts +1 -1
  155. package/dist/utils.js.map +1 -1
  156. package/package.json +5 -5
  157. package/src/Actions/ContractAction.ts +9 -10
  158. package/src/Actions/ERC721MintAction.ts +12 -13
  159. package/src/Actions/EventAction.test.ts +45 -54
  160. package/src/Actions/EventAction.ts +100 -100
  161. package/src/AllowLists/SimpleAllowList.ts +5 -5
  162. package/src/AllowLists/SimpleDenyList.ts +6 -6
  163. package/src/Boost.ts +19 -0
  164. package/src/BoostCore.test.ts +117 -1
  165. package/src/BoostCore.ts +121 -57
  166. package/src/BoostRegistry.ts +29 -21
  167. package/src/Budgets/ManagedBudget.ts +18 -18
  168. package/src/Budgets/VestingBudget.ts +23 -23
  169. package/src/Deployable/Contract.ts +4 -5
  170. package/src/Deployable/Deployable.ts +1 -1
  171. package/src/Deployable/DeployableTarget.ts +5 -5
  172. package/src/Deployable/DeployableTargetWithRBAC.ts +15 -15
  173. package/src/Incentives/AllowListIncentive.ts +12 -12
  174. package/src/Incentives/CGDAIncentive.ts +15 -15
  175. package/src/Incentives/ERC1155Incentive.ts +26 -26
  176. package/src/Incentives/ERC20Incentive.ts +23 -23
  177. package/src/Incentives/ERC20VariableCriteriaIncentive.test.ts +184 -0
  178. package/src/Incentives/ERC20VariableCriteriaIncentive.ts +309 -0
  179. package/src/Incentives/ERC20VariableIncentive.ts +19 -19
  180. package/src/Incentives/Incentive.ts +6 -5
  181. package/src/Incentives/PointsIncentive.test.ts +21 -21
  182. package/src/Incentives/PointsIncentive.ts +14 -14
  183. package/src/Validators/SignerValidator.ts +14 -14
  184. package/src/Validators/Validator.ts +1 -1
  185. package/src/claiming.ts +1 -1
  186. package/src/errors.ts +165 -0
  187. package/src/index.test.ts +117 -33
  188. package/src/index.ts +1 -0
  189. package/src/transfers.ts +1 -1
  190. package/src/utils.ts +1 -1
  191. package/dist/Incentive-DJf-vdyL.js.map +0 -1
  192. package/dist/Incentive-DNwROd1r.cjs.map +0 -1
  193. package/dist/SimpleDenyList-DMlUkmAn.cjs.map +0 -1
  194. package/dist/SimpleDenyList-DvUvmOeE.js.map +0 -1
  195. package/dist/componentInterfaces-BPVR_Ykd.js +0 -13
  196. package/dist/componentInterfaces-BPVR_Ykd.js.map +0 -1
  197. package/dist/componentInterfaces-BfppSIl4.cjs +0 -2
  198. package/dist/componentInterfaces-BfppSIl4.cjs.map +0 -1
  199. package/dist/deployments-BvFcK_eR.js +0 -40
  200. package/dist/deployments-BvFcK_eR.js.map +0 -1
  201. package/dist/deployments-Ho4PnGCS.cjs +0 -2
  202. package/dist/deployments-Ho4PnGCS.cjs.map +0 -1
  203. package/dist/generated-CMQ6ZC2_.cjs +0 -3
  204. package/dist/generated-CMQ6ZC2_.cjs.map +0 -1
  205. package/dist/generated-C_7Jx3YG.js.map +0 -1
@@ -143,7 +143,7 @@ export class VestingBudget extends DeployableTargetWithRBAC<
143
143
  * Get the owner of the budget
144
144
  *
145
145
  * @public
146
- * @param {?ReadParams<typeof vestingBudgetAbi, 'owner'>} [params]
146
+ * @param {?ReadParams} [params]
147
147
  * @returns {Promise<Address>}
148
148
  */
149
149
  public owner(params?: ReadParams<typeof vestingBudgetAbi, 'owner'>) {
@@ -159,8 +159,8 @@ export class VestingBudget extends DeployableTargetWithRBAC<
159
159
  * The timestamp at which the vesting schedule begins
160
160
  *
161
161
  * @public
162
- * @param {?ReadParams<typeof vestingBudgetAbi, 'start'>} [params]
163
- * @returns {*}
162
+ * @param {?ReadParams} [params]
163
+ * @returns {Promise<bigint>}
164
164
  */
165
165
  public start(params?: ReadParams<typeof vestingBudgetAbi, 'start'>) {
166
166
  return readVestingBudgetStart(this._config, {
@@ -175,8 +175,8 @@ export class VestingBudget extends DeployableTargetWithRBAC<
175
175
  * The duration of the vesting schedule (in seconds)
176
176
  *
177
177
  * @public
178
- * @param {?ReadParams<typeof vestingBudgetAbi, 'duration'>} [params]
179
- * @returns {*}
178
+ * @param {?ReadParams} [params]
179
+ * @returns {Promise<bigint>}
180
180
  */
181
181
  public duration(params?: ReadParams<typeof vestingBudgetAbi, 'duration'>) {
182
182
  return readVestingBudgetDuration(this._config, {
@@ -191,8 +191,8 @@ export class VestingBudget extends DeployableTargetWithRBAC<
191
191
  * The duration of the cliff period (in seconds)
192
192
  *
193
193
  * @public
194
- * @param {?ReadParams<typeof vestingBudgetAbi, 'cliff'>} [params]
195
- * @returns {*}
194
+ * @param {?ReadParams} [params]
195
+ * @returns {Promise<bigint>}
196
196
  */
197
197
  public cliff(params?: ReadParams<typeof vestingBudgetAbi, 'cliff'>) {
198
198
  return readVestingBudgetCliff(this._config, {
@@ -211,7 +211,7 @@ export class VestingBudget extends DeployableTargetWithRBAC<
211
211
  * @public
212
212
  * @async
213
213
  * @param {(FungibleTransferPayload)} transfer
214
- * @param {?WriteParams<typeof vestingBudgetAbi, 'allocate'>} [params]
214
+ * @param {?WriteParams} [params]
215
215
  * @returns {Promise<boolean>} - True if the allocation was successful
216
216
  */
217
217
  public async allocate(
@@ -229,8 +229,8 @@ export class VestingBudget extends DeployableTargetWithRBAC<
229
229
  * @public
230
230
  * @async
231
231
  * @param {(FungibleTransferPayload)} transfer
232
- * @param {?WriteParams<typeof vestingBudgetAbi, 'allocate'>} [params]
233
- * @returns {Promise<boolean>} - True if the allocation was successful
232
+ * @param {?WriteParams} [params]
233
+ * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if the allocation was successful
234
234
  */
235
235
  public async allocateRaw(
236
236
  transfer: FungibleTransferPayload,
@@ -259,7 +259,7 @@ export class VestingBudget extends DeployableTargetWithRBAC<
259
259
  * @public
260
260
  * @async
261
261
  * @param {(FungibleTransferPayload)} transfer
262
- * @param {?WriteParams<typeof vestingBudgetAbi, 'clawback'>} [params]
262
+ * @param {?WriteParams} [params]
263
263
  * @returns {Promise<boolean>} - True if the request was successful
264
264
  */
265
265
  public async clawback(
@@ -278,8 +278,8 @@ export class VestingBudget extends DeployableTargetWithRBAC<
278
278
  * @public
279
279
  * @async
280
280
  * @param {(FungibleTransferPayload)} transfer
281
- * @param {?WriteParams<typeof vestingBudgetAbi, 'clawback'>} [params]
282
- * @returns {Promise<boolean>} - True if the request was successful
281
+ * @param {?WriteParams} [params]
282
+ * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if the request was successful
283
283
  */
284
284
  public async clawbackRaw(
285
285
  transfer: FungibleTransferPayload,
@@ -306,7 +306,7 @@ export class VestingBudget extends DeployableTargetWithRBAC<
306
306
  * @public
307
307
  * @async
308
308
  * @param {(FungibleTransferPayload)} transfer
309
- * @param {?WriteParams<typeof vestingBudgetAbi, 'disburse'>} [params]
309
+ * @param {?WriteParams} [params]
310
310
  * @returns {Promise<boolean>} - True if the disbursement was successful
311
311
  */
312
312
  public async disburse(
@@ -323,8 +323,8 @@ export class VestingBudget extends DeployableTargetWithRBAC<
323
323
  * @public
324
324
  * @async
325
325
  * @param {(FungibleTransferPayload)} transfer
326
- * @param {?WriteParams<typeof vestingBudgetAbi, 'disburse'>} [params]
327
- * @returns {Promise<boolean>} - True if the disbursement was successful
326
+ * @param {?WriteParams} [params]
327
+ * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if the disbursement was successful
328
328
  */
329
329
  public async disburseRaw(
330
330
  transfer: FungibleTransferPayload,
@@ -350,7 +350,7 @@ export class VestingBudget extends DeployableTargetWithRBAC<
350
350
  * @public
351
351
  * @async
352
352
  * @param {Array<FungibleTransferPayload>} transfers
353
- * @param {?WriteParams<typeof vestingBudgetAbi, 'disburseBatch'>} [params]
353
+ * @param {?WriteParams} [params]
354
354
  * @returns {Promise<boolean>} - True if all disbursements were successful
355
355
  */
356
356
  public async disburseBatch(
@@ -366,8 +366,8 @@ export class VestingBudget extends DeployableTargetWithRBAC<
366
366
  * @public
367
367
  * @async
368
368
  * @param {Array<FungibleTransferPayload>} transfers
369
- * @param {?WriteParams<typeof vestingBudgetAbi, 'disburseBatch'>} [params]
370
- * @returns {Promise<boolean>} - True if all disbursements were successful
369
+ * @param {?WriteParams} [params]
370
+ * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if all disbursements were successful
371
371
  */
372
372
  public async disburseBatchRaw(
373
373
  transfers: FungibleTransferPayload[],
@@ -391,7 +391,7 @@ export class VestingBudget extends DeployableTargetWithRBAC<
391
391
  * Get the end time of the vesting schedule
392
392
  *
393
393
  * @public
394
- * @param {?ReadParams<typeof vestingBudgetAbi, 'end'>} [params]
394
+ * @param {?ReadParams} [params]
395
395
  * @returns {Promise<bigint>}
396
396
  */
397
397
  public end(params?: ReadParams<typeof vestingBudgetAbi, 'end'>) {
@@ -409,7 +409,7 @@ export class VestingBudget extends DeployableTargetWithRBAC<
409
409
  *
410
410
  * @public
411
411
  * @param {Address} [asset="0x0000000000000000000000000000000000000000"] - The address of the asset (or the zero address for native assets)
412
- * @param {?ReadParams<typeof vestingBudgetAbi, 'total'>} [params]
412
+ * @param {?ReadParams} [params]
413
413
  * @returns {Promise<bigint>}
414
414
  */
415
415
  public total(
@@ -430,7 +430,7 @@ export class VestingBudget extends DeployableTargetWithRBAC<
430
430
  *
431
431
  * @public
432
432
  * @param {Address} [asset="0x0000000000000000000000000000000000000000"] - The address of the asset (or the zero address for native assets)
433
- * @param {?ReadParams<typeof vestingBudgetAbi, 'available'>} [params]
433
+ * @param {?ReadParams} [params]
434
434
  * @returns {Promise<bigint>} - The amount of assets currently available for distribution
435
435
  */
436
436
  public available(
@@ -450,7 +450,7 @@ export class VestingBudget extends DeployableTargetWithRBAC<
450
450
  *
451
451
  * @public
452
452
  * @param {Address} [asset="0x0000000000000000000000000000000000000000"]
453
- * @param {?ReadParams<typeof vestingBudgetAbi, 'distributed'>} [params]
453
+ * @param {?ReadParams} [params]
454
454
  * @returns {Promise<bigint>} - The amount of assets distributed
455
455
  */
456
456
  public distributed(
@@ -61,7 +61,7 @@ export class Contract<ContractAbi extends Abi> {
61
61
  *
62
62
  * @public
63
63
  * @readonly
64
- * @type {*}
64
+ * @type {Address | undefined}
65
65
  */
66
66
  public get address() {
67
67
  return this._address;
@@ -174,7 +174,6 @@ export class Contract<ContractAbi extends Abi> {
174
174
  * A typed wrapper for `wagmi.watchContractEvent`
175
175
  *
176
176
  * @public
177
- * @async
178
177
  * @template {ContractEvent} event
179
178
  * @param {(
180
179
  * log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number],
@@ -182,9 +181,9 @@ export class Contract<ContractAbi extends Abi> {
182
181
  * @param {?WatchParams<ContractAbi, event> & {
183
182
  * eventName?: event;
184
183
  * }} [params]
185
- * @returns {unknown, params?: any) => unknown}
184
+ * @returns {() => void}
186
185
  */
187
- public async subscribe<event extends ContractEventName<ContractAbi>>(
186
+ public subscribe<event extends ContractEventName<ContractAbi>>(
188
187
  cb: (
189
188
  log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number],
190
189
  ) => unknown,
@@ -218,7 +217,7 @@ export class Contract<ContractAbi extends Abi> {
218
217
  * @template [Result=unknown]
219
218
  * @param {Promise<HashAndSimulatedResult<Result>>} hashPromise
220
219
  * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]
221
- * @returns {unknown}
220
+ * @returns {Promise<Result>}
222
221
  */
223
222
  protected async awaitResult<Result = unknown>(
224
223
  hashPromise: Promise<HashAndSimulatedResult<Result>>,
@@ -149,7 +149,7 @@ export class Deployable<
149
149
  * @param {?Payload} [_payload]
150
150
  * @param {?DeployableOptions} [_options]
151
151
  * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams] - See [viem.WaitForTransactionReceipt](https://v1.viem.sh/docs/actions/public/waitForTransactionReceipt.html#waitfortransactionreceipt)
152
- * @returns {unknown}
152
+ * @returns {Promise<this>}
153
153
  */
154
154
  protected async deploy(
155
155
  _payload?: Payload,
@@ -131,7 +131,7 @@ export class DeployableTarget<
131
131
  * @param {?Payload} [payload]
132
132
  * @param {?DeployableOptions} [options]
133
133
  * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]
134
- * @returns {unknown}
134
+ * @returns {Promise<this>}
135
135
  */
136
136
  protected override async deploy(
137
137
  payload?: Payload,
@@ -174,8 +174,8 @@ export class DeployableTarget<
174
174
  * @public
175
175
  * @async
176
176
  * @param {Hex} interfaceId - The interface identifier
177
- * @param {?ReadParams<typeof contractActionAbi, 'supportsInterface'>} [params]
178
- * @returns {unknown} - True if the contract supports the interface
177
+ * @param {?ReadParams} [params]
178
+ * @returns {Promise<boolean>} - True if the contract supports the interface
179
179
  */
180
180
  public async supportsInterface(
181
181
  interfaceId: Hex,
@@ -196,8 +196,8 @@ export class DeployableTarget<
196
196
  *
197
197
  * @public
198
198
  * @async
199
- * @param {?ReadParams<typeof contractActionAbi, 'getComponentInterface'>} [params]
200
- * @returns {unknown}
199
+ * @param {?ReadParams} [params]
200
+ * @returns {Promise<Hex>}
201
201
  */
202
202
  public async getComponentInterface(
203
203
  params?: ReadParams<typeof aCloneableAbi, 'getComponentInterface'>,
@@ -68,7 +68,7 @@ export class DeployableTargetWithRBAC<
68
68
  * @async
69
69
  * @param {Address[]} addresses - The accounts to authorize or deauthorize
70
70
  * @param {boolean[]} allowed - The authorization status for the given accounts
71
- * @param {?WriteParams<typeof rbacAbi, 'setAuthorized'>} [params]
71
+ * @param {?WriteParams} [params]
72
72
  * @returns {Promise<void>}
73
73
  */
74
74
  public async setAuthorized(
@@ -89,7 +89,7 @@ export class DeployableTargetWithRBAC<
89
89
  * @async
90
90
  * @param {Address[]} addresses - The accounts to authorize or deauthorize
91
91
  * @param {boolean[]} allowed - The authorization status for the given accounts
92
- * @param {?WriteParams<typeof rbacAbi, 'setAuthorized'>} [params]
92
+ * @param {?WriteParams} [params]
93
93
  * @returns {Promise<void>}
94
94
  */
95
95
  public async setAuthorizedRaw(
@@ -119,8 +119,8 @@ export class DeployableTargetWithRBAC<
119
119
  * @async
120
120
  * @param {Address[]} addresses
121
121
  * @param {RbacRoles[]} roles
122
- * @param {?WriteParams<typeof rbacAbi, 'grantRoles'>} [params]
123
- * @returns {unknown}
122
+ * @param {?WriteParams} [params]
123
+ * @returns {Promise<void>}
124
124
  */
125
125
  public async grantRoles(
126
126
  addresses: Address[],
@@ -141,8 +141,8 @@ export class DeployableTargetWithRBAC<
141
141
  * @async
142
142
  * @param {Address[]} addresses
143
143
  * @param {RbacRoles[]} roles
144
- * @param {?WriteParams<typeof rbacAbi, 'grantRoles'>} [params]
145
- * @returns {unknown}
144
+ * @param {?WriteParams} [params]
145
+ * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
146
146
  */
147
147
  public async grantRolesRaw(
148
148
  addresses: Address[],
@@ -175,8 +175,8 @@ export class DeployableTargetWithRBAC<
175
175
  * @async
176
176
  * @param {Address[]} addresses
177
177
  * @param {RbacRoles[]} roles
178
- * @param {?WriteParams<typeof rbacAbi, 'revokeRoles'>} [params]
179
- * @returns {unknown}
178
+ * @param {?WriteParams} [params]
179
+ * @returns {Promise<void>}
180
180
  */
181
181
  public async revokeRoles(
182
182
  addresses: Address[],
@@ -198,8 +198,8 @@ export class DeployableTargetWithRBAC<
198
198
  * @async
199
199
  * @param {Address[]} addresses
200
200
  * @param {RbacRoles[]} roles
201
- * @param {?WriteParams<typeof rbacAbi, 'revokeRoles'>} [params]
202
- * @returns {unknown}
201
+ * @param {?WriteParams} [params]
202
+ * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
203
203
  */
204
204
  public async revokeRolesRaw(
205
205
  addresses: Address[],
@@ -228,7 +228,7 @@ export class DeployableTargetWithRBAC<
228
228
  * (await rbac.rolesOf(0xfoo)).includes(RbacRoles.ADMIN)
229
229
  * @public
230
230
  * @param {Address} account
231
- * @param {?ReadParams<typeof rbacAbi, 'rolesOf'>} [params]
231
+ * @param {?ReadParams} [params]
232
232
  * @returns {Promise<Array<RbacRoles>>}
233
233
  */
234
234
  public async rolesOf(
@@ -256,7 +256,7 @@ export class DeployableTargetWithRBAC<
256
256
  * @public
257
257
  * @param {Address} account
258
258
  * @param {RbacRoles} roles
259
- * @param {?ReadParams<typeof rbacAbi, 'hasAnyRole'>} [params]
259
+ * @param {?ReadParams} [params]
260
260
  * @returns {Promise<boolean>}
261
261
  */
262
262
  public hasAnyRole(
@@ -283,8 +283,8 @@ export class DeployableTargetWithRBAC<
283
283
  * @public
284
284
  * @param {Address} account
285
285
  * @param {RbacRoles} roles
286
- * @param {?ReadParams<typeof rbacAbi, 'hasAllRoles'>} [params]
287
- * @returns {*}
286
+ * @param {?ReadParams} [params]
287
+ * @returns {Promise<boolean>}
288
288
  */
289
289
  public hasAllRoles(
290
290
  account: Address,
@@ -305,7 +305,7 @@ export class DeployableTargetWithRBAC<
305
305
  *
306
306
  * @public
307
307
  * @param {Address} account
308
- * @param {?ReadParams<typeof rbacAbi, 'isAuthorized'>} [params]
308
+ * @param {?ReadParams} [params]
309
309
  * @returns {Promise<boolean>} - True if the account is authorized
310
310
  */
311
311
  public isAuthorized(
@@ -112,8 +112,8 @@ export class AllowListIncentive extends DeployableTarget<
112
112
  *
113
113
  * @public
114
114
  * @async
115
- * @param {?ReadParams<typeof allowListIncentiveAbi, 'owner'>} [params]
116
- * @returns {unknown}
115
+ * @param {?ReadParams} [params]
116
+ * @returns {Promise<Address>}
117
117
  */
118
118
  public async owner(
119
119
  params?: ReadParams<typeof allowListIncentiveAbi, 'owner'>,
@@ -131,7 +131,7 @@ export class AllowListIncentive extends DeployableTarget<
131
131
  *
132
132
  * @public
133
133
  * @async
134
- * @param {?ReadParams<typeof allowListIncentiveAbi, 'claims'>} [params]
134
+ * @param {?ReadParams} [params]
135
135
  * @returns {Promise<bigint>}
136
136
  */
137
137
  public async claims(
@@ -150,7 +150,7 @@ export class AllowListIncentive extends DeployableTarget<
150
150
  *
151
151
  * @public
152
152
  * @async
153
- * @param {?ReadParams<typeof allowListIncentiveAbi, 'reward'>} [params]
153
+ * @param {?ReadParams} [params]
154
154
  * @returns {Promise<bigint>}
155
155
  */
156
156
  public async reward(
@@ -170,7 +170,7 @@ export class AllowListIncentive extends DeployableTarget<
170
170
  * @public
171
171
  * @async
172
172
  * @param {Address} address
173
- * @param {?ReadParams<typeof allowListIncentiveAbi, 'claimed'>} [params]
173
+ * @param {?ReadParams} [params]
174
174
  * @returns {Promise<boolean>}
175
175
  */
176
176
  public async claimed(
@@ -190,7 +190,7 @@ export class AllowListIncentive extends DeployableTarget<
190
190
  *
191
191
  * @public
192
192
  * @async
193
- * @param {?ReadParams<typeof allowListIncentiveAbi, 'allowList'>} [params]
193
+ * @param {?ReadParams} [params]
194
194
  * @returns {Promise<SimpleAllowList>}
195
195
  */
196
196
  public async allowList(
@@ -212,8 +212,8 @@ export class AllowListIncentive extends DeployableTarget<
212
212
  *
213
213
  * @public
214
214
  * @async
215
- * @param {?ReadParams<typeof allowListIncentiveAbi, 'limit'>} [params]
216
- * @returns {unknown}
215
+ * @param {?ReadParams} [params]
216
+ * @returns {Promise<bigint>}
217
217
  */
218
218
  public async limit(
219
219
  params?: ReadParams<typeof allowListIncentiveAbi, 'limit'>,
@@ -231,7 +231,7 @@ export class AllowListIncentive extends DeployableTarget<
231
231
  * @public
232
232
  * @async
233
233
  * @param {Pick<ClaimPayload, 'target'>} payload
234
- * @param {?WriteParams<typeof allowListIncentiveAbi, 'claim'>} [params]
234
+ * @param {?WriteParams} [params]
235
235
  * @returns {Promise<true>} - return true if successful, otherwise revert
236
236
  */
237
237
  protected async claim(
@@ -247,8 +247,8 @@ export class AllowListIncentive extends DeployableTarget<
247
247
  * @public
248
248
  * @async
249
249
  * @param {Pick<ClaimPayload, 'target'>} payload
250
- * @param {?WriteParams<typeof allowListIncentiveAbi, 'claim'>} [params]
251
- * @returns {Promise<true>} - return true if successful, otherwise revert
250
+ * @param {?WriteParams} [params]
251
+ * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - return true if successful, otherwise revert
252
252
  */
253
253
  protected async claimRaw(
254
254
  payload: Pick<ClaimPayload, 'target'>,
@@ -274,7 +274,7 @@ export class AllowListIncentive extends DeployableTarget<
274
274
  * @public
275
275
  * @async
276
276
  * @param {Pick<ClaimPayload, 'target'>} payload
277
- * @param {?ReadParams<typeof allowListIncentiveAbi, 'isClaimable'>} [params]
277
+ * @param {?ReadParams} [params]
278
278
  * @returns {Promise<boolean>} - True if the incentive is claimable based on the data payload
279
279
  */
280
280
  public async isClaimable(
@@ -164,8 +164,8 @@ export class CGDAIncentive extends DeployableTarget<
164
164
  *
165
165
  * @public
166
166
  * @async
167
- * @param {?ReadParams<typeof cgdaIncentiveAbi, 'owner'>} [params]
168
- * @returns {unknown}
167
+ * @param {?ReadParams} [params]
168
+ * @returns {Promise<Address>}
169
169
  */
170
170
  public async owner(params?: ReadParams<typeof cgdaIncentiveAbi, 'owner'>) {
171
171
  return await readCgdaIncentiveOwner(this._config, {
@@ -181,7 +181,7 @@ export class CGDAIncentive extends DeployableTarget<
181
181
  *
182
182
  * @public
183
183
  * @async
184
- * @param {?ReadParams<typeof cgdaIncentiveAbi, 'claims'>} [params]
184
+ * @param {?ReadParams} [params]
185
185
  * @returns {Promise<bigint>}
186
186
  */
187
187
  public async claims(params?: ReadParams<typeof cgdaIncentiveAbi, 'claims'>) {
@@ -198,7 +198,7 @@ export class CGDAIncentive extends DeployableTarget<
198
198
  *
199
199
  * @public
200
200
  * @async
201
- * @param {?ReadParams<typeof allowListIncentiveAbi, 'reward'>} [params]
201
+ * @param {?ReadParams} [params]
202
202
  * @returns {Promise<bigint>}
203
203
  */
204
204
  public async reward(params?: ReadParams<typeof cgdaIncentiveAbi, 'reward'>) {
@@ -216,7 +216,7 @@ export class CGDAIncentive extends DeployableTarget<
216
216
  * @public
217
217
  * @async
218
218
  * @param {Address} address
219
- * @param {?ReadParams<typeof cgdaIncentiveAbi, 'claimed'>} [params]
219
+ * @param {?ReadParams} [params]
220
220
  * @returns {Promise<boolean>}
221
221
  */
222
222
  public async claimed(
@@ -236,8 +236,8 @@ export class CGDAIncentive extends DeployableTarget<
236
236
  *
237
237
  * @public
238
238
  * @async
239
- * @param {?ReadParams<typeof cgdaIncentiveAbi, 'asset'>} [params]
240
- * @returns {unknown}
239
+ * @param {?ReadParams} [params]
240
+ * @returns {Promise<Address>}
241
241
  */
242
242
  public async asset(params?: ReadParams<typeof cgdaIncentiveAbi, 'asset'>) {
243
243
  return await readCgdaIncentiveAsset(this._config, {
@@ -252,7 +252,7 @@ export class CGDAIncentive extends DeployableTarget<
252
252
  *
253
253
  * @public
254
254
  * @async
255
- * @param {?ReadParams<typeof cgdaIncentiveAbi, 'cgdaParams'>} [params]
255
+ * @param {?ReadParams} [params]
256
256
  * @returns {Promise<CGDAParameters>}
257
257
  */
258
258
  public async cgdaParams(
@@ -277,7 +277,7 @@ export class CGDAIncentive extends DeployableTarget<
277
277
  *
278
278
  * @public
279
279
  * @async
280
- * @param {?ReadParams<typeof cgdaIncentiveAbi, 'totalBudget'>} [params]
280
+ * @param {?ReadParams} [params]
281
281
  * @returns {Promise<bigint>}
282
282
  */
283
283
  public async totalBudget(
@@ -296,7 +296,7 @@ export class CGDAIncentive extends DeployableTarget<
296
296
  * @public
297
297
  * @async
298
298
  * @param {ClaimPayload} payload
299
- * @param {?WriteParams<typeof cgdaIncentiveAbi, 'claim'>} [params]
299
+ * @param {?WriteParams} [params]
300
300
  * @returns {Promise<boolean>} - Returns true if successfully claimed
301
301
  */
302
302
  protected async claim(
@@ -312,7 +312,7 @@ export class CGDAIncentive extends DeployableTarget<
312
312
  * @public
313
313
  * @async
314
314
  * @param {ClaimPayload} payload
315
- * @param {?WriteParams<typeof cgdaIncentiveAbi, 'claim'>} [params]
315
+ * @param {?WriteParams} [params]
316
316
  * @returns {Promise<boolean>} - Returns true if successfully claimed
317
317
  */
318
318
  protected async claimRaw(
@@ -336,7 +336,7 @@ export class CGDAIncentive extends DeployableTarget<
336
336
  * @public
337
337
  * @async
338
338
  * @param {ClaimPayload} payload
339
- * @param {?WriteParams<typeof cgdaIncentiveAbi, 'clawback'>} [params]
339
+ * @param {?WriteParams} [params]
340
340
  * @returns {Promise<boolean>} - True if the assets were successfully clawbacked
341
341
  */
342
342
  public async clawback(
@@ -352,7 +352,7 @@ export class CGDAIncentive extends DeployableTarget<
352
352
  * @public
353
353
  * @async
354
354
  * @param {ClaimPayload} payload
355
- * @param {?WriteParams<typeof cgdaIncentiveAbi, 'clawback'>} [params]
355
+ * @param {?WriteParams} [params]
356
356
  * @returns {Promise<boolean>} - True if the assets were successfully clawbacked
357
357
  */
358
358
  public async clawbackRaw(
@@ -379,7 +379,7 @@ export class CGDAIncentive extends DeployableTarget<
379
379
  * @public
380
380
  * @async
381
381
  * @param {ClaimPayload} payload
382
- * @param {?ReadParams<typeof cgdaIncentiveAbi, 'isClaimable'>} [params]
382
+ * @param {?ReadParams} [params]
383
383
  * @returns {Promise<boolean>} - True if the incentive is claimable based on the data payload
384
384
  */
385
385
  public async isClaimable(
@@ -401,7 +401,7 @@ export class CGDAIncentive extends DeployableTarget<
401
401
  *
402
402
  * @public
403
403
  * @async
404
- * @param {?ReadParams<typeof cgdaIncentiveAbi, 'currentReward'>} [params]
404
+ * @param {?ReadParams} [params]
405
405
  * @returns {Promise<bigint>} - The current reward
406
406
  */
407
407
  public async currentReward(
@@ -144,8 +144,8 @@ export class ERC1155Incentive extends DeployableTarget<
144
144
  *
145
145
  * @public
146
146
  * @async
147
- * @param {?ReadParams<typeof erc1155IncentiveAbi, 'claims'>} [params]
148
- * @returns {unknown}
147
+ * @param {?ReadParams} [params]
148
+ * @returns {Promise<bigint>}
149
149
  */
150
150
  public async claims(
151
151
  params?: ReadParams<typeof erc1155IncentiveAbi, 'claims'>,
@@ -163,8 +163,8 @@ export class ERC1155Incentive extends DeployableTarget<
163
163
  *
164
164
  * @public
165
165
  * @async
166
- * @param {?ReadParams<typeof erc1155IncentiveAbi, 'reward'>} [params]
167
- * @returns {unknown}
166
+ * @param {?ReadParams} [params]
167
+ * @returns {Promise<bigint>}
168
168
  */
169
169
  public async reward(
170
170
  params?: ReadParams<typeof erc1155IncentiveAbi, 'reward'>,
@@ -183,8 +183,8 @@ export class ERC1155Incentive extends DeployableTarget<
183
183
  * @public
184
184
  * @async
185
185
  * @param {Address} address
186
- * @param {?ReadParams<typeof erc1155IncentiveAbi, 'claimed'>} [params]
187
- * @returns {unknown}
186
+ * @param {?ReadParams} [params]
187
+ * @returns {Promise<boolean>}
188
188
  */
189
189
  public async claimed(
190
190
  address: Address,
@@ -203,8 +203,8 @@ export class ERC1155Incentive extends DeployableTarget<
203
203
  *
204
204
  * @public
205
205
  * @async
206
- * @param {?ReadParams<typeof erc1155IncentiveAbi, 'asset'>} [params]
207
- * @returns {unknown}
206
+ * @param {?ReadParams} [params]
207
+ * @returns {Promise<Address>}
208
208
  */
209
209
  public async asset(params?: ReadParams<typeof erc1155IncentiveAbi, 'asset'>) {
210
210
  return await readErc1155IncentiveAsset(this._config, {
@@ -219,7 +219,7 @@ export class ERC1155Incentive extends DeployableTarget<
219
219
  *
220
220
  * @public
221
221
  * @async
222
- * @param {?ReadParams<typeof erc1155IncentiveAbi, 'strategy'>} [params]
222
+ * @param {?ReadParams} [params]
223
223
  * @returns {Promise<StrategyType>}
224
224
  */
225
225
  public strategy(
@@ -237,7 +237,7 @@ export class ERC1155Incentive extends DeployableTarget<
237
237
  *
238
238
  * @public
239
239
  * @async
240
- * @param {?ReadParams<typeof erc1155IncentiveAbi, 'limit'>} [params]
240
+ * @param {?ReadParams} [params]
241
241
  * @returns {unknown}
242
242
  */
243
243
  public async limit(params?: ReadParams<typeof erc1155IncentiveAbi, 'limit'>) {
@@ -253,8 +253,8 @@ export class ERC1155Incentive extends DeployableTarget<
253
253
  *
254
254
  * @public
255
255
  * @async
256
- * @param {?ReadParams<typeof erc1155IncentiveAbi, 'tokenId'>} [params]
257
- * @returns {unknown}
256
+ * @param {?ReadParams} [params]
257
+ * @returns {Promise<bigint>}
258
258
  */
259
259
  public async tokenId(
260
260
  params?: ReadParams<typeof erc1155IncentiveAbi, 'tokenId'>,
@@ -271,8 +271,8 @@ export class ERC1155Incentive extends DeployableTarget<
271
271
  *
272
272
  * @public
273
273
  * @async
274
- * @param {?ReadParams<typeof erc1155IncentiveAbi, 'extraData'>} [params]
275
- * @returns {unknown}
274
+ * @param {?ReadParams} [params]
275
+ * @returns {Promise<Hex>}
276
276
  */
277
277
  public async extraData(
278
278
  params?: ReadParams<typeof erc1155IncentiveAbi, 'extraData'>,
@@ -290,8 +290,8 @@ export class ERC1155Incentive extends DeployableTarget<
290
290
  * @public
291
291
  * @async
292
292
  * @param {ClaimPayload} payload
293
- * @param {?WriteParams<typeof erc1155IncentiveAbi, 'claim'>} [params]
294
- * @returns {unknown}
293
+ * @param {?WriteParams} [params]
294
+ * @returns {Promise<boolean>}
295
295
  */
296
296
  protected async claim(
297
297
  payload: ClaimPayload,
@@ -306,8 +306,8 @@ export class ERC1155Incentive extends DeployableTarget<
306
306
  * @public
307
307
  * @async
308
308
  * @param {ClaimPayload} payload
309
- * @param {?WriteParams<typeof erc1155IncentiveAbi, 'claim'>} [params]
310
- * @returns {unknown}
309
+ * @param {?WriteParams} [params]
310
+ * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>}
311
311
  */
312
312
  protected async claimRaw(
313
313
  payload: ClaimPayload,
@@ -333,8 +333,8 @@ export class ERC1155Incentive extends DeployableTarget<
333
333
  * @public
334
334
  * @async
335
335
  * @param {ClaimPayload} payload
336
- * @param {?WriteParams<typeof erc1155IncentiveAbi, 'clawback'>} [params]
337
- * @returns {unknown}
336
+ * @param {?WriteParams} [params]
337
+ * @returns {Promise<boolean>}
338
338
  */
339
339
  public async clawback(
340
340
  payload: ClaimPayload,
@@ -349,8 +349,8 @@ export class ERC1155Incentive extends DeployableTarget<
349
349
  * @public
350
350
  * @async
351
351
  * @param {ClaimPayload} payload
352
- * @param {?WriteParams<typeof erc1155IncentiveAbi, 'clawback'>} [params]
353
- * @returns {unknown}
352
+ * @param {?WriteParams} [params]
353
+ * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>}
354
354
  */
355
355
  public async clawbackRaw(
356
356
  payload: ClaimPayload,
@@ -376,8 +376,8 @@ export class ERC1155Incentive extends DeployableTarget<
376
376
  * @public
377
377
  * @async
378
378
  * @param {ClaimPayload} payload
379
- * @param {?ReadParams<typeof erc1155IncentiveAbi, 'isClaimable'>} [params]
380
- * @returns {unknown}
379
+ * @param {?ReadParams} [params]
380
+ * @returns {Promise<boolean>}
381
381
  */
382
382
  public async isClaimable(
383
383
  payload: ClaimPayload,
@@ -397,8 +397,8 @@ export class ERC1155Incentive extends DeployableTarget<
397
397
  * @public
398
398
  * @async
399
399
  * @param {ERC1155IncentivePayload} data
400
- * @param {?ReadParams<typeof erc1155IncentiveAbi, 'preflight'>} [params]
401
- * @returns {unknown}
400
+ * @param {?ReadParams} [params]
401
+ * @returns {Promise<Hex>}
402
402
  */
403
403
  public async preflight(
404
404
  data: ERC1155IncentivePayload,