Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/okp4/cosmos-faucet
🚰 CØSMOS Faucet backend implementation
https://github.com/okp4/cosmos-faucet
cosmos-sdk faucet-crypto golang
Last synced: 4 days ago
JSON representation
🚰 CØSMOS Faucet backend implementation
- Host: GitHub
- URL: https://github.com/okp4/cosmos-faucet
- Owner: okp4
- License: bsd-3-clause
- Created: 2022-04-28T07:17:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-25T20:23:48.000Z (5 months ago)
- Last Synced: 2024-10-02T00:12:36.877Z (about 1 month ago)
- Topics: cosmos-sdk, faucet-crypto, golang
- Language: Go
- Homepage:
- Size: 1.39 MB
- Stars: 20
- Watchers: 2
- Forks: 7
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - okp4/cosmos-faucet - 🚰 CØSMOS Faucet backend implementation (Go)
README
# CØSMOS Faucet
[](https://github.com/okp4/cosmos-faucet/releases)
[](https://github.com/okp4/cosmos-faucet/actions/workflows/lint.yml)
[](https://github.com/okp4/cosmos-faucet/actions/workflows/build.yml)
[](https://github.com/okp4/cosmos-faucet/actions/workflows/test.yml)
[](https://codeclimate.com/github/okp4/cosmos-faucet/maintainability)
[](https://codecov.io/gh/okp4/cosmos-faucet)
[](https://conventionalcommits.org)
[](https://github.com/okp4/.github/blob/main/CODE_OF_CONDUCT.md)
[](https://opensource.org/licenses/BSD-3-Clause)
This 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.
The faucet app supports any Cosmos based blockchain and is intended to be configured on testnet networks.
## Install
```sh
go install github.com/okp4/cosmos-faucet@latest
cosmos-faucet --help
```
## Config
Configuration can be passed as CLI argument, configuration file (`config.yml`) or by environment variable prefixed by `FAUCET` (i.e.: `FAUCET_MNEMONIC`).
```yml
grpc-address: 127.0.0.1:9090
mnemonic: "kiwi nuclear blast wet badge..."
chain-id: testnet-1
denom: uatom
prefix: cosmos
fee-amount: 0
amount-send: 1
memo: "Sent by økp4 faucet"
gas-limit: 200000
```
## Usage
### CLI
#### Send
```shell
Send tokens to a given address
Usage:
cosmos-faucet send
[flags]
Flags:
-h, --help help for send
Global Flags:
--amount-send int Amount send value (default 1)
--chain-id string The network chain ID (default "localnet-okp4-1")
--denom string Token denom (default "know")
--fee-amount int Fee amount
--gas-limit uint Gas limit (default 200000)
--grpc-address string The grpc okp4 server url (default "127.0.0.1:9090")
--memo string The memo description (default "Sent by økp4 faucet")
--mnemonic string
--no-tls No encryption with the GRPC endpoint
--prefix string Address prefix (default "okp4")
--tls-skip-verify Encryption with the GRPC endpoint but skip certificates verification
--tx-timeout duration Transaction timeout (default 5s)
```
#### Start
```shell
Start the GraphQL api
Usage:
cosmos-faucet start [flags]
Flags:
--address string graphql api address (default ":8080")
--batch-window duration Batch temporal window, can be seen a the minimum duration between too transactions. (default 8s)
--captcha enable captcha verification
--captcha-min-score float set Captcha min score (default 0.5)
--captcha-secret string set Captcha secret
--captcha-verify-url string set Captcha verify URL (default "https://www.google.com/recaptcha/api/siteverify")
--health enable health endpoint
-h, --help help for start
--metrics enable metrics endpoint
Global Flags:
--amount-send int Amount send value (default 1)
--chain-id string The network chain ID (default "localnet-okp4-1")
--denom string Token denom (default "know")
--fee-amount int Fee amount
--gas-limit uint Gas limit (default 200000)
--grpc-address string The grpc okp4 server url (default "127.0.0.1:9090")
--memo string The memo description (default "Sent by økp4 faucet")
--mnemonic string
--no-tls No encryption with the GRPC endpoint
--prefix string Address prefix (default "okp4")
--tls-skip-verify Encryption with the GRPC endpoint but skip certificates verification
--tx-timeout duration Transaction timeout (default 5s)
```
### GraphQL
Start GraphQL server with captcha verification for the send token mutation and subscription.
```shell
cosmos-faucet start --captcha --captcha-secret $CAPCTHA_SECRET
```
Access on playground and documentation at the root of server.
## Build
The 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:
- for macOS:
- for Windows:
- for Linux:
To build the app, invoke the following goal `build` of the `Makefile`:
```sh
make build
```
The app will be generated under the folder `target/dist`.
## :heart: Supporting this project & Contributing
A simple star in this repository is enough to make us happy!
But 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.
Remember 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.