Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 2.08 KB

README.md

File metadata and controls

69 lines (48 loc) · 2.08 KB

Yearn SDK

CI Styled With Prettier

Getting Started

Installation

npm i @yfi/sdk

Configuration/Usage

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

Documentation

Autogenerated documentation can be found here.

Helpful links

Contributing

Releasing the SDK to npmjs

Debug the website with a local copy of the sdk