{"_id":"@chanceprotocol/v4-periphery","name":"@chanceprotocol/v4-periphery","dist-tags":{"latest":"1.4.0"},"versions":{"1.4.0":{"name":"@chanceprotocol/v4-periphery","version":"1.4.0","description":"PoolTogether V4 Periphery","main":"index.js","license":"GPL-3.0","peerDependencies":{"@openzeppelin/contracts":"4.7.3","@chanceprotocol/v4-core":"1.3.1"},"devDependencies":{"@nomiclabs/hardhat-ethers":"2.2.0","@nomiclabs/hardhat-etherscan":"3.1.1","@nomiclabs/hardhat-waffle":"2.0.3","@openzeppelin/contracts":"4.7.3","@studydefi/money-legos":"2.4.2","@typechain/ethers-v5":"10.1.0","@typechain/hardhat":"6.1.3","@types/chai":"4.3.3","@types/debug":"4.1.7","@types/mocha":"10.0.0","@types/node":"18.11.4","chai":"4.3.6","chalk":"4.1.2","debug":"4.3.4","ethereum-waffle":"3.4.4","ethers":"5.7.2","hardhat":"2.12.0","hardhat-abi-exporter":"2.10.1","hardhat-dependency-compiler":"1.1.3","hardhat-deploy":"0.11.18","hardhat-deploy-ethers":"0.3.0-beta.13","hardhat-gas-reporter":"1.0.9","hardhat-log-remover":"2.0.2","npm-run-all":"4.1.5","prettier":"2.7.1","prettier-plugin-solidity":"1.0.0-beta.24","solc":"0.8.17","solhint":"3.3.7","solidity-coverage":"0.8.2","solidity-docgen":"0.5.17","ts-generator":"0.1.1","ts-node":"10.9.1","typechain":"8.1.0","typescript":"4.8.4","wait-on":"6.0.1","@chanceprotocol/v4-core":"1.3.1","@chanceprotocol/owner-manager-contracts":"1.1.0","@chanceprotocol/pooltogether-rng-contracts":"1.5.3","@chanceprotocol/yield-source-interface":"1.4.0"},"scripts":{"clean":"rm -rf cache/ artifacts/ types/","compile":"mkdir -p abis && hardhat --show-stack-traces --max-memory 8192 compile","coverage":"HIDE_DEPLOY_LOG=true OPTIMIZER_DISABLED=true hardhat coverage","coverage:file":"HIDE_DEPLOY_LOG=true OPTIMIZER_DISABLED=true hardhat coverage --testfiles","deploy":"hardhat deploy --write true --network","docs":"solidity-docgen --solc-module solc -i contracts -o docs -t templates","verify":"hardhat etherscan-verify --license MIT --solc-input --network","etherscan-verify":"hardhat etherscan:verify --network","etherscan-verify-polygon":"hardhat --config hardhat.config.polygon.js run ./scripts/verify.js --network","format":"prettier --config .prettierrc --write \"**/*.{ts,js}\" \"contracts/**/*.sol\"","format:file":"prettier --config .prettierrc --write","hint":"solhint \"contracts/**/*.sol\"","start-fork":"FORK_ENABLED=true hardhat node --no-reset --no-deploy","impersonate":"hardhat --network localhost fork:impersonate ","distribute":"hardhat --network localhost fork:distribute","remove-logs":"yarn run hardhat remove-logs","twab-rewards-fork":"wait-on tcp:8545 && yarn impersonate && yarn distribute && hardhat --network localhost fork:twab-rewards","run-twab-rewards-fork":"OPTIMIZER_DISABLED=true rm -rf deployments/localhost/ && npm-run-all -p -r start-fork twab-rewards-fork","test":"HIDE_DEPLOY_LOG=true OPTIMIZER_DISABLED=true hardhat test"},"_id":"@chanceprotocol/v4-periphery@1.4.0","_integrity":"sha512-orfQEaNx6wYN8WQovWsTKHKQUZgsNoHfw7McOJcsV00yp1Lj5aHpf2XnhIwofUzdghZTlSPGWnWbvZMrM/hjMA==","_resolved":"/tmp/faa116cacaf03f8c64e9791bae76b39e/chanceprotocol-v4-periphery-1.4.0.tgz","_from":"file:chanceprotocol-v4-periphery-1.4.0.tgz","_nodeVersion":"16.15.1","_npmVersion":"9.6.5","dist":{"integrity":"sha512-orfQEaNx6wYN8WQovWsTKHKQUZgsNoHfw7McOJcsV00yp1Lj5aHpf2XnhIwofUzdghZTlSPGWnWbvZMrM/hjMA==","shasum":"6b820e7506f490e74cc0fa35160e2075012d7532","tarball":"https://registry.npmjs.org/@chanceprotocol/v4-periphery/-/v4-periphery-1.4.0.tgz","fileCount":354,"unpackedSize":17687891,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC/ycZqRJqEoyA2toMse7fkXsZ3HAcFG49Io1rtkRimdAiEA+lukFaMGo3yBe/p//r2QdUwuPNRnxoYqWTMEBJKF+W8="}]},"_npmUser":{"name":"chanceprotocol","email":"chance@netixsol.com"},"directories":{},"maintainers":[{"name":"chanceprotocol","email":"chance@netixsol.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/v4-periphery_1.4.0_1692257301537_0.8357359460463063"},"_hasShrinkwrap":false}},"time":{"created":"2023-08-17T07:28:21.449Z","1.4.0":"2023-08-17T07:28:21.851Z","modified":"2023-08-17T07:28:22.104Z"},"maintainers":[{"name":"chanceprotocol","email":"chance@netixsol.com"}],"description":"PoolTogether V4 Periphery","license":"GPL-3.0","readme":"# PoolTogether V4 Periphery Contracts\n\n\n\n[](https://coveralls.io/github/pooltogether/v4-periphery?branch=master)\n[](https://docs.openzeppelin.com/)\n[](http://perso.crans.org/besson/LICENSE.html)\n\nHave questions or want the latest news?\n
Join the PoolTogether Discord or follow us on Twitter:\n\n[](https://discord.gg/JFBPMxv5tr)\n[](https://twitter.com/PoolTogether_)\n\n**Documentation**
\nhttps://v4.docs.pooltogether.com\n\n**Deployments**
\n- [Ethereum](https://v4.docs.pooltogether.com/protocol/deployments/mainnet#mainnet)\n- [Polygon](https://v4.docs.pooltogether.com/protocol/deployments/mainnet#polygon)\n- [Avalanche](https://v4.docs.pooltogether.com/protocol/deployments/mainnet#avalanche)\n\n# Overview\n- [PrizeDistributionFactory](/contracts/PrizeDistributionFactory.sol)\n- [PrizeFlush](/contracts/PrizeFlush.sol)\n- [PrizeTierHistory](/contracts/PrizeTierHistory.sol)\n- [TwabRewards](/contracts/TwabRewards.sol)\n\n# Getting Started\n\nThe project is made available as a NPM package.\n\n```sh\n$ yarn add @chanceprotocol/v4-periphery\n```\n\nThe repo can be cloned from Github for contributions.\n\n```sh\n$ git clone https://github.com/pooltogether/v4-periphery\n```\n\n```sh\n$ yarn\n```\n\nWe use [direnv](https://direnv.net/) to manage environment variables. You'll likely need to install it.\n\n```sh\ncp .envrc.example .envrc\n```\n\n# Testing\n\nWe use [Hardhat](https://hardhat.dev) and [hardhat-deploy](https://github.com/wighawag/hardhat-deploy)\n\nTo run unit tests:\n\n```sh\n$ yarn test\n```\n\nTo run coverage:\n\n```sh\n$ yarn coverage\n```\n\n# Forking\n\nMainnet fork tests have been implemented to test the functionalities of the TWAB Rewards contract.\n\nTo start the mainnet fork RPC server, run:\n\n```sh\n$ yarn start-fork\n```\n\nTo run the mainnet fork tests for the TWAB Rewards contract, run:\n\n```sh\n$ yarn twab-rewards-fork\n```\n\nIf you wish to run both at the same time, run:\n\n```sh\n$ yarn run-twab-rewards-fork\n```\n\nThis command is used in the Github Actions workflow located in `.github/workflows/fork.yml`.\n\n\n# Deployment\n\n## Testnets\nDeployment is maintained in a different [repo](https://github.com/pooltogether/v4-testnet).\n\n## Mainnet\nDeployment is maintained in a different [repo](https://github.com/pooltogether/v4-mainnet).\n","readmeFilename":"README.md"}