@boostxyz/sdk 0.0.0-alpha.2 → 0.0.0-alpha.21

package/dist/utils.d.ts

@@ -1,6 +1,20 @@
 import { type Config, type ReadContractParameters, type WatchContractEventParameters, type WriteContractParameters } from '@wagmi/core';
 import type { ExtractAbiEvent } from 'abitype';
-import type { Abi, AbiEvent, Address, ContractEventName, ContractFunctionName, GetLogsParameters, Hash, Hex, Log, PrivateKeyAccount, WaitForTransactionReceiptParameters } from 'viem';
+import type { Abi, AbiEvent, Address, ContractEventName, ContractFunctionName, GetLogsParameters, Hash, Log, WaitForTransactionReceiptParameters } from 'viem';
+export type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
+/**
+ * Enum encapsulating all the different types of targets used in the Boost V2 Protocol.
+ *
+ * @export
+ * @enum {number}
+ */
+export declare enum RegistryType {
+    ACTION = 0,
+    ALLOW_LIST = 1,
+    BUDGET = 2,
+    INCENTIVE = 3,
+    VALIDATOR = 4
+}
 /**
  * Helper type that encapsulates common writeContract parameters without fields like `abi`, `args`, `functionName`, `address` that are expected to be provided the SDK.
  * See (writeContract)[https://viem.sh/docs/contract/writeContract]
@@ -10,7 +24,7 @@ import type { Abi, AbiEvent, Address, ContractEventName, ContractFunctionName, G
  * @template {Abi} abi
  * @template {ContractFunctionName<abi>} functionName
  */
-export type WriteParams<abi extends Abi, functionName extends ContractFunctionName<abi>> = Partial<Omit<WriteContractParameters<abi, functionName>, 'address' | 'args' | 'functionName' | 'abi'>>;
+export type WriteParams<abi extends Abi = Abi, functionName extends ContractFunctionName<abi> = ContractFunctionName<abi>> = Partial<Omit<WriteContractParameters<abi, functionName>, 'address' | 'args' | 'functionName' | 'abi'>>;
 /**
  * Helper type that encapsulates common readContract parameters without fields like `abi`, `args`, `functionName`, `address` that are expected to be provided the SDK.
  * See (readContract)[https://viem.sh/docs/contract/readContract]
@@ -63,7 +77,7 @@ export type GenericLog<abi extends Abi, event extends ContractEventName<abi> = C
  * @param {string} input
  * @returns {Hex}
  */
-export declare function bytes4(input: Hex): `0x${string}`;
+export declare function bytes4(input: string): `0x${string}`;
 /**
  * Utility function to wait for a transaction receipt, and extract the contractAddress
  *
@@ -72,7 +86,7 @@ export declare function bytes4(input: Hex): `0x${string}`;
  * @param {WagmiConfig} config - [Wagmi Configuration](https://wagmi.sh/core/api/createConfig)
  * @param {Promise<Hash>} hash - A transaction hash promise
  * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams] - @see {@link WaitForTransactionReceiptParameters}
- * @returns {unknown}
+ * @returns {Promise<Address>}
  * @throws {@link NoContractAddressUponReceiptError} if no `contractAddress` exists after the transaction has been received
  */
 export declare function getDeployedContractAddress(config: Config, hash: Promise<Hash>, waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>): Promise<`0x${string}`>;
