protocol

OneLedger Protocol

This repo is the OneLedger blockchain full-node, which is currently an ABCi app based on low-level parts of the Tendermint consensus library

Table of Contents

• Getting Started
  • Development
  • Join OneLedger Testnet
• License

Getting Started

Development

These instructions will get a copy of the OneLedger Protocol up and running on your local machine.

System Requirements

Ensure your system meets the following requirements:

• Operating System must be one of the following:
  • macOS
    • Ensure Xcode Developer Tools is installed
  • A Debian-based Linux distribution
    • Ubuntu is recommended for the smoothest install, otherwise you will have to set up your distribution for installing PPAs
• Go version 1.11 or higher
• git

Install

Before running any install scripts, ensure your GOPATH and the necessary environment variables are set up on your account. Visit the Setting up the GOPATH page on the wiki for more help.

First clone the repository for the OneLedger Protocol:

$ mkdir -p $OLROOT
$ cd $OLROOT
$ git clone github.com/Oneledger/protocol

Before running any scripts, you'll need to set up the required environment variables properly.

Install the required dependencies:

$ cd "$OLROOT/protocol/node"
$ make setup

General scripts for running the OneLedger Protocol are inside node/scripts.

Make Targets

If everything is set up properly, you can begin testing the OneLedger Protocol with the make targets provided. Run the following scripts from inside the $OLREPO/node directory:

See Make Targets to see a list of make commands you can run to interact with the OneLedger Protocol.

Join OneLedger Testnet

• Setup a node

• Become Validator

• Check the explorer

License

The OneLedger Protocol is released under the terms of the Apache 2.0 license. See LICENSE.md for more details or visit https://www.apache.org/licenses/LICENSE-2.0.html.