Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 1.23 KB

README.md

File metadata and controls

48 lines (38 loc) · 1.23 KB

eth-faucet

The faucet is a web application with the goal of distributing small amounts of Ether in private and test networks.

Get started

Prerequisites

  • Go (1.16 or later)
  • Node.js

Build

  1. Clone the repository
git clone https://github.com/chainflag/eth-faucet.git
  1. Bundle web using rollup
cd web && npm install
npm run build

For more details, please refer to the web readme

  1. Build binary application
cd ..
go build -o eth-faucet main.go

Usage

First create config file config.yml based on the example

  • provider Ethereum json rpc endpoint
  • payout Number of Ethers to transfer per request
  • queuecap Maximum transactions waiting to be sent
  • wallet Funder account specified via hex private key or keystore. Faucet will use private key first if it is not empty.

then start the faucet server

./eth-faucet -port 8080

or run faucet using docker without the compiled binary

docker run -d -p 8080:8080 -v `pwd`/config.yml:/app/config.yml chainflag/eth-faucet

License

This project is licensed under the MIT License