@@ -100,1355 +114,17 @@ export type HashAndSimulatedResult<T = unknown> = {
  */
 export declare function awaitResult<Result = unknown>(config: Config, hashPromise: Promise<HashAndSimulatedResult<Result>>, waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>): Promise<Result>;
 /**
- * Enum encapsulating all the different types of targets used in the Boost V2 Protocol.
- *
- * @export
- * @enum {number}
- */
-export declare enum RegistryType {
-    ACTION = 0,
-    ALLOW_LIST = 1,
-    BUDGET = 2,
-    INCENTIVE = 3,
-    VALIDATOR = 4
-}
-/**
- * Enum representing incentive disbursement strategies.
- *
- * @export
- * @enum {number}
- */
-export declare enum StrategyType {
-    POOL = 0,
-    MINT = 1,
-    RAFFLE = 2
-}
-/**
- * Enum representing inventive disbursement strategies for {@link ERC1155Incentive}
- *
- * @export
- * @enum {number}
- */
-export declare enum ERC1155StrategyType {
-    POOL = 0,
-    MINT = 1
-}
-/**
- * Object representation of `BoostLib.Target` struct. Used for low level Boost creation operations.
- * This is used to pass the base contract and its initialization parameters in an efficient manner
- *
- * @export
- * @typedef {Target}
- */
-export type Target = {
-    isBase: boolean;
-    instance: Address;
-    parameters: Hex;
-};
-/**
- * Filter types used to determine how criteria are evaluated.
+ * Given a wagmi config and a map of chain id's to addresses, determine an address/chainId combo that maps to the currently connected chain id, or throw a typed error.
  *
  * @export
- * @enum {number}
+ * @param {Config} config
+ * @param {Record<string, Address>} addressByChainId
+ * @param {number} desiredChainId
+ * @returns {{ chainId: number, address: Address }}
+ * @throws {@link InvalidProtocolChainIdError}
  */
-export declare enum FilterType {
-    EQUAL = 0,
-    NOT_EQUAL = 1,
-    GREATER_THAN = 2,
-    LESS_THAN = 3,
-    CONTAINS = 4
-}
-/**
- * The primitive types supported for filtering.
- *
- * @export
- * @enum {number}
- */
-export declare enum PrimitiveType {
-    UINT = 0,
-    ADDRESS = 1,
-    BYTES = 2,
-    STRING = 3
-}
-/**
- * Object representation of a `Criteria` struct used in event actions.
- *
- * @export
- * @interface Criteria
- * @typedef {Criteria}
- */
-export interface Criteria {
-    /**
-     * The filter type used in this criteria.
-     *
-     * @type {FilterType}
-     */
-    filterType: FilterType;
-    /**
-     * The primitive type of the field being filtered.
-     *
-     * @type {PrimitiveType}
-     */
-    fieldType: PrimitiveType;
-    /**
-     * The index in the logs argument array where the field is located.
-     *
-     * @type {number}
-     */
-    fieldIndex: number;
-    /**
-     * The filter data used for complex filtering.
-     *
-     * @type {Hex}
-     */
-    filterData: Hex;
-}
-/**
- * Whether a given signature is an event or function
- *
- * @export
- * @enum {number}
- */
-export declare enum SignatureType {
-    EVENT = 0,
-    FUNC = 1
-}
-/**
- *  The payload describing how claimants are identified
- *
- * @export
- * @interface ActionClaimant
- * @typedef {ActionClaimant}
- */
-export interface ActionClaimant {
-    /**
-     * Whether claimaint is inferred from event or function
-     *
-     * @type {SignatureType}
-     */
-    signatureType: SignatureType;
-    /**
-     * The 4 byte signature of the event or function
-     *
-     * @type {Hex}
-     */
-    signature: Hex;
-    /**
-     * The index corresponding to claimant.
-     *
-     * @type {number}
-     */
-    fieldIndex: number;
-    /**
-     * The address of the target contract
-     *
-     * @type {Address}
-     */
-    targetContract: Address;
-}
-/**
- * Object representation of an `ActionStep` struct used in event actions.
- *
- * @export
- * @interface ActionStep
- * @typedef {ActionStep}
- */
-export interface ActionStep {
-    /**
-     * The signature of the event.
-     *
-     * @type {Hex}
-     */
-    signature: Hex;
-    /**
-     * Whether claimaint is inferred from event or function
-     *
-     * @type {SignatureType}
-     */
-    signatureType: SignatureType;
-    /**
-     * The type of action being performed.
-     *
-     * @type {number}
-     */
-    actionType: number;
-    /**
-     * The address of the target contract.
-     *
-     * @type {Address}
-     */
-    targetContract: Address;
-    /**
-     * The criteria used for this action event.
-     *
-     * @type {Criteria}
-     */
-    actionParameter: Criteria;
-}
-/**
- * Object representation of an `InitPayload` struct used to initialize event actions.
- *
- * @export
- * @interface EventActionPayload
- * @typedef {EventActionPayload}
- */
-export interface EventActionPayload {
-    /**
-     *  The payload describing how claimants are identified
-     *
-     * @type {ActionClaimant}
-     */
-    actionClaimant: ActionClaimant;
-    /**
-     * The first action event.
-     *
-     * @type {ActionStep}
-     */
-    actionStepOne: ActionStep;
-    /**
-     * The second action event.
-     *
-     * @type {ActionStep}
-     */
-    actionStepTwo: ActionStep;
-    /**
-     * The third action event.
-     *
-     * @type {ActionStep}
-     */
-    actionStepThree: ActionStep;
-    /**
-     * The fourth action event.
-     *
-     * @type {ActionStep}
-     */
-    actionStepFour: ActionStep;
-}
-/**
- * Function to properly encode an event action payload.
- *
- * @param {InitPayload} param0
- * @param {ActionStep} param0.actionStepOne - The first action event to initialize.
- * @param {ActionStep} param0.actionStepTwo - The second action event to initialize.
- * @param {ActionStep} param0.actionStepThree - The third action event to initialize.
- * @param {ActionStep} param0.actionStepFour - The fourth action event to initialize.
- * @returns {Hex}
- */
-export declare const prepareEventActionPayload: ({ actionClaimant, actionStepOne, actionStepTwo, actionStepThree, actionStepFour, }: EventActionPayload) => `0x${string}`;
-/**
- * Object representation of the `ERC20Incentive.InitPayload`.
- *
- * @export
- * @interface ERC20IncentivePayload
- * @typedef {ERC20IncentivePayload}
- */
-export interface ERC20IncentivePayload {
-    /**
-     * The address of the incentivized asset.
-     *
-     * @type {Address}
-     */
-    asset: Address;
-    /**
-     * The type of disbursement strategy for the incentive. `StrategyType.MINT` is not supported for `ERC20Incentives`
-     *
-     * @type {StrategyType}
-     */
-    strategy: StrategyType;
-    /**
-     * The amount of the asset to distribute.
-     *
-     * @type {bigint}
-     */
-    reward: bigint;
-    /**
-     * How many times can this incentive be claimed.
-     *
-     * @type {bigint}
-     */
-    limit: bigint;
-}
-/**
- * Object representing the payload for signing before validaton.
- *
- * @export
- * @interface SignerValidatorSignaturePayload
- * @typedef {SignerValidatorSignaturePayload}
- */
-export interface SignerValidatorSignaturePayload {
-    /**
-     * The ID of the boost.
-     *
-     * @type {bigint}
-     */
-    boostId: bigint;
-    /**
-     * The ID of the incentive.
-     *
-     * @type {number}
-     */
-    incentiveQuantity: number;
-    /**
-     * The address of the claimant.
-     *
-     * @type {Address}
-     */
-    claimant: Address;
-    /**
-     * The claim data.
-     *
-     * @type {Hex}
-     */
-    incentiveData: Hex;
-}
-/**
- * Object reprentation of a {@link SignerValidator} initialization payload
- *
- * @export
- * @interface SignerValidatorPayload
- * @typedef {SignerValidatorPayload}
- */
-export interface SignerValidatorPayload {
-    /**
-     * The list of authorized signers. The first address in the list will be the initial owner of the contract.
-     *
-     * @type {Address[]}
-     */
-    signers: Address[];
-    /**
-     * The authorized caller of the {@link prepareSignerValidator} function
-     * @type {Address}
-     */
-    validatorCaller: Address;
-}
-/**
- * Description placeholder
- *
- * @export
- * @interface SignerValidatorValidatePayload
- * @typedef {SignerValidatorValidatePayload}
- */
-export interface SignerValidatorValidatePayload {
-    /**
-     * The ID of the boost.
-     *
-     * @type {bigint}
-     */
-    boostId: bigint;
-    /**
-     * The ID of the incentive.
-     *
-     * @type {bigint}
-     */
-    incentiveId: bigint;
-    /**
-     * The address of the claimant.
-     *
-     * @type {Address}
-     */
-    claimant: Address;
-    /**
-     * The claim data.
-     *
-     * @type {Hex}
-     */
-    claimData: Hex;
-}
-/**
- * Given a {@link SignerValidatorPayload}, properly encode the initialization payload.
- *
- * @param {SignerValidatorPayload} param0
- * @param {Address[]} param0.signers
- * @param {Address} param0.validatorCaller
- * @returns {Hex}
- */
-export declare const prepareSignerValidatorPayload: ({ signers, validatorCaller, }: SignerValidatorPayload) => `0x${string}`;
-/**
- * Object representation of a {@link BoostClaimData} initialization payload
- *
- * @export
- * @interface BoostClaimData
- * @typedef {BoostClaimData}
- */
-export interface BoostClaimData {
-    /**
-     * The validator data.
-     *
-     * @type {Hex}
-     */
-    validatorData: Hex;
-    /**
-     * The incentive data.
-     *
-     * @type {Hex}
-     */
-    incentiveData: Hex;
-}
-/**
- * Given a {@link BoostClaimData}, properly encode the initialization payload.
- *
- * @param {BoostClaimData} param0
- * @param {Hex} param0.validatorData
- * @param {Hex} param0.incentiveData
- * @returns {Hex}
- */
-export declare const prepareBoostClaimData: ({ validatorData, incentiveData, }: BoostClaimData) => `0x${string}`;
-/**
- * Object representation of a {@link SignerValidatorInputParams} initialization payload
- *
- * @export
- * @interface SignerValidatorInputParams
- * @typedef {SignerValidatorInputParams}
- */
-export interface SignerValidatorInputParams {
-    /**
-     * The signer address.
-     *
-     * @type {Address}
-     */
-    signer: Address;
-    /**
-     * The signature data.
-     *
-     * @type {string}
-     */
-    signature: Hex;
-    /**
-     * The incentive quantity.
-     *
-     * @type {number}
-     */
-    incentiveQuantity: number;
-}
-/**
- * Given a {@link SignerValidatorInputParams}, properly encode the initialization payload.
- *
- * @param {SignerValidatorInputParams} param0
- * @param {Address} param0.signer
- * @param {Hex} param0.signature
- * @param {number} param0.incentiveQuantity
- * @returns {Hex}
- */
-export declare const prepareSignerValidatorInputParams: ({ signer, signature, incentiveQuantity, }: SignerValidatorInputParams) => `0x${string}`;
-/**
- * Signer Validator Claim Data Payload
- *
- * @export
- * @interface SignerValidatorClaimDataParams
- * @typedef {SignerValidatorClaimDataParams}
- */
-export interface SignerValidatorClaimDataParams {
-    /**
-     * The signer with which to sign the input
-     *
-     * @type {{
-     *     account: Address;
-     *     key: Hex;
-     *     privateKey: PrivateKeyAccount;
-     *   }}
-     */
-    signer: {
-        account: Address;
-        key: Hex;
-        privateKey: PrivateKeyAccount;
-    };
-    /**
-     * The encoded data to provide the underlying incentive. You can use {@link prepareAllowListIncentivePayload}, {@link prepareCGDAIncentivePayload}, {@link prepareERC20IncentivePayload}, {@link prepareERC1155IncentivePayload}, or {@link preparePointsIncentivePayload}
-     *
-     * @type {Hex}
-     */
-    incentiveData: Hex;
-    /**
-     * The chain id to target
-     *
-     * @type {number}
-     */
+export declare function assertValidAddressByChainId(config: Config, addressByChainId: Record<number, Address>, desiredChainId?: number): {
     chainId: number;
-    /**
-     * The address of the validator
-     *
-     * @type {Address}
-     */
-    validator: Address;
-    /**
-     * The incentive quantity.
-     *
-     * @type {number}
-     */
-    incentiveQuantity: number;
-    /**
-     * The address of the claimant
-     *
-     * @type {Address}
-     */
-    claimant: Address;
-    /**
-     * The ID of the boost
-     *
-     * @type {bigint}
-     */
-    boostId: bigint;
-}
-/**
- * Signer Validator Claim Data Payload Preparation
- *
- * @export
- * @async
- * @param {SignerValidatorClaimDataParams} param0
- * @param {{ account: Address; key: Hex; privateKey: PrivateKeyAccount; }} param0.signer
- * @param {Hex} param0.incentiveData
- * @param {number} param0.chainId
- * @param {Address} param0.validator
- * @param {number} param0.incentiveQuantity
- * @param {Address} param0.claimant
- * @param {bigint} param0.boostId
- * @returns {Promise<Hex>}
- */
-export declare function prepareSignerValidatorClaimDataPayload({ signer, incentiveData, chainId, validator, incentiveQuantity, claimant, boostId, }: SignerValidatorClaimDataParams): Promise<Hex>;
-/**
- * Object representation of a {@link SimpleAllowList} initialization payload.
- *
- * @export
- * @interface SimpleAllowListPayload
- * @typedef {SimpleAllowListPayload}
- */
-export interface SimpleAllowListPayload {
-    /**
-     * The allow list's owner, given the {@link LIST_MANAGER_ROLE} role.
-     *
-     * @type {Address}
-     */
-    owner: Address;
-    /**
-     * List of allowed addresses.
-     *
-     * @type {Address[]}
-     */
-    allowed: Address[];
-}
-/**
- * Given a {@link SimpleAllowListPayload}, properly encode the initialization payload.
- *
- * @param {SimpleAllowListPayload} param0
- * @param {Address} param0.owner - The allow list's owner, given the {@link LIST_MANAGER_ROLE} role.
- * @param {Address[]} param0.allowed - List of allowed addresses.
- * @returns {Hex}
- */
-export declare const prepareSimpleAllowListPayload: ({ owner, allowed, }: SimpleAllowListPayload) => `0x${string}`;
-/**
- * Object representation of a {@link SimpleDenyList} initialization payload.
- *
- * @export
- * @interface SimpleDenyListPayload
- * @typedef {SimpleDenyListPayload}
- */
-export interface SimpleDenyListPayload {
-    /**
-     * The allow list's owner
-     *
-     * @type {Address}
-     */
-    owner: Address;
-    /**
-     * List of denied addresses.
-     *
-     * @type {Address[]}
-     */
-    denied: Address[];
-}
-/**
- * Given a {@link SimpleDenyListPayload}, properly encode the initialization payload.
- *
- * @param {SimpleDenyListPayload} param0
- * @param {Address} param0.owner - The allow list's owner
- * @param {Address[]} param0.denied - List of denied addresses.
- * @returns {Hex}
- */
-export declare const prepareSimpleDenyListPayload: ({ owner, denied, }: SimpleDenyListPayload) => `0x${string}`;
-/**
- * Object representation of `BoostCore.InitPayload` struct.
- *
- * @export
- * @interface BoostPayload
- * @typedef {BoostPayload}
- */
-export interface BoostPayload {
-    /**
-     * Address to valid budget.
-     *
-     * @type {Address}
-     */
-    budget: Address;
-    /**
-     * Target for existing action, or base with initialization payload.
-     *
-     * @type {Target}
-     */
-    action: Target;
-    /**
-     * Target for existing validator, or base with initialization payload.
-     *
-     * @type {Target}
-     */
-    validator: Target;
-    /**
-     * Target for existing allowList, or base with initialization payload.
-     *
-     * @type {Target}
-     */
-    allowList: Target;
-    /**
-     * Targets for new incentives, with initialization payloads.
-     *
-     * @type {Target[]}
-     */
-    incentives: Target[];
-    /**
-     * The base protocol fee (in bps)
-     *
-     * @type {?bigint}
-     */
-    protocolFee?: bigint;
-    /**
-     * The base referral fee (in bps)
-     *
-     * @type {?bigint}
-     */
-    referralFee?: bigint;
-    /**
-     * Optional maximum amount of participants in the Boost.
-     *
-     * @type {?bigint}
-     */
-    maxParticipants?: bigint;
-    /**
-     * The owner of the Boost.
-     *
-     * @type {Address}
-     */
-    owner: Address;
-}
-/**
- * Given a valid {@link BoostPayload}, properly encode and compress the payload for use with `createBoost`
- *
- * @export
- * @param {BoostPayload} param0
- * @param {Address} param0.budget - Address to valid budget.
- * @param {Target} param0.action - Target for existing action, or base with initialization payload.
- * @param {Target} param0.validator - Target for existing validator, or base with initialization payload.
- * @param {Target} param0.allowList - Target for existing allowList, or base with initialization payload.
- * @param {Target[]} param0.incentives - Targets for new incentives, with initialization payloads.
- * @param {bigint} [param0.protocolFee=0n] - The base protocol fee (in bps)
- * @param {bigint} [param0.referralFee=0n] - The base referral fee (in bps)
- * @param {bigint} [param0.maxParticipants=0n] - Optional maximum amount of participants in the Boost.
- * @param {Address} param0.owner - The owner of the Boost.
- * @returns {Hex}
- */
-export declare function prepareBoostPayload({ budget, action, validator, allowList, incentives, protocolFee, referralFee, maxParticipants, owner, }: BoostPayload): Hex;
-/**
- * Object representation of
- *
- * @export
- * @interface ERC1155Payload
- * @typedef {ERC1155Payload}
- */
-export interface ERC1155Payload {
-    /**
-     * The ERC1155 token ID for the incentive
-     *
-     * @type {bigint}
-     */
-    tokenId: bigint;
-    /**
-     * The amount to transfer
-     *
-     * @type {bigint}
-     */
-    amount: bigint;
-}
-/**
- * Given a token ID and amount, properly encode a `ERC1155Incentive.ERC1155Payload` for use with {@link ERC1155Incentive} initialization.
- *
- * @export
- * @param {ERC1155Payload} param0
- * @param {bigint} param0.tokenId - The ERC1155 token ID for the incentive
- * @param {bigint} param0.amount - The amount to transfer
- * @returns {Hex}
- */
-export declare function prepareERC1155Payload({ tokenId, amount }: ERC1155Payload): `0x${string}`;
-/**
- * The object representation of a `PointsIncentive.InitPayload`
- *
- * @export
- * @interface PointsIncentivePayload
- * @typedef {PointsIncentivePayload}
- */
-export interface PointsIncentivePayload {
-    /**
-     * The address of the points contract
-     *
-     * @type {Address}
-     */
-    venue: Address;
-    /**
-     * The selector for the issuance function on the points contract
-     *
-     * @type {Hex}
-     */
-    selector: Hex;
-    /**
-     * The reward amount issued for each claim
-     *
-     * @type {bigint}
-     */
-    reward: bigint;
-    /**
-     *  The maximum number of claims that can be made (one per address)
-     *
-     * @type {bigint}
-     */
-    limit: bigint;
-}
-/**
- * Given a {@link PointsIncentivePayload}, properly encode a `PointsIncentive.InitPayload` for use with {@link PointsIncentive} initialization.
- *
- * @param {PointsIncentivePayload} param0
- * @param {Address} param0.venue - The address of the points contract
- * @param {Hex} param0.selector - The selector for the issuance function on the points contract
- * @param {bigint} param0.reward - The reward amount issued for each claim
- * @param {bigint} param0.limit -  The maximum number of claims that can be made (one per address)
- * @returns {*}
- */
-export declare const preparePointsIncentivePayload: ({ venue, selector, reward, limit, }: PointsIncentivePayload) => `0x${string}`;
-/**
- *  The configuration parameters for the CGDAIncentive
- *
- * @export
- * @interface CGDAParameters
- * @typedef {CGDAParameters}
- */
-export interface CGDAParameters {
-    /**
-     * The amount to subtract from the current reward after each claim
-     *
-     * @type {bigint}
-     */
-    rewardDecay: bigint;
-    /**
-     * The amount by which the reward increases for each hour without a claim (continuous linear increase)
-     *
-     * @type {bigint}
-     */
-    rewardBoost: bigint;
-    /**
-     * The timestamp of the last claim
-     *
-     * @type {bigint}
-     */
-    lastClaimTime: bigint;
-    /**
-     * The current reward amount
-     *
-     * @type {bigint}
-     */
-    currentReward: bigint;
-}
-/**
- * The object representation of a `CGDAIncentive.InitPayload`
- *
- * @export
- * @interface CGDAIncentivePayload
- * @typedef {CGDAIncentivePayload}
- */
-export interface CGDAIncentivePayload {
-    /**
-     * The address of the ERC20-like token
-     *
-     * @type {Address}
-     */
-    asset: Address;
-    /**
-     * The initial reward amount
-     *
-     * @type {bigint}
-     */
-    initialReward: bigint;
-    /**
-     * The amount to subtract from the current reward after each claim
-     *
-     * @type {bigint}
-     */
-    rewardDecay: bigint;
-    /**
-     * The amount by which the reward increases for each hour without a claim (continuous linear increase)
-     *
-     * @type {bigint}
-     */
-    rewardBoost: bigint;
-    /**
-     * The total budget for the incentive
-     *
-     * @type {bigint}
-     */
-    totalBudget: bigint;
-}
-/**
- * Given a {@link CGDAIncentivePayload}, properly encode a `CGDAIncentive.InitPayload` for use with {@link CGDAIncentive} initialization.
- *
- * @param {CGDAIncentivePayload} param0
- * @param {Address} param0.asset - The address of the ERC20-like token
- * @param {bigint} param0.initialReward - The initial reward amount
- * @param {bigint} param0.rewardDecay - The amount to subtract from the current reward after each claim
- * @param {bigint} param0.rewardBoost - The amount by which the reward increases for each hour without a claim (continuous linear increase)
- * @param {bigint} param0.totalBudget - The total budget for the incentive
- * @returns {Hex}
- */
-export declare const prepareCGDAIncentivePayload: ({ asset, initialReward, rewardDecay, rewardBoost, totalBudget, }: CGDAIncentivePayload) => `0x${string}`;
-/**
- * The object representation of a `ERC1155Incentive.InitPayload`
- *
- * @export
- * @interface ERC1155IncentivePayload
- * @typedef {ERC1155IncentivePayload}
- */
-export interface ERC1155IncentivePayload {
-    /**
-     * The address of the `ERC1155` asset
-     *
-     * @type {Address}
-     */
-    asset: Address;
-    /**
-     * Should be `Strategy.POOL`
-     *
-     * @type {ERC1155StrategyType}
-     */
-    strategy: ERC1155StrategyType;
-    /**
-     * The token ID to target
-     *
-     * @type {bigint}
-     */
-    tokenId: bigint;
-    /**
-     *  The maximum number of claims that can be made (one per address)
-     *
-     * @type {bigint}
-     */
-    limit: bigint;
-    /**
-     *  Any extra data to accompany the claim, if applicable.
-     *
-     * @type {Hex}
-     */
-    extraData: Hex;
-}
-/**
- * Given a {@link ERC1155IncentivePayload}, properly encode a `ERC1155Incentive.InitPayload` for use with {@link ERC1155Incentive} initialization.
- *
- * @param {ERC1155IncentivePayload} param0
- * @param {Address} param0.asset - The address of the `ERC1155` asset
- * @param {ERC1155StrategyType} param0.strategy - Should be `Strategy.POOL`
- * @param {bigint} param0.tokenId - The token ID to target
- * @param {bigint} param0.limit -  The maximum number of claims that can be made (one per address)
- * @param {Hex} param0.extraData - Any extra data to accompany the claim, if applicable.
- * @returns {Hex}
- */
-export declare const prepareERC1155IncentivePayload: ({ asset, strategy, tokenId, limit, extraData, }: ERC1155IncentivePayload) => `0x${string}`;
-/**
- * The object representation of a `AllowListIncentive.InitPayload`
- *
- * @export
- * @interface AllowListIncentivePayload
- * @typedef {AllowListIncentivePayload}
- */
-export interface AllowListIncentivePayload {
-    /**
-     * The address to the allowlist to add claimers to.
-     *
-     * @type {Address}
-     */
-    allowList: Address;
-    /**
-     *  The maximum number of claims that can be made (one per address)
-     *
-     * @type {bigint}
-     */
-    limit: bigint;
-}
-/**
- * Given a {@link AllowListIncentivePayload}, properly encode a `AllowListIncentive.InitPayload` for use with {@link AllowListIncentive} initialization.
- *
- * @param {AllowListIncentivePayload} param0
- * @param {Address} param0.allowList - The address to the allowlist to add claimers to.
- * @param {bigint} param0.limit -  The maximum number of claims that can be made (one per address)
- * @returns {Hex}
- */
-export declare const prepareAllowListIncentivePayload: ({ allowList, limit, }: AllowListIncentivePayload) => `0x${string}`;
-/**
- * The object representation of a `ERC20Incentive.InitPayload`
- *
- * @export
- * @interface ERC20IncentivePayload
- * @typedef {ERC20IncentivePayload}
- */
-export interface ERC20IncentivePayload {
-    /**
-     * The address of the incentivized asset.
-     *
-     * @type {Address}
-     */
-    asset: Address;
-    /**
-     * The type of disbursement strategy for the incentive. `StrategyType.MINT` is not supported for `ERC20Incentives`
-     *
-     * @type {StrategyType}
-     */
-    strategy: StrategyType;
-    /**
-     * The amount of the asset to distribute.
-     *
-     * @type {bigint}
-     */
-    reward: bigint;
-    /**
-     * How many times can this incentive be claimed.
-     *
-     * @type {bigint}
-     */
-    limit: bigint;
-}
-/**
- * Given a {@link ERC20IncentivePayload}, properly encode a `ERC20Incentive.InitPayload` for use with {@link ERC20Incentive} initialization.
- *
- * @param {ERC20IncentivePayload} param0
- * @param {Address} param0.asset - The address of the incentivized asset.
- * @param {StrategyType} param0.strategy - The type of disbursement strategy for the incentive. `StrategyType.MINT` is not supported for `ERC20Incentives`
- * @param {bigint} param0.reward - The amount of the asset to distribute.
- * @param {bigint} param0.limit - How many times can this incentive be claimed.
- * @returns {*}
- */
-export declare const prepareERC20IncentivePayload: ({ asset, strategy, reward, limit, }: ERC20IncentivePayload) => `0x${string}`;
-/**
- * The object representation of a `ERC20VariableIncentivePayload.InitPayload`
- *
- * @export
- * @interface ERC20VariableIncentivePayload
- * @typedef {ERC20VariableIncentivePayload}
- */
-export interface ERC20VariableIncentivePayload {
-    /**
-     * The address of the incentivized asset.
-     *
-     * @type {Address}
-     */
-    asset: Address;
-    /**
-     * The amount of the asset to distribute.
-     *
-     * @type {bigint}
-     */
-    reward: bigint;
-    /**
-     * How many times can this incentive be claimed.
-     *
-     * @type {bigint}
-     */
-    limit: bigint;
-}
-/**
- * Given a {@link ERC20VariableIncentivePayload}, properly encode a ` ERC20VariableIncentive.InitPayload` for use with {@link ERC20VariableIncentive} initialization.
- *
- * @param {ERC20VariableIncentivePayload} param0
- * @param {Address} param0.asset - The address of the incentivized asset.
- * @param {bigint} param0.reward - The amount of the asset to distribute.
- * @param {bigint} param0.limit - How many times can this incentive be claimed.
- * @returns {*}
- */
-export declare const prepareERC20VariableIncentivePayload: ({ asset, reward, limit, }: ERC20VariableIncentivePayload) => `0x${string}`;
-/**
- * The object representation of a `ContractAction.InitPayload`
- *
- * @export
- * @interface ContractActionPayload
- * @typedef {ContractActionPayload}
- */
-export interface ContractActionPayload {
-    /**
-     * The chain ID on which the target exists
-     *
-     * @type {bigint}
-     */
-    chainId: bigint;
-    /**
-     * The target contract address
-     *
-     * @type {Address}
-     */
-    target: Address;
-    /**
-     * The selector for the function to be called
-     *
-     * @type {Hex}
-     */
-    selector: Hex;
-    /**
-     * The native token value to send with the function call
-     *
-     * @type {bigint}
-     */
-    value: bigint;
-}
-/**
- * `ERC721MintActionPayload` is a re-exported `ContractActionPayload`
- *
- * @export
- * @typedef {ERC721MintActionPayload}
- */
-export type ERC721MintActionPayload = ContractActionPayload;
-/**
- * The object representation of a `SimpleBudgetPayload.InitPayload`
- *
- * @export
- * @interface SimpleBudgetPayload
- * @typedef {SimpleBudgetPayload}
- */
-export interface SimpleBudgetPayload {
-    /**
-     * The budget's owner
-     *
-     * @type {Address}
-     */
-    owner: Address;
-    /**
-     * List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
-     *
-     * @type {Address[]}
-     */
-    authorized: Address[];
-}
-/**
- * Given a {@link SimpleBudgetPayload}, properly encode a `SimpleBudget.InitPayload` for use with {@link SimpleBudget} initialization.
- *
- * @param {SimpleBudgetPayload} param0
- * @param {Address} param0.owner - The budget's owner
- * @param {{}} param0.authorized - List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
- * @returns {*}
- */
-export declare const prepareSimpleBudgetPayload: ({ owner, authorized, }: SimpleBudgetPayload) => `0x${string}`;
-/**
- * The object representation of a `ManagedBudgetPayload.InitPayload`
- *
- * @export
- * @interface ManagedBudgetPayload
- * @typedef {ManagedBudgetPayload}
- */
-export interface ManagedBudgetPayload {
-    /**
-     * The budget's owner
-     *
-     * @type {Address}
-     */
-    owner: Address;
-    /**
-     * List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
-     *
-     * @type {Address[]}
-     */
-    authorized: Address[];
-    /**
-     * List of roles to assign to the corresponding account by index.
-     *
-     * @type {bigint[]}
-     */
-    roles: bigint[];
-}
-/**
- * Given a {@link ManagedBudgetPayload}, properly encode a `ManagedBudget.InitPayload` for use with {@link ManagedBudget} initialization.
- *
- * @param {ManagedBudgetPayload} param0
- * @param {Address} param0.owner - The budget's owner
- * @param {{}} param0.authorized - List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
- * @param {{}} param0.roles - List of roles to assign to the corresponding account by index.
- * @returns {*}
- */
-export declare const prepareManagedBudgetPayload: ({ owner, authorized, roles, }: ManagedBudgetPayload) => `0x${string}`;
-/**
- * The object representation of a `VestingBudget.InitPayload`
- *
- * @export
- * @interface VestingBudgetPayload
- * @typedef {VestingBudgetPayload}
- */
-export interface VestingBudgetPayload {
-    /**
-     * The budget's owner.
-     *
-     * @type {Address}
-     */
-    owner: Address;
-    /**
-     * List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
-     *
-     * @type {Address[]}
-     */
-    authorized: Address[];
-    /**
-     * The timestamp at which the vesting schedule begins
-     *
-     * @type {bigint}
-     */
-    start: bigint;
-    /**
-     * The duration of the vesting schedule (in seconds)
-     *
-     * @type {bigint}
-     */
-    duration: bigint;
-    /**
-     * The duration of the cliff period (in seconds)
-     *
-     * @type {bigint}
-     */
-    cliff: bigint;
-}
-/**
- * Given a {@link VestingBudgetPayload}, properly encode a `VestingBudget.InitPayload` for use with {@link VestingBudget} initialization.
- *
- * @param {VestingBudgetPayload} param0
- * @param {Address} param0.owner - The budget's owner.
- * @param {{}} param0.authorized - List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
- * @param {bigint} param0.start - The timestamp at which the vesting schedule begins
- * @param {bigint} param0.duration - The duration of the vesting schedule (in seconds)
- * @param {bigint} param0.cliff - The duration of the cliff period (in seconds)
- * @returns {Hex}
- */
-export declare const prepareVestingBudgetPayload: ({ owner, authorized, start, duration, cliff, }: VestingBudgetPayload) => `0x${string}`;
-/**
- * Given a {@link ContractActionPayload}, properly encode a `ContractAction.InitPayload` for use with {@link ContractAction} initialization.
- *
- * @param {ContractActionPayload} param0
- * @param {bigint} param0.chainId - The chain ID on which the target exists
- * @param {Address} param0.target - The target contract address
- * @param {Hex} param0.selector - The selector for the function to be called
- * @param {bigint} param0.value - The native token value to send with the function call
- * @returns {Hex}
- */
-export declare const prepareContractActionPayload: ({ chainId, target, selector, value, }: ContractActionPayload) => `0x${string}`;
-/**
- * Given a {@link ContractActionPayload}, properly encode a `ContractAction.InitPayload` for use with {@link ERC721MintAction} initialization.
- *
- * @param {ContractActionPayload} param0
- * @param {bigint} param0.chainId - The chain ID on which the target exists
- * @param {Address} param0.target - The target contract address
- * @param {Hex} param0.selector - The selector for the function to be called
- * @param {bigint} param0.value - The native token value to send with the function call
- * @returns {*}
- */
-export declare const prepareERC721MintActionPayload: ({ chainId, target, selector, value, }: ContractActionPayload) => `0x${string}`;
-/**
- * The object representation of an `Incentive.ClaimPayload`
- *
- * @export
- * @interface ClaimPayload
- * @typedef {ClaimPayload}
- */
-export interface ClaimPayload {
-    /**
-     * The address of the recipient
-     *
-     * @type {Address}
-     */
-    target: Address;
-    /**
-     * The implementation-specific data for the claim, if needed
-     *
-     * @type {?Hex}
-     */
-    data?: Hex;
-}
-/**
- * Given a valid {@link ClaimPayload}, encode the payload for use with Incentive operations.
- *
- * @param {ClaimPayload} param0
- * @param {Address} param0.target - The address of the recipient
- * @param {Hex} [param0.data=zeroHash] - The implementation-specific data for the claim, if needed
- * @returns {*}
- */
-export declare const prepareClaimPayload: ({ target, data, }: ClaimPayload) => `0x${string}`;
-/**
- * The various types of assets supported in Budgets and Incentives.
- *
- * @export
- * @enum {number}
- */
-export declare enum AssetType {
-    ETH = 0,
-    ERC20 = 1,
-    ERC1155 = 2
-}
-/**
- * Object representation of a generic `Transfer` struct.
- *
- * @export
- * @interface TransferPayload
- * @typedef {TransferPayload}
- */
-export interface TransferPayload {
-    /**
-     * The type of the asset being transferred.
-     *
-     * @type {AssetType}
-     */
-    assetType: AssetType;
-    /**
-     * The address of the asset to transfer, zero address for ETH.
-     *
-     * @type {Address}
-     */
     address: Address;
-    /**
-     * The account from which to transfer the assets.
-     *
-     * @type {Address}
-     */
-    target: Address;
-    /**
-     * An encoded {@link FungiblePayload}, use {@link prepareFungiblePayload} to construct.
-     *
-     * @type {Hex}
-     */
-    data: Hex;
-}
-/**
- * Encodes parameters for transferring the transfer of Fungible and ERC1155 assets, used for {@link Budget} operations.
- * Typically you'd use {@link prepareFungibleTransfer} or {@link prepareERC1155Transfer}
- *
- * @param {TransferPayload} param0
- * @param {AssetType} param0.assetType - The asset type being transferred.
- * @param {Address} param0.address - The address of the asset, use zero address for ETH transfers.
- * @param {Address} param0.target - The address of the account being transferred from
- * @param {Hex} param0.data - Use {@link prepareFungiblePayload} to properly encode an amount to transfer
- * @returns {Hex}
- */
-export declare const prepareTransferPayload: ({ assetType, address, target, data, }: TransferPayload) => `0x${string}`;
-/**
- * An object representation of the `Budget.Transfer` contract struct for transfers of ERC1155 assets.
- *
- * @export
- * @interface ERC1155TransferPayload
- * @typedef {ERC1155TransferPayload}
- */
-export interface ERC1155TransferPayload {
-    /**
-     * The token ID to transfer
-     *
-     * @type {bigint}
-     */
-    tokenId: bigint;
-    /**
-     * The amount to transfer
-     *
-     * @type {bigint}
-     */
-    amount: bigint;
-    /**
-     * The address of the asset to target
-     *
-     * @type {Address}
-     */
-    asset: Address;
-    /**
-     * The account to transfer from
-     *
-     * @type {Address}
-     */
-    target: Address;
-}
-/**
- * Encodes parameters for transferring the transfer of ERC1155 assets, used for {@link Budget} operations.
- * The caller must have already approved the contract to transfer the asset.
- *
- * @export
- * @param {ERC1155TransferPayload} param0
- * @param {bigint} param0.tokenId - The token ID to transfer
- * @param {bigint} param0.amount - The amount to transfer
- * @param {Address} param0.asset - The address of the asset to target
- * @param {Address} param0.target - The account to transfer from
- * @returns {Hex}
- */
-export declare function prepareERC1155Transfer({ tokenId, amount, asset, target, }: ERC1155TransferPayload): `0x${string}`;
-/**
- * An object representation of the `FungiblePayload` struct
- *
- * @export
- * @interface FungiblePayload
- * @typedef {FungiblePayload}
- */
-export interface FungiblePayload {
-    /**
-     * The amount being transferred
-     *
-     * @type {bigint}
-     */
-    amount: bigint;
-}
-/**
- * Encodes an amount for the `FungiblePayload` struct
- *
- * @export
- * @param {FungiblePayload} param0
- * @param {bigint} param0.amount - The amount being transferred
- * @returns {*}
- */
-export declare function prepareFungiblePayload({ amount }: FungiblePayload): `0x${string}`;
-/**
- * An object representation of the `Budget.Transfer` contract struct for transfers of fungible assets.
- *
- * @export
- * @interface FungibleTransferPayload
- * @typedef {FungibleTransferPayload}
- */
-export interface FungibleTransferPayload {
-    /**
-     * The amount to transfer
-     *
-     * @type {bigint}
-     */
-    amount: bigint;
-    /**
-     * The address of the asset. Use zero address for ETH transfers.
-     *
-     * @type {Address}
-     */
-    asset: Address;
-    /**
-     * The account to transfer from
-     *
-     * @type {Address}
-     */
-    target: Address;
-}
-/**
- * Encodes parameters for a Fungible transfer, used for Budget allocations.
- * The caller must have already approved the contract to transfer the asset.
- *
- * @export
- * @param {FungibleTransferPayload} param0
- * @param {bigint} param0.amount - The amount to transfer
- * @param {Address} param0.asset - The address of the asset. Use zero address for ETH transfers.
- * @param {Address} param0.target - The account to transfer from
- * @returns {Hex}
- */
-export declare function prepareFungibleTransfer({ amount, asset, target, }: FungibleTransferPayload): `0x${string}`;
-/**
- * Encodes a payload to validate that an action has been completed successfully.
- *
- *
- * @export
- * @param {Address} holder - The holder address
- * @param {bigint} payload - The token ID
- * @returns {Hex} - The first 20 bytes of the payload will be the holder address and the remaining bytes must be an encoded token ID (uint256)
- */
-export declare function prepareERC721MintActionValidate(holder: Address, payload: bigint): `0x${string}`;
+};
 //# sourceMappingURL=utils.d.ts.map