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

@badger-dao/sdk

v1.23.0

Published

Badger Protocol Typescript SDK

Downloads

421

Readme

Badger SDK

BadgerDAO is a decentralized autonomous organization focused on bringing Bitcoin to DeFi. The Badger SDK provides easy access to the Badger Protocol on any chain, as well as fast access to the Badger API for JavaScript applcations.

Version License Service Tests semantic-release: angular

Documentation

Installation

Install the package:

yarn add @badger-dao/sdk

Getting Started

Utilizing the SDK requires an RPC provider:

import BadgerSDK, { Network } from '@badger-dao/sdk';

const sdk = new BadgerSDK({
  network: Network.Ethereum,
  provider: 'https://eth-archival.gateway.pokt.network/v1/lb/<APP_ID>',
  graphURL: '<Graph API URl>', // optional
});

Or, utilizing the API requires only a network input:

import { BadgerAPI, Network } from '@badger-dao/sdk';

const api = new BadgerAPI({ network: Network.Ethereum });

await api.loadPrices();

Badger subgraph is also available for use:

import { BadgerGraph, Network } from '@badger-dao/sdk';

const subgraph = new BadgerGraph({
  network: Network.Ethereum,
  baseURL: '<Graph API URl>', // optional
});

await subgraph.loadSetts({
  orderBy: 'id',
  orderDirection: 'asc',
});

Development

Consider to use package lock file, while installing node dependencies:

yarn install --frozen-lockfile
# This will auto-generete contracts and the graph code
# for further development
yarn init:sdk

General knowledge for contributing to the repository is kept in Documentation.

Some topics covered include:

Releasing new version

Releases are determined by the commit messages. Commits beginning with fix: will release a new patch version, commits beginning with feat: will release a new minor version, and commits beginning with BREAKING CHANGE: will release a new major version. The action will run on a push to main.