npm i @yfi/sdk
To use the SDK, you will need to instantiate a Yearn object with your desired configuration;
import { Yearn } from "@yfi/sdk";
import { JsonRpcProvider } from "@ethersproject/providers";
// Ethereum mainnet
const chainId = 1;
// It is recommended to use Alchemy for your Web3 provider when using the Yearn SDK.
const rpcUrl = "https://eth-mainnet.alchemyapi.io/v2/secret-id-here";
const yearn = new Yearn(chainId, {
provider: new JsonRpcProvider(rpcUrl)
});
Autogenerated documentation can be found here.
- Code style follows prettier conventions (
yarn lint). Commit messages follow Conventional Commits.