\n\n \n\n# 🧰 Javascript Utility Library - PoolTogether V5\n\n[📖 Documentation](https://v4.docs.pooltogether.com/protocol/introduction)\n\n## Compute\n\nThe `@generationsoftware/v5-utils-js` [node module package](https://www.npmjs.com/package/@generationsoftware/v5-utils-js) provides computations for the PoolTogether v5 protocol.\n\nHigh-order operations like processing subgraphs and chain state (draws, winners, etc..) is included in the `compute` namespaced functions.\n\n**🖥️ Computations:**\n\nConsume subgraph and protocol chain state to return computed outcomes:\n\n- [computeDrawWinners](docs/md/modules.md#computedrawwinners)\n\n[Create Issue](https://github.com/generationsoftware/v5-utils-js/issues) to request new features. [Open Pull Request](#) adhering to Contribution guidelines.\n\n# 💾 Installation\n\nThis project is available as an NPM package:\n\n```sh\nnpm install @generationsoftware/v5-utils-js\n```\n\n```sh\nyarn add @generationsoftware/v5-utils-js\n```\n\nThe repo can be cloned from Github for contributions.\n\n```sh\ngit clone https://github.com/generationsoftware/v5-utils-js\n```\n\n# 📄 Contracts Blob\n\n### `downloadContractsBlob(contractJsonUrl)`\n\nGets the list of contracts for a specific network. Typically this would be the URL of the raw JSON file on committed on GitHub.\n\n```ts\nimport { downloadContractsBlob } from \"@generationsoftware/v5-utils-js\";\n\nasync function runAsync() {\n const contracts = await downloadContractsBlob(contractJsonUrl);\n}\nrunAsync();\n```\n\n# 🏆 Draw Results\n\n### `computeDrawWinners(provider, contracts, subgraphUrl)`\n\nA helper function that runs five intensive utility functions to compute and return a JSON blob of all previous draw winner's Claim objects for each tier of a prize pool, grouped by vault.\n\n```ts\nimport { computeDrawWinners } from \"@generationsoftware/v5-utils-js\";\n\nasync function runAsync() {\n const subgraphUrl = \"https://api.studio.thegraph.com/query/63100/pt-v5-optimism/version/latest\";\n\n // Compute Winners for the last Draw\n const winners = await computeDrawWinners(provider, contracts, subgraphUrl);\n}\nrunAsync();\n\n// Returns Claim[] array:\n//\n// interface Claim {\n// vault: string;\n// winner: string;\n// tier: number;\n// prizeIndex: number;\n// claimed?: boolean;\n// }\n//\n```\n\n# 🏊 Prize Pool Info\n\n### `getPrizePoolInfo(readProvider, contracts)`\n\nGathers info about the prize pool contained in provided the `contracts` JSON blob.\n\n```ts\nimport { getPrizePoolInfo, PrizePoolInfo } from \"@generationsoftware/v5-utils-js\";\n\nasync function runAsync() {\n const prizePoolInfo: PrizePoolInfo = await getPrizePoolInfo(readProvider, contracts);\n}\nrunAsync();\n\n// Returns PrizePoolInfo object:\n//\n// interface PrizePoolInfo {\n// drawId: number;\n// numTiers: number;\n// numPrizeIndices: number;\n// reserve: string;\n// tiersRangeArray: number[]; // an easily iterable range of numbers for each tier available (ie. [0, 1, 2])\n// tierPrizeData: {\n// [tierNum: string]: TierPrizeData;\n// };\n// }\n//\n// interface TierPrizeData {\n// prizeIndicesCount: number;\n// prizeIndicesRangeArray: number[]; // an easily iterable range of numbers for each tier's prize indices\n// amount: BigNumber;\n// liquidity: BigNumber;\n// }\n//\n```\n\n# 🏦 Get Subgraph Prize Vaults\n\n### `getSubgraphPrizeVaults(subgraphUrl)`\n\nCollects all vaults from the PT v5 subgraph for a specific chain into an array.\n\n```ts\nimport { getSubgraphPrizeVaults } from \"@generationsoftware/v5-utils-js\";\n\nasync function runAsync() {\n const subgraphUrl = \"https://api.studio.thegraph.com/query/63100/pt-v5-optimism/version/latest\";\n\n const prizeVaults = await getSubgraphPrizeVaults(subgraphUrl);\n}\nrunAsync();\n\n// Returns PrizeVault[] array:\n//\n// interface PrizeVault {\n// id: string;\n// accounts: PrizeVaultAccount[]; // empty\n// }\n```\n\n# 👥 Populate Subgraph Prize Vault Accounts\n\n### `populateSubgraphPrizeVaultAccounts(subgraphUrl, vaults)`\n\nTakes the prize vaults from `getSubgraphPrizeVaults` and adds user deposit account arrays for each. `populateSubgraphPrizeVaultAccounts` is split up into a separate call from `getSubgraphPrizeVaults` as it's very network heavy, needing to page through potentially hundreds of thousands of accounts from the subgraph.\n\n```ts\nimport { populateSubgraphPrizeVaultAccounts } from \"@generationsoftware/v5-utils-js\";\n\nasync function runAsync() {\n const subgraphUrl = \"https://api.studio.thegraph.com/query/63100/pt-v5-optimism/version/latest\";\n\n let prizeVaults = await getSubgraphPrizeVaults(subgraphUrl);\n\n prizeVaults = await populateSubgraphPrizeVaultAccounts(subgraphUrl, prizeVaults);\n}\nrunAsync();\n\n// Returns PrizeVault[] array:\n//\n// interface PrizeVault {\n// ...\n// accounts: PrizeVaultAccount[]; // populated!\n// }\n```\n\n# 🏁 Get Winner's Claims\n\n### `getWinnersClaims(readaProvider, prizePoolInfo, contracts, vaults)`\n\nCollects Claim objects into an array for all prizes in the past draw.\n\n```ts\nimport { getWinnersClaims } from \"@generationsoftware/v5-utils-js\";\n\nasync function runAsync() {\n let claims: Claim[] = await getWinnersClaims(readProvider, prizePoolInfo, contracts, vaults);\n}\nrunAsync();\n\n// Returns Claim[] array:\n//\n// interface Vault {\n// vault: string;\n// winner: string;\n// tier: number;\n// prizeIndex: number;\n// claimed?: boolean; // null\n// }\n```\n\n# 🏁 Flag Claimed (RPC)\n\n### `flagClaimedRpc(readProvider, contracts, claims)`\n\nAdds the `claimed` boolean to the claims using RPC lookups.\n\n```ts\nimport { flagClaimedRpc } from \"@generationsoftware/v5-utils-js\";\n\nasync function runAsync() {\n claims = await flagClaimedRpc(readProvider, contracts, claims);\n}\nrunAsync();\n\n// Returns Claim[] array:\n//\n// interface Vault {\n// ...\n// claimed?: boolean; // now set true or false\n// }\n```\n","readmeFilename":"README.md"}
![\"PoolTogether](\"https://raw.githubusercontent.com/GenerationSoftware/pt-v5-utils-js/main/img/pooltogether-logo--purple@2x.png?raw=true\"){kind=logo}
\n