Class ERC20Incentive

A simple ERC20 incentive implementation that allows claiming of tokens

Export

ERC20Incentive

Hierarchy (view full)

DeployableTarget<ERC20IncentivePayload, typeof erc20IncentiveAbi>
- ERC20Incentive

Constructors

constructor

new ERC20Incentive(options, payload?, isBase?): ERC20Incentive
Creates an instance of DeployableTarget.
Parameters
- options: DeployableOptions
- Optionalpayload: DeployablePayloadOrAddress<ERC20IncentivePayload>
  Either a given implementation's initialization payload, or an address to an existing on chain target.
- OptionalisBase: boolean
  A property asserting that the protocol should eiher clone and initialize a new target from the base implementation, or re-use an existing contract without initializing.
Returns ERC20Incentive
Inherited from DeployableTarget.constructor
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:84

Properties

`Static`bases

bases: Record<number, `0x${string}`> = ...

A static property representing a map of stringified chain ID's to the address of the base implementation on chain, used when cloning base contracts.

Static

`Static`registryType

registryType: RegistryType = RegistryType.INCENTIVE

The target's registry type.

Static

`Readonly`abi

abi: readonly [{
    type: "constructor";
    inputs: readonly [];
    stateMutability: "nonpayable";
}, {
    type: "error";
    inputs: readonly [];
    name: "AlreadyInitialized";
}, {
    type: "error";
    inputs: readonly [];
    name: "ClaimFailed";
}, {
    type: "error";
    inputs: readonly [{
        name: "caller";
        internalType: "address";
        type: "address";
    }, {
        name: "data";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "ClaimFailed";
}, {
    type: "error";
    inputs: readonly [];
    name: "CloneAlreadyInitialized";
}, {
    type: "error";
    inputs: readonly [];
    name: "InitializerNotImplemented";
}, {
    type: "error";
    inputs: readonly [{
        name: "asset";
        internalType: "address";
        type: "address";
    }, {
        name: "available";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "required";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "InsufficientFunds";
}, {
    type: "error";
    inputs: readonly [];
    name: "InvalidInitialization";
}, {
    type: "error";
    inputs: readonly [];
    name: "InvalidInitialization";
}, {
    type: "error";
    inputs: readonly [];
    name: "InvalidInitializationData";
}, {
    type: "error";
    inputs: readonly [];
    name: "LengthMismatch";
}, {
    type: "error";
    inputs: readonly [];
    name: "NewOwnerIsZeroAddress";
}, {
    type: "error";
    inputs: readonly [];
    name: "NoHandoverRequest";
}, {
    type: "error";
    inputs: readonly [];
    name: "NotClaimable";
}, {
    type: "error";
    inputs: readonly [];
    name: "NotInitializing";
}, {
    type: "error";
    inputs: readonly [];
    name: "Unauthorized";
}, {
    type: "error";
    inputs: readonly [];
    name: "Unauthorized";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "recipient";
        internalType: "address";
        type: "address";
        indexed: true;
    }, {
        name: "data";
        internalType: "bytes";
        type: "bytes";
        indexed: false;
    }];
    name: "Claimed";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "entry";
        internalType: "address";
        type: "address";
        indexed: true;
    }];
    name: "Entry";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "version";
        internalType: "uint64";
        type: "uint64";
        indexed: false;
    }];
    name: "Initialized";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "pendingOwner";
        internalType: "address";
        type: "address";
        indexed: true;
    }];
    name: "OwnershipHandoverCanceled";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "pendingOwner";
        internalType: "address";
        type: "address";
        indexed: true;
    }];
    name: "OwnershipHandoverRequested";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "oldOwner";
        internalType: "address";
        type: "address";
        indexed: true;
    }, {
        name: "newOwner";
        internalType: "address";
        type: "address";
        indexed: true;
    }];
    name: "OwnershipTransferred";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "user";
        internalType: "address";
        type: "address";
        indexed: true;
    }, {
        name: "roles";
        internalType: "uint256";
        type: "uint256";
        indexed: true;
    }];
    name: "RolesUpdated";
}, {
    type: "function";
    inputs: readonly [];
    name: "ADMIN_ROLE";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [];
    name: "MANAGER_ROLE";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [];
    name: "asset";
    outputs: readonly [{
        name: "";
        internalType: "address";
        type: "address";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [];
    name: "cancelOwnershipHandover";
    outputs: readonly [];
    stateMutability: "payable";
}, {
    type: "function";
    inputs: readonly [{
        name: "claimTarget";
        internalType: "address";
        type: "address";
    }, {
        name: "";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "claim";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "";
        internalType: "address";
        type: "address";
    }];
    name: "claimed";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [];
    name: "claims";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "data_";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "clawback";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "";
        internalType: "address";
        type: "address";
    }];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "pendingOwner";
        internalType: "address";
        type: "address";
    }];
    name: "completeOwnershipHandover";
    outputs: readonly [];
    stateMutability: "payable";
}, {
    type: "function";
    inputs: readonly [];
    name: "currentReward";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [];
    name: "drawRaffle";
    outputs: readonly [];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "entries";
    outputs: readonly [{
        name: "";
        internalType: "address";
        type: "address";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [];
    name: "getComponentInterface";
    outputs: readonly [{
        name: "";
        internalType: "bytes4";
        type: "bytes4";
    }];
    stateMutability: "pure";
}, {
    type: "function";
    inputs: readonly [{
        name: "accounts_";
        internalType: "address[]";
        type: "address[]";
    }, {
        name: "roles_";
        internalType: "uint256[]";
        type: "uint256[]";
    }];
    name: "grantManyRoles";
    outputs: readonly [];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "user";
        internalType: "address";
        type: "address";
    }, {
        name: "roles";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "grantRoles";
    outputs: readonly [];
    stateMutability: "payable";
}, {
    type: "function";
    inputs: readonly [{
        name: "user";
        internalType: "address";
        type: "address";
    }, {
        name: "roles";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "hasAllRoles";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "user";
        internalType: "address";
        type: "address";
    }, {
        name: "roles";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "hasAnyRole";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "data_";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "initialize";
    outputs: readonly [];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "account_";
        internalType: "address";
        type: "address";
    }];
    name: "isAuthorized";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "claimTarget";
        internalType: "address";
        type: "address";
    }, {
        name: "";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "isClaimable";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [];
    name: "limit";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [];
    name: "owner";
    outputs: readonly [{
        name: "result";
        internalType: "address";
        type: "address";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "pendingOwner";
        internalType: "address";
        type: "address";
    }];
    name: "ownershipHandoverExpiresAt";
    outputs: readonly [{
        name: "result";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "data_";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "preflight";
    outputs: readonly [{
        name: "budgetData";
        internalType: "bytes";
        type: "bytes";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [];
    name: "renounceOwnership";
    outputs: readonly [];
    stateMutability: "payable";
}, {
    type: "function";
    inputs: readonly [{
        name: "roles";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "renounceRoles";
    outputs: readonly [];
    stateMutability: "payable";
}, {
    type: "function";
    inputs: readonly [];
    name: "requestOwnershipHandover";
    outputs: readonly [];
    stateMutability: "payable";
}, {
    type: "function";
    inputs: readonly [{
        name: "accounts_";
        internalType: "address[]";
        type: "address[]";
    }, {
        name: "roles_";
        internalType: "uint256[]";
        type: "uint256[]";
    }];
    name: "revokeManyRoles";
    outputs: readonly [];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "user";
        internalType: "address";
        type: "address";
    }, {
        name: "roles";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "revokeRoles";
    outputs: readonly [];
    stateMutability: "payable";
}, {
    type: "function";
    inputs: readonly [];
    name: "reward";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "user";
        internalType: "address";
        type: "address";
    }];
    name: "rolesOf";
    outputs: readonly [{
        name: "roles";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "accounts_";
        internalType: "address[]";
        type: "address[]";
    }, {
        name: "authorized_";
        internalType: "bool[]";
        type: "bool[]";
    }];
    name: "setAuthorized";
    outputs: readonly [];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [];
    name: "strategy";
    outputs: readonly [{
        name: "";
        internalType: "enum AERC20Incentive.Strategy";
        type: "uint8";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "interfaceId";
        internalType: "bytes4";
        type: "bytes4";
    }];
    name: "supportsInterface";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "newOwner";
        internalType: "address";
        type: "address";
    }];
    name: "transferOwnership";
    outputs: readonly [];
    stateMutability: "payable";
}] = erc20IncentiveAbi

`Readonly`_isBase

_isBase: boolean = true

A property asserting that the protocol should eiher clone and initialize a new target from the base implementation, or re-use an existing contract without initializing.

`Protected`_payload

_payload: undefined | ERC20IncentivePayload

The deployable payload used either for contract construction or initialization

`Protected`_config

_config: Config

See

Wagmi Configuration

`Protected`_address

_address: undefined | `0x${string}`

The internally managed address for this contract

`Protected` `Optional`_account

_account?: Account

If it exists, Viem Local Account, if in a Node environment

Accessors

isBase

get isBase(): boolean
Returns boolean
Inherited from DeployableTarget.isBase
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:64

bases

get bases(): Record<number, `0x${string}`>
A getter that will return the base implementation's static addresses by numerical chain ID

Returns Record<number, `0x${string}`>
Inherited from DeployableTarget.bases
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:111

registryType

get registryType(): RegistryType
A getter that returns the registry type of the base implementation

Returns RegistryType
Inherited from DeployableTarget.registryType
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:122

payload

get payload(): undefined | Payload
Returns the attached deployable payload, if it exists

Returns undefined | Payload
Inherited from DeployableTarget.payload
- Defined in packages/sdk/src/Deployable/Deployable.ts:125

address

get address(): undefined | `0x${string}`
A getter returning this contract's deployed address, if it exists.

Returns undefined | `0x${string}`
Inherited from DeployableTarget.address
- Defined in packages/sdk/src/Deployable/Contract.ts:66

Methods

owner

owner(params?): Promise<`0x${string}`>
The owner of the incentive
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<`0x${string}`>
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:147

currentReward

currentReward(params?): Promise<bigint>
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)
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<bigint>
- The current reward
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:164

claims

claims(params?): Promise<bigint>
The number of claims that have been made
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<bigint>
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:181

claimed

claimed(address, params?): Promise<boolean>
A mapping of address to claim status
Parameters
- address: `0x${string}`
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<boolean>
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:199

asset

asset(params?): Promise<`0x${string}`>
The address of the ERC20-like token
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<`0x${string}`>
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:216

strategy

strategy(params?): Promise<StrategyType>
The strategy for the incentive (MINT or POOL)
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<StrategyType>
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:232

reward

reward(params?): Promise<bigint>
The reward amount issued for each claim
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<bigint>
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:248

limit

limit(params?): Promise<bigint>
The limit (max claims, or max entries for raffles)
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<bigint>
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:264

entries

entries(i, params?): Promise<`0x${string}`>
The set of addresses that have claimed a slot in the incentive raffle, accessed by bigint index.
Parameters
- i: bigint
  Index of address
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<`0x${string}`>
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:281

claim

claim(payload, params?): Promise<boolean>
Claim the incentive
Parameters
- payload: ClaimPayload
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<boolean>
- Returns true if successfully claimed
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:299

claimRaw

claimRaw(payload, params?): Promise<{
hash: `0x${string}`;
result: boolean;
}>
Claim the incentive
Parameters
- payload: ClaimPayload
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<{
hash: `0x${string}`;
result: boolean;
}>
- Returns true if successfully claimed
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:312

clawback

clawback(payload, params?): Promise<readonly [bigint, `0x${string}`]>
Clawback assets from the incentive
Parameters
- payload: ClaimPayload
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<readonly [bigint, `0x${string}`]>
- True if the assets were successfully clawbacked
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:336

clawbackRaw

clawbackRaw(payload, params?): Promise<{
hash: `0x${string}`;
result: readonly [bigint, `0x${string}`];
}>
Clawback assets from the incentive
Parameters
- payload: ClaimPayload
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<{
hash: `0x${string}`;
result: readonly [bigint, `0x${string}`];
}>
- True if the assets were successfully clawbacked
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:349

isClaimable

isClaimable(payload, params?): Promise<boolean>
Check if an incentive is claimable. For the POOL strategy, the bytes data portion of the payload ignored. The recipient must not have already claimed the incentive.
Parameters
- payload: ClaimPayload
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<boolean>
= True if the incentive is claimable based on the data payload

Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:373

drawRaffle

drawRaffle(params?): Promise<void>
Draw a winner from the raffle. Only callable by owner. Only valid when the strategy is set to Strategy.RAFFLE
Parameters
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<void>
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:390

drawRaffleRaw

drawRaffleRaw(params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Draw a winner from the raffle. Only callable by owner. Only valid when the strategy is set to Strategy.RAFFLE
Parameters
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<{
hash: `0x${string}`;
result: void;
}>
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:402

getTotalBudget

getTotalBudget(params?): Promise<bigint>
Get the maximum amount that can be claimed by this incentive. Useful when used in conjunction with BoostCore.calculateProtocolFee
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<bigint>
= Return a bigint representing that maximum amount that can be distributed by this incentive.

Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:424

canBeClaimed

canBeClaimed(params?): Promise<boolean>
Check if any claims remain by comparing the incentive's total claims against its limit. Does not take requesting user's elligibility into account.
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<boolean>
- True if total claims is less than limit
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:450

getRemainingClaimPotential

getRemainingClaimPotential(params?): Promise<bigint>
Check how many claims remain by comparing the incentive's total claims against its limit. Does not take requesting user's elligibility into account.
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<bigint>
- True if total claims is less than limit
Async
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:462

buildParameters

buildParameters(_payload?, _options?): GenericDeployableParams
Base parameter constructor, should return a partial viem.deployContract parameters shape including abi, bytecode, and arguments, if any. Expected to be overridden by protocol contracts.
Parameters
- Optional_payload: ERC20IncentivePayload
- Optional_options: DeployableOptions
Returns GenericDeployableParams
Overrides DeployableTarget.buildParameters
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:478

buildClawbackData

buildClawbackData(amount): `0x${string}`
Encodes an amount to clawback from the incentive
Parameters
- amount: bigint
  How much of the asset to clawback
Returns `0x${string}`
- Returns an encoded uint256
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:501

buildClaimData

buildClaimData(): "0x0000000000000000000000000000000000000000000000000000000000000000"
Builds the claim data for the ERC20Incentive.

Returns "0x0000000000000000000000000000000000000000000000000000000000000000"
A zeroHash, as ERC20Incentive doesn't require specific claim data.

Description
This function returns zeroHash because ERC20Incentive doesn't use any specific claim data.
- Defined in packages/sdk/src/Incentives/ERC20Incentive.ts:512

deploy

deploy(payload?, options?, waitParams?): Promise<ERC20Incentive>
High level deployment function to deploy and await the contract address. This is mainly a convenience method to easily deploy a contract, but will not initialize a Cloneable, which makes it useless for Boost components. Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.
Parameters
- Optionalpayload: ERC20IncentivePayload
- Optionaloptions: DeployableOptions
- OptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">
Returns Promise<ERC20Incentive>
Async
Inherited from DeployableTarget.deploy
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:136

deployRaw

deployRaw(_payload?, _options?): Promise<`0x${string}`>
The lower level contract deployment function that does not await for the transaction receipt. This is mainly a convenience method to easily deploy a contract, but will not initialize a Cloneable, which makes it useless for Boost components. Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.
Parameters
- Optional_payload: ERC20IncentivePayload
- Optional_options: DeployableOptions
Returns Promise<`0x${string}`>
Async
Throws
DeployableAlreadyDeployedError

Throws
DeployableWagmiConfigurationRequiredError

Throws
DeployableMissingPayloadError
Inherited from DeployableTarget.deployRaw
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:155

supportsInterface

supportsInterface(interfaceId, params?): Promise<boolean>
Check if the contract supports the given interface
Parameters
- interfaceId: `0x${string}`
  The interface identifier
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<boolean>
- True if the contract supports the interface
Async
Inherited from DeployableTarget.supportsInterface
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:180

getComponentInterface

getComponentInterface(params?): Promise<`0x${string}`>
Return a cloneable's unique identifier for downstream consumers to differentiate various targets All implementations must override this function
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<`0x${string}`>
Async
Inherited from DeployableTarget.getComponentInterface
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:199

withPayload

withPayload(payload): ERC20Incentive
Attaches a new payload for use with this deployable's initialization
Parameters
- payload: ERC20IncentivePayload
Returns ERC20Incentive
Inherited from DeployableTarget.withPayload
- Defined in packages/sdk/src/Deployable/Deployable.ts:136

at

at(address): ERC20Incentive
Will set this contract's address and return the instance for chaining. Does not verify that provided address is valid.
Parameters
- address: `0x${string}`
Returns ERC20Incentive
Inherited from DeployableTarget.at
- Defined in packages/sdk/src/Deployable/Contract.ts:77

withConfig

withConfig(config): ERC20Incentive
Will set this contract's internal Wagmi Configuration and return the instance for chaining.
Parameters
- config: Config
Returns ERC20Incentive
Inherited from DeployableTarget.withConfig
- Defined in packages/sdk/src/Deployable/Contract.ts:89

assertValidAddress

assertValidAddress(): `0x${string}`
Utility function to validate the existence of an address on this Contract.

Returns `0x${string}`
Throws
ContractAddressRequiredError if no address exists on this Contract instance
Inherited from DeployableTarget.assertValidAddress
- Defined in packages/sdk/src/Deployable/Contract.ts:101

getLogs

getLogs<event, const abiEvent>(params?): Promise<GetLogsReturnType<abiEvent, abiEvent[]>>
A typed wrapper for (viem.getLogs)[https://viem.sh/docs/actions/public/getLogs#getlogs]. Accepts eventName and eventNames as optional parameters to narrow the returned log types.
Type Parameters
- event extends
      | "Initialized"
      | "OwnershipHandoverCanceled"
      | "OwnershipHandoverRequested"
      | "OwnershipTransferred"
      | "RolesUpdated"
      | "Claimed"
      | "Entry"
- const abiEvent extends
      | {
          name: event;
      } & {
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "recipient";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "data";
              internalType: "bytes";
              type: "bytes";
              indexed: false;
          }];
          name: "Claimed";
      }
      | {
          name: event;
      } & {
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "entry";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "Entry";
      }
      | {
          name: event;
      } & {
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "version";
              internalType: "uint64";
              type: "uint64";
              indexed: false;
          }];
          name: "Initialized";
      }
      | {
          name: event;
      } & {
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "pendingOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "OwnershipHandoverCanceled";
      }
      | {
          name: event;
      } & {
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "pendingOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "OwnershipHandoverRequested";
      }
      | {
          name: event;
      } & {
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "oldOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "newOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "OwnershipTransferred";
      }
      | {
          name: event;
      } & {
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "user";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "roles";
              internalType: "uint256";
              type: "uint256";
              indexed: true;
          }];
          name: "RolesUpdated";
      } =
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "recipient";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "data";
              internalType: "bytes";
              type: "bytes";
              indexed: false;
          }];
          name: "Claimed";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "entry";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "Entry";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "version";
              internalType: "uint64";
              type: "uint64";
              indexed: false;
          }];
          name: "Initialized";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "pendingOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "OwnershipHandoverCanceled";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "pendingOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "OwnershipHandoverRequested";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "oldOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "newOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "OwnershipTransferred";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "user";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "roles";
              internalType: "uint256";
              type: "uint256";
              indexed: true;
          }];
          name: "RolesUpdated";
      }, {
          name: event;
      }>
