✔️How to create a vault

You can create a new Vault using the VaultFactory contract. This process involves calling the createVault function and specifying various parameters to configure the initial settings of the Vault.

Function Signature

function createVault(
    IERC20 asset,
    string memory name,
    string memory symbol,
    uint256 initialFee,
    address initialFeeRecipient,
    uint256 minDelay,
    IVault.VaultType vaultType
) external returns (Vault)

Parameters

Parameter	Type	Description
asset	IERC20	The address of the base asset (token) to be used in the Vault
name	string	The name of the Vault
symbol	string	The symbol of the Vault
initialFee	uint256	Initial fee setting (max 1000, which represents 10%)
initialFeeRecipient	address	The initial address to receive fees
minDelay	uint256	Minimum delay for timelock operations (in seconds)
vaultType	IVault.VaultType	Type of the Vault (Public or Private)

Returns

• Vault: The address of the newly created Vault contract

Usage Example (using ethers.js)

const VaultFactory = // Initialize VaultFactory contract instance

// Prepare parameters
const asset = "0x..."; // Base asset token address
const name = "My Vault";
const symbol = "MVLT";
const initialFee = 100; // 1% fee
const initialFeeRecipient = "0x..."; // Fee recipient address
const minDelay = 86400; // 1 day
const vaultType = 0; // 0: Public, 1: Private

// Create Vault
const tx = await VaultFactory.createVault(
    asset,
    name,
    symbol,
    initialFee,
    initialFeeRecipient,
    minDelay,
    vaultType
);

const receipt = await tx.wait();

// Extract new Vault address from event
const vaultCreatedEvent = receipt.events.find(e => e.event === 'VaultCreated');
const newVaultAddress = vaultCreatedEvent.args.vault;
console.log(`New Vault created at: ${newVaultAddress}`);

Important Notes

• initialFee should be a value between 0 and 1000 (0% - 10%).

• minDelay should be set carefully. Too short may pose security risks, while too long may cause operational inconvenience. (minimum: 600 seconds)

• If creating a Private Vault (type: 1), subsequent whitelist management will be necessary.

• After creating the Vault, you need to add the required Banks and set allocations.

Event

A VaultCreated event is emitted when a Vault is created:

event VaultCreated(
    address indexed vault,
    address indexed asset,
    string name,
    string symbol
);

You can monitor this event to track the creation of new Vaults.

After creating a Vault, you can use its address to perform additional setup and management operations.