universe-tree-db

README

Universe Tree DB

A gRPC service wrapped around the Aergo State Trie

This service also includes metadata about the trees stored in BadgerDB.

Table of Contents

• Build
• Usage
• Maintainer
• License

Build

Prerequisites

• Go 1.12+ (use gvm or your system's package manager)
• Protobuf Compiler (use your package manager to install protobuf-compiler or equivalent)
• Go tools and protobuf plugin:

go get -u golang.org/x/tools/cmd/goimports
go get -u golang.org/x/lint/golint
go get -u github.com/golang/protobuf/protoc-gen-go

Build Binaries

git clone https://github.com/dashevo/universe-tree-db.git
cd universe-tree-db

make

Compile Protobuf Schema

The default make target compiles this before building the server and example client binaries. You can also compile protocol buffers for Go using protoc target:

make protoc

These generated files are considered built artifacts and should not be checked in to source code repository.

Usage

Create data dir (first time only) and start the server:

mkdir $PWD/data

UNIDB_DIR=$PWD/data ./bin/server

Test w/the example client:

# list trees
./bin/client list

# create a tree called 'x'
./bin/client create x

# update tree w/hash of string 'hi'
./bin/client update x hi

# get value of string hash from tree
./bin/client get x hi

Maintainer

@nmarley

License

ISC © Dash Core Group, Inc.