{"id":20001909,"url":"https://github.com/pooltogether/v4-twab-delegator-js","last_synced_at":"2026-02-27T23:43:00.201Z","repository":{"id":57683451,"uuid":"473676364","full_name":"pooltogether/v4-twab-delegator-js","owner":"pooltogether","description":null,"archived":false,"fork":false,"pushed_at":"2022-10-31T14:10:32.000Z","size":513,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-23T05:47:25.430Z","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":"mit","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":"2022-03-24T15:59:33.000Z","updated_at":"2022-03-29T04:16:40.000Z","dependencies_parsed_at":"2022-09-05T16:50:49.622Z","dependency_job_id":null,"html_url":"https://github.com/pooltogether/v4-twab-delegator-js","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pooltogether/v4-twab-delegator-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fv4-twab-delegator-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fv4-twab-delegator-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fv4-twab-delegator-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fv4-twab-delegator-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pooltogether","download_url":"https://codeload.github.com/pooltogether/v4-twab-delegator-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fv4-twab-delegator-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29919330,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T19:37:42.220Z","status":"ssl_error","status_checked_at":"2026-02-27T19:37:41.463Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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:05.538Z","updated_at":"2026-02-27T23:43:00.184Z","avatar_url":"https://github.com/pooltogether.png","language":"TypeScript","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# 💻 \u0026nbsp; PoolTogether Delegator Library || PoolTogether V4\n\n![Tests](https://github.com/pooltogether/v4-twab-delegator-js/actions/workflows/main.yml/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/pooltogether/v4-client-js/badge.svg?branch=main)](https://coveralls.io/github/pooltogether/v4-client-js?branch=main)\n![ts](https://badgen.net/badge/-/TypeScript?icon=typescript\u0026label\u0026labelColor=blue\u0026color=555555)\n[![MIT license](https://img.shields.io/npm/l/@pooltogether/v4-client-js)](https://img.shields.io/npm/l/@pooltogether/v4-client-js)\n![npm](https://img.shields.io/npm/v/@pooltogether/v4-client-js)\n\n[Application](https://app.pooltogether.com/) | [Client](https://github.com/pooltogether/v4-client-js) | [Contracts](https://github.com/pooltogether/v4-core) | [Documentation](https://dev.docs.pooltogether.com/) | [Draw Calculator](https://github.com/pooltogether/draw-calculator-cli) | [Utility Library](https://github.com/pooltogether/v4-utils-js) | [Static Cache](https://github.com/pooltogether/v4-draw-results)\n\n# 🏆 \u0026nbsp; Overview\n\nThis library includes a simplified interface for interacting with a v4 PoolTogether TWAB Delegator deployment.\n\n- [TwabDelegator](./Classes/PrizePoolNetwork/)\n\n## 💾 \u0026nbsp; Installation\n\nThis project is available as an NPM package:\n\n```sh\nnpm install @pooltogether/v4-twab-delegator-js\n```\n\nor\n\n```sh\nyarn add @pooltogether/v4-twab-delegator-js\n```\n\nThe repo can be cloned from Github for contributions.\n\n```sh\ngit clone https://github.com/pooltogether/v4-twab-delegator-js.git\n```\n\n## 🏎️ \u0026nbsp; Quickstart\n\n### TwabDelegator\n\nA `TwabDelegator` is a wrapper on an ethers `Contract` with utility functions.\n\nTo create an instance of `TwabDelegator` you will need:\n\n- [Ethers providers](https://docs.ethers.io/v5/api/providers/) for every chain that you want to interact with.\n\n```js\nimport { TwabDelegator, deployments } from '@pooltogether/v4-twab-delegator-js'\nimport { mainnet } from '@pooltogether/v4-pool-data'\n\nconst provider = getProvider(CHAIN_ID.mainnet)\nconst delegator = new TwabDelegator(provider, deployments[CHAIN_ID.mainnet])\n```\n\n\u003e NOTE: This interface will change in the future. A chain id is not a sufficient key once the protocol expands to multiple Prize Pools.\n\n#### ESLint\n\nThe TSDX linting configuration is overwritten to include override(s)\\* for:\n\n- Import/Order (used to enforce consistent module import ordering)\n\n###### \\*The ESLint overrides may incorrectly be interpreted by VSCode since the nested config file is ignored in the IDE\n\n### Porting docs to PoolTogether V4 Docs\n\n1. `yarn docs`\n2. Copy \u0026 paste\n\n- `classes` to `Classes`\n- `interfaces` to `Interfaces`\n- `README.md` below header to `index.md`\n\n3. Replace all `.md` with `` (nothing) in links\n4. Replace all `README` links to `./` and `../README` to `../`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpooltogether%2Fv4-twab-delegator-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpooltogether%2Fv4-twab-delegator-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpooltogether%2Fv4-twab-delegator-js/lists"}