# build image
$ docker build -t symbol-faucet .
# or pull from dockerhub
$ docker pull symbolplatform/symbol-faucet:0.4.0faucet:
image: symbolplatform/symbol-faucet:0.4.0
stop_signal: SIGINT
environment:
- DEFAULT_NODE=http://rest-gateway:3000
- FAUCET_PRIVATE_KEY=__YOUR_PRIVATE_KEY__
ports:
- '4000:4000'
depends_on:
- rest-gatewayfaucet:
image: symbolplatform/symbol-faucet:0.4.0
stop_signal: SIGINT
environment:
- DEFAULT_NODE=http://rest-gateway:3000
- NATIVE_CURRENCY_ID=3E70742C9A38ACAB
ports:
- '4000:4000'
depends_on:
- rest-gateway
Need to set SYMBOL_PRIVATE_KEY(PrivateKey of your faucet account) while deployment.
If you want to use ReCaptcha, set both variables RECAPTCHA_CLIENT_SECRET and RECAPTCHA_SERVER_SECRET.
# Example in testnet
# Mosaic ID (3A8416DB2D53B6C8) is XYM from testnet
# Amount 0 returns random amount whereas nonzero returns exact amount
curl -X POST -H "Content-Type: application/json" https://testnet.symbol.tools/claims -d '{"recipient": "__YOUR_ADDRESS__", "amount": 0, "selectedMosaics":["3A8416DB2D53B6C8"]}'
# Example in localhost
curl -X POST -H "Content-Type: application/json" http://localhost:4000/claims -d '{"recipient": "__YOUR_ADDRESS__", "amount": 0, "selectedMosaics":["__MOSAIC_ID__"]}'# set enviroment variables
# DEFAULT_NODE
# HOST
# PORT= (default: 3000)
# NATIVE_CURRENCY_NAME
# NATIVE_CURRENCY_ID
# NATIVE_CURRENCY_OUT_MAX
# NATIVE_CURRENCY_OUT_MIN
# FAUCET_PRIVATE_KEY
# MAX_FEE
# ENOUGH_BALANCE
# MAX_UNCONFIRMED
# BLACKLIST_MOSAIC_IDS
# EXPLORER_URL
# see .env.sample
# install packages
$ npm install
# start app
$ npm start
# or for development
$ npm run dev