Parameters
- Optionalparams: Omit<GetLogsParams<readonly [{
      type: "constructor";
      inputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "error";
      inputs: readonly [];
      name: "AlreadyInitialized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "ClaimFailed";
  }, {
      type: "error";
      inputs: readonly [{
          name: "caller";
          internalType: "address";
          type: "address";
      }, {
          name: "data";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "ClaimFailed";
  }, {
      type: "error";
      inputs: readonly [];
      name: "CloneAlreadyInitialized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InitializerNotImplemented";
  }, {
      type: "error";
      inputs: readonly [{
          name: "asset";
          internalType: "address";
          type: "address";
      }, {
          name: "available";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "required";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "InsufficientFunds";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InvalidInitialization";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InvalidInitialization";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InvalidInitializationData";
  }, {
      type: "error";
      inputs: readonly [];
      name: "LengthMismatch";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NewOwnerIsZeroAddress";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NoHandoverRequest";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NotClaimable";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NotInitializing";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Unauthorized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Unauthorized";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "recipient";
          internalType: "address";
          type: "address";
          indexed: true;
      }, {
          name: "data";
          internalType: "bytes";
          type: "bytes";
          indexed: false;
      }];
      name: "Claimed";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "entry";
          internalType: "address";
          type: "address";
          indexed: true;
      }];
      name: "Entry";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "version";
          internalType: "uint64";
          type: "uint64";
          indexed: false;
      }];
      name: "Initialized";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "pendingOwner";
          internalType: "address";
          type: "address";
          indexed: true;
      }];
      name: "OwnershipHandoverCanceled";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "pendingOwner";
          internalType: "address";
          type: "address";
          indexed: true;
      }];
      name: "OwnershipHandoverRequested";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "oldOwner";
          internalType: "address";
          type: "address";
          indexed: true;
      }, {
          name: "newOwner";
          internalType: "address";
          type: "address";
          indexed: true;
      }];
      name: "OwnershipTransferred";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "user";
          internalType: "address";
          type: "address";
          indexed: true;
      }, {
          name: "roles";
          internalType: "uint256";
          type: "uint256";
          indexed: true;
      }];
      name: "RolesUpdated";
  }, {
      type: "function";
      inputs: readonly [];
      name: "ADMIN_ROLE";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "MANAGER_ROLE";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "asset";
      outputs: readonly [{
          name: "";
          internalType: "address";
          type: "address";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "cancelOwnershipHandover";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "claimTarget";
          internalType: "address";
          type: "address";
      }, {
          name: "";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "claim";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "";
          internalType: "address";
          type: "address";
      }];
      name: "claimed";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "claims";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "data_";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "clawback";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "";
          internalType: "address";
          type: "address";
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "pendingOwner";
          internalType: "address";
          type: "address";
      }];
      name: "completeOwnershipHandover";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [];
      name: "currentReward";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "drawRaffle";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "entries";
      outputs: readonly [{
          name: "";
          internalType: "address";
          type: "address";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "getComponentInterface";
      outputs: readonly [{
          name: "";
          internalType: "bytes4";
          type: "bytes4";
      }];
      stateMutability: "pure";
  }, {
      type: "function";
      inputs: readonly [{
          name: "accounts_";
          internalType: "address[]";
          type: "address[]";
      }, {
          name: "roles_";
          internalType: "uint256[]";
          type: "uint256[]";
      }];
      name: "grantManyRoles";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "user";
          internalType: "address";
          type: "address";
      }, {
          name: "roles";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "grantRoles";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "user";
          internalType: "address";
          type: "address";
      }, {
          name: "roles";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "hasAllRoles";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "user";
          internalType: "address";
          type: "address";
      }, {
          name: "roles";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "hasAnyRole";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "data_";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "initialize";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "account_";
          internalType: "address";
          type: "address";
      }];
      name: "isAuthorized";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "claimTarget";
          internalType: "address";
          type: "address";
      }, {
          name: "";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "isClaimable";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "limit";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "owner";
      outputs: readonly [{
          name: "result";
          internalType: "address";
          type: "address";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "pendingOwner";
          internalType: "address";
          type: "address";
      }];
      name: "ownershipHandoverExpiresAt";
      outputs: readonly [{
          name: "result";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "data_";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "preflight";
      outputs: readonly [{
          name: "budgetData";
          internalType: "bytes";
          type: "bytes";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "renounceOwnership";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "roles";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "renounceRoles";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [];
      name: "requestOwnershipHandover";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "accounts_";
          internalType: "address[]";
          type: "address[]";
      }, {
          name: "roles_";
          internalType: "uint256[]";
          type: "uint256[]";
      }];
      name: "revokeManyRoles";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "user";
          internalType: "address";
          type: "address";
      }, {
          name: "roles";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "revokeRoles";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [];
      name: "reward";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "user";
          internalType: "address";
          type: "address";
      }];
      name: "rolesOf";
      outputs: readonly [{
          name: "roles";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "accounts_";
          internalType: "address[]";
          type: "address[]";
      }, {
          name: "authorized_";
          internalType: "bool[]";
          type: "bool[]";
      }];
      name: "setAuthorized";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [];
      name: "strategy";
      outputs: readonly [{
          name: "";
          internalType: "enum AERC20Incentive.Strategy";
          type: "uint8";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "interfaceId";
          internalType: "bytes4";
          type: "bytes4";
      }];
      name: "supportsInterface";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "newOwner";
          internalType: "address";
          type: "address";
      }];
      name: "transferOwnership";
      outputs: readonly [];
      stateMutability: "payable";
  }], event, abiEvent, abiEvent[]>, "event" | "events"> & {
      eventName?: event;
      eventNames?: event[];
  }
