An API designed for users interacting with SmartKey. It allows you to send small amounts of funds without authentication. The API documentation is available at the root path e.g. https://faucet.skey.network/ (or http://localhost:3000/ if you're developing locally).
We can distinguish between four types of a request methods:
refill address to max amount
refill address to max amount with captcha
refill address to max amount only if it has authorized tokens
refill address to max amount with API key.
The tool is available at https://faucet.skey.network/
Node.js
Blockchain address with funds
Docker (Optional if you don't want to use Node.js - minimum version 19.03 required)
Waves private node (Optional) from https://hub.docker.com/r/wavesplatform/waves-private-node
NOTE: Default Captcha key will verify anything, so make sure to set a different one in production!
Site key for default secret key: 6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
BLOCKCHAIN_SEED is required to start the app.
The app uses waves private node by default. If you want to deploy the app to testnet, change those environment variables:
export BLOCKCHAIN_NODE_URL='https://master.testnet.node.smartkeyplatform.io'
export BLOCKCHAIN_CHAIN_ID='A'
and make sure you have funds on your account.
Parameter | Description | Default Value |
---|---|---|
PORT
Port to run application on
3000
APP_ENABLE_STANDARD_FAUCET
Enable /faucet/refill/{address} endpoint
true
APP_ENABLE_CAPTCHA_FAUCET
Enable /faucet/refill_with_captcha endpoint
false
APP_ENABLE_KEY_OWNER_FAUCET
Enable /faucet/refill_token_owner endpoint
false
APP_ENABLE_AUTHORIZED_FAUCET
Enable /faucet/refill_authorized/{address} endpoint
false
BLOCKCHAIN_NODE_URL
Blockchain node url
http://localhost:6869
BLOCKCHAIN_CHAIN_ID
Blockchain chain id
R
BLOCKCHAIN_SEED
Organisation address seed phrase (required)
-
FAUCET_REFILL_MAX_AMOUNT
Maximum amount of tokens while refilling
1
CAPTCHA_SECRET_KEY
Google reCaptcha v2 secret key
6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe
FAUCET_DAPP_FATHER_ADDRESS
Dapp father address used for validation
-
FAUCET_AUTHORIZED_API_KEY
Api key used for validating refill_authorized method
-