Class ManagedBudgetWithFees

A minimal budget implementation that simply holds and distributes tokens (ERC20-like and native) This type of budget supports ETH, ERC20, and ERC1155 assets only

Export

ManagedBudgetWithFees

Hierarchy (view full)

DeployableTargetWithRBAC<ManagedBudgetWithFeesPayload, typeof managedBudgetWithFeesAbi>
- ManagedBudgetWithFees

Index

Constructors

constructor

new ManagedBudgetWithFees(options, payload?, isBase?): ManagedBudgetWithFees
Creates an instance of DeployableTarget.
Parameters
- options: DeployableOptions
- Optionalpayload: DeployablePayloadOrAddress<ManagedBudgetWithFeesPayload>
  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 ManagedBudgetWithFees
Inherited from DeployableTargetWithRBAC.constructor
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:83

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.BUDGET

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: "CloneAlreadyInitialized";
}, {
    type: "error";
    inputs: readonly [];
    name: "FnSelectorNotRecognized";
}, {
    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: "asset";
        internalType: "address";
        type: "address";
    }, {
        name: "amount";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "InvalidAllocation";
}, {
    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: "NotImplemented";
}, {
    type: "error";
    inputs: readonly [];
    name: "NotInitializing";
}, {
    type: "error";
    inputs: readonly [];
    name: "Reentrancy";
}, {
    type: "error";
    inputs: readonly [{
        name: "asset";
        internalType: "address";
        type: "address";
    }, {
        name: "to";
        internalType: "address";
        type: "address";
    }, {
        name: "amount";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "TransferFailed";
}, {
    type: "error";
    inputs: readonly [];
    name: "Unauthorized";
}, {
    type: "error";
    inputs: readonly [];
    name: "Unauthorized";
}, {
    type: "error";
    inputs: readonly [];
    name: "ZeroBalancePayout";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "asset";
        internalType: "address";
        type: "address";
        indexed: true;
    }, {
        name: "to";
        internalType: "address";
        type: "address";
        indexed: false;
    }, {
        name: "amount";
        internalType: "uint256";
        type: "uint256";
        indexed: false;
    }];
    name: "Distributed";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "version";
        internalType: "uint64";
        type: "uint64";
        indexed: false;
    }];
    name: "Initialized";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "questId";
        internalType: "uint256";
        type: "uint256";
        indexed: true;
    }, {
        name: "incentiveId";
        internalType: "uint256";
        type: "uint256";
        indexed: true;
    }, {
        name: "manager";
        internalType: "address";
        type: "address";
        indexed: true;
    }, {
        name: "amount";
        internalType: "uint256";
        type: "uint256";
        indexed: false;
    }];
    name: "ManagementFeePaid";
}, {
    type: "event";
    anonymous: false;
    inputs: readonly [{
        name: "newFee";
        internalType: "uint256";
        type: "uint256";
        indexed: false;
    }];
    name: "ManagementFeeSet";
}, {
    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: "fallback";
    stateMutability: "payable";
}, {
    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: "data_";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "allocate";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "payable";
}, {
    type: "function";
    inputs: readonly [{
        name: "asset_";
        internalType: "address";
        type: "address";
    }];
    name: "available";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "asset_";
        internalType: "address";
        type: "address";
    }, {
        name: "tokenId_";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "available";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [];
    name: "cancelOwnershipHandover";
    outputs: readonly [];
    stateMutability: "payable";
}, {
    type: "function";
    inputs: readonly [{
        name: "data_";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "clawback";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "target";
        internalType: "address";
        type: "address";
    }, {
        name: "data_";
        internalType: "bytes";
        type: "bytes";
    }, {
        name: "boostId";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "incentiveId";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "clawbackFromTarget";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "";
        internalType: "address";
        type: "address";
    }];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "target";
        internalType: "address";
        type: "address";
    }, {
        name: "data_";
        internalType: "bytes";
        type: "bytes";
    }, {
        name: "boostId";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "incentiveId";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "clawbackFromTargetAndPayFee";
    outputs: readonly [{
        name: "amount";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "asset";
        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: "data_";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "disburse";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "data_";
        internalType: "bytes[]";
        type: "bytes[]";
    }];
    name: "disburseBatch";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "asset_";
        internalType: "address";
        type: "address";
    }];
    name: "distributed";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "asset_";
        internalType: "address";
        type: "address";
    }, {
        name: "tokenId_";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "distributed";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    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: "";
        internalType: "address";
        type: "address";
    }];
    name: "incentiveFeesDisbursed";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "";
        internalType: "address";
        type: "address";
    }];
    name: "incentiveFeesMax";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    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: "managementFee";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "";
        internalType: "address";
        type: "address";
    }, {
        name: "";
        internalType: "address";
        type: "address";
    }, {
        name: "";
        internalType: "uint256[]";
        type: "uint256[]";
    }, {
        name: "";
        internalType: "uint256[]";
        type: "uint256[]";
    }, {
        name: "";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "onERC1155BatchReceived";
    outputs: readonly [{
        name: "";
        internalType: "bytes4";
        type: "bytes4";
    }];
    stateMutability: "pure";
}, {
    type: "function";
    inputs: readonly [{
        name: "";
        internalType: "address";
        type: "address";
    }, {
        name: "";
        internalType: "address";
        type: "address";
    }, {
        name: "";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "onERC1155Received";
    outputs: readonly [{
        name: "";
        internalType: "bytes4";
        type: "bytes4";
    }];
    stateMutability: "pure";
}, {
    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: "boostId";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "incentiveId";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "payManagementFee";
    outputs: readonly [];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "reconcile";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "nonpayable";
}, {
    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: "";
        internalType: "address";
        type: "address";
    }];
    name: "reservedFunds";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    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: "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: "fee_";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "setManagementFee";
    outputs: readonly [];
    stateMutability: "nonpayable";
}, {
    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: "target";
        internalType: "address";
        type: "address";
    }, {
        name: "boostId";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "incentiveId";
        internalType: "uint256";
        type: "uint256";
    }, {
        name: "data_";
        internalType: "bytes";
        type: "bytes";
    }];
    name: "topupIncentive";
    outputs: readonly [{
        name: "";
        internalType: "bool";
        type: "bool";
    }];
    stateMutability: "nonpayable";
}, {
    type: "function";
    inputs: readonly [{
        name: "asset_";
        internalType: "address";
        type: "address";
    }];
    name: "total";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "asset_";
        internalType: "address";
        type: "address";
    }, {
        name: "tokenId_";
        internalType: "uint256";
        type: "uint256";
    }];
    name: "total";
    outputs: readonly [{
        name: "";
        internalType: "uint256";
        type: "uint256";
    }];
    stateMutability: "view";
}, {
    type: "function";
    inputs: readonly [{
        name: "newOwner";
        internalType: "address";
        type: "address";
    }];
    name: "transferOwnership";
    outputs: readonly [];
    stateMutability: "payable";
}, {
    type: "receive";
    stateMutability: "payable";
}] = managedBudgetWithFeesAbi