Returns Promise<GetLogsReturnType<abiEvent, abiEvent[]>>
Example
```
const logs = contract.getLogs({ eventName: 'EventName' })
const logs = contract.getLogs({ eventNames: ['EventName'] })

@public
@async
@template {ContractEvent} event
@template {ExtractAbiEvent<
      ContractAbi,
      event
    >} [abiEvent=ExtractAbiEvent<ContractAbi, event>]
@param {?Omit<
      GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>,
      'event' | 'events'
    > & {
      eventName?: event;
      eventNames?: event[];
    }} [params]
@returns {Promise<GetLogsReturnType<abiEvent, abiEvent
```
Inherited from DeployableTarget.getLogs
- Defined in packages/sdk/src/Deployable/Contract.ts:131

subscribe<event>(cb, params?): (() => void)
A typed wrapper for wagmi.watchContractEvent
Type Parameters
- event extends
      | "Initialized"
      | "OwnershipHandoverCanceled"
      | "OwnershipHandoverRequested"
      | "OwnershipTransferred"
      | "RolesUpdated"
      | "Claimed"
      | "Entry"
Parameters
- cb: ((log: Log<bigint, number, false,
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "recipient";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "data";
              internalType: "bytes";
              type: "bytes";
              indexed: false;
          }];
          name: "Claimed";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "entry";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "Entry";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "version";
              internalType: "uint64";
              type: "uint64";
              indexed: false;
          }];
          name: "Initialized";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "pendingOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "OwnershipHandoverCanceled";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "pendingOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "OwnershipHandoverRequested";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "oldOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "newOwner";
              internalType: "address";
              type: "address";
              indexed: true;
          }];
          name: "OwnershipTransferred";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "user";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "roles";
              internalType: "uint256";
              type: "uint256";
              indexed: true;
          }];
          name: "RolesUpdated";
      }, {
          name: event;
      }>, true>) => unknown)
  - - (log): unknown
    - Parameters
      log: Log<bigint, number, false,
          | Extract<{
              type: "event";
              anonymous: false;
              inputs: readonly [{
                  name: "recipient";
                  internalType: "address";
                  type: "address";
                  indexed: true;
              }, {
                  name: "data";
                  internalType: "bytes";
                  type: "bytes";
                  indexed: false;
              }];
              name: "Claimed";
          }, {
              name: event;
          }>
          | Extract<{
              type: "event";
              anonymous: false;
              inputs: readonly [{
                  name: "entry";
                  internalType: "address";
                  type: "address";
                  indexed: true;
              }];
              name: "Entry";
          }, {
              name: event;
          }>
          | Extract<{
              type: "event";
              anonymous: false;
              inputs: readonly [{
                  name: "version";
                  internalType: "uint64";
                  type: "uint64";
                  indexed: false;
              }];
              name: "Initialized";
          }, {
              name: event;
          }>
          | Extract<{
              type: "event";
              anonymous: false;
              inputs: readonly [{
                  name: "pendingOwner";
                  internalType: "address";
                  type: "address";
                  indexed: true;
              }];
              name: "OwnershipHandoverCanceled";
          }, {
              name: event;
          }>
          | Extract<{
              type: "event";
              anonymous: false;
              inputs: readonly [{
                  name: "pendingOwner";
                  internalType: "address";
                  type: "address";
                  indexed: true;
              }];
              name: "OwnershipHandoverRequested";
          }, {
              name: event;
          }>
          | Extract<{
              type: "event";
              anonymous: false;
              inputs: readonly [{
                  name: "oldOwner";
                  internalType: "address";
                  type: "address";
                  indexed: true;
              }, {
                  name: "newOwner";
                  internalType: "address";
                  type: "address";
                  indexed: true;
              }];
              name: "OwnershipTransferred";
          }, {
              name: event;
          }>
          | Extract<{
              type: "event";
              anonymous: false;
              inputs: readonly [{
                  name: "user";
                  internalType: "address";
                  type: "address";
                  indexed: true;
              }, {
                  name: "roles";
                  internalType: "uint256";
                  type: "uint256";
                  indexed: true;
              }];
              name: "RolesUpdated";
          }, {
              name: event;
          }>, true>
      Returns unknown
