gitlab.com/jaxnet/core/shard.core

Shard Core

shard.core is a full node JAX.Network implementation written in Go (golang).

Requirements

Go 1.14 or newer.

Installation

Windows - MSI Available

todo

Linux/BSD/MacOSX/POSIX - Build from Source

• Install Go according to the installation instructions here: http://golang.org/doc/install

• Ensure Go was installed properly and is a supported version:

$ go version
$ go env GOROOT GOPATH

NOTE: The GOROOT and GOPATH above must not be the same path. It is recommended that GOPATH is set to a directory in your home directory such as ~/goprojects to avoid write permission issues. It is also recommended adding $GOPATH/bin to your PATH at this point.

• Run the following commands to obtain shard.core, all dependencies, and install it:

$ cd $GOPATH/src/gitlab.com/jaxnet/core/shard.core
$ GO111MODULE=on go install -v . ./cmd/...

• shard.core (and utilities) will now be installed in $GOPATH/bin. If you did not already add the bin directory to your system path during Go installation, we recommend you do so now.

Updating

Windows

Install a newer MSI

Linux/BSD/MacOSX/POSIX - Build from Source

• Run the following commands to update btcd, all dependencies, and install it:

$ cd $GOPATH/src/gitlab.com/jaxnet/core/shard.core
$ git pull
$ GO111MODULE=on go install -v . ./cmd/...

Getting Started

shard.core has several configuration options available to tweak how it runs, but all the basic operations described in the intro section work with zero configuration.

Configuration

todo

Windows (Installed from MSI)

Launch shard.core from your Start menu.

Linux/BSD/POSIX/Source

$ ./shard.core

Issue Tracker

The integrated github issue tracker is used for this project.

Documentation

The documentation is a work-in-progress. It is located in the docs folder.

Release Verification

Please see our documentation on the current build/verification process for all our releases for information on how to verify the integrity of published releases using our reproducible build system.

License

shard.core is licensed under the copyfree ISC License.