Ravencore

This project is for end users of the RavenDevKit. It's purpose is to help them install and configure the full stack, giving them access to the API and Block Explorer.

Getting Started

Known to work on this platform: Ubuntu 16.04/x86_64

Deploying Ravencore full-stack manually:

mkdir ~/rdk
mkdir ~/.ravencore
mkdir ~/.ravencore/data
cd ~/rdk
sudo apt-get update
sudo apt-get -y install libevent-dev libboost-all-dev libminiupnpc10 libzmq5 software-properties-common curl git build-essential libzmq3-dev
sudo add-apt-repository ppa:bitcoin/bitcoin
sudo apt-get update
sudo apt-get -y install libdb4.8-dev libdb4.8++-dev
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash

##(restart your shell/os)##
cd ~/rdk
nvm install lts/dubnium
nvm install-latest-npm
nvm use lts/dubnium
##(install mongodb)##
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2930ADAE8CAF5059EE73BB4B58712A2291FA4AD5
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/3.6 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.6.list
sudo apt-get update
sudo apt-get install -y mongodb-org
sudo systemctl enable mongod.service

##(restart your shell/os)##
cd ~/rdk
##(install ravencore)##
git clone https://github.com/RavenDevKit/ravencore.git

## install ravencore, with or without ravencoin
## option 1: downloads and installs ravencoin at /node_modules/ravencore-node/bin/ravend
npm install -g ravencore --production
## options 2: use this instead if you're maintaining your own ravencoin installation
#SKIP_RAVENCOIN_DOWNLOAD=1 npm install -g ravencore --production

Ravencore Node Configuration

Copy the example configuration to ~/.ravencore/ravencore-node.json

Some things you'll want to customize:

• insight-api/db: settings should match the ones you use when you set up Mongo (see below)
• disableCors: set to false if you want to restrict cross-origin requests.
• socket.io
  • If you'd like to restrict other services from being able to query your API with live updates:
  • add this setting at the top level (does not follow standard regex rules. If you have a subdomain, the format would be(without angle brackets<>):
    • "allowedOriginRegexp": "^https://<yourdomain>\\.<yourTLD>$"
    • "allowedOriginRegexp": "^https://<yoursubdomain>\\.<yourdomain>\\.<yourTLD>$"
  • change disablePolling to true
  • enableSocketRPC should be set to false unless you can control who is connecting to your socket.io service.

Mongo Configuration

MongoDB is used to store values behind some stats endpoints. Run the following commands to set it up (the ones that start with > are run within mongo):

mongo
>use raven-api-livenet
>db.createUser( { user: "test", pwd: "test1234", roles: [ "readWrite" ] } )
>exit

(NOTE: if you change any of the values here, change them in the insight-api/db section of your ravencore-node.json)

Ravencoin Node Configuration

Copy the example configuration to ~/.ravencore/data/raven.conf

(NOTE: If you change the rpcuser or rpcpassword in this file be sure to also change it in the ravend section of your ~/.ravencore/ravencore-node.json)

Launch Ravencore

ravencored

You can then view the Ravencoin block explorer at the location: http://localhost:3001

Troubleshooting

Here are a few known issues that have come up and workarounds.

If the mongod isn't running some users have fixed it with these steps:

1. change mongo host from 127.0.0.1 --> 0.0.0.0 in /etc/mongod.conf
2. restart with sudo service mongod restart

If npm is having trouble with node-x16r:

1. sudo apt-get install node-gyp
2. run node-gyp rebuild from ravencore/node_modules/node-x16r
3. run npm install from ravencore/node_modules/node-x16r

If node is having trouble with "zmq.node":

1. run npm install zeromq in ravencore
2. or, run npm rebuild zeromq in ravencore

There may still be some lurking problems with the download-ravend script:

• unknown host breaks download into interactive mode
• the ln doesn't seem to work (but works manually afterwards)
• there's a path setting problem if ravencore isn't in your home directory

Create an Nginx proxy

To forward port 80 and 443 (with a snakeoil ssl cert) traffic:

IMPORTANT: this "nginx-ravencore" config is not meant for production use see this guide here for production usage

sudo apt-get install -y nginx ssl-cert

copy the following into a file named "nginx-ravencore" and place it in /etc/nginx/sites-available/

server {
    listen 80;
    listen 443 ssl;

    include snippets/snakeoil.conf;
    root /home/ravencore/www;
    access_log /var/log/nginx/ravencore-access.log;
    error_log /var/log/nginx/ravencore-error.log;
    location / {
        proxy_pass http://127.0.0.1:3001;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
        proxy_connect_timeout 10;
        proxy_send_timeout 10;
        proxy_read_timeout 100; # 100s is timeout of Cloudflare
        send_timeout 10;
    }
    location /robots.txt {
       add_header Content-Type text/plain;
       return 200 "User-agent: *\nallow: /\n";
    }
    location /ravencore-hostname.txt {
        alias /var/www/html/ravencore-hostname.txt;
    }
}

Then enable your site:

sudo ln -s /etc/nginx/sites-available/nginx-ravencore /etc/nginx/sites-enabled
sudo rm -f /etc/nginx/sites-enabled/default /etc/nginx/sites-available/default
sudo mkdir /etc/systemd/system/nginx.service.d
sudo printf "[Service]\nExecStartPost=/bin/sleep 0.1\n" | sudo tee /etc/systemd/system/nginx.service.d/override.conf
sudo systemctl daemon-reload
sudo systemctl restart nginx

Upgrading Ravencore full-stack manually:

• This will leave the local blockchain copy intact: Shutdown the ravencored application first, and backup your unique raven.conf and ravencore-node.json

  $cd ~/
  $rm -rf .npm .node-gyp ravencore
  $rm .ravencore/data/raven.conf .ravencore/ravencore-node.json
  ##reboot##
  $git clone https://github.com/RavenDevKit/ravencore.git
  $npm install -g ravencore --production

  (recreate your unique raven.conf and ravencore-node.json)

• This will redownload a new blockchain copy: (Some updates may require you to reindex the blockchain data. If this is the case, redownloading the blockchain only takes 20 minutes) Shutdown the ravencored application first, and backup your unique raven.conf and ravencore-node.json

  $cd ~/
  $rm -rf .npm .node-gyp ravencore
  $rm -rf .ravencore
  ##reboot##
  $git clone https://github.com/RavenDevKit/ravencore.git
  $npm install -g ravencore --production

  (recreate your unique raven.conf and ravencore-node.json)

reboot

git clone https://github.com/underdarkskies/ravencore.git cd ravencore && git checkout lightweight npm install -g --production

(recreate your unique raven.conf and ravencore-node.json)

Undeploying Ravencore full-stack manually:
----

nvm deactivate nvm uninstall 10.5.0 rm -rf .npm .node-gyp ravencore rm .ravencore/data/raven.conf .ravencore/ravencore-node.json mongo

use raven-api-livenet db.dropDatabase() exit

Applications

• Node - A full node with extended capabilities using Ravencoin Core
• Insight API - A blockchain explorer HTTP API
• Insight UI - A blockchain explorer web user interface

Libraries

• Lib - All of the core Ravencoin primatives including transactions, private key management and others
• P2P - The peer-to-peer networking protocol
• Message - Ravencoin message verification and signing

Security

We're using Ravencore in production, but please use common sense when doing anything related to finances! We take no responsibility for your implementation decisions.

Contributing

Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our CONTRIBUTING file.

To verify signatures, use the following PGP keys:

• TBD

License

Code released under the MIT license.