- Optionalparams: Partial<Omit<UnionCompute<WatchContractEventParameters<readonly [{
      type: "constructor";
      inputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "error";
      inputs: readonly [];
      name: "AlreadyInitialized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "ClaimFailed";
  }, {
      type: "error";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "ClaimFailed";
  }, {
      type: "error";
      inputs: readonly [];
      name: "CloneAlreadyInitialized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InitializerNotImplemented";
  }, {
      type: "error";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "InsufficientFunds";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InvalidInitialization";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InvalidInitialization";
  }, {
      type: "error";
      inputs: readonly [];
      name: "InvalidInitializationData";
  }, {
      type: "error";
      inputs: readonly [];
      name: "LengthMismatch";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NewOwnerIsZeroAddress";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NoHandoverRequest";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NotClaimable";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NotInitializing";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Unauthorized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Unauthorized";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "Claimed";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "Entry";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "Initialized";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "OwnershipHandoverCanceled";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "OwnershipHandoverRequested";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "OwnershipTransferred";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "RolesUpdated";
  }, {
      type: "function";
      inputs: readonly [];
      name: "ADMIN_ROLE";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "MANAGER_ROLE";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "asset";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "cancelOwnershipHandover";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "claim";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "claimed";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "claims";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "clawback";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "completeOwnershipHandover";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [];
      name: "currentReward";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "drawRaffle";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "entries";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "getComponentInterface";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "pure";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "grantManyRoles";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "grantRoles";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "hasAllRoles";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "hasAnyRole";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "initialize";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "isAuthorized";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "isClaimable";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "limit";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "owner";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "ownershipHandoverExpiresAt";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "preflight";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "renounceOwnership";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "renounceRoles";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [];
      name: "requestOwnershipHandover";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "revokeManyRoles";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "revokeRoles";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [];
      name: "reward";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "rolesOf";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "setAuthorized";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [];
      name: "strategy";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "supportsInterface";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "transferOwnership";
      outputs: readonly [];
      stateMutability: "payable";
  }], event, undefined, WebSocketTransport> & ChainIdParameter<Config, number> & SyncConnectedChainParameter>, "address" | "abi">> & {
      eventName?: event;
  }
