Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pooltogether/pooltogetherjs
PoolTogether Client JavaScript library
https://github.com/pooltogether/pooltogetherjs
Last synced: about 2 months ago
JSON representation
PoolTogether Client JavaScript library
- Host: GitHub
- URL: https://github.com/pooltogether/pooltogetherjs
- Owner: pooltogether
- License: mit
- Created: 2019-10-07T21:31:21.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T22:20:13.000Z (almost 2 years ago)
- Last Synced: 2024-08-08T21:33:07.105Z (5 months ago)
- Language: JavaScript
- Size: 1.75 MB
- Stars: 11
- Watchers: 3
- Forks: 3
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PoolTogether.js
Helper functions for calculating Pool values. Functions use the BigNumber library `bn.js`.
The PoolTogether algorithm is described in the Medium article [Inside PoolTogether v2.0](https://medium.com/pooltogether/inside-pooltogether-v2-0-e7d0e1b90a08).
# Example / Demo
There is an example app located at https://github.com/pooltogether/pooltogetherjs-example-dapp to show you how to get data from the Ethereum blockchain you will need before using this library.
## Installation
The library is built as a CommonJS module:
```bash
# yarn add pooltogether/pooltogetherjs
```
## Usage
```javascript
const pt = require('pooltogetherjs')
pt.utils.calculatePrize(balance, accountedBalance, feeFraction)
```
[API Reference](https://pooltogether.github.io/pooltogetherjs/)
## 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:
```javascript
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.
```javascript
const ethers = require('ethers')
// Use the next prize award date as the string.
// For daily pools every day at noon PST, for weekly every Friday at noon PST.
const awardAtMs = Date.parse('28 Feb 2020 12:00:00 PST');
const remainingTimeS = (awardAtMs - (new Date()).getTime()) / 1000
const remainingBlocks = remainingTimeS / 15.0 // about 15 second block periods
const blockFixedPoint18 = ethers.utils.parseEther(remainingBlocks) // convert to fixed point 18 for fractional blocks
```
Now you can calculate the final estimated prize:
```javascript
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
)
```