Setting up

Activating your client account

First, contact @konstantinius, @paypri on Telegram or @yieldlayer on X in order to request activating your client account on Yelay's vaults.

Each integrator will get their range of pools (i.e. your ‘pools’ within Yelay vaults). Your FE will manage transactions to and from the range of your 'pool' in Yelay vault (that is shared between all clients and pools). You will be able to fetch accrued yield for each Pool ID separately, for users individually as well as for the users within specific Pool IDs. The image below shows 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

SDK is using etherjs v5.

Vaults and pools

To start using the SDK, initialise it with an Ethereum signer or provider and chainID.

Yelay has two types of vaults, test and production ones. Use test vaults for test transactions. For user funds, use production vautls only.

Test vaults will be on Base only. Production ones will be on multiple chains in addition to Base.

In order to fetch actual vault addresses, use getVaults() method. In order to fetch pool ids belonging to the vault, use clientData()method. Both methods are described here: https://v3sdk.yelay.io/supportive-methods

For the reference, here are the addresses of the vaults on Base.

Yelay test vault addresses on Base:

USDC VAULT: 0x7b3D25c37c6ADf650F1f7696be2278cCFa2b638F

WETH VAULT: 0x1f463353feA78e38568499Cf117437493d334eCf

Yelay production vault addresses on Base:

USDC VAULT: 0x0c6dAf9B4e0EB49A0c80c325da82EC028Cb8118B

WETH VAULT: 0xf0533A9eb11b144aC3B9BbE134728D0F7F547c52

More chains are coming soon.

Initialising SDK for test use

Ensure to pass third parameter as 'true' in order to initalize access to the 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);

Initialising SDK for production use

Initialize SDK with an Ethereum signer or provider and chainId:

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