jovijovi/ether-faucet

A Faucet contract & microservice for the Ethereum ecosystem

Ether Faucet

A Faucet contract & microservice for the Ethereum ecosystem.

Features

• Faucet contract
  • Permission control
  • Operator pool
• Safe keystore
• RESTFul Faucet APIs for the Ethereum ecosystem
• Microservice run in Docker

Supported Chains

• Ethereum
• Polygon

Development Environment

• typescript 4.8.4
• node v16.17.1
• ts-node v10.9.1
• yarn v1.22.19

Contract Dependencies

• @openzeppelin/contracts: 4.7.3

Quick Guide

• Install dependency

  yarn

• Build code

  Install all dependencies and compile code.

  make build

• Build docker image

  make docker

• Run

  • Params

    • --config Config filepath. Example:

      ts-node ./src/main/index.ts --config ./conf/app.config.yaml

  • Run code directly by ts-node

    yarn dev-run --config ./conf/app.config.yaml

  • Run compiled code by node

    yarn dist-run --config ./conf/app.config.yaml

• Clean

  make clean

Roadmap

• Development documents
• API documents
• Faucet history

License

MIT