@generationsoftware/pt-v5-utils-js-beta

🧰 Javascript Utility Library - PoolTogether V5

📖 Documentation

Compute

The @pooltogether/v5-utils-js node module package provides computations for the PoolTogether v5 protocol.

High-order operations like processing subgraphs and chain state (draws, winners, etc..) is included in the compute namespaced functions.

🖥️ Computations:

Consume subgraph and protocol chain state to return computed outcomes:

• computeDrawWinners

Create Issue to request new features.
Open Pull Request adhering to Contribution guidelines.

💾 Installation

This project is available as an NPM package:

npm install @pooltogether/v5-utils-js

yarn add @pooltogether/v5-utils-js

The repo can be cloned from Github for contributions.

git clone https://github.com/pooltogether/v5-utils-js

🏆 Quickstart (Contracts Blob)

Getting the list of contracts for a specific network is easy using the downloadContractsBlob(chainId) function.

Currently supports:

• Optimism Goerli (testnet)
• Goerli (testnet)

import { downloadContractsBlob } from "@pooltogether/v5-utils-js";

async function main() {
  const contracts = await downloadContractsBlob(chainId);
}
main();

🏆 Quickstart (Draw Results)

computeDrawWinners(provider, contracts, chainId) computes and returns a JSON blob of all previous draw winner's Claim objects for each tier of a prize pool, grouped by vault.

import { computeDrawWinners } from "@pooltogether/v5-utils-js";

// Compute Winners for the last Draw
const winners = computeDrawWinners(provider, contracts, chainId);

// Returns Claim[]:
//
// interface Claim {
//   vault: string;
//   winner: string;
//   tier: number;
//   prizeIndex: number;
//   claimed?: boolean;
// }
//