{"id":13564273,"url":"https://github.com/okp4/cosmos-faucet","last_synced_at":"2025-04-03T21:30:35.754Z","repository":{"id":37100800,"uuid":"486487164","full_name":"okp4/cosmos-faucet","owner":"okp4","description":"🚰 CØSMOS Faucet backend implementation","archived":false,"fork":false,"pushed_at":"2025-01-28T17:42:59.000Z","size":1111,"stargazers_count":20,"open_issues_count":12,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-28T22:36:56.842Z","etag":null,"topics":["cosmos-sdk","faucet-crypto","golang"],"latest_commit_sha":null,"homepage":"","language":"Go","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/okp4.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2022-04-28T07:17:31.000Z","updated_at":"2025-01-28T17:41:35.000Z","dependencies_parsed_at":"2024-01-03T09:52:28.851Z","dependency_job_id":"e208979c-992b-490e-9ac8-f063d02a64c0","html_url":"https://github.com/okp4/cosmos-faucet","commit_stats":{"total_commits":380,"total_committers":10,"mean_commits":38.0,"dds":0.5289473684210526,"last_synced_commit":"122d318bda256a542a80d116753bade86aca66d6"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":"okp4/template-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okp4%2Fcosmos-faucet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okp4%2Fcosmos-faucet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okp4%2Fcosmos-faucet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okp4%2Fcosmos-faucet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/okp4","download_url":"https://codeload.github.com/okp4/cosmos-faucet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246892791,"owners_count":20850846,"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":["cosmos-sdk","faucet-crypto","golang"],"created_at":"2024-08-01T13:01:29.036Z","updated_at":"2025-04-03T21:30:35.297Z","avatar_url":"https://github.com/okp4.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# CØSMOS Faucet\n\n[![version](https://img.shields.io/github/v/release/okp4/cosmos-faucet?style=for-the-badge\u0026logo=github)](https://github.com/okp4/cosmos-faucet/releases)\n[![lint](https://img.shields.io/github/actions/workflow/status/okp4/cosmos-faucet/lint.yml?branch=main\u0026label=lint\u0026style=for-the-badge\u0026logo=github)](https://github.com/okp4/cosmos-faucet/actions/workflows/lint.yml)\n[![build](https://img.shields.io/github/actions/workflow/status/okp4/cosmos-faucet/build.yml?branch=main\u0026label=build\u0026style=for-the-badge\u0026logo=github)](https://github.com/okp4/cosmos-faucet/actions/workflows/build.yml)\n[![test](https://img.shields.io/github/actions/workflow/status/okp4/cosmos-faucet/test.yml?branch=main\u0026label=test\u0026style=for-the-badge\u0026logo=github)](https://github.com/okp4/cosmos-faucet/actions/workflows/test.yml)\n[![maintainability](https://img.shields.io/codeclimate/maintainability/okp4/cosmos-faucet?style=for-the-badge)](https://codeclimate.com/github/okp4/cosmos-faucet/maintainability)\n[![coverage](https://img.shields.io/codecov/c/github/okp4/cosmos-faucet?style=for-the-badge\u0026token=0VQHJDMY5B\u0026logo=codecov)](https://codecov.io/gh/okp4/cosmos-faucet)\n[![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge\u0026logo=conventionalcommits)](https://conventionalcommits.org)\n[![contributor covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=for-the-badge)](https://github.com/okp4/.github/blob/main/CODE_OF_CONDUCT.md)\n[![license](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge)](https://opensource.org/licenses/BSD-3-Clause)\n\nThis faucet app allows anyone to request tokens for a [Cosmos](https://cosmos.network/) account address, either in command line or in service mode, with optional [ReCaptcha](https://www.google.com/recaptcha/about/) security.\n\nThe faucet app supports any Cosmos based blockchain and is intended to be configured on testnet networks.\n\n## Install\n\n```sh\ngo install github.com/okp4/cosmos-faucet@latest\n\ncosmos-faucet --help\n```\n\n## Config\n\n Configuration can be passed as CLI argument, configuration file (`config.yml`) or by environment variable prefixed by `FAUCET` (i.e.: `FAUCET_MNEMONIC`).\n\n```yml\ngrpc-address: 127.0.0.1:9090\nmnemonic: \"kiwi nuclear blast wet badge...\"\nchain-id: testnet-1\ndenom: uatom\nprefix: cosmos\nfee-amount: 0\namount-send: 1\nmemo: \"Sent by økp4 faucet\"\ngas-limit: 200000\n```\n\n## Usage\n\n### CLI\n\n#### Send\n\n```shell\nSend tokens to a given address\n\nUsage:\n  cosmos-faucet send \u003caddress\u003e [flags]\n\nFlags:\n  -h, --help   help for send\n\nGlobal Flags:\n      --amount-send int       Amount send value (default 1)\n      --chain-id string       The network chain ID (default \"localnet-okp4-1\")\n      --denom string          Token denom (default \"know\")\n      --fee-amount int        Fee amount\n      --gas-limit uint        Gas limit (default 200000)\n      --grpc-address string   The grpc okp4 server url (default \"127.0.0.1:9090\")\n      --memo string           The memo description (default \"Sent by økp4 faucet\")\n      --mnemonic string\n      --no-tls                No encryption with the GRPC endpoint\n      --prefix string         Address prefix (default \"okp4\")\n      --tls-skip-verify       Encryption with the GRPC endpoint but skip certificates verification\n      --tx-timeout duration   Transaction timeout (default 5s)\n```\n\n#### Start\n\n```shell\nStart the GraphQL api\n\nUsage:\n  cosmos-faucet start [flags]\n\nFlags:\n      --address string              graphql api address (default \":8080\")\n      --batch-window duration       Batch temporal window, can be seen a the minimum duration between too transactions. (default 8s)\n      --captcha                     enable captcha verification\n      --captcha-min-score float     set Captcha min score (default 0.5)\n      --captcha-secret string       set Captcha secret\n      --captcha-verify-url string   set Captcha verify URL (default \"https://www.google.com/recaptcha/api/siteverify\")\n      --health                      enable health endpoint\n  -h, --help                        help for start\n      --metrics                     enable metrics endpoint\n\nGlobal Flags:\n      --amount-send int       Amount send value (default 1)\n      --chain-id string       The network chain ID (default \"localnet-okp4-1\")\n      --denom string          Token denom (default \"know\")\n      --fee-amount int        Fee amount\n      --gas-limit uint        Gas limit (default 200000)\n      --grpc-address string   The grpc okp4 server url (default \"127.0.0.1:9090\")\n      --memo string           The memo description (default \"Sent by økp4 faucet\")\n      --mnemonic string\n      --no-tls                No encryption with the GRPC endpoint\n      --prefix string         Address prefix (default \"okp4\")\n      --tls-skip-verify       Encryption with the GRPC endpoint but skip certificates verification\n      --tx-timeout duration   Transaction timeout (default 5s)\n```\n\n### GraphQL\n\nStart GraphQL server with captcha verification for the send token mutation and subscription.\n\n```shell\ncosmos-faucet start --captcha --captcha-secret $CAPCTHA_SECRET\n```\n\nAccess on playground and documentation at the root of server.\n\n## Build\n\nThe project comes with a convenient `Makefile` which depends on [Docker](https://www.docker.com). Please verify that Docker is properly installed and if not, follow the instructions:\n\n- for macOS: \u003chttps://docs.docker.com/docker-for-mac/install/\u003e\n- for Windows: \u003chttps://docs.docker.com/docker-for-windows/install/\u003e\n- for Linux: \u003chttps://docs.docker.com/engine/install/\u003e\n\nTo build the app, invoke the following goal `build` of the `Makefile`:\n\n```sh\nmake build\n```\n\nThe app will be generated under the folder `target/dist`.\n\n## :heart: Supporting this project \u0026 Contributing\n\nA simple star in this repository is enough to make us happy!\n\nBut you're also welcome to contribute! We appreciate any help you're willing to give. Don't hesitate to open issues and/or submit pull requests.\n\nRemember that this is the Cosmos Token Faucet we use at [OKP4](http://okp4.network). This is why we may have to refuse change requests simply because they do not comply with our internal requirements, and not because they are not relevant.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokp4%2Fcosmos-faucet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fokp4%2Fcosmos-faucet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokp4%2Fcosmos-faucet/lists"}