Skip to content

Latest commit

 

History

History
157 lines (107 loc) · 5.13 KB

README.md

File metadata and controls

157 lines (107 loc) · 5.13 KB
Raw

Asch Blockchain Explorer

Asch Explorer version 1.1.0 works in conjunction with the Asch Core API. It uses Redis for caching data and Freegeoip to parse IP geo-location data.

Prerequisites

These programs and resources are required to install and run Asch Explorer

  • Nodejs v6.9.2 or higher (https://nodejs.org/) -- Nodejs serves as the underlying engine for code execution.

    curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
sudo apt-get install -y nodejs

  • Redis (http://redis.io) -- Redis is used for caching parsed exchange data.

    sudo apt-get install -y redis-server

  • Freegeoip (https://github.com/fiorix/freegeoip) -- Freegeoip is used by the Network Monitor for IP address geo-location.

    wget https://github.com/fiorix/freegeoip/releases/download/v3.1.5/freegeoip-3.1.5-linux-amd64.tar.gz
tar -zxf freegeoip-3.1.5-linux-amd64.tar.gz
ln -s freegeoip-3.1.5-linux-amd64 freegeoip
nohup ./freegeoip/freegeoip > ./freegeoip/freegeoip.log 2>&1 &

  • Bower (http://bower.io/) -- Bower helps to install required JavaScript dependencies.

    sudo npm install -g bower

  • Grunt.js (http://gruntjs.com/) -- Grunt is used to compile the frontend code and serves other functions.

    sudo npm install -g grunt

  • Forever (https://github.com/foreverjs/forever) -- Forever manages the node processes for Asch Explorer

    sudo npm install -g forever

  • Git (https://github.com/git/git) -- Used for cloning and updating Asch Explorer

    sudo apt-get install -y git

  • Tool chain components -- Used for compiling dependencies

    sudo apt-get install -y python build-essential automake autoconf libtool

Installation Steps

Clone the Asch Explorer Repository:

git clone https://github.com/sportshark/asch-explorer.git
cd asch-explorer
npm install
bower install

Build Steps

Frontend

The frontend must be built with Grunt before starting Asch Explorer. Run the following command to compile the frontend components:

grunt compile

Configuration

The default config.json file contains all of the configuration settings for Asch Explorer. These options can be modified and have been documented below.

Example:

{
    "host": "0.0.0.0",
    "port": 6040,
    "asch" : {
        "host" : "127.0.0.1",
        "port" : 8000
    },
    "freegeoip" : {
        "host" : "127.0.0.1",
        "port" : 8080
    },
    "redis" : {
        "host" : "127.0.0.1",
        "port" : 6379,
        "password" : ""
    },
    "exchangeRates": {
        "enabled": true,
        "updateInterval": 30000,
        "exchanges": {
            "XAS": {
                "BTC": "poloniex",
                "CNY": "jubi"
            },
            "BTC": {
                "USD": "bitfinex",
                "EUR": "bitstamp"
            }
        }
    },
    "cacheTTL" : 20,
    "enableCandles" : true,
    "updateCandlesInterval" : 30000,
    "enableOrders" : true,
    "updateOrdersInterval" : 15000
}
  • cacheTTL - time to live cache in redis.
  • fixedPoint - fixed point number of Asch (10^8).
  • enableCandles - enable or disable updating of candlestick data.
  • updateCandlesInterval - time to update candlestick data.
  • enableOrders - enable or disable updating of order book data.
  • updateOrdersInterval - time to update order book data.
  • updateInterval - time to update exchange currency courses.

Managing Asch Explorer

To test that Asch Explorer is configured correctly, run the following command:

node app.js

Open: http://localhost:6040, or if its running on a remote system, switch localhost for the external IP Address of the machine.

Once the process is verified as running correctly, CTRL+C and start the process with forever. This will fork the process into the background and automatically recover the process if it fails.

forever start app.js

After the process is started its runtime status and log location can be found by issuing this statement:

forever list

To stop Explorer after it has been started with forever, issue the following command:

forever stop app.js


## License

The MIT License (MIT)
Copyright (c) 2017 Asch
Copyright (c) 2016 Lisk
Copyright (c) 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.