@boostxyz/sdk 4.0.0 → 5.1.0

package/dist/Incentives/ERC20PeggedVariableCriteriaIncentive.d.ts

@@ -0,0 +1,1035 @@
+import { erc20PeggedVariableCriteriaIncentiveAbi } from '@boostxyz/evm';
+import { type Address, type ContractEventName } from 'viem';
+import type { DeployableOptions, GenericDeployableParams } from '../Deployable/Deployable';
+import { DeployableTarget } from '../Deployable/DeployableTarget';
+import { type ClaimPayload } from '../claiming';
+import { type GenericLog, type ReadParams, RegistryType, type WriteParams } from '../utils';
+import type { GetIncentiveScalarParams, IncentiveCriteria } from './ERC20VariableCriteriaIncentive';
+export { erc20PeggedVariableCriteriaIncentiveAbi };
+/**
+ * The object representation of a `Erc20PeggedVariableCriteriaIncentive.InitPayload`
+ *
+ * @export
+ * @interface Erc20PeggedVariableCriteriaIncentive
+ * @typedef {Erc20PeggedVariableCriteriaIncentive}
+ */
+export interface ERC20PeggedVariableCriteriaIncentivePayload {
+    /**
+     * The address of the incentivized asset.
+     *
+     * @type {Address}
+     */
+    asset: Address;
+    /**
+     * The peg to normalize to.
+     *
+     * @type {Address}
+     */
+    peg: Address;
+    /**
+     * The amount of the asset to distribute.
+     *
+     * @type {bigint}
+     */
+    reward: bigint;
+    /**
+     * Total spend for the incentive.
+     *
+     * @type {bigint}
+     */
+    limit: bigint;
+    /**
+     * Maximum reward each claim is elligible for.
+     *
+     * @type {bigint}
+     */
+    maxReward: bigint;
+    /**
+     * (Optional) The address of the entity that can managed the incentive.
+     *
+     * @type {Address}
+     * @optional
+     */
+    manager?: Address;
+    /**
+     * The criteria for the incentive that determines how the reward is distributed.
+     *
+     * @type {IncentiveCriteria}
+     */
+    criteria: IncentiveCriteria;
+}
+/**
+ * A generic `viem.Log` event with support for `Erc20PeggedVariableCriteriaIncentive` event types.
+ *
+ * @export
+ * @typedef {Erc20PeggedVariableCriteriaIncentiveLog}
+ * @template {ContractEventName<typeof erc20PeggedVariableCriteriaIncentiveAbi>} [event=ContractEventName<
+ *     typeof erc20PeggedVariableCriteriaIncentiveAbi
+ *   >]
+ */
+export type Erc20PeggedVariableCriteriaIncentiveLog<event extends ContractEventName<typeof erc20PeggedVariableCriteriaIncentiveAbi> = ContractEventName<typeof erc20PeggedVariableCriteriaIncentiveAbi>> = GenericLog<typeof erc20PeggedVariableCriteriaIncentiveAbi, event>;
+/**
+ * A simple ERC20 incentive implementation that allows claiming of tokens
+ *
+ * @export
+ * @class Erc20PeggedVariableCriteriaIncentive
+ * @typedef {ERC20PeggedVariableCriteriaIncentive}
+ * @extends {DeployableTarget<ERC20PeggedVariableCriteriaIncentive>}
+ */
+export declare class ERC20PeggedVariableCriteriaIncentive extends DeployableTarget<ERC20PeggedVariableCriteriaIncentivePayload, typeof erc20PeggedVariableCriteriaIncentiveAbi> {
+    readonly abi: readonly [{
+        readonly type: "constructor";
+        readonly inputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "AlreadyInitialized";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "ClaimFailed";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "CloneAlreadyInitialized";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InitializerNotImplemented";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [{
+            readonly name: "asset";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "available";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "required";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "InsufficientFunds";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InvalidInitialization";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InvalidInitialization";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InvalidInitializationData";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "LengthMismatch";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NewOwnerIsZeroAddress";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NoHandoverRequest";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NotClaimable";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NotInitializing";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "Unauthorized";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "recipient";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "data";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+            readonly indexed: false;
+        }];
+        readonly name: "Claimed";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "asset";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "peg";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "reward";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "limit";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "manager";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: false;
+        }, {
+            readonly name: "maxReward";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "criteria";
+            readonly internalType: "struct AERC20PeggedVariableCriteriaIncentive.IncentiveCriteria";
+            readonly type: "tuple";
+            readonly components: readonly [{
+                readonly name: "criteriaType";
+                readonly internalType: "enum SignatureType";
+                readonly type: "uint8";
+            }, {
+                readonly name: "signature";
+                readonly internalType: "bytes32";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "fieldIndex";
+                readonly internalType: "uint8";
+                readonly type: "uint8";
+            }, {
+                readonly name: "targetContract";
+                readonly internalType: "address";
+                readonly type: "address";
+            }];
+            readonly indexed: false;
+        }];
+        readonly name: "ERC20PeggedIncentiveInitialized";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "version";
+            readonly internalType: "uint64";
+            readonly type: "uint64";
+            readonly indexed: false;
+        }];
+        readonly name: "Initialized";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }];
+        readonly name: "OwnershipHandoverCanceled";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }];
+        readonly name: "OwnershipHandoverRequested";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "oldOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "newOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }];
+        readonly name: "OwnershipTransferred";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: true;
+        }];
+        readonly name: "RolesUpdated";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "ADMIN_ROLE";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "MANAGER_ROLE";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "asset";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "cancelOwnershipHandover";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "claimTarget";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "claim";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "claimed";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "claims";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "clawback";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "completeOwnershipHandover";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "currentReward";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "getComponentInterface";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }];
+        readonly stateMutability: "pure";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "getIncentiveCriteria";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "struct AERC20PeggedVariableCriteriaIncentive.IncentiveCriteria";
+            readonly type: "tuple";
+            readonly components: readonly [{
+                readonly name: "criteriaType";
+                readonly internalType: "enum SignatureType";
+                readonly type: "uint8";
+            }, {
+                readonly name: "signature";
+                readonly internalType: "bytes32";
+                readonly type: "bytes32";
+            }, {
+                readonly name: "fieldIndex";
+                readonly internalType: "uint8";
+                readonly type: "uint8";
+            }, {
+                readonly name: "targetContract";
+                readonly internalType: "address";
+                readonly type: "address";
+            }];
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "getMaxReward";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "getPeg";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "accounts_";
+            readonly internalType: "address[]";
+            readonly type: "address[]";
+        }, {
+            readonly name: "roles_";
+            readonly internalType: "uint256[]";
+            readonly type: "uint256[]";
+        }];
+        readonly name: "grantManyRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "grantRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "hasAllRoles";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "hasAnyRole";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "incentiveCriteria";
+        readonly outputs: readonly [{
+            readonly name: "criteriaType";
+            readonly internalType: "enum SignatureType";
+            readonly type: "uint8";
+        }, {
+            readonly name: "signature";
+            readonly internalType: "bytes32";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "fieldIndex";
+            readonly internalType: "uint8";
+            readonly type: "uint8";
+        }, {
+            readonly name: "targetContract";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "initialize";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "account_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "isAuthorized";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "claimTarget";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "isClaimable";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "limit";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "owner";
+        readonly outputs: readonly [{
+            readonly name: "result";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "ownershipHandoverExpiresAt";
+        readonly outputs: readonly [{
+            readonly name: "result";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "peg";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "preflight";
+        readonly outputs: readonly [{
+            readonly name: "budgetData";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "renounceOwnership";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "renounceRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "requestOwnershipHandover";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "accounts_";
+            readonly internalType: "address[]";
+            readonly type: "address[]";
+        }, {
+            readonly name: "roles_";
+            readonly internalType: "uint256[]";
+            readonly type: "uint256[]";
+        }];
+        readonly name: "revokeManyRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "revokeRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "reward";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "rolesOf";
+        readonly outputs: readonly [{
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "accounts_";
+            readonly internalType: "address[]";
+            readonly type: "address[]";
+        }, {
+            readonly name: "authorized_";
+            readonly internalType: "bool[]";
+            readonly type: "bool[]";
+        }];
+        readonly name: "setAuthorized";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "interfaceId";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }];
+        readonly name: "supportsInterface";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "totalClaim";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "totalClaimed";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "newOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "transferOwnership";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }];
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @static
+     * @type {Record<number, Address>}
+     */
+    static bases: Record<number, Address>;
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @static
+     * @type {RegistryType}
+     */
+    static registryType: RegistryType;
+    /**
+     * The owner of the incentive
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<Address>}
+     */
+    owner(params?: ReadParams): Promise<`0x${string}`>;
+    /**
+     * Calculates the current reward based on the time since the last claim. The reward is calculated based on the time since the last claim, the available budget, and the reward parameters. It increases linearly over time in the absence of claims, with each hour adding `rewardBoost` to the current reward, up to the available budget. For example, if there is one claim in the first hour, then no claims for three hours, the claimable reward would be `initialReward - rewardDecay + (rewardBoost * 3)`
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>} - The current reward
+     */
+    currentReward(params?: ReadParams): Promise<bigint>;
+    /**
+     * Retrieves the maximum reward amount per claim.
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>} The maximum reward amount per claim
+     */
+    getMaxReward(params?: ReadParams): Promise<bigint>;
+    /**
+     * Fetches the incentive scalar from a transaction hash
+     *
+     * @param {GetIncentiveScalarParams} params
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>}
+     * @throws {InvalidCriteriaTypeError | NoMatchingLogsError | DecodedArgsError}
+     */
+    getIncentiveScalar({ chainId, hash, knownSignatures }: GetIncentiveScalarParams, params?: ReadParams): Promise<bigint>;
+    /**
+     * The number of claims that have been made
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>}
+     */
+    claims(params?: ReadParams): Promise<bigint>;
+    /**
+     * The total amount of rewards claimed
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>}
+     */
+    totalClaimed(params?: ReadParams): Promise<bigint>;
+    /**
+     * A mapping of address to claim status
+     *
+     * @public
+     * @async
+     * @param {Address} address
+     * @param {?ReadParams} [params]
+     * @returns {Promise<boolean>}
+     */
+    claimed(address: Address, params?: ReadParams): Promise<boolean>;
+    /**
+     * The address of the ERC20-like token
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<Address>}
+     */
+    asset(params?: ReadParams): Promise<`0x${string}`>;
+    /**
+     * The address of the pegged ERC20-like token
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<Address>}
+     */
+    peg(params?: ReadParams): Promise<`0x${string}`>;
+    /**
+     * The reward amount issued for each claim
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>}
+     */
+    reward(params?: ReadParams): Promise<bigint>;
+    /**
+     * The limit (max possible rewards payout in reward token)
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>}
+     */
+    limit(params?: ReadParams): Promise<bigint>;
+    /**
+     * Claim the incentive
+     *
+     * @public
+     * @async
+     * @param {ClaimPayload} payload
+     * @param {?WriteParams} [params]
+     * @returns {Promise<boolean>} - Returns true if successfully claimed
+     */
+    protected claim(payload: ClaimPayload, params?: WriteParams): Promise<boolean>;
+    /**
+     * Claim the incentive
+     *
+     * @public
+     * @async
+     * @param {ClaimPayload} payload
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - Returns true if successfully claimed
+     */
+    protected claimRaw(payload: ClaimPayload, params?: WriteParams): Promise<{
+        hash: `0x${string}`;
+        result: boolean;
+    }>;
+    /**
+     * Clawback assets from the incentive
+     *
+     * @public
+     * @async
+     * @param {ClaimPayload} payload
+     * @param {?WriteParams} [params]
+     * @returns {Promise<boolean>} -  True if the assets were successfully clawbacked
+     */
+    clawback(payload: ClaimPayload, params?: WriteParams): Promise<readonly [bigint, `0x${string}`]>;
+    /**
+     * Clawback assets from the incentive
+     *
+     * @public
+     * @async
+     * @param {ClaimPayload} payload
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} -  True if the assets were successfully clawbacked
+     */
+    clawbackRaw(payload: ClaimPayload, params?: WriteParams): Promise<{
+        hash: `0x${string}`;
+        result: readonly [bigint, `0x${string}`];
+    }>;
+    /**
+     * Check if an incentive is claimable.
+     *
+     * @public
+     * @async
+     * @param {ClaimPayload} payload
+     * @param {?ReadParams} [params]
+     * @returns {Promise<boolean>} = True if the incentive is claimable based on the data payload
+     */
+    isClaimable(payload: ClaimPayload, params?: ReadParams): Promise<boolean>;
+    /**
+     * read the peg token for the incentive.
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<Address>} = The address of the token the reward is pegged to
+     */
+    getPeg(params?: ReadParams): Promise<`0x${string}`>;
+    /**
+     * Get the maximum amount that can be claimed by this incentive. Useful when used in conjunction with `BoostCore.calculateProtocolFee`
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>} = Return a bigint representing that maximum amount that can be distributed by this incentive.
+     */
+    getTotalBudget(params?: ReadParams): Promise<bigint>;
+    /**
+     * Check if any claims remain by comparing the incentive's total claims against its limit. Does not take requesting user's elligibility into account.
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<boolean>} - True if total claims is less than limit
+     */
+    canBeClaimed(params?: ReadParams): Promise<boolean>;
+    /**
+     * Check how many claims remain by comparing the incentive's total claims against its limit. Does not take requesting user's elligibility into account.
+     *
+     * @public
+     * @async
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>} - True if total claims is less than limit
+     */
+    getRemainingClaimPotential(params?: ReadParams): Promise<bigint>;
+    /**
+     *Functions from the ERC20VariableIncentive contract
+     */
+    /**
+     * Fetches the IncentiveCriteria struct from the contract
+     *
+     * @param {?ReadParams} [params]
+     * @returns {Promise<IncentiveCriteria>} Incentive criteria structure
+     * @throws {IncentiveCriteriaNotFoundError}
+     */
+    getIncentiveCriteria(params?: ReadParams): Promise<IncentiveCriteria>;
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @param {?ERC20PeggedVariableCriteriaIncentivePayload} [_payload]
+     * @param {?DeployableOptions} [_options]
+     * @returns {GenericDeployableParams}
+     */
+    buildParameters(_payload?: ERC20PeggedVariableCriteriaIncentivePayload, _options?: DeployableOptions): GenericDeployableParams;
+    /**
+     * Encodes an amount to clawback from the incentive
+     *
+     * @public
+     * @param {bigint} amount - How much of the asset to clawback
+     * @returns {Hex} - Returns an encoded uint256
+     */
+    buildClawbackData(amount: bigint): `0x${string}`;
+    /**
+     * Builds the claim data for the ERC20PeggedVariableCriteriaIncentivePayload.
+     *
+     * @public
+     * @param {bigint} rewardAmount
+     * @returns {Hash} Returns the encoded claim data
+     * @description This function returns the encoded claim data for the ERC20PeggedVariableCriteriaIncentivePayload.
+     */
+    buildClaimData(rewardAmount: bigint): `0x${string}`;
+}
+/**
+ * Given a {@link ERC20PeggedVariableCriteriaIncentivePayload}, properly encode a `ERC20PeggedVariableCriteriaIncentivePayload.InitPayload` for use with {@link ERC20PeggedVariableCriteriaIncentivePayload} initialization.
+ *
+ * @param {ERC20PeggedVariableCriteriaIncentivePayload} param0
+ * @param {Address} param0.asset - The address of the incentivized asset.
+ * @param {Address} param0.peg - The peg to normalize to.
+ * @param {bigint} param0.reward - The amount of the asset to distribute.
+ * @param {bigint} param0.limit - How many times can this incentive be claimed.
+ * @param {Address} [param0.manager=zeroAddress] - The entity that can manage the incentive.
+ * @param {IncentiveCriteria} param0.criteria - The incentive criteria for reward distribution.
+ * @returns {Hex}
+ */
+export declare function prepareERC20PeggedVariableCriteriaIncentivePayload({ asset, peg, reward, limit, maxReward, manager, criteria, }: ERC20PeggedVariableCriteriaIncentivePayload): `0x${string}`;
+//# sourceMappingURL=ERC20PeggedVariableCriteriaIncentive.d.ts.map