{"id":13564807,"url":"https://github.com/tendermint/faucet","last_synced_at":"2025-07-09T08:06:00.526Z","repository":{"id":40758088,"uuid":"304467580","full_name":"tendermint/faucet","owner":"tendermint","description":"A faucet for cosmos-sdk apps that uses the app binary only","archived":false,"fork":false,"pushed_at":"2023-11-01T16:30:20.000Z","size":325,"stargazers_count":31,"open_issues_count":6,"forks_count":42,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-02T01:42:12.891Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/tendermint.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":"2020-10-15T23:07:14.000Z","updated_at":"2025-02-09T14:46:50.000Z","dependencies_parsed_at":"2024-01-14T03:49:22.375Z","dependency_job_id":"07d84908-2c6a-4dbd-b04d-8ab898e8f974","html_url":"https://github.com/tendermint/faucet","commit_stats":null,"previous_names":["allinbits/cosmos-faucet"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tendermint%2Ffaucet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tendermint%2Ffaucet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tendermint%2Ffaucet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tendermint%2Ffaucet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tendermint","download_url":"https://codeload.github.com/tendermint/faucet/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tendermint%2Ffaucet/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":258737967,"owners_count":22749805,"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-08-01T13:01:36.376Z","updated_at":"2025-06-10T17:36:05.239Z","avatar_url":"https://github.com/tendermint.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# faucet\n\nA faucet that uses [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) executable binaries only.\n\nThe main purpose of this `faucet` is to avoid using RPC or API endpoints, and use the CLI binary instead, more\nspecifically, the commands:\n\n```bash\n$ {app}d tx bank send\n```\n\nand:\n\n```bash\n$ {app}d query txs\n```\n\nSince the faucet only uses the CLI binary, it is compatible with practically any blockchain built with\n[cosmos-sdk](https://github.com/cosmos/cosmos-sdk) even if different types of keys are used (such as in\n[ethermint](https://github.com/cosmos/ethermint) for example).\n\n## Installation\n\n### Using cURL\n\n```bash\n$ curl https://get.starport.network/faucet! | bash \n```\n\n### Use docker image\n\nUse docker image `ghcr.io/tendermint/faucet`. You can use it in a Kubernetes pod with\n[shareProcessNamespace](https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/#configure-a-pod)\nor mount the chain binary using docker:\n\n```bash\n$ docker run -it -v ~/go/bin/gaiad:/usr/local/bin/gaiad ghcr.io/tendermint/faucet\n```\n\n### From Source\n\nYou can build the faucet with:\n\n```bash\n$ make build\n```\n\nThe executable binary will be avaialable in the `./build/` directory. To install it to `$GOPATH/bin`, use instead:\n\n```bash\n$ make install\n```\n\n## Usage\n\n### Configuration\n\nYou can configure the faucet either using command line flags or environment variables. The following table\nshows the available configuration options and respective defaults:\n\n| flag                | env               | description                                                   | default   |\n|---------------------|-------------------|-------------------------------------------------------------- |-----------|\n| port                | PORT              | tcp port where faucet will be listening for requests          | 8000      |\n| account-name        | ACCOUNT_NAME      | name of the account to be used by the faucet                  | faucet    |\n| mnemonic            | MNEMONIC          | mnemonic for restoring an account                             |           |\n| keyring-password    | KEYRING_PASSWORD  | password for accessing keyring                                |           |\n| cli-name            | DENOMS            | denomination of the coins sent by default (comma separated)   | uatom     |\n| credit-amount       | CREDIT_AMOUNT     | amount to credit in each request                              | 10000000  |\n| max-credit          | MAX_CREDIT        | maximum credit per account                                    | 100000000 |\n| sdk-version         | SDK_VERSION       | version of sdk (launchpad or stargate)                        | stargate  |\n| node                | NODE              | address of tendermint RPC endpoint for this chain             |           |\n| keyring-backend     | KEYRING_BACKEND   | keyring backend to be used                                    |           |\n| legacy-send         | LEGACY_SEND       | whether to use legacy send command                            | false     |\n| coin-type           | COIN_TYPE         | registered coin type number for HD derivation (BIP-0044)      | 118       |\n| home                | HOME              | replaces the default home used by the chain                   |           |\n|                     |                   |                                                               |           |\n\n### [gaia](https://github.com/cosmos/gaia) example\n\nThis faucet options default to work with [gaia](https://github.com/cosmos/gaia). So you can start the faucet with just:\n\n```bash\n$ faucet --keyring-password 12345678\nINFO[0000] listening on :8000\n```\n\nor, with environment variables:\n\n```bash\n$ export KEYRING_PASSWORD=12345678\n$ faucet\nINFO[0000] listening on :8000\n```\n\n### [ethermint](https://github.com/cosmos/ethermint) example\n\nStart the faucet with:\n\n```bash\n$ faucet --cli-name ethermintcli --denoms ueth --keyring-password 12345678 --sdk-version launchpad\nINFO[0000] listening on :8000\n```\n\nor, with environment variables:\n\n```bash\n$ export CLI_NAME=ethermintcli\n$ export SDK_VERSION=launchpad\n$ export DENOMS=ueth\n$ export KEYRING_PASSWORD=12345678\n$ faucet\nINFO[0000] listening on :8000\n```\n\n### [wasmd](https://github.com/CosmWasm/wasmd) example\n\nStart the faucet with:\n\n```bash\n$ faucet --cli-name wasmcli --denoms ucosm --keyring-password 12345678\nINFO[0000] listening on :8000\n```\n\nor, with environment variables:\n\n```bash\n$ export CLI_NAME=wasmcli\n$ export DENOMS=ucosm\n$ export KEYRING_PASSWORD=12345678\n$ faucet\nINFO[0000] listening on :8000\n```\n\n### Request tokens\n\nYou can request tokens by sending a `POST` request to the faucet, with a key address in a `JSON`:\n\n```bash\n$ curl -X POST -d '{\"address\": \"cosmos1kd63kkhtswlh5vcx5nd26fjmr9av74yd4sf8ve\"}' http://localhost:8000\n{\"transfers\":[{\"coin\":\"10000000uatom\",\"status\":\"ok\"}]}\n```\n\nFor requesting specific coins, use:\n\n```bash\n$ curl -X POST -d '{\"address\": \"cosmos1kd63kkhtswlh5vcx5nd26fjmr9av74yd4sf8ve\", \"coins\": [\"10uatom\", \"20ueth\"]}' http://localhost:8000\n{\"transfers\":[{\"coin\":\"10uatom\",\"status\":\"ok\"}, {\"coin\":\"20ueth\",\"status\":\"ok\"}]}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftendermint%2Ffaucet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftendermint%2Ffaucet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftendermint%2Ffaucet/lists"}