{"id":20002002,"url":"https://github.com/pooltogether/pooltogether-contracts-template","last_synced_at":"2025-08-20T22:07:04.590Z","repository":{"id":45884833,"uuid":"368270982","full_name":"pooltogether/pooltogether-contracts-template","owner":"pooltogether","description":"Template opinionated repo to setup contract projects","archived":false,"fork":false,"pushed_at":"2022-08-26T22:24:33.000Z","size":1287,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-20T22:05:09.108Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"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":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-17T17:35:42.000Z","updated_at":"2022-04-20T09:13:06.000Z","dependencies_parsed_at":"2022-07-21T02:34:32.241Z","dependency_job_id":null,"html_url":"https://github.com/pooltogether/pooltogether-contracts-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/pooltogether/pooltogether-contracts-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fpooltogether-contracts-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fpooltogether-contracts-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fpooltogether-contracts-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fpooltogether-contracts-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pooltogether","download_url":"https://codeload.github.com/pooltogether/pooltogether-contracts-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fpooltogether-contracts-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271393754,"owners_count":24751769,"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","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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:27.825Z","updated_at":"2025-08-20T22:07:04.540Z","avatar_url":"https://github.com/pooltogether.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/pooltogether/pooltogether--brand-assets\"\u003e\n    \u003cimg src=\"https://github.com/pooltogether/pooltogether--brand-assets/blob/977e03604c49c63314450b5d432fe57d34747c66/logo/pooltogether-logo--purple-gradient.png?raw=true\" alt=\"PoolTogether Brand\" style=\"max-width:100%;\" width=\"200\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr /\u003e\n\n# PoolTogether Contracts Template\n\n[![Coverage Status](https://coveralls.io/repos/github/pooltogether/pooltogether-contracts-template/badge.svg?branch=master)](https://coveralls.io/github/pooltogether/pooltogether-contracts-template?branch=master)\n\n![Tests](https://github.com/pooltogether/pooltogether-contracts-template/actions/workflows/main.yml/badge.svg)\n\n# Usage\n\n1. Clone this repo: `git clone git@github.com:pooltogether/pooltogether-contracts-template.git \u003cDESTINATION REPO\u003e`\n1. Create repo using Github GUI\n1. Set remote repo (`git remote add origin git@github.com:pooltogether/\u003cNAME_OF_NEW_REPO\u003e.git`),\n1. Checkout a new branch (`git checkout -b name_of_new_branch`)\n1. Begin implementing as appropriate.\n1. Update this README\n\n## Usage\n\nThis repo is setup to compile (`nvm use \u0026\u0026 yarn compile`) and successfully pass tests (`yarn test`)\n\n# Preset Packages\n\n## Generic Proxy Factory\n\nThe minimal proxy factory is a powerful pattern used throughout PoolTogethers smart contracts. A [typescript package](https://www.npmjs.com/package/@pooltogether/pooltogether-proxy-factory-package) is available to use a generic deployed instance. This is typically used in the deployment script.\n\n## Generic Registry\n\nThe [generic registry](https://www.npmjs.com/package/@pooltogether/pooltogether-generic-registry) is a iterable singly linked list data structure that is commonly used throughout PoolTogethers contracts. Consider using this where appropriate or deploying in a seperate repo such as the (Prize Pool Registry)[https://github.com/pooltogether/pooltogether-prizepool-registry.\n\n# Installation\n\nInstall the repo and dependencies by running:\n`yarn`\n\n## Deployment\n\nThese contracts can be deployed to a network by running:\n`yarn deploy \u003cnetworkName\u003e`\n\n## Verification\n\nThese contracts can be verified on Etherscan, or an Etherscan clone, for example (Polygonscan) by running:\n`yarn etherscan-verify \u003cethereum network name\u003e` or `yarn etherscan-verify-polygon matic`\n\n# Testing\n\nRun the unit tests locally with:\n`yarn test`\n\n## Coverage\n\nGenerate the test coverage report with:\n`yarn coverage`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpooltogether%2Fpooltogether-contracts-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpooltogether%2Fpooltogether-contracts-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpooltogether%2Fpooltogether-contracts-template/lists"}