@boostxyz/sdk 0.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/LICENSE +674 -0
  2. package/README.md +7 -0
  3. package/dist/Actions/Action.cjs +1 -0
  4. package/dist/Actions/Action.d.ts +31 -0
  5. package/dist/Actions/Action.d.ts.map +1 -0
  6. package/dist/Actions/Action.js +27 -0
  7. package/dist/Actions/ContractAction.d.ts +327 -0
  8. package/dist/Actions/ContractAction.d.ts.map +1 -0
  9. package/dist/Actions/ERC721MintAction.d.ts +486 -0
  10. package/dist/Actions/ERC721MintAction.d.ts.map +1 -0
  11. package/dist/Actions/EventAction.cjs +1 -0
  12. package/dist/Actions/EventAction.d.ts +433 -0
  13. package/dist/Actions/EventAction.d.ts.map +1 -0
  14. package/dist/Actions/EventAction.js +211 -0
  15. package/dist/AllowLists/AllowList.cjs +1 -0
  16. package/dist/AllowLists/AllowList.d.ts +33 -0
  17. package/dist/AllowLists/AllowList.d.ts.map +1 -0
  18. package/dist/AllowLists/AllowList.js +28 -0
  19. package/dist/AllowLists/SimpleAllowList.cjs +1 -0
  20. package/dist/AllowLists/SimpleAllowList.d.ts +452 -0
  21. package/dist/AllowLists/SimpleAllowList.d.ts.map +1 -0
  22. package/dist/AllowLists/SimpleAllowList.js +138 -0
  23. package/dist/AllowLists/SimpleDenyList.cjs +1 -0
  24. package/dist/AllowLists/SimpleDenyList.d.ts +306 -0
  25. package/dist/AllowLists/SimpleDenyList.d.ts.map +1 -0
  26. package/dist/AllowLists/SimpleDenyList.js +202 -0
  27. package/dist/Auth/Auth.cjs +1 -0
  28. package/dist/Auth/Auth.d.ts +10 -0
  29. package/dist/Auth/Auth.d.ts.map +1 -0
  30. package/dist/Auth/Auth.js +4 -0
  31. package/dist/Auth/PassthroughAuth.cjs +1 -0
  32. package/dist/Auth/PassthroughAuth.d.ts +51 -0
  33. package/dist/Auth/PassthroughAuth.d.ts.map +1 -0
  34. package/dist/Auth/PassthroughAuth.js +38 -0
  35. package/dist/Boost.cjs +1 -0
  36. package/dist/Boost.d.ts +142 -0
  37. package/dist/Boost.d.ts.map +1 -0
  38. package/dist/Boost.js +15 -0
  39. package/dist/BoostCore.cjs +2 -0
  40. package/dist/BoostCore.d.ts +460 -0
  41. package/dist/BoostCore.d.ts.map +1 -0
  42. package/dist/BoostCore.js +1105 -0
  43. package/dist/BoostRegistry.cjs +1 -0
  44. package/dist/BoostRegistry.d.ts +229 -0
  45. package/dist/BoostRegistry.d.ts.map +1 -0
  46. package/dist/BoostRegistry.js +250 -0
  47. package/dist/Budgets/Budget.cjs +1 -0
  48. package/dist/Budgets/Budget.d.ts +31 -0
  49. package/dist/Budgets/Budget.d.ts.map +1 -0
  50. package/dist/Budgets/Budget.js +27 -0
  51. package/dist/Budgets/ManagedBudget.cjs +1 -0
  52. package/dist/Budgets/ManagedBudget.d.ts +1065 -0
  53. package/dist/Budgets/ManagedBudget.d.ts.map +1 -0
  54. package/dist/Budgets/ManagedBudget.js +498 -0
  55. package/dist/Budgets/SimpleBudget.d.ts +793 -0
  56. package/dist/Budgets/SimpleBudget.d.ts.map +1 -0
  57. package/dist/Budgets/VestingBudget.d.ts +726 -0
  58. package/dist/Budgets/VestingBudget.d.ts.map +1 -0
  59. package/dist/Deployable/Contract.cjs +1 -0
  60. package/dist/Deployable/Contract.d.ts +125 -0
  61. package/dist/Deployable/Contract.d.ts.map +1 -0
  62. package/dist/Deployable/Contract.js +149 -0
  63. package/dist/Deployable/Deployable.cjs +1 -0
  64. package/dist/Deployable/Deployable.d.ts +155 -0
  65. package/dist/Deployable/Deployable.d.ts.map +1 -0
  66. package/dist/Deployable/Deployable.js +124 -0
  67. package/dist/Deployable/DeployableTarget.cjs +1 -0
  68. package/dist/Deployable/DeployableTarget.d.ts +115 -0
  69. package/dist/Deployable/DeployableTarget.d.ts.map +1 -0
  70. package/dist/Deployable/DeployableTarget.js +128 -0
  71. package/dist/Incentives/AllowListIncentive.cjs +1 -0
  72. package/dist/Incentives/AllowListIncentive.d.ts +483 -0
  73. package/dist/Incentives/AllowListIncentive.d.ts.map +1 -0
  74. package/dist/Incentives/AllowListIncentive.js +188 -0
  75. package/dist/Incentives/CGDAIncentive.cjs +1 -0
  76. package/dist/Incentives/CGDAIncentive.d.ts +560 -0
  77. package/dist/Incentives/CGDAIncentive.d.ts.map +1 -0
  78. package/dist/Incentives/CGDAIncentive.js +249 -0
  79. package/dist/Incentives/ERC1155Incentive.d.ts +652 -0
  80. package/dist/Incentives/ERC1155Incentive.d.ts.map +1 -0
  81. package/dist/Incentives/ERC20Incentive.cjs +1 -0
  82. package/dist/Incentives/ERC20Incentive.d.ts +622 -0
  83. package/dist/Incentives/ERC20Incentive.d.ts.map +1 -0
  84. package/dist/Incentives/ERC20Incentive.js +292 -0
  85. package/dist/Incentives/ERC20VariableIncentive.d.ts +545 -0
  86. package/dist/Incentives/ERC20VariableIncentive.d.ts.map +1 -0
  87. package/dist/Incentives/Incentive.cjs +1 -0
  88. package/dist/Incentives/Incentive.d.ts +39 -0
  89. package/dist/Incentives/Incentive.d.ts.map +1 -0
  90. package/dist/Incentives/Incentive.js +280 -0
  91. package/dist/Incentives/PointsIncentive.cjs +1 -0
  92. package/dist/Incentives/PointsIncentive.d.ts +615 -0
  93. package/dist/Incentives/PointsIncentive.d.ts.map +1 -0
  94. package/dist/Incentives/PointsIncentive.js +197 -0
  95. package/dist/Validators/SignerValidator.cjs +1 -0
  96. package/dist/Validators/SignerValidator.d.ts +452 -0
  97. package/dist/Validators/SignerValidator.d.ts.map +1 -0
  98. package/dist/Validators/SignerValidator.js +167 -0
  99. package/dist/Validators/Validator.cjs +1 -0
  100. package/dist/Validators/Validator.d.ts +31 -0
  101. package/dist/Validators/Validator.d.ts.map +1 -0
  102. package/dist/Validators/Validator.js +25 -0
  103. package/dist/errors.cjs +1 -0
  104. package/dist/errors.d.ts +257 -0
  105. package/dist/errors.d.ts.map +1 -0
  106. package/dist/errors.js +161 -0
  107. package/dist/generated-BaaleHW-.cjs +2 -0
  108. package/dist/generated-x_abr3Yv.js +6228 -0
  109. package/dist/index.cjs +1 -0
  110. package/dist/index.d.ts +29 -0
  111. package/dist/index.d.ts.map +1 -0
  112. package/dist/index.js +1355 -0
  113. package/dist/utils.cjs +1 -0
  114. package/dist/utils.d.ts +1454 -0
  115. package/dist/utils.d.ts.map +1 -0
  116. package/dist/utils.js +643 -0
  117. package/package.json +197 -0