Returns (() => void)
- - (): void
  - Returns void
Inherited from DeployableTarget.subscribe
- Defined in packages/sdk/src/Deployable/Contract.ts:186

`Protected`validateDeploymentConfig

validateDeploymentConfig<P>(_payload?, _options?): [P, DeployableOptions]
Protected
Internal method used to ensure that a Wagmi configuration and payload are always present when deploying.
Type Parameters
- P = ERC20IncentivePayload
Parameters
- Optional_payload: P
- Optional_options: DeployableOptions
Returns [P, DeployableOptions]
Throws
DeployableWagmiConfigurationRequiredError

Throws
DeployableMissingPayloadError
Inherited from DeployableTarget.validateDeploymentConfig
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:218

`Protected`optionallyAttachAccount

optionallyAttachAccount(account?): {
account: Account;
} | {
account: undefined;
}
Protected
Internal function to attach the connected account to write methods to avoid manually passing in an account each call.
Parameters
- Optionalaccount: Account
Returns {
account: Account;
} | {
account: undefined;
}
Inherited from DeployableTarget.optionallyAttachAccount
- Defined in packages/sdk/src/Deployable/Deployable.ts:206

`Protected`awaitResult

awaitResult<Result>(hashPromise, waitParams?): Promise<Result>
Protected
Type Parameters
- Result = unknown
Parameters
- hashPromise: Promise<HashAndSimulatedResult<Result>>
- OptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">
Returns Promise<Result>
See
awaitResult

