@boostxyz/sdk 6.1.3 → 7.0.0-canary.1

package/dist/Budgets/TransparentBudget.d.ts

@@ -0,0 +1,944 @@
+import { transparentBudgetAbi } from '@boostxyz/evm';
+import { type Address, type ContractEventName, type Hex } from 'viem';
+import type { DeployableOptions, GenericDeployableParams } from '../Deployable/Deployable';
+import { DeployableTargetWithRBAC } from '../Deployable/DeployableTargetWithRBAC';
+import type { ERC1155TransferPayload, FungibleTransferPayload } from '../transfers';
+import { type GenericLog, type ReadParams, RegistryType, type WriteParams } from '../utils';
+export { transparentBudgetAbi };
+export type { ERC1155TransferPayload, FungibleTransferPayload };
+/**
+ * A generic `viem.Log` event with support for `TransparentBudget` event types.
+ *
+ * @export
+ * @typedef {TransparentBudgetLog}
+ * @template {ContractEventName<typeof transparentBudgetAbi>} [event=ContractEventName<
+ *     typeof transparentBudgetAbi
+ *   >]
+ */
+export type TransparentBudgetLog<event extends ContractEventName<typeof transparentBudgetAbi> = ContractEventName<typeof transparentBudgetAbi>> = GenericLog<typeof transparentBudgetAbi, event>;
+/**
+ * A budget implementation that transfers assets to the budget on Boost creation.
+ * Can be used with or without [Permit2](https://github.com/Uniswap/permit2) for token approval
+ *
+ * @export
+ * @class TransparentBudget
+ * @typedef {TransparentBudget}
+ * @extends {DeployableTargetWithRBAC<TransparentBudgetPayload>}
+ */
+export declare class TransparentBudget extends DeployableTargetWithRBAC<never, typeof transparentBudgetAbi> {
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @readonly
+     * @type {*}
+     */
+    readonly abi: readonly [{
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "AlreadyInitialized";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "CloneAlreadyInitialized";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "FnSelectorNotRecognized";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InitializerNotImplemented";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [{
+            readonly name: "asset";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "available";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "required";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "InsufficientFunds";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [{
+            readonly name: "asset";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "amount";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "InvalidAllocation";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InvalidInitialization";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InvalidInitializationData";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "LengthMismatch";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NewOwnerIsZeroAddress";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NoHandoverRequest";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NotImplemented";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NotInitializing";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "Reentrancy";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [{
+            readonly name: "asset";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "to";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "amount";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "TransferFailed";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "Unauthorized";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "Unauthorized";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "asset";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "to";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: false;
+        }, {
+            readonly name: "amount";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }];
+        readonly name: "Distributed";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "version";
+            readonly internalType: "uint64";
+            readonly type: "uint64";
+            readonly indexed: false;
+        }];
+        readonly name: "Initialized";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }];
+        readonly name: "OwnershipHandoverCanceled";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }];
+        readonly name: "OwnershipHandoverRequested";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "oldOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "newOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }];
+        readonly name: "OwnershipTransferred";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: true;
+        }];
+        readonly name: "RolesUpdated";
+    }, {
+        readonly type: "fallback";
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "ADMIN_ROLE";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "MANAGER_ROLE";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "PERMIT2";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "contract IPermit2";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "allocate";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "available";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "available";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "cancelOwnershipHandover";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "clawback";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "target";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }, {
+            readonly name: "boostId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "incentiveId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "clawbackFromTarget";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "completeOwnershipHandover";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "_allocations";
+            readonly internalType: "bytes[]";
+            readonly type: "bytes[]";
+        }, {
+            readonly name: "core";
+            readonly internalType: "contract BoostCore";
+            readonly type: "address";
+        }, {
+            readonly name: "_boostPayload";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "createBoost";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "_allocations";
+            readonly internalType: "bytes[]";
+            readonly type: "bytes[]";
+        }, {
+            readonly name: "core";
+            readonly internalType: "contract BoostCore";
+            readonly type: "address";
+        }, {
+            readonly name: "_boostPayload";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }, {
+            readonly name: "_permit2Signature";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }, {
+            readonly name: "nonce";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "deadline";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "createBoostWithPermit2";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "disburse";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "data_";
+            readonly internalType: "bytes[]";
+            readonly type: "bytes[]";
+        }];
+        readonly name: "disburseBatch";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "asset_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "distributed";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "asset_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "tokenId_";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "distributed";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "getComponentInterface";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }];
+        readonly stateMutability: "pure";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "accounts_";
+            readonly internalType: "address[]";
+            readonly type: "address[]";
+        }, {
+            readonly name: "roles_";
+            readonly internalType: "uint256[]";
+            readonly type: "uint256[]";
+        }];
+        readonly name: "grantManyRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "grantRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "hasAllRoles";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "hasAnyRole";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "initialize";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "account_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "isAuthorized";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "";
+            readonly internalType: "uint256[]";
+            readonly type: "uint256[]";
+        }, {
+            readonly name: "";
+            readonly internalType: "uint256[]";
+            readonly type: "uint256[]";
+        }, {
+            readonly name: "";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "onERC1155BatchReceived";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }];
+        readonly stateMutability: "pure";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "onERC1155Received";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }];
+        readonly stateMutability: "pure";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "owner";
+        readonly outputs: readonly [{
+            readonly name: "result";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "ownershipHandoverExpiresAt";
+        readonly outputs: readonly [{
+            readonly name: "result";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "reconcile";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "renounceOwnership";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "renounceRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "requestOwnershipHandover";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "accounts_";
+            readonly internalType: "address[]";
+            readonly type: "address[]";
+        }, {
+            readonly name: "roles_";
+            readonly internalType: "uint256[]";
+            readonly type: "uint256[]";
+        }];
+        readonly name: "revokeManyRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "revokeRoles";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "user";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "rolesOf";
+        readonly outputs: readonly [{
+            readonly name: "roles";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "accounts_";
+            readonly internalType: "address[]";
+            readonly type: "address[]";
+        }, {
+            readonly name: "authorized_";
+            readonly internalType: "bool[]";
+            readonly type: "bool[]";
+        }];
+        readonly name: "setAuthorized";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "interfaceId";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }];
+        readonly name: "supportsInterface";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bool";
+            readonly type: "bool";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "asset_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "total";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "asset_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "tokenId_";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "total";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "newOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "transferOwnership";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "receive";
+        readonly stateMutability: "payable";
+    }];
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @static
+     * @type {Record<number, Address>}
+     */
+    static bases: Record<number, Address>;
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @static
+     * @type {RegistryType}
+     */
+    static registryType: RegistryType;
+    /**
+     * 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.
+     *
+     * @example
+     * ```ts
+     * const [amount, address] = await budgets.budget.clawbackFromTarget(
+     *   core.assertValidAddress(),
+     *   erc20Incentive.buildClawbackData(1n),
+     *   boost.id,
+     *   incentiveId,
+     * );
+     * ```
+     * @public
+     * @async
+     * @param {Address} target - The address of a contract implementing clawback, typically `BoostCore`
+     * @param {Hex} data - The encoded data payload for the clawback, can be acquired with `incentive.buildClawbackData`
+     * @param {bigint | number} boostId - The ID of the boost
+     * @param {bigint | number} incentiveId - The ID of the incentive
+     * @param {?WriteParams} [params] - Optional write parameters
+     * @returns {Promise<[bigint, Address]>} - Returns a tuple of amount reclaimed and the address reclaimed from
+     */
+    clawbackFromTarget(target: Address, data: Hex, boostId: bigint | number, incentiveId: bigint | number, params?: WriteParams): 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.
+     *
+     * @example
+     * ```ts
+     * const { hash, result: [ amount, address ] } = await budgets.budget.clawbackFromTargetRaw(
+     *   core.assertValidAddress(),
+     *   erc20Incentive.buildClawbackData(1n),
+     *   boost.id,
+     *   incentiveId,
+     * );
+     * ```
+     * @public
+     * @async
+     * @param {Address} target - The address of a contract implementing clawback, typically `BoostCore`
+     * @param {Hex} data - The encoded data payload for the clawback, can be acquired with `incentive.buildClawbackData`
+     * @param {bigint | number} boostId - The ID of the boost
+     * @param {bigint | number} incentiveId - The ID of the incentive
+     * @param {?WriteParams} [params] - Optional write parameters
+     * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - Returns transaction hash and simulated result
+     */
+    clawbackFromTargetRaw(target: Address, data: Hex, boostId: bigint | number, incentiveId: bigint | number, params?: WriteParams): Promise<{
+        hash: `0x${string}`;
+        result: readonly [bigint, `0x${string}`];
+    }>;
+    /**
+     * Disburses assets from the budget to a single recipient
+     * If the asset transfer fails, the disbursement will revert
+     *
+     * @public
+     * @async
+     * @param {(FungibleTransferPayload | ERC1155TransferPayload)} transfer
+     * @param {?WriteParams} [params]
+     * @returns {Promise<boolean>} - True if the disbursement was successful
+     */
+    disburse(transfer: FungibleTransferPayload | ERC1155TransferPayload, params?: WriteParams): Promise<boolean>;
+    /**
+     * Disburses assets from the budget to a single recipient
+     * If the asset transfer fails, the disbursement will revert
+     *
+     * @public
+     * @async
+     * @param {(FungibleTransferPayload | ERC1155TransferPayload)} transfer
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if the disbursement was successful
+     */
+    disburseRaw(transfer: FungibleTransferPayload | ERC1155TransferPayload, params?: WriteParams): Promise<{
+        hash: `0x${string}`;
+        result: boolean;
+    }>;
+    /**
+     * Disburses assets from the budget to multiple recipients
+     *
+     * @public
+     * @async
+     * @param {Array<FungibleTransferPayload | ERC1155TransferPayload>} transfers
+     * @param {?WriteParams} [params]
+     * @returns {Promise<boolean>} - True if all disbursements were successful
+     */
+    disburseBatch(transfers: Array<FungibleTransferPayload | ERC1155TransferPayload>, params?: WriteParams): Promise<boolean>;
+    /**
+     * Disburses assets from the budget to multiple recipients
+     *
+     * @public
+     * @async
+     * @param {Array<FungibleTransferPayload | ERC1155TransferPayload>} transfers
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - True if all disbursements were successful
+     */
+    disburseBatchRaw(transfers: Array<FungibleTransferPayload | ERC1155TransferPayload>, params?: WriteParams): Promise<{
+        hash: `0x${string}`;
+        result: boolean;
+    }>;
+    /**
+     * 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
+     *
+     * @public
+     * @param {Address} [asset="0x0000000000000000000000000000000000000000"] - The address of the asset
+     * @param {?(bigint | undefined)} [tokenId] - The ID of the token
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>} - The total amount of assets
+     */
+    total(asset?: Address, tokenId?: bigint | undefined, params?: ReadParams): 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
+     *
+     * @public
+     * @param {Address} [asset="0x0000000000000000000000000000000000000000"]
+     * @param {?(bigint | undefined)} [tokenId]
+     * @param {?ReadParams} [params]
+     * @returns {Promise<bigint>} - The amount of assets distributed
+     */
+    distributed(asset?: Address, tokenId?: bigint | undefined, params?: ReadParams): Promise<never>;
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @param {?TransparentBudgetPayload} [_payload]
+     * @param {?DeployableOptions} [_options]
+     * @returns {GenericDeployableParams}
+     */
+    buildParameters(_payload?: never, _options?: DeployableOptions): GenericDeployableParams;
+}
+//# sourceMappingURL=TransparentBudget.d.ts.map