{"id":37475229,"url":"https://github.com/aboutcircles/crc-faucet","last_synced_at":"2026-01-16T07:20:51.637Z","repository":{"id":321022484,"uuid":"1073645238","full_name":"aboutcircles/crc-faucet","owner":"aboutcircles","description":null,"archived":false,"fork":false,"pushed_at":"2025-11-13T15:10:15.000Z","size":1556,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-13T17:13:37.665Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://sepolia-faucet.aboutcircles.com/","language":"TypeScript","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/aboutcircles.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-10T12:12:57.000Z","updated_at":"2025-11-13T15:09:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"dc9767fa-d730-466d-88f1-ed27e04c18db","html_url":"https://github.com/aboutcircles/crc-faucet","commit_stats":null,"previous_names":["aboutcircles/crc-faucet"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aboutcircles/crc-faucet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcircles%2Fcrc-faucet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcircles%2Fcrc-faucet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcircles%2Fcrc-faucet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcircles%2Fcrc-faucet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aboutcircles","download_url":"https://codeload.github.com/aboutcircles/crc-faucet/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcircles%2Fcrc-faucet/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"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":"2026-01-16T07:20:50.295Z","updated_at":"2026-01-16T07:20:51.626Z","avatar_url":"https://github.com/aboutcircles.png","language":"TypeScript","funding_links":[],"categories":["APIs \u0026 Infrastructure"],"sub_categories":["Developer Demos"],"readme":"# Circles Faucet\n\nThis project is a faucet that allows Circles users to exchange their Circles tokens (CRC) for Sepolia ETH. It consists of three main components: a smart contract, a backend worker, and a frontend application.\n\n## For Users: How to get Sepolia ETH\n\nTo receive Sepolia ETH, you need to have a Circles account, be a registered human and with trust score \u003e 50. You can then use the faucet to exchange your CRC for Sepolia ETH.\n\n### Prerequisites\n\n1.  **Circles Account**: You need a Circles account. If you don't have one, you can create one at [app.metri.xyz](https://app.metri.xyz/).\n2.  **Registered Human**: Your Circles account must be registered as a human.\n3.  **Trust Score**: Your Circles account must have a trust score of at least 50.\n4.  **Wallet**: You need a web3 wallet like MetaMask to interact with the faucet.\n\n### Steps to get Sepolia ETH\n\n1.  **Go to the Faucet Website**: Open the faucet website in your browser.\n2.  **Connect Your Wallet**: Connect your wallet to the website.\n3.  **Check Eligibility**: The website will check if you are eligible to use the faucet.\n4.  **Enter Recipient Address**: Enter the Sepolia address where you want to receive the ETH.\n5.  **Select Amount**: Choose the amount of ETH you want to receive.\n6.  **Transfer CRC**: You will be redirected to Metri to transfer the corresponding amount of CRC to the faucet.\n7.  **Receive ETH**: Once the CRC transfer is confirmed, you will receive the Sepolia ETH in your wallet.\n\n## For Developers: How it Works\n\nThe project is a monorepo containing three packages: `contracts`, `backend`, and `app`.\n\n### Architecture\n\n1.  **`contracts`**: A Foundry project with the `FaucetOrg.sol` smart contract. This contract is deployed on the Gnosis chain and is registered as an organization on the Circles Hub. It receives CRC from users and emits a `FaucetRequested` event.\n2.  **`backend`**: A Node.js application that listens for `FaucetRequested` events from the `FaucetOrg` contract on the Gnosis chain. When an event is received, it sends the corresponding amount of Sepolia ETH to the user's address.\n3.  **`app`**: A React application that provides a user interface for the faucet. It allows users to connect their wallet, check their eligibility, and initiate the process of exchanging CRC for Sepolia ETH.\n\n### Workflow\n\n1.  A user visits the faucet web application (`app`).\n2.  The user connects their wallet. The application checks if the user's Circles account is eligible for the faucet (registered as human, trust score \u003e 50).\n3.  The user specifies a recipient address on the Sepolia network and the amount of ETH they want to claim.\n4.  The application generates a link or QR code that directs the user to Metri to transfer CRC to the `FaucetOrg` smart contract on the Gnosis chain. The recipient address and CRC amount are encoded in the transaction data.\n5.  The `FaucetOrg` contract receives the CRC, verifies the user's eligibility, and emits a `FaucetRequested` event with the recipient address and the amount of ETH to be sent.\n6.  The `backend` worker, listening for events on the Gnosis chain, catches the `FaucetRequested` event.\n7.  The `backend` worker sends the specified amount of Sepolia ETH to the recipient address.\n\n### Development Setup\n\nTo set up the development environment, you need to have Node.js and Foundry installed.\n\n1.  **Clone the repository**:\n\n    ```bash\n    git clone \u003crepository-url\u003e\n    cd circles-faucet\n    ```\n\n2.  **Install dependencies**:\n\n    ```bash\n    pnpm install\n    ```\n\n3.  **Set up environment variables**:\n\n    - Create a `.env` file in the `app`, `backend`, and `contracts` directories by copying the `.env.example` files.\n    - Fill in the required environment variables in each `.env` file.\n\n4.  **Run the applications**:\n    - **Contracts**:\n      ```bash\n      cd contracts\n      forge build\n      ```\n    - **Backend**:\n      ```bash\n      cd backend\n      pnpm start:faucetWorker\n      ```\n    - **App**:\n      ```bash\n      cd app\n      pnpm dev\n      ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faboutcircles%2Fcrc-faucet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faboutcircles%2Fcrc-faucet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faboutcircles%2Fcrc-faucet/lists"}