Async
Inherited from DeployableTarget.awaitResult
- Defined in packages/sdk/src/Deployable/Contract.ts:222

Class ERC20Incentive

Export

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ERC20Incentive

Properties

Staticbases

Static

StaticregistryType

Static

Readonlyabi

Readonly_isBase

Protected_payload

Protected_config

See

Protected_address

Protected Optional_account

Accessors

isBase

Returns boolean

bases

Returns Record<number, `0x${string}`>

registryType

Returns RegistryType

payload

Returns undefined | Payload

address

Returns undefined | `0x${string}`

Methods

owner

Parameters

Returns Promise<`0x${string}`>

Async

currentReward

Parameters

Returns Promise<bigint>

Async

claims

Parameters

Returns Promise<bigint>

Async

claimed

Parameters

Returns Promise<boolean>

Async

asset

Parameters

Returns Promise<`0x${string}`>

Async

strategy

Parameters

Returns Promise<StrategyType>

Async

reward

Parameters

Returns Promise<bigint>

Async

limit

Parameters

Returns Promise<bigint>

Async

entries

Parameters

Returns Promise<`0x${string}`>

Async

claim

Parameters

Returns Promise<boolean>

Async

claimRaw

Parameters

Returns Promise<{ hash: `0x${string}`; result: boolean; }>

Async

`Static`bases

`Static`registryType

`Readonly`abi

`Readonly`_isBase

`Protected`_payload

`Protected`_config

`Protected`_address

`Protected` `Optional`_account

Returns Promise<{
hash: `0x${string}`;
result: boolean;
}>

Returns Promise<{
hash: `0x${string}`;
result: readonly [bigint, `0x${string}`];
}>

Returns Promise<{
hash: `0x${string}`;
result: void;
}>