zoobc-core

README

ZOOBC Core

Zoobc-core is the main node application to run the zoobc blockchain. This repository consist of the main node application and the command line interface tools to help with development, which is located in the cmd/ directory.

Table of Contents:

• Environments
• Development
  • Build
  • Run
  • Flags:
• Tests
• Installation script
• Swagger
• Contributing

Environments

• golang, currently using go.1.14
• go-swagger optional. Used as tools to document the rpc endpoint.
• protoc, optional as we are pushing the generated go file to the repo. Version compatible: this
• protoc-gen-go, optional as we are pushing the generated go file to the repo. Instruction: here
• golangci-lint lint tools we used to keep the code clean and well structured.
• tdm-gcc (windows-only), if you are running on windows you'll need to install this to build the binary.
• grpc-gateway (optional), for reverse proxy server.

Development

• clone the repository.
• Dep user: run dep ensure -v --vendor-only to install the dependencies read from Gopkg.toml only.
• Go mod user: go mod download to generate vendor directory which is should download the packages from Gopkg.toml or read from project recursively
• run git submodule update --init --recursive --remote to update / fetch submodule.
• run make test to run the test and linter.

Build

To make use of the Makefile please rename github.token.example to github.token and place your github token there. This is required since we are accessing private repository for one of our dependencies.

• ZOOBC CORE

  note: For cross compilation please install and activate docker. For:

  • host: go build -o zoobc
  • darwin: make VERSION=v1.10.1 core-darwin
  • linux (386 & amd64): make VERSION=v1.10.1 core-linux
  • windows (32 & 64bit): make VERSION=v1.10.1 core-windows
  • common os (darwin, linux, windows) : make VERSION=v1.10.1 core-common-os

    With genesis replacement, you can add argument genesis=true and what your target is {develop,staging,alhpa(default),local}, like: make build genesis=true gen-target=develop gen-output=dist for the local target you need create local.preRegisteredNodes.json.

• ZOOBC CMD

  For:

  • host: go build -o zoobc
  • darwin: make VERSION=v1.10.1 cmd-darwin
  • linux (386 & amd64): make VERSION=v1.10.1 cmd-linux
  • windows (32 & 64bit): make VERSION=v1.10.1 cmd-windows
  • common os (darwin, linux, windows) : make VERSION=v1.10.1 cmd-common-os

Run

Usage:
   [command]

Available Commands:
  daemon      Run node on daemon service, which mean running in the background. Similar to launchd or systemd
  help        Help about any command
  run         Run node as without daemon.

Flags:
      --config-path string      Configuration path (default "./")
      --config-postfix string   Configuration version
      --debug                   Run on debug mode
  -h, --help                    help for this command
      --profiling               Run with profiling
      --use-env                 Running node without configuration file

Use " [command] --help" for more information about a command.

Flags:

• debug (bool): enters debug mode with capabilities like prometheus monitoring (uses port defined by monitoringPort in the config file).
• config-postfix (string): defines which config file with defined postfix to use. It will use the config file in ./resource/config{postfix}.toml.
• config-path (string): defines the directory that will hold the resources and configs. by default it will use ./resource. This will be useful particularly for robust resource placements, for example while used in Zoobc-Testing-Framework.
• cpu-profile (bool): enable realtime profiling for the running instance, via http server. See http pprof for documentation on how to use this tool
• Command line tools

  cd cmd
  go run main.go --help
  go run main.go tx generate -t registerNode
  

  for more detail check this out cmd session

Tests

• Unit tests

  • run all tests without cache go test ./... -count=1
  • run all test with coverage report go test ./... -coverprofile=cover.out && go tool cover -html=cover.out

• Linter

  • install linter tools curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.20.0
  • run golangci-lint run to check any linting error in the changes.
  • remember to run tests, and lint before submitting PR.

Installation script

ZooBC installation script based on bashscript for help user to install ZooBC node in one easy way. It will download the latest binary that contains:

• zcmd: command line tools helper for developer and that needed for check and parse wallet certificate and stuff at first time running the installation script.
• zoobc: zoobc core binary Both will downloaded by the script and for more detail you can check here.

Swagger

• install
• pull newest schema and run ./compile-go.sh to recompile the go file and produce swagger definition from it.

Contributing

please refer to contribute.md and code of conduct.

Documentation

Overview

ZooBC Copyright (C) 2020 Quasisoft Limited - Hong Kong This file is part of ZooBC <https://github.com/zoobc/zoobc-core>

ZooBC is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

ZooBC is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with ZooBC. If not, see <http://www.gnu.org/licenses/>.

Additional Permission Under GNU GPL Version 3 section 7. As the special exception permitted under Section 7b, c and e, in respect with the Author’s copyright, please refer to this section:

1. You are free to convey this Program according to GNU GPL Version 3, as long as you respect and comply with the Author’s copyright by showing in its user interface an Appropriate Notice that the derivate program and its source code are “powered by ZooBC”. This is an acknowledgement for the copyright holder, ZooBC, as the implementation of appreciation of the exclusive right of the creator and to avoid any circumvention on the rights under trademark law for use of some trade names, trademarks, or service marks.

2. Complying to the GNU GPL Version 3, you may distribute the program without any permission from the Author. However a prior notification to the authors will be appreciated.

ZooBC is architected by Roberto Capodieci & Barton Johnston

contact us at roberto.capodieci[at]blockchainzoo.com
and barton.johnston[at]blockchainzoo.com

Core developers that contributed to the current implementation of the software are:

Ahmad Ali Abdilah ahmad.abdilah[at]blockchainzoo.com
Allan Bintoro allan.bintoro[at]blockchainzoo.com
Andy Herman
Gede Sukra
Ketut Ariasa
Nawi Kartini nawi.kartini[at]blockchainzoo.com
Stefano Galassi stefano.galassi[at]blockchainzoo.com

IMPORTANT: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.