/MassNet-miner

MassNet-miner is a Golang implementation of MassNet full-node miner.

Primary LanguageGoMIT LicenseMIT

MassNet Miner

Build Status MIT

MassNet Miner is a Golang implementation of MassNet full-node miner.

Cluster-Mining Guide

Deploy cluster-mining by referring to this guide.

Requirements

Go 1.13 or newer.

Development

Build from Source

Linux/Darwin

  • Clone source code to $GOPATH/src/github.com/massnetorg/MassNet-miner.
  • Go to project directory cd $GOPATH/src/github.com/massnetorg/MassNet-miner.
  • Run Makefile make build. An executable massminerd would be generated in ./bin/.

Contributing Code

Prerequisites

  • Install Golang 1.13 or newer.
  • Install the specific version or ProtoBuf, and related protoc-*:
    # libprotoc
    libprotoc 3.6.1
    
    # github.com/golang/protobuf 1.4.2
    protoc-gen-go
    
    # github.com/gogo/protobuf 1.3.1
    protoc-gen-gogo
    protoc-gen-gofast
    
    # github.com/grpc-ecosystem/grpc-gateway 1.14.5
    protoc-gen-grpc-gateway
    protoc-gen-swagger
    

Modifying Code

  • New codes should be compatible with Go 1.13 or newer.
  • Run gofmt and goimports to lint go files.
  • Run make test before building executables.

Reporting Bugs

Contact MASS community via community@massnet.org, and we will get back to you soon.

Verifying Commits

The following keys maybe trusted to commit code.

Name Fingerprint
massnetorg A8A9 5C74 1AB8 08D3 E6E6 5B6C F8A8 D5CF 14D0 C419

Documentation

API

A documentation for API is provided here.

Transaction Scripts

A documentation for Transaction Scripts is provided here.

License

MassNet Miner is licensed under the terms of the MIT license. See LICENSE for more information or see https://opensource.org/licenses/MIT.