Introduction

Get started with Yelay SDK. Learn about the inner workings of Yelay protocol and explore the usage possibilities by studying provided examples.

Yelay SDK is a TypeScript npm package that provides a convenient way to interact with Yelay protocol. It encapsulates RPC calls to the Yelay smart contract as well as API calls to the subgraph, making it easier for developers to integrate Yelay functionality into their own projects.

This document contains and code snippets of all SDK functions, along with short explanations. On top of that, all the important concepts are explained in an easy-to-understnd manner that includes text and schemes. In that way we enable developers, new to Yelay , to quickly get a grasp of how things work to speed up their onboarding.

With Yelay SDK, Typescript developers can implement their own custom DeFi yield-farming product experiences, such as:

• Get user details (like used vaults and information about deposits/withdrawals)

• Get vault details (like information about the vault, TVL and APY)

• Enable users to make transactions via Yelay (like depositing to and withdrawing from the vaults)

• Enable your product or your users to create custom vaults

• Manage vault incentivisation (adding, adjusting or extending on- and off-chain incentives)

Aditional information

For Testnet usage and testing, Yelay is set up on Sepolia testnet. See the examples in this docs on how to connect and use it. To obtain Sepolia testnet tokens, please contact the Yelay team in Discord by tagging @web3lling.