{"id":19952933,"url":"https://github.com/ethersphere/onboarding-faucet","last_synced_at":"2025-08-19T09:15:09.691Z","repository":{"id":36985271,"uuid":"473242420","full_name":"ethersphere/onboarding-faucet","owner":"ethersphere","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-06T02:14:52.000Z","size":11133,"stargazers_count":3,"open_issues_count":9,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-03T19:39:25.817Z","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":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ethersphere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-03-23T15:13:17.000Z","updated_at":"2024-10-16T17:04:50.000Z","dependencies_parsed_at":"2025-05-03T19:44:25.535Z","dependency_job_id":null,"html_url":"https://github.com/ethersphere/onboarding-faucet","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/ethersphere/onboarding-faucet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fonboarding-faucet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fonboarding-faucet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fonboarding-faucet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fonboarding-faucet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ethersphere","download_url":"https://codeload.github.com/ethersphere/onboarding-faucet/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fonboarding-faucet/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271129083,"owners_count":24703879,"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-19T02:00:09.176Z","response_time":63,"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-13T01:14:49.342Z","updated_at":"2025-08-19T09:15:09.668Z","avatar_url":"https://github.com/ethersphere.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# onboarding-faucet\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fethersphere%2Fonboarding-faucet.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fethersphere%2Fonboarding-faucet?ref=badge_shield)\n[![](https://img.shields.io/badge/made%20by-Swarm-blue.svg?style=flat-square)](https://swarm.ethereum.org/)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)\n![](https://img.shields.io/badge/npm-%3E%3D6.0.0-orange.svg?style=flat-square)\n![](https://img.shields.io/badge/Node.js-%3E%3D12.0.0-orange.svg?style=flat-square)\n\nThis faucet aims to create transactions that can be used for the overlay address verification of\n[bee](https://github.com/ethersphere/bee) nodes.\n\n## Install\n\n```sh\ngit clone https://github.com/ethersphere/onboarding-faucet.git\ncd onboarding-faucet\n```\n\n## Usage\n\n### Example\n\n#### No funding\n\n```sh\nexport PRIVATE_KEY=...\n\nnpm run start\n```\n\n#### Funding\n\n```sh\nexport PRIVATE_KEY=...\nexport FUND_BZZ_AMOUNT=1000000000000000 # 0.1 BZZ\nexport FUND_NATIVE_AMOUNT=10000000000000000 # 0.01 ETH\n\nnpm run start\n```\n\n### Environment variables\n\n| Name               | Default Value                                | Description                                                                                                |\n| ------------------ | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |\n| LOG_LEVEL          | `info`                                       | Log level (`critical`, `error`, `warn`, `info`, `verbose`, `debug`).                                       |\n| RPC_URL            | `https://rpc.gnosischain.com`                | URL of the RPC provider.                                                                                   |\n| PRIVATE_KEY        | `undefined`                                  | Private key used to create transactions and send tokens.                                                   |\n| PORT               | `3000`                                       | Port used by the faucet's http server.                                                                     |\n| HOSTNAME           | `localhost`                                  | Hostname on which the faucet's http server listens to.                                                     |\n| BZZ_ADDRESS        | `0xdBF3Ea6F5beE45c02255B2c26a16F300502F68da` | Address of the BZZ contract.                                                                               |\n| FUND_BZZ_AMOUNT    | `0`                                          | Amount of BZZ to send on the funding route.                                                                |\n| FUND_NATIVE_AMOUNT | `0`                                          | Amount of native tokens (`ETH`, `xDAI`) to send on the funding route.                                      |\n| AUTH_TOKEN         | `undefined`                                  | Authentication secret, disabled if not set (this secret is checked in the request header `authorization`). |\n\n## API\n\n| Endpoint                            | Response code | Response text                                                                                             |\n| ----------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------- |\n| `POST /faucet/overlay/:address`     | `200`         | `{ blockHash: 'string', transactionHash: 'string', nextBlockHash: 'string', nextBlockHashBee: 'string' }` |\n|                                     | `400`         | `{ error: 'invalid address' }`                                                                            |\n|                                     | `500`         | `Internal Server Error`                                                                                   |\n| `POST /faucet/fund/bzz/:address`    | `200`         | `require(\"@ethersproject/abstract-provider\").TransactionReceipt`                                          |\n|                                     | `400`         | `{ error: 'invalid address' }`                                                                            |\n|                                     | `500`         | `Internal Server Error`                                                                                   |\n|                                     | `503`         | `{ error: 'amount not configured' }`                                                                      |\n| `POST /faucet/fund/native/:address` | `200`         | `require(\"@ethersproject/abstract-provider\").TransactionReceipt`                                          |\n|                                     | `400`         | `{ error: 'invalid address' }`                                                                            |\n|                                     | `500`         | `Internal Server Error`                                                                                   |\n|                                     | `503`         | `{ error: 'amount not configured' }`                                                                      |\n\n## Contribute\n\nThere are some ways you can make this module better:\n\n- Consult our [open issues](https://github.com/ethersphere/onboarding-faucet/issues) and take on one of them\n- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or\n  want to give feedback\n\n## Maintainers\n\n- [filoozom](https://github.com/filoozom)\n- [Cafe137](https://github.com/Cafe137)\n\n## License\n\n[BSD-3-Clause](./LICENSE)\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fethersphere%2Fonboarding-faucet.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fethersphere%2Fonboarding-faucet?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fonboarding-faucet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethersphere%2Fonboarding-faucet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fonboarding-faucet/lists"}