Setting up

Activating your client account

To activate your client account on Yelay's vaults, contact @konstantinius or @paypri on Telegram, or reach out to @yieldlayer on X.

Each integrator will receive their designated range of pools (i.e., your "pools" within Yelay vaults). Your frontend will handle transactions to and from your assigned pool within the Yelay vault, which is shared among all clients and pools.

You will be able to retrieve accrued yield data for each Pool ID separately—both for individual users and for users within specific Pool IDs.

The image below illustrates the relationship between User, Client, Pool, and Vault:

Installation

To install the SDK, use npm or pnpm:

npm install @yelay-lite/sdk

or

pnpm add @yelay-lite/sdk

The SDK uses ethers.js v5.

Vaults and pools

To start using the SDK, initialize it with an Ethereum signer or provider and a chain ID.

Yelay has two types of vaults: test and production.

• Use test vaults for testing transactions.

• For real user funds, use production vaults only.

Test vaults are available on Base only, while production vaults will be deployed across multiple chains in addition to Base.

To retrieve actual vault addresses, use the getVaults() method. To fetch pool IDs belonging to a vault, use the clientData() method.

Both methods are described here: 🔗 Yelay SDK Supportive Methods

Vault Addresses on Base

Yelay Test Vault Addresses

• USDC Vault: 0x7b3D25c37c6ADf650F1f7696be2278cCFa2b638F

• WETH Vault: 0x1f463353feA78e38568499Cf117437493d334eCf

Yelay Production Vault Addresses

• USDC Vault: 0x0c6dAf9B4e0EB49A0c80c325da82EC028Cb8118B

• WETH Vault: 0xf0533A9eb11b144aC3B9BbE134728D0F7F547c52

More chains will be supported soon.

Initialising the SDK

For Test Use

Ensure you pass the third parameter as true to initialize access to test vaults instead of production vaults.

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

const signerOrProvider: Signer | Provider = /* Your signer or provider */;
const chainId = 8453; // Supported chain ID

const sdk = new YelayLiteSdk(signerOrProvider, chainID, true);

For Production Use

Initialize the SDK with an Ethereum signer or provider and a chain ID:

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

const signerOrProvider: Signer | Provider = /* Your signer or provider */;
const chainId = 8453; // Supported chain ID

const sdk = new YelayLiteSdk(signerOrProvider, chainId);