Deposit

Handling deposits

In order to deposit to the Yelay V3 vault using vault's asset currency, do the following:

const vaultAddress = '0x1234';
const poolId = 1234;
const amount = '1000000';

const allowance = await sdk.vaults.allowance(vault);

if (allowance.isZero()) {
	const approveTx = await sdk.vaults.approve(vaultAddress, amount);
	await approveTx.wait();
}

const depositTx = await sdk.vaults.deposit(vaultAddress, poolId, amount);
await depositTx.wait();

Where:

• vaultAddress is one of the vaults set up by Yelay. You can fetch addresses of the vaults by using sdk.vaults.getVaults() method. See 'Supportive methods' chapter.

• poolId is one of the pools set up by the Client in the vault

Once deposit is done, the corresponding amount of NFT ERC-1155 shares is minted in user's wallet.

F.e. for this deposit of 1 USDC to the Yelay V3 test vault with Pool ID = 1, corresponding amount of 1,000,000 ERC-1155 has been minted:

If deposit is 2 USDC, 2,000,000 NFTs will be minted, etc.

Depositing with any asset

1. Any ERC-20 token

In order to deposit any ERC-20 token and swap it on the way, use sdk.vaults.swapAndDeposit method:

const vault = '0x123';
const pool = 1234;
const amount = '1000000';
const tokenToSwap = '0x456';
// only 1inch Aggregation Router v6 is supported
const swapTarget = '1inch Aggregation Router v6 address';
const swapCallData = '0x9...1';

const allowance = await sdk.vaults.vaultWrapperAllowance(tokenToSwap);

if (allowance.isZero()) {
	const approveTx = await sdk.vaults.approveVaultWrapper(tokenToSwap, amount);
	await approveTx.wait();
}

const swapAndDepositTX = await sdk.vaults.swapAndDeposit(vault, pool, amount, {
	swapCallData,
	swapTarget,
	tokenIn: tokenToSwap,
});
await swapAndDepositTX.wait();

Where:

• vault - the address of the vault

• pool - one the pools set up by the Client in the vault

• amount - the deposit amount

• swapCallData - swap args from 1Inch

• swapTarget - should be asset of the vault

• tokenToSwap - deposit token that needs to be swapped

The method a promise that resolves to the result of the deposit transaction.

(!) Note that using this method requires getting 1inch API key and getting swapData from it. This means that using this method will incur swap costs for the users.

1. Wrap ETH when depositing to WETH vault

Use depositEth method in order to deposit specified amount of ETH into the WETH vault (i.e. naturally wrap ETH into WETH instead of swapping in order to avoid swap fees) :

const tx = await sdk.vaults.depositEth(vault, poolId, amount);
await tx.wait();

The method uses the VaultWrapper contract underneath in order to handle ETH wrapping and depositing in a single transaction.

Where:

• vault - address of Yelay V3 WETH vault on the given chain

• poolId - id of the pool where user deposits

• amount - amount of ETH to deposit

Method returns {Promise} - a promise that resolves to the result of the deposit transaction.