{"id":19147842,"url":"https://github.com/refcell/faucet","last_synced_at":"2025-07-09T07:05:45.562Z","repository":{"id":54278748,"uuid":"338527640","full_name":"refcell/faucet","owner":"refcell","description":"fungibility-agnostic and gas-efficient token contracts for gamifying TVL","archived":false,"fork":false,"pushed_at":"2021-02-27T05:54:02.000Z","size":2383,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-09T07:53:44.500Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/refcell.png","metadata":{"files":{"readme":"README.md","changelog":"changelog-template.hbs","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":"audit-checklist.md","citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-13T08:12:34.000Z","updated_at":"2024-10-16T17:00:07.000Z","dependencies_parsed_at":"2022-08-13T10:50:24.110Z","dependency_job_id":null,"html_url":"https://github.com/refcell/faucet","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refcell%2Ffaucet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refcell%2Ffaucet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refcell%2Ffaucet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refcell%2Ffaucet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/refcell","download_url":"https://codeload.github.com/refcell/faucet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232370378,"owners_count":18512922,"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-09T07:52:30.634Z","updated_at":"2025-01-03T17:28:49.683Z","avatar_url":"https://github.com/refcell.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Faucet\n\n![Solidity Coverage](https://github.com/abigger87/Faucet/workflows/Coverage/badge.svg)\n![Solidity Compiling](https://github.com/abigger87/Faucet/workflows/Compile/badge.svg)\n![Solidity Linting](https://github.com/abigger87/Faucet/workflows/Lint/badge.svg)\n\nSDK Package [faucet-sdk](https://github.com/abigger87/faucet-sdk)\n\n[![NPM](https://nodei.co/npm/faucet-sdk.png?compact=true)](https://npmjs.org/package/faucet-sdk)\n\nFungibility-agnostic and gas-efficient token contracts for gamifying TVL.\n\nBuilt on top of OpenZeppelin's ERC 1155 Implementation.\n\n### How it works\n\nThe Faucet contract located in `contracts/Faucet.sol` is the base contract.\n\nThis is a Faucet that manages how Pool TVL-based NFT tokens are distributed to pool members.\n\nFaucet has an Adapter (interface: `contracts/interfaces/IAdapter.sol` and implemented in `contracts/adapters/`)\nthat specifies how to interact with various pools.\nSo, Faucet is easily extensible by creating an adapter to manage the interaction between Faucet.sol and your pool.\n\n### Structure\n\n\u003cb\u003eBase Contracts\u003c/b\u003e: `contracts/`\n\n\u003cb\u003eAdapters\u003c/b\u003e: `contracts/adapters/`\n\n\u003cb\u003eInterfaces\u003c/b\u003e: `contracts/interfaces/`\n\n\u003cb\u003eVarious Abstract Parent Contracts\u003c/b\u003e: `contracts/abstracts/`\n\n\u003cb\u003eTests\u003c/b\u003e: `tests/`\n\n\u003cb\u003eHardhat Deployment\u003c/b\u003e: `tasks.ts`\n\nNOTE: Scripts and Migrations are redundand\n\n\u003cb\u003eMigrations\u003c/b\u003e: `migrations/`\n\n\u003cb\u003eScripts\u003c/b\u003e: `scripts/`\n\n### Major Roadmap/TODO\n\n- [x] Basic Tranche Implementation\n- [x] Basic Tranche Tests\n- [ ] Uri substitutions\n- [ ] Token Redemptions\n  - Need to ensure tokens are transferred correctly\n  - Still needs more tests\n- [x] Emergency Pausing\n  - Implemented with the Pausible functionality\n- [ ] Liquidations\n- [ ] Rug Pull Functionality\n\n### Backlog\n\n- [ ] Governing points\n- [ ] Discord role points\n- [ ] Private Pool Access\n- [ ] Twitter shoutouts?\n\n### Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n### License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n### Noted Issues\n\n`SyntaxError: Cannot use import statement outside a module`\nSpecifically for `hardhat.config.ts`\nfix is to change tsconfig.json module to commonjs from usually \"es5\" or \"es6\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frefcell%2Ffaucet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frefcell%2Ffaucet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frefcell%2Ffaucet/lists"}