npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bombearn/sdk

v3.0.3

Published

Interaction framework for the yearn protocol

Downloads

6

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

1coinassets1coinassets

Keywords

yearncryptosdktypescript

Readme

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

  • Code style follows prettier conventions (yarn lint). Commit messages follow Conventional Commits.
  • PR conventions should follow our guidelines outlined at https://github.com/yearn/yearn-sdk/wiki/PR-conventions

Releasing the SDK to npmjs

  • Get write access to the package on npmjs - https://www.npmjs.com/package/@yfi/sdk
  • Login to npm - npm login
  • Install np - https://www.npmjs.com/package/np
  • Checkout and pull the master branch
  • Run yarn build
  • Run np and follow the instructions

Debug the website with a local copy of the sdk

  • Install yalc - https://www.npmjs.com/package/yalc
  • Run yarn build
  • Run yalc publish
  • Clone the website repo, configure the enviornment and open a terminal in it - https://github.com/yearn/yearn-finance-v3
  • Run yalc add @yfi/sdk
  • Run yarn install
  • Run yarn start