# 🧰 Javascript Utility Library - PoolTogether V5
[Documentation](https://docs.pooltogether.com/)
## Calculations, Computations and Core Logic
The `@pooltogether/v5-utils-js` [node module package](https://www.npmjs.com/package/@pooltogether/v5-utils-js) provides computations for the PoolTogether v5 protocol.
High-order operations like processing subgraphs and chain state (draws, winners, etc..) is included in the `computations` namespaced functions.
**🖥️ Computations:**
Consume subgraph and protocol chain state to return computed outcomes:
- [computeDrawWinners](docs/md/modules.md#computedrawwinners)
[Create Issue](https://github.com/pooltogether/v5-utils-js/issues) to request new features.
[Open Pull Request](#) adhering to Contribution guidelines.
# 💾 Installation
This project is available as an NPM package:
```sh
npm install @pooltogether/v5-utils-js
```
```sh
yarn add @pooltogether/v5-utils-js
```
The repo can be cloned from Github for contributions.
```sh
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:
- Sepolia (testnet)
- Mumbai (testnet)
- Goerli (testnet) (outdated!)
```ts
import { downloadContractsBlob } from "@pooltogether/v5-utils-js";
async function main() {
const contracts = await downloadContractsBlob(chainId);
}
main();
```
# 🏆 Quickstart (Draw Results)
Functions like `computeDrawWinners(chainId, prizePool)` compute and return JSON of winners for each tier of a prize pool, grouped by vault.
```ts
import { computeDrawWinners } from "@pooltogether/v5-utils-js";
// Compute Winners for the last Draw (where prizePool is the address)
const winners = computeDrawWinners(chainId, prizePool);
```
# 📖 Documentation
### Namespaces
- [compute](docs/md/modules/compute.md)
- [utils](docs/md/modules/utils.md)