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

pooltogetherjs

v0.2.0

Published

PoolTogether Client JavaScript library

Downloads

17

Readme

PoolTogether.js

Helper functions for calculating Pool values. Functions use the BigNumber library bn.js which is common to both ethers.js and web3.js.

The PoolTogether algorithm is described in the Medium article Inside PoolTogether v2.0.

Installation

The library is built as a CommonJS module:

# yarn add pooltogether/pooltogetherjs

Usage

const pt = require('pooltogetherjs')
pt.utils.calculatePrize(balance, accountedBalance, feeFraction)

API Reference

Recipe

Calculating the Current Prize

To calculate the current (accrued so far) prize, first pull the following values from the Pool:

  • balance = Pool#balance: the current balance of the Pool in Compound
  • accountedBalance = Pool#accountedBalance: the balance of the Pool that has thus far been accounted for
  • currentCommittedDrawId = Pool#currentCommittedDrawId: the currently "locked" prize that will be awarded next
  • draw = Pool#getDraw(currentCommittedDrawId): gets the current committed draw information

Now you can calculate the current prize:

const pt = require('pooltogetherjs')
const prize = pt.utils.calculatePrize(
  balance,
  accountedBalance,
  draw.feeFraction
)

Determining the Draw Date

The award date occurs two weeks after the prize is opened for deposits. You can calculate the date for either the current committed prize (i.e. the next prize to be awarded) or the current open prize (the prize that everyone is currently depositing into).

  • currentCommittedDrawId = Pool#currentCommittedDrawId: the currently "locked" prize that will be awarded next
  • draw = Pool#getDraw(currentCommittedDrawId): gets the current committed draw information

You can use the draw.openedBlock to determine the timestamp of the block, then add two weeks to it. That'll give you the draw date.

Calculating the Estimated Prize

To calculate the estimated prize, first pull the following values from the Pool:

  • balance = Pool#balance: the current balance of the Pool in Compound
  • accountedBalance = Pool#accountedBalance: the balance of the Pool that has thus far been accounted for
  • currentCommittedDrawId = Pool#currentCommittedDrawId: the currently "locked" prize that will be awarded next
  • draw = Pool#getDraw(currentCommittedDrawId): gets the current committed draw information
  • supplyRatePerBlock = Pool#supplyRatePerBlock: gets the current supply rate per block

You'll also need to determine how many blocks are remaining before the prize is awarded.

const pt = require('pooltogetherjs')
const balance = // retrieve the balance via ethers.js or web3.js
const balanceTakenAt = new Date()

Now you can calculate the final estimated prize:

const pt = require('pooltogetherjs')
const prize = pt.utils.calculatePrize(
  balance,
  accountedBalance,
  draw.feeFraction
)

const prizeSupplyRate = pt.utils.calculatePrizeSupplyRate(
  supplyRatePerBlock,
  draw.feeFraction
)

const prizeEstimate = pt.utils.calculatePrizeEstimate(
  balance,
  prize,
  blocksFixedPoint18,
  prizeSupplyRate
)