{"id":26562878,"url":"https://github.com/aelfproject/faucet-backend","last_synced_at":"2026-05-02T22:38:24.135Z","repository":{"id":243029272,"uuid":"811238652","full_name":"AElfProject/faucet-backend","owner":"AElfProject","description":"Service designed to provide users with test tokens on the aelf blockchain network.","archived":false,"fork":false,"pushed_at":"2024-10-29T03:30:38.000Z","size":548,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-29T04:19:09.521Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","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/AElfProject.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}},"created_at":"2024-06-06T07:58:01.000Z","updated_at":"2024-10-23T09:04:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"be23f78f-d2f8-4b43-86ce-e614c110779f","html_url":"https://github.com/AElfProject/faucet-backend","commit_stats":null,"previous_names":["aelfproject/faucet-backend"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AElfProject%2Ffaucet-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AElfProject%2Ffaucet-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AElfProject%2Ffaucet-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AElfProject%2Ffaucet-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AElfProject","download_url":"https://codeload.github.com/AElfProject/faucet-backend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244977688,"owners_count":20541709,"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":"2025-03-22T15:29:04.840Z","updated_at":"2025-10-25T16:17:11.636Z","avatar_url":"https://github.com/AElfProject.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AElf Faucet Backend\n\nThe AElf Faucet Backend is a service designed to provide users with test tokens on the AElf blockchain network. This service is primarily intended for developers who need test tokens for development and testing purposes.\n\n## Table of Contents\n\n- [AElf Faucet Backend](#aelf-faucet-backend)\n    - [Table of Contents](#table-of-contents)\n    - [Overview](#overview)\n    - [Features](#features)\n    - [Prerequisites](#prerequisites)\n    - [Installation](#installation)\n    - [Configuration](#configuration)\n    - [Usage](#usage)\n    - [Contributing](#contributing)\n    - [License](#license)\n\n## Overview\n\nThis project implements a backend service that allows users to request test tokens from an AElf testnet faucet. It includes endpoints for claiming tokens and verifying eligibility based on various criteria.\n\n## Features\n\n- Claim test tokens\n- Verification of eligibility\n- Logging and monitoring\n- Easy configuration and deployment\n\n## Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n\n- [.NET SDK](https://dotnet.microsoft.com/download) (version 8.0 or later)\n- [AElf SDK](https://github.com/AElfProject/AElf)\n\n## Installation\n\n1. Clone the repository:\n    ```bash\n    git clone https://github.com/AElfProject/faucet-backend.git\n    cd faucet-backend\n    ```\n\n2. Restore the dependencies:\n    ```bash\n    dotnet restore\n    ```\n\n3. Build the project:\n    ```bash\n    dotnet build\n    ```\n\n## Configuration\n\nCreate a `appsettings.json` file in the AELFFaucet.Web directory of the project with the following content:\n\n```json\n{\n  \"App\": {\n    \"AllowedHosts\": \"*\",\n    \"CorsOrigins\": \"*\"\n  },\n  \"ConnectionStrings\": {\n    \"Default\": \"mongodb://localhost:27017/SendTokenDB\"\n  },\n  \"Kestrel\": {\n    \"EndPoints\": {\n      \"Http\": {\n        \"Url\": \"http://*:8801/\"\n      }\n    }\n  },\n  \"Logging\": {\n    \"LogLevel\": {\n      \"Default\": \"Information\",\n      \"System\": \"Error\",\n      \"Microsoft\": \"Error\"\n    }\n  }\n}\n```\n\n## Setup secrets.json file\n\nRun this following command in terminal of the AELFFaucet.Web directory to generate the secrets.json file with all ENV keys: \n\n```base title=\"Terminal\"\ndotnet user-secrets init\ndotnet user-secrets set \"ApiConfig:PrivateKey\" \"b192e30XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX280c51c\"\ndotnet user-secrets set \"ApiConfig:NftSeedPrivateKey\" \"97a1747XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX12fabdd7\"\ndotnet user-secrets set \"ApiConfig:FaucetUI\" \"6LcovXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXKxcEW\"\ndotnet user-secrets set \"ApiConfig:Playground\" \"6LfgxXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXrnKGK\"\ndotnet user-secrets set \"ApiConfig:AelfStudio\" \"6LfkxXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_UXyr\"\ndotnet user-secrets set \"ConnectionStrings:Default\" \"mongodb://localhost:27017/SendTokenDB\"\n```\n \nReplace the Value of all keys with your actual values for storing token pool for token distribution.\n\n## Usage\nRun the service:\n\n```bash\ndotnet run\n```\nThe service will be available at http://localhost:8801.\nYou can access the swagger documentation at http://localhost:8801/swagger/index.html.\n\n## Contributing\nContributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.\n\n## License\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faelfproject%2Ffaucet-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faelfproject%2Ffaucet-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faelfproject%2Ffaucet-backend/lists"}