Inherit Doc

`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 | ManagedBudgetWithFeesPayload

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 DeployableTargetWithRBAC.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 DeployableTargetWithRBAC.bases
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:110

registryType

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

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

payload

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

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

account

get account(): undefined | Account
Returns the attached account, if it exists

Returns undefined | Account
Inherited from DeployableTargetWithRBAC.account
- Defined in packages/sdk/src/Deployable/Deployable.ts:135

address

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

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

config

get config(): Config
A getter returning this contract's Wagmi configuration.

Returns Config
Inherited from DeployableTargetWithRBAC.config
- Defined in packages/sdk/src/Deployable/Contract.ts:77

Methods

allocate

allocate(transfer, params?): Promise<boolean>
Allocates assets to the budget. The caller must have already approved the contract to transfer the asset If the asset transfer fails, the allocation will revert
Parameters
- transfer: ERC1155TransferPayload | FungibleTransferPayload
- 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>
- True if the allocation was successful
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:160

allocateRaw

allocateRaw(transfer, params?): Promise<{
hash: `0x${string}`;
result: boolean;
}>
Allocates assets to the budget. The caller must have already approved the contract to transfer the asset If the asset transfer fails, the allocation will revert
Parameters
- transfer: ERC1155TransferPayload | FungibleTransferPayload
- 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;
}>
- True if the allocation was successful
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:178

clawback

clawback(transfer, params?): Promise<bigint>
Clawbacks assets from the budget. Only the owner can directly clawback assets from the budget If the amount is zero, the entire balance of the asset will be transferred to the receiver If the asset transfer fails, the reclamation will revert
Parameters
- transfer: ERC1155TransferPayload | FungibleTransferPayload
- 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<bigint>
- True if the request was successful
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:208

clawbackRaw

clawbackRaw(transfer, params?): Promise<{
hash: `0x${string}`;
result: bigint;
}>
Clawbacks assets from the budget. Only the owner or admin can directly clawback assets from the budget If the amount is zero, the entire balance of the asset will be transferred to the receiver If the asset transfer fails, the reclamation will revert
Parameters
- transfer: ERC1155TransferPayload | FungibleTransferPayload
- 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: bigint;
}>
- True if the request was successful
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:227

clawbackFromTarget

clawbackFromTarget(target, data, boostId, incentiveId, params?): Promise<readonly [bigint, `0x${string}`]>
Clawbacks assets from an incentive associated with the budget via Boost Core. Only the authorized users can clawback assets from an incentive. If the asset transfer fails, the reclamation will revert.
Parameters
- target: `0x${string}`
  The address of a contract implementing clawback, typically BoostCore
- data: `0x${string}`
  The encoded data payload for the clawback, can be acquired with incentive.buildClawbackData
- boostId: number | bigint
  The ID of the boost
- incentiveId: number | bigint
  The ID of the incentive
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
  Optional write parameters
Returns Promise<readonly [bigint, `0x${string}`]>
- Returns a tuple of amount reclaimed and the address reclaimed from
Example
```
const [amount, address] = await budgets.budget.clawbackFromTarget(
  core.assertValidAddress(),
  erc20Incentive.buildClawbackData(1n),
  boost.id,
  incentiveId,
);
```
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:268

clawbackFromTargetRaw

clawbackFromTargetRaw(target, data, boostId, incentiveId, params?): Promise<{
hash: `0x${string}`;
result: readonly [bigint, `0x${string}`];
}>
Clawbacks assets from an incentive associated with the budget via Boost Core. Only the authorized users can clawback assets from an incentive. If the asset transfer fails, the reclamation will revert.
Parameters
- target: `0x${string}`
  The address of a contract implementing clawback, typically BoostCore
- data: `0x${string}`
  The encoded data payload for the clawback, can be acquired with incentive.buildClawbackData
- boostId: number | bigint
  The ID of the boost
- incentiveId: number | bigint
  The ID of the incentive
- Optionalparams: Partial<Omit<UnionCompute<UnionStrictOmit<SimulateContractParameters<Abi, string, readonly unknown[], Chain, Chain, (`0x${string}` | Account)>, "chain">> & ChainIdParameter<Config, number> & ConnectorParameter,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
  Optional write parameters
Returns Promise<{
hash: `0x${string}`;
result: readonly [bigint, `0x${string}`];
}>
- Returns transaction hash and simulated result
Example
```
const { hash, result: [ amount, address ] } = await budgets.budget.clawbackFromTargetRaw(
  core.assertValidAddress(),
  erc20Incentive.buildClawbackData(1n),
  boost.id,
  incentiveId,
);
```
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:303

disburse

disburse(transfer, params?): Promise<boolean>
Disburses assets from the budget to a single recipient If the asset transfer fails, the disbursement will revert
Parameters
- transfer: ERC1155TransferPayload | FungibleTransferPayload
- 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>
- True if the disbursement was successful
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:337

disburseRaw

disburseRaw(transfer, params?): Promise<{
hash: `0x${string}`;
result: boolean;
}>
Disburses assets from the budget to a single recipient If the asset transfer fails, the disbursement will revert
Parameters
- transfer: ERC1155TransferPayload | FungibleTransferPayload
- 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;
}>
- True if the disbursement was successful
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:354

disburseBatch

disburseBatch(transfers, params?): Promise<boolean>
Disburses assets from the budget to multiple recipients
Parameters
- transfers: (ERC1155TransferPayload | FungibleTransferPayload)[]
- 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>
- True if all disbursements were successful
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:381

disburseBatchRaw

disburseBatchRaw(transfers, params?): Promise<{
hash: `0x${string}`;
result: boolean;
}>
Disburses assets from the budget to multiple recipients
Parameters
- transfers: (ERC1155TransferPayload | FungibleTransferPayload)[]
- 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;
}>
- True if all disbursements were successful
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:397

payManagementFee

payManagementFee(boostId, incentiveId, params?): Promise<void>
Pays out reserved management fees to the boost owner for a given incentive
Parameters
- boostId: string | bigint
- incentiveId: string | bigint
- 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>
- True if the payout was successful
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:426

payManagementFeeRaw

payManagementFeeRaw(boostId, incentiveId, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Pays out reserved management fees to the boost owner
Parameters
- boostId: string | bigint
- incentiveId: string | bigint
- 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;
}>
- True if the payout was successful
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:446

setManagementFee

setManagementFee(managementFee, params?): Promise<void>
Sets the management fee for the budget
Parameters
- managementFee: bigint
- 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>
- will throw if the transaction fails
Async
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:474

setManagementFeeRaw

setManagementFeeRaw(managementFee, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Sets the management fee for the budget
Parameters
- managementFee: bigint
- 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/Budgets/ManagedBudgetWithFees.ts:488

managementFee

managementFee(params?): Promise<bigint>
Get the configured management fee for the budget
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<bigint>
- The management fee
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:513

owner

owner(params?): Promise<`0x${string}`>
Get the owner of the budget
Parameters
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<`0x${string}`>
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:529

total

total(asset?, tokenId?, params?): Promise<never>
Get the total amount of assets allocated to the budget, including any that have been distributed If a tokenId is provided, get the total amount of ERC1155 assets allocated to the budget, including any that have been distributed
Parameters
- Optionalasset: `0x${string}` = zeroAddress
  The address of the asset
- OptionaltokenId: bigint
  The ID of the token
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<never>
- The total amount of assets
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:548

available

available(asset?, tokenId?, params?): Promise<never>
Get the amount of assets available for distribution from the budget. If a tokenId is provided, get the amount of ERC1155 assets available for distribution from the budget
Parameters
- Optionalasset: `0x${string}` = zeroAddress
- OptionaltokenId: bigint
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<never>
- The amount of assets available
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:571

distributed

distributed(asset?, tokenId?, params?): Promise<never>
Get the amount of assets that have been distributed from the budget. If a tokenId is provided, get the amount of ERC1155 assets that have been distributed from the budget
Parameters
- Optionalasset: `0x${string}` = zeroAddress
- OptionaltokenId: bigint
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<never>
- The amount of assets distributed
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:594

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: ManagedBudgetWithFeesPayload
- Optional_options: DeployableOptions
Returns GenericDeployableParams
Overrides DeployableTargetWithRBAC.buildParameters
- Defined in packages/sdk/src/Budgets/ManagedBudgetWithFees.ts:615

setAuthorized

setAuthorized(addresses, allowed, params?): Promise<void>
Set the authorized status of the given accounts The mechanism for managing authorization is left to the implementing contract
Parameters
- addresses: `0x${string}`[]
  The accounts to authorize or deauthorize
- allowed: boolean[]
  The authorization status for the given accounts
- 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
Inherited from DeployableTargetWithRBAC.setAuthorized
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:91

setAuthorizedRaw

setAuthorizedRaw(addresses, allowed, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Set the authorized status of the given accounts The mechanism for managing authorization is left to the implementing contract
Parameters
- addresses: `0x${string}`[]
  The accounts to authorize or deauthorize
- allowed: boolean[]
  The authorization status for the given accounts
- 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
Inherited from DeployableTargetWithRBAC.setAuthorizedRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:112

grantRoles

grantRoles(address, role, params?): Promise<void>
Grant permissions for a user on the rbac.
Parameters
- address: `0x${string}`
- role: Roles
- 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>
Example
```
await rbac.grantRoles('0xfoo', Roles.MANAGER)
```
Async
Inherited from DeployableTargetWithRBAC.grantRoles
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:142

grantRolesRaw

grantRolesRaw(address, role, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Grant permissions for a user on the rbac.
Parameters
- address: `0x${string}`
- role: Roles
- 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;
}>
Example
```
await rbac.grantRoles('0xfoo', Roles.MANAGER)
```
Async
Inherited from DeployableTargetWithRBAC.grantRolesRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:160

revokeRoles

revokeRoles(address, role, params?): Promise<void>
Revoke permissions for a user on the rbac.
Parameters
- address: `0x${string}`
- role: Roles
- 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>
Example
```
await rbac.revokeRoles('0xfoo', Roles.MANAGER)
```
Async
Inherited from DeployableTargetWithRBAC.revokeRoles
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:194

revokeRolesRaw

revokeRolesRaw(address, role, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Revoke permissions for a user on the rbac.
Parameters
- address: `0x${string}`
- role: Roles
- 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;
}>
Example
```
await rbac.revokeRoles('0xfoo', Roles.MANAGER)
```
Async
Inherited from DeployableTargetWithRBAC.revokeRolesRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:216

grantManyRoles

grantManyRoles(addresses, roles, params?): Promise<void>
Grant many accounts permissions on the rbac.
Parameters
- addresses: `0x${string}`[]
- roles: Roles[]
- 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>
Example
```
await rbac.grantManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])
```
Async
Inherited from DeployableTargetWithRBAC.grantManyRoles
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:250

grantManyRolesRaw

grantManyRolesRaw(addresses, roles, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Grant many accounts permissions on the rbac.
Parameters
- addresses: `0x${string}`[]
- roles: Roles[]
- 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;
}>
Example
```
await rbac.grantManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])
```
Async
Inherited from DeployableTargetWithRBAC.grantManyRolesRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:274

revokeManyRoles

revokeManyRoles(addresses, roles, params?): Promise<void>
Revoke many accounts' permissions on the rbac.
Parameters
- addresses: `0x${string}`[]
- roles: Roles[]
- 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>
Example
```
await rbac.revokeManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])
```
Async
Inherited from DeployableTargetWithRBAC.revokeManyRoles
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:308

revokeManyRolesRaw

revokeManyRolesRaw(addresses, roles, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Revoke many accounts' permissions on the rbac.
Parameters
- addresses: `0x${string}`[]
- roles: Roles[]
- 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;
}>
Example
```
await rbac.revokeManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])
```
Async
Inherited from DeployableTargetWithRBAC.revokeManyRolesRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:332

rolesOf

rolesOf(account, params?): Promise<Roles[]>
Return an array of the roles assigned to the given account.
Parameters
- account: `0x${string}`
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<Roles[]>
Example
```
(await rbac.rolesOf(0xfoo)).includes(Roles.ADMIN)
```
Inherited from DeployableTargetWithRBAC.rolesOf
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:366

hasAnyRole

hasAnyRole(account, roles, params?): Promise<boolean>
Returns whether given account has any of the provided roles bitmap.
Parameters
- account: `0x${string}`
- roles: Roles
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<boolean>
Example
```
await rbac.hasAnyRole(0xfoo, Roles.ADMIN | Roles.MANAGER)
```
Inherited from DeployableTargetWithRBAC.hasAnyRole
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:392

hasAllRoles

hasAllRoles(account, roles, params?): Promise<boolean>
Returns whether given account has all of the provided roles bitmap.
Parameters
- account: `0x${string}`
- roles: Roles
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<boolean>
Example
```
await rbac.hasAllRoles(0xfoo, Roles.ADMIN | Roles.MANAGER)
```
Inherited from DeployableTargetWithRBAC.hasAllRoles
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:415

isAuthorized

isAuthorized(account, params?): Promise<boolean>
Check if the given account is authorized to use the rbac
Parameters
- account: `0x${string}`
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<boolean>
- True if the account is authorized
Inherited from DeployableTargetWithRBAC.isAuthorized
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:433

transferOwnership

transferOwnership(newOwner, params?): Promise<void>
Transfer ownership of the contract to a new address
Parameters
- newOwner: `0x${string}`
  The address to transfer ownership to
- 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
Inherited from DeployableTargetWithRBAC.transferOwnership
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:452

transferOwnershipRaw

transferOwnershipRaw(newOwner, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Transfer ownership of the contract to a new address
Parameters
- newOwner: `0x${string}`
  The address to transfer ownership to
- 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
Inherited from DeployableTargetWithRBAC.transferOwnershipRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:465

renounceOwnership

renounceOwnership(params?): Promise<void>
Renounce ownership of the contract
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
Inherited from DeployableTargetWithRBAC.renounceOwnership
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:491

renounceOwnershipRaw

renounceOwnershipRaw(params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Renounce ownership of the contract
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
Inherited from DeployableTargetWithRBAC.renounceOwnershipRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:503

requestOwnershipHandover

requestOwnershipHandover(params?): Promise<void>
Request a two-step ownership handover to the caller The request will automatically expire in 48 hours

Note: This is part of a two-step ownership transfer process:
1. New owner calls requestOwnershipHandover()
2. Current owner calls completeOwnershipHandover(newOwner)
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
Inherited from DeployableTargetWithRBAC.requestOwnershipHandover
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:533

requestOwnershipHandoverRaw

requestOwnershipHandoverRaw(params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Request a two-step ownership handover to the caller The request will automatically expire in 48 hours
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
Inherited from DeployableTargetWithRBAC.requestOwnershipHandoverRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:546

completeOwnershipHandover

completeOwnershipHandover(pendingOwner, params?): Promise<void>
Complete a pending ownership handover to a new owner Must be called by the current owner after the new owner has requested the handover

Note: This is part of a two-step ownership transfer process:
1. New owner calls requestOwnershipHandover()
2. Current owner calls completeOwnershipHandover(newOwner)
Parameters
- pendingOwner: `0x${string}`
  The address that requested the ownership handover
- 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
Inherited from DeployableTargetWithRBAC.completeOwnershipHandover
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:575

completeOwnershipHandoverRaw

completeOwnershipHandoverRaw(pendingOwner, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Complete a pending ownership handover to a new owner Must be called by the current owner after the new owner has requested the handover
Parameters
- pendingOwner: `0x${string}`
  The address that requested the ownership handover
- 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
Inherited from DeployableTargetWithRBAC.completeOwnershipHandoverRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:594

cancelOwnershipHandover

cancelOwnershipHandover(params?): Promise<void>
Cancel a pending ownership handover request Must be called by the account that originally requested the handover
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
Inherited from DeployableTargetWithRBAC.cancelOwnershipHandover
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:622

cancelOwnershipHandoverRaw

cancelOwnershipHandoverRaw(params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Cancel a pending ownership handover request Must be called by the account that originally requested the handover
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
Inherited from DeployableTargetWithRBAC.cancelOwnershipHandoverRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:635

ownershipHandoverExpiresAt

ownershipHandoverExpiresAt(pendingOwner, params?): Promise<bigint>
Get the expiry timestamp for a pending ownership handover Returns 0 if there is no pending handover request for the given address
Parameters
- pendingOwner: `0x${string}`
  The address to check for pending handover requests
- Optionalparams: Partial<Omit<ReadContractParameters,
      | "address"
      | "abi"
      | "functionName"
      | "args">>
Returns Promise<bigint>
- The timestamp when the handover request expires, or 0 if no request exists
Inherited from DeployableTargetWithRBAC.ownershipHandoverExpiresAt
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:659

renounceRoles

renounceRoles(roles, params?): Promise<void>
Allow the caller to remove their own roles If the caller does not have a role, then it will be a no-op for that role
Parameters
- roles: Roles
  Bitmap of roles to renounce
- 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
Inherited from DeployableTargetWithRBAC.renounceRoles
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:682

renounceRolesRaw

renounceRolesRaw(roles, params?): Promise<{
hash: `0x${string}`;
result: void;
}>
Allow the caller to remove their own roles If the caller does not have a role, then it will be a no-op for that role
Parameters
- roles: Roles
  Bitmap of roles to renounce
- 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
Inherited from DeployableTargetWithRBAC.renounceRolesRaw
- Defined in packages/sdk/src/Deployable/DeployableTargetWithRBAC.ts:696

deploy

deploy(payload?, options?, waitParams?): Promise<ManagedBudgetWithFees>
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: ManagedBudgetWithFeesPayload
- Optionaloptions: DeployableOptions
- OptionalwaitParams: Omit<WaitForTransactionReceiptParameters, "hash">
Returns Promise<ManagedBudgetWithFees>
Async
Inherited from DeployableTargetWithRBAC.deploy
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:135

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: ManagedBudgetWithFeesPayload
- Optional_options: DeployableOptions
Returns Promise<`0x${string}`>
Async
Throws
DeployableAlreadyDeployedError

Throws
DeployableWagmiConfigurationRequiredError

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

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 DeployableTargetWithRBAC.supportsInterface
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:179

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 DeployableTargetWithRBAC.getComponentInterface
- Defined in packages/sdk/src/Deployable/DeployableTarget.ts:198

withPayload

withPayload(payload): ManagedBudgetWithFees
Attaches a new payload for use with this deployable's initialization
Parameters
- payload: ManagedBudgetWithFeesPayload
Returns ManagedBudgetWithFees
Inherited from DeployableTargetWithRBAC.withPayload
- Defined in packages/sdk/src/Deployable/Deployable.ts:146

at

at(address): ManagedBudgetWithFees
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 ManagedBudgetWithFees
Inherited from DeployableTargetWithRBAC.at
- Defined in packages/sdk/src/Deployable/Contract.ts:88

withConfig

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

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 DeployableTargetWithRBAC.assertValidAddress
- Defined in packages/sdk/src/Deployable/Contract.ts:112

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"
      | "Distributed"
      | "ManagementFeePaid"
      | "ManagementFeeSet"
- const abiEvent extends
      | {
          name: event;
      } & {
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "asset";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "to";
              internalType: "address";
              type: "address";
              indexed: false;
          }, {
              name: "amount";
              internalType: "uint256";
              type: "uint256";
              indexed: false;
          }];
          name: "Distributed";
      }
      | {
          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: "questId";
              internalType: "uint256";
              type: "uint256";
              indexed: true;
          }, {
              name: "incentiveId";
              internalType: "uint256";
              type: "uint256";
              indexed: true;
          }, {
              name: "manager";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "amount";
              internalType: "uint256";
              type: "uint256";
              indexed: false;
          }];
          name: "ManagementFeePaid";
      }
      | {
          name: event;
      } & {
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "newFee";
              internalType: "uint256";
              type: "uint256";
              indexed: false;
          }];
          name: "ManagementFeeSet";
      }
      | {
          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: "asset";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "to";
              internalType: "address";
              type: "address";
              indexed: false;
          }, {
              name: "amount";
              internalType: "uint256";
              type: "uint256";
              indexed: false;
          }];
          name: "Distributed";
      }, {
          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: "questId";
              internalType: "uint256";
              type: "uint256";
              indexed: true;
          }, {
              name: "incentiveId";
              internalType: "uint256";
              type: "uint256";
              indexed: true;
          }, {
              name: "manager";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "amount";
              internalType: "uint256";
              type: "uint256";
              indexed: false;
          }];
          name: "ManagementFeePaid";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "newFee";
              internalType: "uint256";
              type: "uint256";
              indexed: false;
          }];
          name: "ManagementFeeSet";
      }, {
          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: "CloneAlreadyInitialized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "FnSelectorNotRecognized";
  }, {
      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: "asset";
          internalType: "address";
          type: "address";
      }, {
          name: "amount";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "InvalidAllocation";
  }, {
      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: "NotImplemented";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NotInitializing";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Reentrancy";
  }, {
      type: "error";
      inputs: readonly [{
          name: "asset";
          internalType: "address";
          type: "address";
      }, {
          name: "to";
          internalType: "address";
          type: "address";
      }, {
          name: "amount";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "TransferFailed";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Unauthorized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Unauthorized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "ZeroBalancePayout";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "asset";
          internalType: "address";
          type: "address";
          indexed: true;
      }, {
          name: "to";
          internalType: "address";
          type: "address";
          indexed: false;
      }, {
          name: "amount";
          internalType: "uint256";
          type: "uint256";
          indexed: false;
      }];
      name: "Distributed";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "version";
          internalType: "uint64";
          type: "uint64";
          indexed: false;
      }];
      name: "Initialized";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "questId";
          internalType: "uint256";
          type: "uint256";
          indexed: true;
      }, {
          name: "incentiveId";
          internalType: "uint256";
          type: "uint256";
          indexed: true;
      }, {
          name: "manager";
          internalType: "address";
          type: "address";
          indexed: true;
      }, {
          name: "amount";
          internalType: "uint256";
          type: "uint256";
          indexed: false;
      }];
      name: "ManagementFeePaid";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: "newFee";
          internalType: "uint256";
          type: "uint256";
          indexed: false;
      }];
      name: "ManagementFeeSet";
  }, {
      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: "fallback";
      stateMutability: "payable";
  }, {
      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: "data_";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "allocate";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "asset_";
          internalType: "address";
          type: "address";
      }];
      name: "available";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "asset_";
          internalType: "address";
          type: "address";
      }, {
          name: "tokenId_";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "available";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [];
      name: "cancelOwnershipHandover";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "data_";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "clawback";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "target";
          internalType: "address";
          type: "address";
      }, {
          name: "data_";
          internalType: "bytes";
          type: "bytes";
      }, {
          name: "boostId";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "incentiveId";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "clawbackFromTarget";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "";
          internalType: "address";
          type: "address";
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "target";
          internalType: "address";
          type: "address";
      }, {
          name: "data_";
          internalType: "bytes";
          type: "bytes";
      }, {
          name: "boostId";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "incentiveId";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "clawbackFromTargetAndPayFee";
      outputs: readonly [{
          name: "amount";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "asset";
          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: "data_";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "disburse";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "data_";
          internalType: "bytes[]";
          type: "bytes[]";
      }];
      name: "disburseBatch";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "asset_";
          internalType: "address";
          type: "address";
      }];
      name: "distributed";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "asset_";
          internalType: "address";
          type: "address";
      }, {
          name: "tokenId_";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "distributed";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      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: "";
          internalType: "address";
          type: "address";
      }];
      name: "incentiveFeesDisbursed";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "";
          internalType: "address";
          type: "address";
      }];
      name: "incentiveFeesMax";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      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: "managementFee";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "";
          internalType: "address";
          type: "address";
      }, {
          name: "";
          internalType: "address";
          type: "address";
      }, {
          name: "";
          internalType: "uint256[]";
          type: "uint256[]";
      }, {
          name: "";
          internalType: "uint256[]";
          type: "uint256[]";
      }, {
          name: "";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "onERC1155BatchReceived";
      outputs: readonly [{
          name: "";
          internalType: "bytes4";
          type: "bytes4";
      }];
      stateMutability: "pure";
  }, {
      type: "function";
      inputs: readonly [{
          name: "";
          internalType: "address";
          type: "address";
      }, {
          name: "";
          internalType: "address";
          type: "address";
      }, {
          name: "";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "onERC1155Received";
      outputs: readonly [{
          name: "";
          internalType: "bytes4";
          type: "bytes4";
      }];
      stateMutability: "pure";
  }, {
      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: "boostId";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "incentiveId";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "payManagementFee";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "reconcile";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "nonpayable";
  }, {
      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: "";
          internalType: "address";
          type: "address";
      }];
      name: "reservedFunds";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      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: "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: "fee_";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "setManagementFee";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      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: "target";
          internalType: "address";
          type: "address";
      }, {
          name: "boostId";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "incentiveId";
          internalType: "uint256";
          type: "uint256";
      }, {
          name: "data_";
          internalType: "bytes";
          type: "bytes";
      }];
      name: "topupIncentive";
      outputs: readonly [{
          name: "";
          internalType: "bool";
          type: "bool";
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: "asset_";
          internalType: "address";
          type: "address";
      }];
      name: "total";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "asset_";
          internalType: "address";
          type: "address";
      }, {
          name: "tokenId_";
          internalType: "uint256";
          type: "uint256";
      }];
      name: "total";
      outputs: readonly [{
          name: "";
          internalType: "uint256";
          type: "uint256";
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: "newOwner";
          internalType: "address";
          type: "address";
      }];
      name: "transferOwnership";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "receive";
      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 DeployableTargetWithRBAC.getLogs
- Defined in packages/sdk/src/Deployable/Contract.ts:142

subscribe<event>(cb, params?): (() => void)
A typed wrapper for wagmi.watchContractEvent
Type Parameters
- event extends
      | "Initialized"
      | "OwnershipHandoverCanceled"
      | "OwnershipHandoverRequested"
      | "OwnershipTransferred"
      | "RolesUpdated"
      | "Distributed"
      | "ManagementFeePaid"
      | "ManagementFeeSet"
Parameters
- cb: ((log: Log<bigint, number, false,
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "asset";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "to";
              internalType: "address";
              type: "address";
              indexed: false;
          }, {
              name: "amount";
              internalType: "uint256";
              type: "uint256";
              indexed: false;
          }];
          name: "Distributed";
      }, {
          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: "questId";
              internalType: "uint256";
              type: "uint256";
              indexed: true;
          }, {
              name: "incentiveId";
              internalType: "uint256";
              type: "uint256";
              indexed: true;
          }, {
              name: "manager";
              internalType: "address";
              type: "address";
              indexed: true;
          }, {
              name: "amount";
              internalType: "uint256";
              type: "uint256";
              indexed: false;
          }];
          name: "ManagementFeePaid";
      }, {
          name: event;
      }>
      | Extract<{
          type: "event";
          anonymous: false;
          inputs: readonly [{
              name: "newFee";
              internalType: "uint256";
              type: "uint256";
              indexed: false;
          }];
          name: "ManagementFeeSet";
      }, {
          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: "asset";
                  internalType: "address";
                  type: "address";
                  indexed: true;
              }, {
                  name: "to";
                  internalType: "address";
                  type: "address";
                  indexed: false;
              }, {
                  name: "amount";
                  internalType: "uint256";
                  type: "uint256";
                  indexed: false;
              }];
              name: "Distributed";
          }, {
              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: "questId";
                  internalType: "uint256";
                  type: "uint256";
                  indexed: true;
              }, {
                  name: "incentiveId";
                  internalType: "uint256";
                  type: "uint256";
                  indexed: true;
              }, {
                  name: "manager";
                  internalType: "address";
                  type: "address";
                  indexed: true;
              }, {
                  name: "amount";
                  internalType: "uint256";
                  type: "uint256";
                  indexed: false;
              }];
              name: "ManagementFeePaid";
          }, {
              name: event;
          }>
          | Extract<{
              type: "event";
              anonymous: false;
              inputs: readonly [{
                  name: "newFee";
                  internalType: "uint256";
                  type: "uint256";
                  indexed: false;
              }];
              name: "ManagementFeeSet";
          }, {
              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: "CloneAlreadyInitialized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "FnSelectorNotRecognized";
  }, {
      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: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "InvalidAllocation";
  }, {
      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: "NotImplemented";
  }, {
      type: "error";
      inputs: readonly [];
      name: "NotInitializing";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Reentrancy";
  }, {
      type: "error";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "TransferFailed";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Unauthorized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "Unauthorized";
  }, {
      type: "error";
      inputs: readonly [];
      name: "ZeroBalancePayout";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "Distributed";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "Initialized";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "ManagementFeePaid";
  }, {
      type: "event";
      anonymous: false;
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
          indexed: ...;
      }];
      name: "ManagementFeeSet";
  }, {
      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: "fallback";
      stateMutability: "payable";
  }, {
      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: ...;
          internalType: ...;
          type: ...;
      }];
      name: "allocate";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "payable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "available";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "available";
      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: "clawback";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "clawbackFromTarget";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "clawbackFromTargetAndPayFee";
      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: ...;
          internalType: ...;
          type: ...;
      }];
      name: "disburse";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "disburseBatch";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "distributed";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "distributed";
      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: "incentiveFeesDisbursed";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "incentiveFeesMax";
      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: "managementFee";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "onERC1155BatchReceived";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "pure";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "onERC1155Received";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "pure";
  }, {
      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: ...;
          internalType: ...;
          type: ...;
      }];
      name: "payManagementFee";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "reconcile";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "nonpayable";
  }, {
      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: "reservedFunds";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      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: ...;
          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: ...;
          internalType: ...;
          type: ...;
      }];
      name: "setManagementFee";
      outputs: readonly [];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "supportsInterface";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "topupIncentive";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "nonpayable";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "total";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }, {
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "total";
      outputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      stateMutability: "view";
  }, {
      type: "function";
      inputs: readonly [{
          name: ...;
          internalType: ...;
          type: ...;
      }];
      name: "transferOwnership";
      outputs: readonly [];
      stateMutability: "payable";
  }, {
      type: "receive";
      stateMutability: "payable";
  }], event, undefined, WebSocketTransport> & ChainIdParameter<Config, number> & SyncConnectedChainParameter>, "address" | "abi">> & {
      eventName?: event;
  }
Returns (() => void)
- - (): void
  - Returns void
Inherited from DeployableTargetWithRBAC.subscribe
- Defined in packages/sdk/src/Deployable/Contract.ts:197

`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 = ManagedBudgetWithFeesPayload
Parameters
- Optional_payload: P
- Optional_options: DeployableOptions
Returns [P, DeployableOptions]
Throws
DeployableWagmiConfigurationRequiredError

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

`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 DeployableTargetWithRBAC.optionallyAttachAccount
- Defined in packages/sdk/src/Deployable/Deployable.ts:216

`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 DeployableTargetWithRBAC.awaitResult
- Defined in packages/sdk/src/Deployable/Contract.ts:233

Class ManagedBudgetWithFees

Export

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ManagedBudgetWithFees

Properties

Staticbases

Static

StaticregistryType

Static

Readonlyabi

Inherit Doc

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

account

Returns undefined | Account

address

Returns undefined | `0x${string}`

config

Returns Config

Methods

allocate

Parameters

Returns Promise<boolean>

Async

allocateRaw

Parameters

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

Async

clawback

Parameters

Returns Promise<bigint>

Async

clawbackRaw

Parameters

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

Async

clawbackFromTarget

Parameters

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

Example

Async

clawbackFromTargetRaw

Parameters

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

Example

Async

disburse

Parameters

Returns Promise<boolean>

Async

disburseRaw

Parameters

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

Async

disburseBatch

Parameters

Returns Promise<boolean>

Async

disburseBatchRaw

`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: bigint;
}>

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

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

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

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

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

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

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

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