@boostxyz/sdk 7.0.0-canary.0 → 7.0.0-canary.1

package/dist/Incentives/ERC20VariableCriteriaIncentive.d.ts

@@ -0,0 +1,884 @@
+import { erc20VariableCriteriaIncentiveAbi } from '@boostxyz/evm';
+import { type AbiEvent, type AbiFunction, type Address, type Hex } from 'viem';
+import { SignatureType } from '../Actions/EventAction';
+import type { DeployableOptions, GenericDeployableParams } from '../Deployable/Deployable';
+import { type ReadParams } from '../utils';
+import { ERC20VariableIncentive } from './ERC20VariableIncentive';
+export { erc20VariableCriteriaIncentiveAbi };
+export interface ERC20VariableCriteriaIncentivePayload {
+    /**
+     * The address of the incentivized asset.
+     *
+     * @type {Address}
+     */
+    asset: Address;
+    /**
+     * The amount of the asset to distribute as reward.
+     *
+     * @type {bigint}
+     */
+    reward: bigint;
+    /**
+     * The total spending limit of the asset that will be distributed.
+     *
+     * @type {bigint}
+     */
+    limit: bigint;
+    /**
+     * The total amount claimable in a single claim or maximum per-action reward.
+     *
+     * @type {bigint}
+     * @optional
+     */
+    maxReward?: bigint;
+    /**
+     * The criteria for the incentive that determines how the reward is distributed.
+     *
+     * @type {IncentiveCriteria}
+     */
+    criteria: IncentiveCriteria;
+}
+export interface IncentiveCriteria {
+    /**
+     * The type of criteria used, either function signature or event signature.
+     *
+     * @type {SignatureType}
+     */
+    criteriaType: SignatureType;
+    /**
+     * The function or event signature used for criteria matching.
+     *
+     * @type {Hex}
+     */
+    signature: Hex;
+    /**
+     * The index of the field from where the scalar value is extracted.
+     *
+     * @type {number}
+     */
+    fieldIndex: number;
+    /**
+     * The address of the contract where the event/function is called/emitted.
+     *
+     * @type {Address}
+     */
+    targetContract: Address;
+}
+export interface ReadIncentiveCriteriaParams extends ReadParams {
+}
+export interface GetIncentiveScalarParams {
+    chainId: number;
+    hash: Hex;
+    knownSignatures: Record<Hex, AbiFunction | AbiEvent>;
+}
+/**
+ * Extended ERC20 Variable Criteria Incentive class that fetches incentive criteria and scalar
+ *
+ * @export
+ * @deprecated Please use only v2 implementations
+ * @class ERC20VariableCriteriaIncentive
+ * @typedef {ERC20VariableCriteriaIncentive}
+ * @extends {ERC20VariableIncentive<ERC20VariableCriteriaIncentivePayload, typeof erc20VariableCriteriaIncentiveAbi>}
+ */
+export declare class ERC20VariableCriteriaIncentive extends ERC20VariableIncentive<ERC20VariableCriteriaIncentivePayload, typeof erc20VariableCriteriaIncentiveAbi, Promise<bigint>> {
+    readonly abi: readonly [{
+        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: "reward";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "limit";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "maxReward";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "criteria";
+            readonly internalType: "struct AERC20VariableCriteriaIncentive.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: "ERC20VariableCriteriaIncentiveInitialized";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "asset";
+            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: "ERC20VariableIncentiveInitialized";
+    }, {
+        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: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "sender";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: false;
+        }, {
+            readonly name: "amount";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }];
+        readonly name: "ToppedUp";
+    }, {
+        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 AERC20VariableCriteriaIncentive.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: "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: "";
+            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: "maxReward";
+        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: "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: "amount";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "topup";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        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>;
+    /**
+     *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>;
+    /**
+     * Decodes claim data for the ERC20VariableCriteriaIncentive, returning the claim amount.
+     * Useful when deriving amount claimed from logs.
+     *
+     * @public
+     * @param {Hex} claimData
+     * @returns {Promise<bigint>} Returns the reward amount from a claim data payload
+     */
+    decodeClaimData(claimData: Hex): Promise<bigint>;
+    /**
+     * Fetches the IncentiveCriteria struct from the contract
+     *
+     * @param {?ReadParams} [params]
+     * @returns {Promise<IncentiveCriteria>} Incentive criteria structure
+     * @throws {IncentiveCriteriaNotFoundError}
+     */
+    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>;
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @param {?ERC20VariableCriteriaIncentivePayload} [_payload]
+     * @param {?DeployableOptions} [_options]
+     * @returns {GenericDeployableParams}
+     */
+    buildParameters(_payload?: ERC20VariableCriteriaIncentivePayload, _options?: DeployableOptions): GenericDeployableParams;
+}
+/**
+ * Creates an IncentiveCriteria object representing a gas rebate incentive.
+ * This object defines a variable incentive criteria where the criteria will be the gas spent.
+ *
+ * The criteria uses a signatureType of EVENT, with a special `fieldIndex` of 255 (using CheatCodes enum), which indicates
+ * that the entire gas cost of the transaction will be used as the scalar value. If you don't want to
+ * rebate the entire gas cost, you can use a reward value on the incentive..
+ *
+ * - `criteriaType`: EVENT, indicating it's based on event logs.
+ * - `signature`: A zeroed signature (0x0000...0000), matching any event.
+ * - `fieldIndex`: 255, indicating the use of transaction gas cost using CheatCodes enum.
+ * - `targetContract`: A zeroed address (0x0000...0000), applicable to any contract.
+ *
+ * @returns {IncentiveCriteria} Returns an IncentiveCriteria object for a gas rebate.
+ *
+ * @example
+ * const incentive = gasRebateIncentiveCriteria();
+ * const actionPayload = {
+ *   criteria: incentive,
+ *   asset: "0xAssetAddress",
+ *   reward: 0, // Set to zero to rebate the entire gas cost
+ *   limit: BigInt(1000) // This is the total spend limit for the incentive
+ * };
+ * deployIncentive(actionPayload);
+ */
+export declare function gasRebateIncentiveCriteria(): IncentiveCriteria;
+/**
+ *
+ *
+ * @param {InitPayloadExtended} param0
+ * @param {Address} param0.asset - The address of the ERC20 asset to incentivize.
+ * @param {bigint} param0.reward - The reward amount to distribute per action.
+ * @param {bigint} param0.limit - The total limit of the asset distribution.
+ * @param {bigint} param0.maxReward - The maximum value claimable from a single completion.
+ * @param {IncentiveCriteria} param0.criteria - The incentive criteria for reward distribution.
+ * @returns {Hex}
+ */
+export declare function prepareERC20VariableCriteriaIncentivePayload({ asset, reward, limit, maxReward, criteria, }: ERC20VariableCriteriaIncentivePayload): `0x${string}`;
+//# sourceMappingURL=ERC20VariableCriteriaIncentive.d.ts.map