\n\n \n\n# 🖥️ PoolTogether V5\n\n### CLI\n\nThe `@generationsoftware/pt-v5-cli` [node module package](https://www.npmjs.com/package/@generationsoftware/pt-v5-cli) is a Node command line interface (CLI) to interact with the **PoolTogether V5 protocol**. The CLI uses the `pt-v5-utils-js` package to fetch and run calculations/computations for essential PoolTogether V5 tasks.\n\nPrimary CLI Commands (help)\n\n```sh\nnpx @generationsoftware/pt-v5-cli help utils compileWinners\n```\n\n### Setup\n\nSet up your environment variables using `dotenv`:\n\n#### ENV\n\nCopy `.envrc.example` and input the env vars needed to run this project:\n\n```sh\ncp .envrc.example .envrc\n```\n\nOnce your env variables are setup, load them with:\n\n```sh\ndirenv allow\n```\n\n#### LIST OF ENVIRONMENT VARIABLES\n\n```sh\nJSON_RPC_URL: Your Infura/Alchemy/etc JSON RPC URI\n\n# OPTIONAL:\n\nDEBUG: if set to true will print more debug information when calculating winners\nPRIZE_TIERS_TO_COMPUTE: optional CSV list of prize tiers to compute - example: '0,2,3,5'\n```\n\n# ⌨️ CLI Installation\n\n\n```sh-session\n$ npm install -g @generationsoftware/pt-v5-cli\n$ ptv5 COMMAND\nrunning command...\n$ ptv5 (--version)\n@generationsoftware/pt-v5-cli/2.1.1 darwin-arm64 node-v22.12.0\n$ ptv5 --help [COMMAND]\nUSAGE\n $ ptv5 COMMAND\n...\n```\n\n\n# Commands\n\n## Compile Winners\n\n```sh-session\nptv5 utils compileWinners\n```\n\nFinds draw's depositors with a non-zero balance for a PrizePool, then computes who won and outputs all this data to a target output directory.\n\nPass the `chainId`, `prizePool`, `outDir`, `contractJsonUrl` and `subgraphUrl` to compute and locally save the results.\n\n```\nUSAGE\n $ ptv5 utils compileWinners --chainId 1 --outDir ./winners --prizePool '0xdd4d117723C257CEe402285D3aCF218E9A8236E1' --contractJsonUrl 'https://raw.githubusercontent.com/GenerationSoftware/pt-v5-testnet/.../contracts.json' --subgraphUrl 'https://api.studio.thegraph.com/query/...'\n\nDESCRIPTION\n Finds draw's depositors with a non-zero balance for a PrizePool, then computes who won and outputs all this data to a target output directory.\n\nEXAMPLES\n $ ptv5 utils compileWinners --chainId 1 --prizePool 0x0000000000000000000000000000000000000000 --outDir ./winners --contractJsonUrl 'https://raw.githubusercontent.com/GenerationSoftware/pt-v5-testnet/.../contracts.json' --subgraphUrl 'https://api.studio.thegraph.com/query/...'\n Running utils:compileWinners on chainId: 1\n```\n\n## Vaults Files ([vaultAddress].json)\n\n```json\n{\n \"chainId\": 10,\n \"prizePoolAddress\": \"0xe32e5E1c5f0c80bD26Def2d0EA5008C107000d6A\",\n \"vaultAddress\": \"0xf0B19f02c63d51B69563A2b675e0160e1C34397C\",\n \"userAddresses\": [\n \"0x07967251f6db5f9d095119379bd8fc4fce60b3e1\",\n \"0x084039db4e3c6775eabfc59cbd3725d3d9a6d752\"\n // ...\n ],\n \"winners\": [\n {\n \"user\": \"0xBBBBBBBBBBBB0af42Df6C28e5cd79458C102f6\",\n \"prizes\": {\n \"3\": [3, 7, 30],\n \"4\": [11, 55]\n }\n }\n // ...\n ]\n}\n```\n\n## Status File (status.json)\n\n```json\n{\n \"status\": \"LOADING\",\n \"createdAt\": \"11\"\n}\n```\n\n### Success\n\n```json\n{\n \"status\": \"SUCCESS\",\n \"createdAt\": 1693423691768,\n \"updatedAt\": 1693423805132,\n \"runtime\": 114,\n \"meta\": {\n \"numVaults\": 7,\n \"numTiers\": 3,\n \"numPrizeIndices\": 21,\n \"numAccounts\": 3830\n }\n}\n```\n\n### Failure\n\n```json\n{\n \"status\": \"FAILURE\",\n \"createdAt\": \"11\",\n \"updatedAt\": \"33\",\n \"runtime\": \"22\",\n \"error\": \"ErrorCode\"\n}\n```\n\n## Help\n\n```sh-session\nptv5 help [COMMAND]\n```\n\nDisplay help for ptv5.\n\n```\nUSAGE\n $ ptv5 help [COMMAND] [-n]\n\nARGUMENTS\n COMMAND Command to show help for.\n\nFLAGS\n -n, --nested-commands Include all nested commands in the output.\n\nDESCRIPTION\n Display help for ptv5.\n```\n\n## Development\n\n### Using the tool in dev\n\nYou can test the CLI while developing by using the following, with whichever chain & prizePool flags you want to test with:\n\n```\n./bin/dev.js utils compileWinners --chainId 1 --outDir ./winners --prizePool '0xdd4d117723C257CEe402285D3aCF218E9A8236E1' --contractJsonUrl 'https://raw.githubusercontent.com/GenerationSoftware/pt-v5-testnet/.../contracts.json' --subgraphUrl 'https://api.studio.thegraph.com/query/...'\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