Yelay Lite SDK

Overview

The Yelay Lite SDK is a lightweight software development kit for interacting with Yelay's blockchain ecosystem. It provides streamlined access to vaults, yield farming, and projects via smart contract interactions as well as Backend queries.

Chains:

• Ethereum Mainnet (chainId: 1)
• Base (chainId: 8453)
• Sonic (chainId: 146)
• Arbitrum One (chainId: 42161)
• Avalanche (chainId: 43114)

Installation

To install the SDK, use npm or pnpm:

npm install @yelay-lite/sdk

or

pnpm add @yelay-lite/sdk

Initialization

To start using the SDK, initialize it with an Ethereum signer or provider and a network chainId:

import { YelayLiteSdk } from '@yelay-lite/sdk';
import { Signer } from 'ethers';
import { Provider } from '@ethersproject/abstract-provider';

const signerOrProvider: Signer | Provider = /* Your signer or provider */;
const chainId = 8453;
const sdk = new YelayLiteSdk(signerOrProvider, chainId);

Get vaults

Get all vaults managed on network.

const vaults = await sdk.vaults.getVaults();

Pool management (for integrators only)

const integratorAddress = '0x555';
const vault = '0x1234';
const { minPool, maxPool, clientName } = await sdk.vaults.clientData(integratorAddress, vault);
const poolToActivate = minPool + 5; // should be in range: minPool < poolToActivate < maxPool
const isPoolActive = await sdk.vaults.poolActive(vault, poolToActivate);
if (!isPoolActive) {
	await sdk.vaults.activatePool(vault, poolToActivate);
}

Deposit ERC20 into the vault

const vault = '0x1234';
const pool = 1234;
const amount = '1000000';

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

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

const depositTx = await sdk.vaults.deposit(vault, pool, amount);
await depositTx.wait();

Deposit ERC20 into the vault on behalf of another address

This function allows you to deposit tokens into a vault pool, but the resulting shares will be credited to a different address (receiver). This is useful for scenarios like depositing on behalf of users.

const vault = '0x1234';
const pool = 1234;
const amount = '1000000';
const receiver = '0x5678'; // Address that will receive the deposit shares

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

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

const depositTx = await sdk.vaults.depositOnBehalf(vault, pool, amount, receiver);
await depositTx.wait();

Deposit ETH into the vault

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

Get claimable yield

You can retrieve the claimable yield for a user, optionally filtering by specific pool IDs and vault addresses:

// Get all claimable yield for the user
const claimable = await sdk.yields.getClaimableYield({
	user: '0xUSER_ADDRESS',
});

// Filter by pools and vaults
const claimableFullyFiltered = await sdk.yields.getClaimableYield({
	user: '0xUSER_ADDRESS',
	poolIds: [1, 2, 3],
	vaultAddresses: ['0xVAULT_ADDRESS1'],
});

console.log(claimable);

Claim yield

Once you have retrieved claimable yield using getClaimableYield, you can claim it using the claimYield method:

// First, get the claimable yield to obtain claim requests
const claimableYield = await sdk.yields.getClaimableYield({
	user: '0xUSER_ADDRESS',
});

// Extract the claim requests from the claimable yield
const claimRequests = claimableYield.map(item => item.claimRequest);

// Submit the transaction to claim the yield
const claimTx = await sdk.yields.claimYield(claimRequests);

// Wait for the transaction to be mined
await claimTx.wait();

The claimYield method sends a transaction to the blockchain to claim yield based on the provided claim requests. It requires a valid signer with sufficient gas to execute the transaction. You can optionally provide gas overrides to customize the transaction parameters.

Swap token and deposit into vault in one transaction

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();

Redeem from the vault

const redeemTx = await sdk.vaults.redeem(vault, pool, amount);
await redeemTx.wait();

Migrate to another pool

const fromPool = 123;
const toPool = 456;
const migrateTx = await sdk.vaults.migrate(vault, fromPool, toPool, amount);
await migrateTx.wait();

Get user share balance in particular pool

const userPoolBalance = await sdk.vaults.balanceOf(vault, pool, await signer.getAddress());

Get pools TVL

const poolsTvl = await sdk.pools.getPoolsTvl(vault, [pool]);

Get historical TVL data for a vault and pool

// Fetch historical TVL data with various filter options
const historicalTVL = await sdk.pools.historicalTVL({
	vaultAddress: '0x1234...5678', // Required: The vault address to get TVL for
	poolId: 1, // Required: The specific pool ID to query
	fromTimestamp: 1641034800, // Optional: Start time in seconds (Jan 1, 2022)
	toTimestamp: 1672570800, // Optional: End time in seconds (Jan 1, 2023)
	page: 1, // Optional: Page number for pagination (starts at 1)
	pageSize: 30, // Optional: Number of records per page (max 100)
});

// Example with just the required parameters
const currentTVL = await sdk.pools.historicalTVL({
	vaultAddress: '0x1234...5678',
	poolId: 1,
});

Response Format

The historicalTVL method returns a paginated response with the following structure:

// Example response from historicalTVL
{
  data: [
    {
      vaultAddress: "0x1234...5678",
      poolId: 1,
      createTimestamp: 1745820000,
      assets: "31000000000000"
    },
    // ... more data items
  ],
  totalItems: 11,    // Total number of items matching the query
  totalPages: 1,     // Total number of pages
  currentPage: 1,    // Current page number
  pageSize: 30       // Number of items per page
}

Get yield data on vaults (filtering on vaults/timeframe)

const vaultsYield = await sdk.yields.getVaultsYield();

Get yield data on pools (filtering on vaults/pools/timeframe)

const poolsYield = await sdk.yields.getPoolsYield();

Get aggregated yield data (filtering on vaults/pools/users/timeframe)

const aggregatedYieldData = await sdk.yields.getYields();

Get protocols

const protocols = await sdk.strategies.getProtocols();

Get active strategies

const activeStrategies = await sdk.strategies.getActiveStrategies(vault);

Response Format

[
	{
		name: 'MV-something',
		protocolId: 'morpho',
		allocation: 100, // Percentage allocated to the strategy
	},
];
// Note: The sum of allocations for all active strategies doesn't have to be 100%; a portion of the funds can remain unallocated in the vault

License

This SDK is licensed under the ISC License.