npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@generationsoftware/pt-v5-cli-beta

v0.0.1-beta.46

Published

PoolTogether V5 Command Line Interface

Downloads

4

Readme

🖥️ PoolTogether V5

CLI

The @generationsoftware/pt-v5-cli node module package is a Node command line interface (CLI) to interact with the PoolTogether V5 protocol. The CLI uses the v5-autotasks-library modules to fetch and run calculations/computations for essential PoolTogether V5 tasks.

Primary CLI Commands (help)

npx @generationsoftware/pt-v5-cli help compute drawPrizes

⌨️ CLI Installation

$ npm install -g @generationsoftware/pt-v5-cli-beta
$ ptv5 COMMAND
running command...
$ ptv5 (--version)
@generationsoftware/pt-v5-cli-beta/0.0.1-beta.46 darwin-arm64 node-v16.14.2
$ ptv5 --help [COMMAND]
USAGE
  $ ptv5 COMMAND
...

Commands

Compute Draw Prizes

ptv5 compute drawPrizes

Computes the previous draw's prizes for a PrizePool to a target output directory.

Simply pass a chainId, prizePool and outDir to compute and locally save the results.

USAGE
  $ ptv5 compute drawPrizes --chainId 1 --outDir ./temp --prizePool '0xdd4d117723C257CEe402285D3aCF218E9A8236E1'

DESCRIPTION
  Computes the previous draw's prizes for a PrizePool to a target output directory.

EXAMPLES
  $ ptv5 compute drawPrizes --chainId 1 --prizePool 0x0000000000000000000000000000000000000000 --outDir ./temp
    Running compute:drawPrizes on chainId: 1

Prizes File (prizes.json)

[
  {
    "vault": "0x0bfe04201c496a9994b920deb6087a60bdadfbbb",
    "winner": "0x07967251f6db5f9d095119379bd8fc4fce60b3e1",
    "tier": 3,
    "prizeIndex": 11,
    "claimed": true,
    "amount": "1633936709514027714"
  },
  {
    "vault": "0x0bfe04201c496a9994b920deb6087a60bdadfbbb",
    "winner": "0x084039db4e3c6775eabfc59cbd3725d3d9a6d752",
    "tier": 2,
    "prizeIndex": 1,
    "claimed": false,
    "amount": "1633936709514027714"
  }
]

Status File (status.json)

{
  "status": "LOADING",
  "createdAt": "11"
}

Success

{
  "status": "SUCCESS",
  "createdAt": 1693423691768,
  "updatedAt": 1693423805132,
  "runtime": 114,
  "meta": {
    "numVaults": 7,
    "numTiers": 3,
    "numPrizeIndices": 21,
    "numAccounts": 3830,
    "numPrizes": 21,
    "prizePoolReserve": "431450369493570544008",
    "amountsTotal": "318001330964753848953",
    "tierPrizeAmounts": {
      "0": "271304907889060131200",
      "1": "45062486366179690039",
      "2": "1633936709514027714"
    },
    "vaultPortions": {
      "0x0410cae69dd01f58224d54881648e35c6cb874fa": "12491920408565",
      "0x0bfe04201c496a9994b920deb6087a60bdadfbbb": "973235150974337855",
      "0x4b7a2e1a70ea05523542c9189fa51b133884f321": "232229504251603",
      "0x9e11c3d53a68c07f6d839e5d89a94052753cedcb": "5916502876505634",
      "0xb9a647d3391b939cb49b44d3c5e93c63d96ad4a4": "9173734225780914",
      "0xe2ef926250b0e8a07578d76d9f57e5092340a6fa": "11429890498715426",
      "0xffb08a9ffc360806be7ef8cf815c1274ef92cea9": "0"
    }
  }
}

Failure

{
  "status": "FAILURE",
  "createdAt": "11",
  "updatedAt": "33",
  "runtime": "22",
  "error": "ErrorCode"
}

Help

ptv5 help [COMMAND]

Display help for ptv5.

USAGE
  $ ptv5 help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for ptv5.

Development

Using the tool in dev

You can test the CLI while developing by using the following, with whichever chain / prizePool flags you want to test with:

./bin/run.js compute drawPrizes --chainId 80001 -o ./temp -p '0xA32C8f94191c9295634f0034eb2b0e2749e77974'