@@ -0,0 +1,460 @@
1
+ import { boostCoreAbi, type iAuthAbi } from '@boostxyz/evm';
2
+ import { type Address, type ContractEventName, type Hex } from 'viem';
3
+ import { type Action } from './Actions/Action';
4
+ import { EventAction } from './Actions/EventAction';
5
+ import { type AllowList } from './AllowLists/AllowList';
6
+ import { SimpleAllowList, type SimpleAllowListPayload } from './AllowLists/SimpleAllowList';
7
+ import { SimpleDenyList, type SimpleDenyListPayload } from './AllowLists/SimpleDenyList';
8
+ import { type Auth, PassthroughAuth } from './Auth/Auth';
9
+ import { Boost } from './Boost';
10
+ import { type Budget } from './Budgets/Budget';
11
+ import { ManagedBudget, type ManagedBudgetPayload } from './Budgets/ManagedBudget';
12
+ import { Deployable, type DeployableOptions, type DeployablePayloadOrAddress, type GenericDeployableParams } from './Deployable/Deployable';
13
+ import { AllowListIncentive, type AllowListIncentivePayload } from './Incentives/AllowListIncentive';
14
+ import { CGDAIncentive, type CGDAIncentivePayload } from './Incentives/CGDAIncentive';
15
+ import { ERC20Incentive, type ERC20IncentivePayload } from './Incentives/ERC20Incentive';
16
+ import { ERC20VariableIncentive, type Incentive } from './Incentives/Incentive';
17
+ import { PointsIncentive, type PointsIncentivePayload } from './Incentives/PointsIncentive';
18
+ import { SignerValidator, type SignerValidatorPayload } from './Validators/SignerValidator';
19
+ import { type Validator } from './Validators/Validator';
20
+ import { type ERC20VariableIncentivePayload, type EventActionPayload, type GenericLog, type ReadParams, type WriteParams } from './utils';
21
+ export { boostCoreAbi };
22
+ /**
23
+ * The fixed address for the deployed Boost Core.
24
+ * By default, `new BoostCore` will use this address if not otherwise provided.
25
+ *
26
+ * @type {Address}
27
+ */
28
+ export declare const BOOST_CORE_ADDRESS: Address;
29
+ /**
30
+ * A generic `viem.Log` event with support for `BoostCore` event types.
31
+ *
32
+ * @export
33
+ * @typedef {BoostCoreLog}
34
+ * @template {ContractEventName<typeof boostCoreAbi>} [event=ContractEventName<
35
+ * typeof boostCoreAbi
36
+ * >]
37
+ */
38
+ export type BoostCoreLog<event extends ContractEventName<typeof boostCoreAbi> = ContractEventName<typeof boostCoreAbi>> = GenericLog<typeof boostCoreAbi, event>;
39
+ /**
40
+ * Boost Core instantiation options for a custom deployed instance.
41
+ *
42
+ * @export
43
+ * @interface BoostCoreDeployedOptions
44
+ * @typedef {BoostCoreDeployedOptions}
45
+ * @extends {DeployableOptions}
46
+ */
47
+ export interface BoostCoreDeployedOptions extends DeployableOptions {
48
+ /**
49
+ * The address of a deployed, custom Boost Core contract.
50
+ *
51
+ * @type {?Address}
52
+ */
53
+ address?: Address;
54
+ }
55
+ /**
56
+ * Boost Core instantiation options when a user intends to deploy a new instance of Boost Core, setting their own registry address and protocol fee receiver.
57
+ *
58
+ * @export
59
+ * @interface BoostCoreOptionsWithPayload
60
+ * @typedef {BoostCoreOptionsWithPayload}
61
+ * @extends {DeployableOptions}
62
+ */
63
+ export interface BoostCoreOptionsWithPayload extends DeployableOptions {
64
+ /**
65
+ * The address of a deployed Boost Registry contract.
66
+ *
67
+ * @type {Address}
68
+ */
69
+ registryAddress: Address;
70
+ /**
71
+ * The address to send fees.
72
+ *
73
+ * @type {Address}
74
+ */
75
+ protocolFeeReceiver: Address;
76
+ }
77
+ /**
78
+ * A union representing both of the valid Boost Core instantiation parameters.
79
+ *
80
+ * @export
81
+ * @typedef {BoostCoreConfig}
82
+ */
83
+ export type BoostCoreConfig = BoostCoreDeployedOptions | BoostCoreOptionsWithPayload;
84
+ /**
85
+ * The interface required to create a new Boost.
86
+ *
87
+ * @export
88
+ * @typedef {CreateBoostPayload}
89
+ */
90
+ export type CreateBoostPayload = {
91
+ budget: Budget;
92
+ action: Action;
93
+ validator: Validator;
94
+ allowList: AllowList;
95
+ incentives: Array<Incentive>;
96
+ protocolFee?: bigint;
97
+ referralFee?: bigint;
98
+ maxParticipants?: bigint;
99
+ owner?: Address;
100
+ };
101
+ /**
102
+ * The core contract for the Boost protocol. Used to create and retrieve deployed Boosts.
103
+ *
104
+ * @export
105
+ * @class BoostCore
106
+ * @typedef {BoostCore}
107
+ * @extends {Deployable<[Address, Address]>}
108
+ */
109
+ export declare class BoostCore extends Deployable<[
110
+ Address,
111
+ Address
112
+ ], typeof boostCoreAbi> {
113
+ /**
114
+ * Creates an instance of BoostCore.
115
+ *
116
+ * @constructor
117
+ * @param {BoostCoreConfig} param0
118
+ * @param {Config} param0.config
119
+ * @param {?Account} [param0.account]
120
+ * @param {({ address?: Address; } | { registryAddress: Address; protocolFeeReceiver: Address; })} param0....options
121
+ */
122
+ constructor({ config, account, ...options }: BoostCoreConfig); /**
123
+ * Create a new Boost.
124
+ *
125
+ * @public
126
+ * @async
127
+ * @param {CreateBoostPayload} _boostPayload
128
+ * @param {?DeployableOptions} [_options]
129
+ * @returns {Boost}
130
+ */
131
+ createBoost(_boostPayload: CreateBoostPayload, _options?: DeployableOptions): Promise<Boost>;
132
+ /**
133
+ * Claims one incentive from a given `Boost` by `boostId` and `incentiveId`
134
+ *
135
+ * @public
136
+ * @async
137
+ * @param {bigint} boostId
138
+ * @param {bigint} incentiveId
139
+ * @param {Address} address
140
+ * @param {Hex} data
141
+ * @param {?WriteParams<typeof boostCoreAbi, 'claimIncentive'>} [params]
142
+ * @returns {unknown}
143
+ */
144
+ claimIncentive(boostId: bigint, incentiveId: bigint, address: Address, data: Hex, params?: WriteParams<typeof boostCoreAbi, 'claimIncentive'>): Promise<void>;
145
+ /**
146
+ * Claim an incentive for a Boost
147
+ *
148
+ * @public
149
+ * @async
150
+ * @param {bigint} boostId - The ID of the Boost
151
+ * @param {bigint} incentiveId - The ID of the Incentive
152
+ * @param {Address} address - The address of the referrer (if any)
153
+ * @param {Hex} data- The data for the claim
154
+ * @param {?WriteParams<typeof boostCoreAbi, 'claimIncentive'>} [params]
155
+ * @returns {unknown}
156
+ */
157
+ claimIncentiveRaw(boostId: bigint, incentiveId: bigint, address: Address, data: Hex, params?: WriteParams<typeof boostCoreAbi, 'claimIncentive'>): Promise<{
158
+ hash: `0x${string}`;
159
+ result: void;
160
+ }>;
161
+ /**
162
+ * Get a Boost by index, will return the raw on chain representation of a Boost.
163
+ *
164
+ * @public
165
+ * @async
166
+ * @param {bigint} id
167
+ * @param {?ReadParams<typeof boostCoreAbi, 'getBoost'>} [params]
168
+ * @returns {unknown}
169
+ */
170
+ readBoost(id: bigint, params?: ReadParams<typeof boostCoreAbi, 'getBoost'>): Promise<{
171
+ action: `0x${string}`;
172
+ validator: `0x${string}`;
173
+ allowList: `0x${string}`;
174
+ budget: `0x${string}`;
175
+ incentives: readonly `0x${string}`[];
176
+ protocolFee: bigint;
177
+ referralFee: bigint;
178
+ maxParticipants: bigint;
179
+ owner: `0x${string}`;
180
+ }>;
181
+ /**
182
+ * 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`
183
+ *
184
+ * @public
185
+ * @async
186
+ * @param {(string | bigint)} _id
187
+ * @param {?ReadParams<typeof boostCoreAbi, 'getBoost'>} [params]
188
+ * @returns {unknown}
189
+ */
190
+ getBoost(_id: string | bigint, params?: ReadParams<typeof boostCoreAbi, 'getBoost'>): Promise<Boost>;
191
+ /**
192
+ * Retrieve the total number of deployed Boosts
193
+ *
194
+ * @public
195
+ * @async
196
+ * @param {?ReadParams<typeof boostCoreAbi, 'getBoostCount'>} [params]
197
+ * @returns {Promise<bigint>}
198
+ */
199
+ getBoostCount(params?: ReadParams<typeof boostCoreAbi, 'getBoostCount'>): Promise<bigint>;
200
+ /**
201
+ * Checks if an address is authorized
202
+ *
203
+ * @public
204
+ * @async
205
+ * @param {Address} address
206
+ * @param {?ReadParams<typeof boostCoreAbi, 'createBoostAuth'> &
207
+ * ReadParams<typeof iAuthAbi, 'isAuthorized'>} [params]
208
+ * @returns {Promise<boolean>}
209
+ */
210
+ isAuthorized(address: Address, params?: ReadParams<typeof boostCoreAbi, 'createBoostAuth'> & ReadParams<typeof iAuthAbi, 'isAuthorized'>): Promise<boolean>;
211
+ /**
212
+ * Retrieve the address of the current creation auth provider.
213
+ *
214
+ * @public
215
+ * @async
216
+ * @param {?ReadParams<typeof boostCoreAbi, 'createBoostAuth'>} [params]
217
+ * @returns {unknown}
218
+ */
219
+ createBoostAuth(params?: ReadParams<typeof boostCoreAbi, 'createBoostAuth'>): Promise<`0x${string}`>;
220
+ /**
221
+ * Replace the current auth scheme.
222
+ *
223
+ * @public
224
+ * @async
225
+ * @param {Auth} auth
226
+ * @param {?WriteParams<typeof boostCoreAbi, 'setCreateBoostAuth'>} [params]
227
+ * @returns {unknown}
228
+ */
229
+ setCreateBoostAuth(auth: Auth, params?: WriteParams<typeof boostCoreAbi, 'setCreateBoostAuth'>): Promise<void>;
230
+ /**
231
+ * Set the createBoostAuth address
232
+ *
233
+ * @public
234
+ * @async
235
+ * @param {Address} address
236
+ * @param {?WriteParams<typeof boostCoreAbi, 'setCreateBoostAuth'>} [params]
237
+ * @returns {unknown}
238
+ */
239
+ setCreateBoostAuthRaw(address: Address, params?: WriteParams<typeof boostCoreAbi, 'setCreateBoostAuth'>): Promise<{
240
+ hash: `0x${string}`;
241
+ result: void;
242
+ }>;
243
+ /**
244
+ * Get the protocol fee.
245
+ *
246
+ * @public
247
+ * @async
248
+ * @param {?ReadParams<typeof boostCoreAbi, 'protocolFee'>} [params]
249
+ * @returns {unknown}
250
+ */
251
+ protocolFee(params?: ReadParams<typeof boostCoreAbi, 'protocolFee'>): Promise<bigint>;
252
+ /**
253
+ * Get the protocol fee receiver.
254
+ *
255
+ * @public
256
+ * @async
257
+ * @param {?ReadParams<typeof boostCoreAbi, 'protocolFeeReceiver'>} [params]
258
+ * @returns {unknown}
259
+ */
260
+ protocolFeeReceiver(params?: ReadParams<typeof boostCoreAbi, 'protocolFeeReceiver'>): Promise<`0x${string}`>;
261
+ /**
262
+ * Set the protocol fee receiver address. This function is only callable by the owner.
263
+ *
264
+ * @public
265
+ * @async
266
+ * @param {Address} address
267
+ * @param {?WriteParams<typeof boostCoreAbi, 'setProtocolFeeReceiver'>} [params]
268
+ * @returns {unknown}
269
+ */
270
+ setProcolFeeReceiver(address: Address, params?: WriteParams<typeof boostCoreAbi, 'setProtocolFeeReceiver'>): Promise<void>;
271
+ /**
272
+ * Set the protocol fee receiver address. This function is only callable by the owner.
273
+ *
274
+ * @public
275
+ * @async
276
+ * @param {Address} address
277
+ * @param {?WriteParams<typeof boostCoreAbi, 'setProtocolFeeReceiver'>} [params]
278
+ * @returns {unknown}
279
+ */
280
+ setProcolFeeReceiverRaw(address: Address, params?: WriteParams<typeof boostCoreAbi, 'setProtocolFeeReceiver'>): Promise<{
281
+ hash: `0x${string}`;
282
+ result: void;
283
+ }>;
284
+ /**
285
+ * Get the claim fee.
286
+ *
287
+ * @public
288
+ * @async
289
+ * @param {?ReadParams<typeof boostCoreAbi, 'claimFee'>} [params]
290
+ * @returns {unknown}
291
+ */
292
+ claimFee(params?: ReadParams<typeof boostCoreAbi, 'claimFee'>): Promise<bigint>;
293
+ /**
294
+ * Sets the claim fee.
295
+ *
296
+ * @public
297
+ * @async
298
+ * @param {bigint} claimFee
299
+ * @param {?WriteParams<typeof boostCoreAbi, 'setClaimFee'>} [params]
300
+ * @returns {unknown}
301
+ */
302
+ setClaimFee(claimFee: bigint, params?: WriteParams<typeof boostCoreAbi, 'setClaimFee'>): Promise<void>;
303
+ /**
304
+ * Sets the claim fee.
305
+ *
306
+ * @public
307
+ * @async
308
+ * @param {bigint} claimFee
309
+ * @param {?WriteParams<typeof boostCoreAbi, 'setClaimFee'>} [params]
310
+ * @returns {unknown}
311
+ */
312
+ setClaimFeeRaw(claimFee: bigint, params?: WriteParams<typeof boostCoreAbi, 'setClaimFee'>): Promise<{
313
+ hash: `0x${string}`;
314
+ result: void;
315
+ }>;
316
+ /**
317
+ * Bound {@link PassthroughAuth} constructor that reuses the same configuration as the Boost Core instance.
318
+ *
319
+ * @example
320
+ * ```ts
321
+ * const auth = core.PassthroughAuth('0x') // is roughly equivalent to
322
+ * const auth = new PassthroughAuth({ config: core._config, account: core._account }, '0x')
323
+ * ```
324
+ * @param {DeployablePayloadOrAddress<{}>} options
325
+ * @param {?boolean} [isBase]
326
+ * @returns {PassthroughAuth}
327
+ */
328
+ PassthroughAuth(address?: Address): PassthroughAuth;
329
+ /**
330
+ * Bound {@link EventAction} constructor that reuses the same configuration as the Boost Core instance.
331
+ *
332
+ * @example
333
+ * ```ts
334
+ * const action = core.EventAction('0x') // is roughly equivalent to
335
+ * const action = new EventAction({ config: core._config, account: core._account }, '0x')
336
+ */
337
+ EventAction(options: DeployablePayloadOrAddress<EventActionPayload>, isBase?: boolean): EventAction;
338
+ /**
339
+ * Bound {@link SimpleAllowList} constructor that reuses the same configuration as the Boost Core instance.
340
+ *
341
+ * @example
342
+ * ```ts
343
+ * const list = core.SimpleAllowList('0x') // is roughly equivalent to
344
+ * const list = new SimpleAllowList({ config: core._config, account: core._account }, '0x')
345
+ * ```
346
+ * @param {DeployablePayloadOrAddress<SimpleAllowListPayload>} options
347
+ * @param {?boolean} [isBase]
348
+ * @returns {SimpleAllowList}
349
+ */
350
+ SimpleAllowList(options: DeployablePayloadOrAddress<SimpleAllowListPayload>, isBase?: boolean): SimpleAllowList;
351
+ /**
352
+ * Bound {@link SimpleDenyList} constructor that reuses the same configuration as the Boost Core instance.
353
+ *
354
+ * @example
355
+ * ```ts
356
+ * const list = core.SimpleDenyList('0x') // is roughly equivalent to
357
+ * const list = new SimpleDenyList({ config: core._config, account: core._account }, '0x')
358
+ * ```
359
+ * @param {DeployablePayloadOrAddress<SimpleDenyListPayload>} options
360
+ * @param {?boolean} [isBase]
361
+ * @returns {SimpleDenyList}
362
+ */
363
+ SimpleDenyList(options: DeployablePayloadOrAddress<SimpleDenyListPayload>, isBase?: boolean): SimpleDenyList;
364
+ /**
365
+ * Bound {@link ManagedBudget} constructor that reuses the same configuration as the Boost Core instance.
366
+ *
367
+ * @example
368
+ * ```ts
369
+ * const budget = core.ManagedBudget('0x') // is roughly equivalent to
370
+ * const budget = new ManagedBudget({ config: core._config, account: core._account }, '0x')
371
+ * ```
372
+ * @param {DeployablePayloadOrAddress<ManagedBudgetPayload>} options
373
+ * @returns {ManagedBudget}
374
+ */
375
+ ManagedBudget(options: DeployablePayloadOrAddress<ManagedBudgetPayload>): ManagedBudget;
376
+ /**
377
+ * Bound {@link AllowListIncentive} constructor that reuses the same configuration as the Boost Core instance.
378
+ *
379
+ * @example
380
+ * ```ts
381
+ * const incentive = core.AllowListIncentive({ ... }) // is roughly equivalent to
382
+ * const incentive = new AllowListIncentive({ config: core._config, account: core._account }, { ... })
383
+ * ```
384
+ * @param {DeployablePayloadOrAddress<VestingBudgetPayload>} options
385
+ * @returns {VestingBudget}
386
+ */
387
+ AllowListIncentive(options: AllowListIncentivePayload): AllowListIncentive;
388
+ /**
389
+ * Bound {@link CGDAIncentive} constructor that reuses the same configuration as the Boost Core instance.
390
+ *
391
+ * @example
392
+ * ```ts
393
+ * const incentive = core.CGDAIncentive({ ... }) // is roughly equivalent to
394
+ * const incentive = new CGDAIncentive({ config: core._config, account: core._account }, { ... })
395
+ * ```
396
+ * @param {CGDAIncentivePayload} options
397
+ * @returns {CGDAIncentive}
398
+ */
399
+ CGDAIncentive(options: CGDAIncentivePayload): CGDAIncentive;
400
+ /**
401
+ * Bound {@link ERC20Incentive} constructor that reuses the same configuration as the Boost Core instance.
402
+ *
403
+ * @example
404
+ * ```ts
405
+ * const incentive = core.ERC20Incentive({ ... }) // is roughly equivalent to
406
+ * const incentive = new ERC20Incentive({ config: core._config, account: core._account }, { ... })
407
+ * ```
408
+ * @param {ERC20IncentivePayload} options
409
+ * @returns {ERC20Incentive}
410
+ */
411
+ ERC20Incentive(options: ERC20IncentivePayload): ERC20Incentive;
412
+ /**
413
+ * Bound {@link PointsIncentive} constructor that reuses the same configuration as the Boost Core instance.
414
+ *
415
+ * @example
416
+ * ```ts
417
+ * const incentive = core.PointsIncentive({ ... }) // is roughly equivalent to
418
+ * const incentive = new PointsIncentive({ config: core._config, account: core._account }, { ... })
419
+ * ```
420
+ * @param {PointsIncentivePayload} options
421
+ * @returns {PointsIncentive}
422
+ */
423
+ PointsIncentive(options: PointsIncentivePayload): PointsIncentive;
424
+ /**
425
+ * Bound {@link SignerValidator} constructor that reuses the same configuration as the Boost Core instance.
426
+ *
427
+ * @example
428
+ * ```ts
429
+ * const validator = core.SignerValidator({ ... }) // is roughly equivalent to
430
+ * const validator = new SignerValidator({ config: core._config, account: core._account }, { ... })
431
+ * ```
432
+ * @param {DeployablePayloadOrAddress<SignerValidatorPayload>} options
433
+ * @param {?boolean} [isBase]
434
+ * @returns {SignerValidator}
435
+ */
436
+ SignerValidator(options: DeployablePayloadOrAddress<SignerValidatorPayload>, isBase?: boolean): SignerValidator;
437
+ /**
438
+ * Bound {@link ERC20VariableIncentive} constructor that reuses the same configuration as the Boost Core instance.
439
+ *
440
+ * @example
441
+ * ```ts
442
+ * const validator = core.ERC20VariableIncentive({ ... }) // is roughly equivalent to
443
+ * const validator = new ERC20VariableIncentive({ config: core._config, account: core._account }, { ... })
444
+ * ```
445
+ * @param {DeployablePayloadOrAddress<ERC20VariableIncentivePayload>} options
446
+ * @param {?boolean} [isBase]
447
+ * @returns {ERC20VariableIncentive}
448
+ */
449
+ ERC20VariableIncentive(options: DeployablePayloadOrAddress<ERC20VariableIncentivePayload>, isBase?: boolean): ERC20VariableIncentive;
450
+ /**
451
+ * @inheritdoc
452
+ *
453
+ * @public
454
+ * @param {?[Address, Address]} [_payload]
455
+ * @param {?DeployableOptions} [_options]
456
+ * @returns {GenericDeployableParams}
457
+ */
458
+ buildParameters(_payload?: [Address, Address], _options?: DeployableOptions): GenericDeployableParams;
459
+ }
460
+ //# sourceMappingURL=BoostCore.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BoostCore.d.ts","sourceRoot":"","sources":["../src/BoostCore.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,KAAK,QAAQ,EAgBd,MAAM,eAAe,CAAC;AAIvB,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,iBAAiB,EACtB,KAAK,GAAG,EAIT,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,KAAK,MAAM,EAAqB,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,KAAK,SAAS,EAAwB,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EACL,eAAe,EACf,KAAK,sBAAsB,EAC5B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,cAAc,EACd,KAAK,qBAAqB,EAC3B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,KAAK,IAAI,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,KAAK,MAAM,EAAqB,MAAM,kBAAkB,CAAC;AAClE,OAAO,EACL,aAAa,EACb,KAAK,oBAAoB,EAC1B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,UAAU,EACV,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAC/B,KAAK,uBAAuB,EAC7B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,EAC/B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,aAAa,EACb,KAAK,oBAAoB,EAC1B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,cAAc,EACd,KAAK,qBAAqB,EAC3B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,sBAAsB,EACtB,KAAK,SAAS,EAEf,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,eAAe,EACf,KAAK,sBAAsB,EAC5B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,eAAe,EACf,KAAK,sBAAsB,EAC5B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,KAAK,SAAS,EAAwB,MAAM,wBAAwB,CAAC;AAO9E,OAAO,EACL,KAAK,6BAA6B,EAClC,KAAK,kBAAkB,EACvB,KAAK,UAAU,EAEf,KAAK,UAAU,EAEf,KAAK,WAAW,EAEjB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,YAAY,EAAE,CAAC;AAExB;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE,OACP,CAAC;AAE3B;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,CACtB,KAAK,SAAS,iBAAiB,CAAC,OAAO,YAAY,CAAC,GAAG,iBAAiB,CACtE,OAAO,YAAY,CACpB,IACC,UAAU,CAAC,OAAO,YAAY,EAAE,KAAK,CAAC,CAAC;AAE3C;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAaD;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE;;;;OAIG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAaD;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GACvB,wBAAwB,GACxB,2BAA2B,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,SAAU,SAAQ,UAAU,CACvC;IAAC,OAAO;IAAE,OAAO;CAAC,EAClB,OAAO,YAAY,CACpB;IACC;;;;;;;;OAQG;gBACS,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,eAAe,GAa1D;;;;;;;;OAQC;IACU,WAAW,CACtB,aAAa,EAAE,kBAAkB,EACjC,QAAQ,CAAC,EAAE,iBAAiB;IA6M9B;;;;;;;;;;;OAWG;IACU,cAAc,CACzB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,GAAG,EACT,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,YAAY,EAAE,gBAAgB,CAAC;IAO7D;;;;;;;;;;;OAWG;IACU,iBAAiB,CAC5B,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,GAAG,EACT,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,YAAY,EAAE,gBAAgB,CAAC;;;;IAgB7D;;;;;;;;OAQG;IACU,SAAS,CACpB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,EAAE,UAAU,CAAC;;;;;;;;;;;IAWtD;;;;;;;;OAQG;IACU,QAAQ,CACnB,GAAG,EAAE,MAAM,GAAG,MAAM,EACpB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,EAAE,UAAU,CAAC;IA2CtD;;;;;;;OAOG;IACU,aAAa,CACxB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,EAAE,eAAe,CAAC;IAW3D;;;;;;;;;OASG;IACU,YAAY,CACvB,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,EAAE,iBAAiB,CAAC,GACzD,UAAU,CAAC,OAAO,QAAQ,EAAE,cAAc,CAAC;IAY/C;;;;;;;OAOG;IACU,eAAe,CAC1B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,EAAE,iBAAiB,CAAC;IAW7D;;;;;;;;OAQG;IACU,kBAAkB,CAC7B,IAAI,EAAE,IAAI,EACV,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,YAAY,EAAE,oBAAoB,CAAC;IASjE;;;;;;;;OAQG;IACU,qBAAqB,CAChC,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,YAAY,EAAE,oBAAoB,CAAC;;;;IAgBjE;;;;;;;OAOG;IACU,WAAW,CACtB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,EAAE,aAAa,CAAC;IAWzD;;;;;;;OAOG;IACU,mBAAmB,CAC9B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,EAAE,qBAAqB,CAAC;IAWjE;;;;;;;;OAQG;IACU,oBAAoB,CAC/B,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,YAAY,EAAE,wBAAwB,CAAC;IASrE;;;;;;;;OAQG;IACU,uBAAuB,CAClC,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,YAAY,EAAE,wBAAwB,CAAC;;;;IAmBrE;;;;;;;OAOG;IACU,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,EAAE,UAAU,CAAC;IAU1E;;;;;;;;OAQG;IACU,WAAW,CACtB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,YAAY,EAAE,aAAa,CAAC;IAK1D;;;;;;;;OAQG;IACU,cAAc,CACzB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,YAAY,EAAE,aAAa,CAAC;;;;IAgB1D;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,OAAO;IA8BjC;;;;;;;OAOG;IACH,WAAW,CACT,OAAO,EAAE,0BAA0B,CAAC,kBAAkB,CAAC,EACvD,MAAM,CAAC,EAAE,OAAO;IA8BlB;;;;;;;;;;;OAWG;IACH,eAAe,CACb,OAAO,EAAE,0BAA0B,CAAC,sBAAsB,CAAC,EAC3D,MAAM,CAAC,EAAE,OAAO;IAQlB;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,OAAO,EAAE,0BAA0B,CAAC,qBAAqB,CAAC,EAC1D,MAAM,CAAC,EAAE,OAAO;IAyBlB;;;;;;;;;;OAUG;IACH,aAAa,CAAC,OAAO,EAAE,0BAA0B,CAAC,oBAAoB,CAAC;IAuBvE;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,OAAO,EAAE,yBAAyB;IAMrD;;;;;;;;;;OAUG;IACH,aAAa,CAAC,OAAO,EAAE,oBAAoB;IAM3C;;;;;;;;;;OAUG;IACH,cAAc,CAAC,OAAO,EAAE,qBAAqB;IAyB7C;;;;;;;;;;OAUG;IACH,eAAe,CAAC,OAAO,EAAE,sBAAsB;IAM/C;;;;;;;;;;;OAWG;IACH,eAAe,CACb,OAAO,EAAE,0BAA0B,CAAC,sBAAsB,CAAC,EAC3D,MAAM,CAAC,EAAE,OAAO;IAQlB;;;;;;;;;;;OAWG;IACH,sBAAsB,CACpB,OAAO,EAAE,0BAA0B,CAAC,6BAA6B,CAAC,EAClE,MAAM,CAAC,EAAE,OAAO;IASlB;;;;;;;OAOG;IACa,eAAe,CAC7B,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,EAC7B,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;CAY3B"}