{"id":20001918,"url":"https://github.com/pooltogether/v4-periphery","last_synced_at":"2025-05-04T15:33:34.231Z","repository":{"id":38444069,"uuid":"411005874","full_name":"pooltogether/v4-periphery","owner":"pooltogether","description":"PoolTogether V4 Periphery Smart Contracts","archived":false,"fork":false,"pushed_at":"2023-01-26T20:39:15.000Z","size":1016,"stargazers_count":9,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-25T04:03:30.992Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pooltogether.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-27T18:51:10.000Z","updated_at":"2023-09-11T09:11:18.000Z","dependencies_parsed_at":"2023-01-28T13:32:44.573Z","dependency_job_id":null,"html_url":"https://github.com/pooltogether/v4-periphery","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":"pooltogether/pooltogether-contracts-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fv4-periphery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fv4-periphery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fv4-periphery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fv4-periphery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pooltogether","download_url":"https://codeload.github.com/pooltogether/v4-periphery/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252356543,"owners_count":21734975,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T05:19:06.362Z","updated_at":"2025-05-04T15:33:33.915Z","avatar_url":"https://github.com/pooltogether.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PoolTogether V4 Periphery Contracts\n\n![Fork](https://github.com/pooltogether/v4-periphery/actions/workflows/fork.yml/badge.svg)\n![Tests](https://github.com/pooltogether/v4-periphery/actions/workflows/main.yml/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/pooltogether/v4-periphery/badge.svg?branch=master)](https://coveralls.io/github/pooltogether/v4-periphery?branch=master)\n[![built-with openzeppelin](https://img.shields.io/badge/built%20with-OpenZeppelin-3677FF)](https://docs.openzeppelin.com/)\n[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html)\n\n\u003cstrong\u003eHave questions or want the latest news?\u003c/strong\u003e\n\u003cbr/\u003eJoin the PoolTogether Discord or follow us on Twitter:\n\n[![Discord](https://badgen.net/badge/icon/discord?icon=discord\u0026label)](https://discord.gg/JFBPMxv5tr)\n[![Twitter](https://badgen.net/badge/icon/twitter?icon=twitter\u0026label)](https://twitter.com/PoolTogether_)\n\n**Documentation**\u003cbr\u003e\nhttps://v4.docs.pooltogether.com\n\n**Deployments**\u003cbr\u003e\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 @pooltogether/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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpooltogether%2Fv4-periphery","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpooltogether%2Fv4-periphery","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpooltogether%2Fv4-periphery/lists"}