This project defines a production ready faucet for the Ethereum test networks, allowing users to request and receive a specified amount of ETH every X hours to an address from a max of N different IP addresses (configurable) after passing Google recaptcha verification. The API tracks IP addresses and wallet addresses which requested and resets them at configurable intervals.
The project comes with functional React and Angular applications to showcase the faucet.
- See releases for a detailed version history.
- To contribute, see here
- Please open an issue if anything is missing, unclear, or for any suggested improvements
Download the latest version of Go. Then, build the project.
make go./dist/faucet --helpOutputs
Run a faucet server for Ethereum using captcha for verification and ip-based rate-limiting
Usage:
faucet [flags]
- Sign-up for Google recaptcha in the admin portal here
- Make note of the captcha secret key and the captcha site key
- Obtain your testnet private key where the faucet funds will be coming from in hex string format (such as 0xa8b01...)
- Obtain the address of your Ethereum node's HTTP API endpoint (by default, the faucet server uses http://localhost:8545 as the web3-provider)
- Run the faucet server with the required parameters
The faucet hosts an http JSON API on localhost:8000 by default and a gRPC server on localhost:5000 for client access. Further customizations and required parameters are specified below:
The following are the available parameters to the faucet server:
Required Flags
| flag | Description | Default Value |
|---|---|---|
| --web3-provider | HTTP web3provider endpoint to an Ethereum node | "http://localhost:8545" |
| --captcha-host | Host for the captcha validation | "" |
| --captcha-secret | Secret for Google captcha validation | "" |
| --private-key | Private key hex string of the funding account | "" |
Web Server Flags
| flag | Description | Default Value |
|---|---|---|
| --http-host | Host to serve REST http requests | 127.0.0.1 |
| --http-port | Port to serve REST http requests | 8000 |
| --grpc-host | Host to serve gRPC requests | 127.0.0.1 |
| --grpc-port | Port to serve gRPC requests | 5000 |
| --allowed-origins | Comma-separated list of allowed origins | "*" |
Misc. Flags
| flag | Description | Default Value |
|---|---|---|
| --config | Path to yaml configuration file for flags | "" |
| --captcha-min-score | Minimum passing captcha score | 0.9 |
| --chain-id | Chain id of the Ethereum network used | 5 (Goerli) |
| --funding-amount | Amount in wei to fund with each request | 32500000000000000000 |
| --gas-limit | Gas limit for funding transactions | 40000 |
| --ip-limit-per-address | Number of ip's allowed per funding address | 5 |
You can configure the faucet by using a yaml configuration file instead of command-line flags as follows:
chain-id: 9999
http-port: 8080
# Insert all other desired customizations below...and running the faucet server by specifying the path to the configuration file as follows:
./dist/faucet --config=/path/to/config.yaml
The Angular project allows you to enter your ETH wallet address, complete a captcha verification, and waits for a transaction to complete:
- Install the latest version of Node.js.
- Paste in the captcha site key from the usage step in
./web/ng/src/environments/environment.tsor./web/ng/src/environments/environment.prod.tsif building for production - Run the faucet server as specified in usage
- Run the Angular app as follows:
cd web/ng
npm install
npm start
Then navigate to http://localhost:4200 and try it out!
You can build it for production with npm run build
- Install the latest version of Node.js.
- Paste in the captcha site key from the usage step in
./web/react-example/src/environment.ts. - Run the faucet server as specified in usage
- Run the React app as follows:
cd web/react-example
npm install -g yarn
yarn install
npm start
Then navigate to http://localhost:3000 and try it out!
You can build it for production with npm run build
Regenerating protobufs:
- Install the latest version of
protoc make proto
Running tests:
go test ./... -v
The project is licensed under the MIT License.