Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Lisk Faucet

Prerequisites

Installation

  1. Install node modules:
npm install
  1. Start redis-server:
redis-server > /dev/null 2>&1 &

Configuration

Open config.json and complete the following details.

  1. Edit your reCaptcha public/private keypair:
"captcha" : {
    "publicKey" : "",     // <-- Your publicKey
    "privateKey" : ""     // <-- Your privateKey
}

NOTE: There are two separate keypairs for development and production environments.

  1. Edit your Lisk connection details:
"lisk" : {
    "host" : "127.0.0.1", // <-- Server IP/hostname
    "port" : 7000,        // <-- 7000 for testnet, 8000 for mainnet
    "passphrase" : "",    // <-- Passphrase of faucet account
    "address" : ""        // <-- Address of faucet account
    "nethash": "",        // <-- Nethash of the network
    "broadhash": "",      // <-- Broadhash of the network
    "version": "0.0.0a",  // <-- Expected version of lisk-core end point
    "minVersion": "0.0.0" // <-- Minimal version of lisk-core that will be accepted
}
  1. Edit your Redis connection details:
"redis" : {
    "host" : "127.0.0.1", // <-- Redis server host (default: 127.0.0.1)
    "port" : 6379,        // <-- Redis server port (default: 6379)
    "password" : ""       // <-- Redis server password
}
  1. Edit the faucet amount:
{ "amount" : 1 }          // <-- Amount sent by faucet (default: 1)

Launch

Development:

node app.js

Open: http://localhost:3000

Production:

NODE_ENV=production node app.js

Open: http://localhost:6000

Authors

License

The MIT License (MIT)

Copyright (c) 2016-2017 Lisk
Copyright (c) 2014-2015 Crypti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.