Skip to content

How to run a Vcash node

jdwldnqi837 edited this page Apr 27, 2019 · 2 revisions

This page is intended to provide basic instructions on how to get started running a Vcash node.

Prerequisites

  • Linux (x86-64 only) or MacOS
  • Relatively recent hardware
  • Some Linux command line knowledge very helpful
  • rust 1.31+ (use rustup- i.e. curl https://sh.rustup.rs -sSf | sh; source $HOME/.cargo/env)
    • if rust is already installed, you can simply update version with rustup update

Downloading the Software

The latest Vcash release can be found on the project Release Page. Binaries are currently provided for Linux and OSX.

Distribution-specific releases will likely appear over time, and will be listed here.

Installation

Linux (all distributions)

Download the zipped binary to your machine, and unzip it using the terminal. This will unzip a single file called vcash, which contains both the server and wallet software.

For now, we'd recommend placing this somewhere relative to your home directory, and editing your path environment variable to ensure the vcash executable is available from wherever you run it. All of this can be done by running the following commands in the directory to which you downloaded grin.

mkdir -p ~/vcash
tar zxvf vcash-v1.0.3-linux-amd64.tgz -C ~/vcash
echo export 'PATH=~/vcash:$PATH' >> ~/.bashrc
source ~/.bashrc

Running a Vcash Node

After following the installation steps, simply run Vcash:

vcash

Or, to run a Floonet (i.e. test network) node:

vcash --floonet

And that is it! The Vcash TUI (Text-User-Interface) should appear and your node should automatically sync up with the blockchain.

Configuring your Vcash node

By default, your Vcash node keeps all of its configuration files and data in the ~/.vcash directory under your user home. The main server configuration file can be found in the file ~/.vcash/main/vcash-server.toml (~/.vcash/floo/vcash-server.toml for Floonet). This file is fully documented, and contains many configuration options for your Vcash server. Leaving these values at their defaults should work for most people who simply want to run a node.

Running from a Custom Directory

You can also keep Vcash's data and configuration files in a custom directory. From the directory in which you want Vcash to store its files, run:

vcash server config

This will create a vcash-server.toml file in the current directory that is configured to place its data files in the same directory. The vcash command will always check the current directory for a vcash-server.toml file, and if one is found it will use it instead of ~/.vcash/main/vcash-server.toml.

Further Help

You can view further details on the various commmand-line options available from grin using the help command:

vcash help
vcash client help
vcash server help
Clone this wiki locally
You can’t perform that action at this time.