Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.boost.xyz/llms.txt

Use this file to discover all available pages before exploring further.

The One-Time Actions docs are under active development and will be subject to changes.
The Managed Budget contract is designed to hold and distribute assets that can be used to deploy boosts. The Boost SDK provides several methods to manage and view the available funds in a budget.

​
API

​
allocate

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.
Before using allocate, you must approve the ManagedBudget to spend the asset you want to allocate.
import { parseUnits } from "viem";

// Allocate assets to the budget
await budget.allocate({
  amount: parseUnits('1', 18), // the amount of tokens to allocate
  asset: '0xf3B2d0E4f2d8F453DBCc278b10e88b20d7f19f8D', // token address
  target: account.address, // the address allocating the funds
});
You can also directly transfer tokens to the ManagedBudget contract address instead of using the allocate function. This allows you to bypass the approval process for ERC20 tokens.

​
Parameters

​
transfer
FungibleTransferPayload
required
​
parameters
Omit<wagmi.WriteContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying writeContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.

​
Returns

​
Promise<boolean>
boolean
Returns true if the allocation was successful.

​
available

Shows the available balance of an asset in the budget. 
await budget.available({
  asset: '0xf3B2d0E4f2d8F453DBCc278b10e88b20d7f19f8D', // token address
});
// 1000000000000000000n

​
Parameters

​
asset
string
The address of the asset. Leave blank to get the balance of the native asset. (ie: ETH)
​
parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.

​
Returns

​
Promise<bigint>
bigint
The available balance of the asset.

​
distributed

Get the total amount of an asset distributed from the budget. 
await budget.distributed({
  asset: '0xf3B2d0E4f2d8F453DBCc278b10e88b20d7f19f8D', // token address
});
// 1000000000000000000n

​
Parameters

​
asset
string
The address of the asset. Leave blank to get the distributed amount of the native asset. (ie: ETH)
​
parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.

​
Returns

​
Promise<bigint>
bigint
The total amount of the asset distributed from the budget.

​
total

Get the total amount of an asset allocated to the budget, including any that have been distributed.
total = available + distributed 
await budget.total({
  asset: '0xf3B2d0E4f2d8F453DBCc278b10e88b20d7f19f8D', // token address
});
// 1000000000000000000n

​
Parameters

​
asset
string
The address of the asset. Leave blank to get the total amount of the native asset. (ie: ETH)
​
parameters
Omit<wagmi.ReadContractParameters, 'address' | 'args' | 'functionName' | 'abi'>
Optional parameters to pass to the underlying readContract method. Checkout wagmi’s documentation for more information. address, args, functionName, abi are handled for you under the hood.

​
Returns

​
Promise<bigint>
bigint
The total amount of the asset allocated to the budget, including any that have been distributed.