go-spacemesh

command module
v0.2.7-beta.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 30, 2021 License: MIT Imports: 5 Imported by: 0

README

Spacemesh logo  

A Programmable Cryptocurrency

Go Report Card Bors enabled

Browse Gitcoin Bounties

go-spacemesh

💾⏰💪 Thanks for your interest in this open source project. This repo is the go implementation of the Spacemesh p2p full node software.

Spacemesh is a decentralized blockchain computer using a new race-free consensus protocol that doesn't involve energy-wasteful proof of work.

We aim to create a secure and scalable decentralized computer formed by a large number of desktop PCs at home.

We are designing and coding a modern blockchain platform from the ground up for scale, security and speed based on the learnings of the achievements and mistakes of previous projects in this space.

To learn more about Spacemesh head over to https://spacemesh.io.

To learn more about the Spacemesh protocol watch this video.

Motivation

Spacemesh is designed to create a decentralized blockchain smart contracts computer and a cryptocurrency that is formed by connecting the home PCs of people from around the world into one virtual computer without incurring massive energy waste and mining pools issues that are inherent in other blockchain computers, and provide a provably-secure and incentive-compatible smart contracts execution environment.

Spacemesh is designed to be ASIC-resistant and in a way that doesn’t give an unfair advantage to rich parties who can afford setting up dedicated computers on the network. We achieve this by using a novel consensus protocol and optimize the software to be most effectively be used on home PCs that are also used for interactive apps.

What is this good for?

Provide dapp and app developers with a robust way to add value exchange and other value related features to their apps at scale. Our goal is to create a truly decentralized cryptocurrency that fulfills the original vision behind bitcoin to become a secure trustless store of value as well as a transactional currency with extremely low transaction fees.

Target Users

go-spacemesh is designed to be installed and operated on users' home PCs to form one decentralized computer. It is going to be distributed in the Spacemesh App but people can also build and run it from source code.

Project Status

We are working hard towards our first major milestone - a public permissionless testnet running the Spacemesh consensus protocol.

Contributing

Thank you for considering to contribute to the go-spacemesh open source project!

We welcome contributions large and small and we actively accept contributions.

Diggin' Deeper

Please read the Spacemesh full FAQ.

go-spacemesh Architecture

High Level Design

Client Software Architecture

Getting

git clone git@github.com:spacemeshos/go-spacemesh.git

-- or --

Fork the project from https://github.com/spacemeshos/go-spacemesh

Since the project uses Go Modules it is best to place the code outside your $GOPATH. Read this for alternatives.

Setting Up Local Dev Environment

Building is supported on OS X, Linux, FreeBSD, and Windows.

Install Go 1.15 or later for your platform, if you haven't already.

On Windows you need to install make via msys2, MingGW-w64 or [mingw] (https://chocolatey.org/packages/mingw)

Ensure that $GOPATH is set correctly and that the $GOPATH/bin directory appears in $PATH.

Before building we need to set up the golang environment. Do this by running:

make install

Building

To build go-spacemesh for your current system architecture, from the project root directory, use:

make build

(On FreeBSD, you should instead use gmake build. You can install gmake with pkg install gmake if it isn't already installed.)

This will build the go-spacemesh binary, saving it in the build/ directory.

To build a binary for a specific architecture directory use:

make darwin | linux | freebsd | windows

Platform-specific binaries are saved to the /build directory.

Using go build and go test without make

To build code without using make the CGO_LDFLAGS environment variable must be set appropriately. The required value can be obtained by running make print-ldflags or make print-test-ldflags.

This can be done in 3 ways:

  1. Setting the variable in the shell environment (e.g., in bash run CGO_LDFLAGS=$(make print-ldflags)).
  2. Prefixing the key and value to the go command (e.g., CGO_LDFLAGS=$(make print-ldflags) go build).
  3. Using go env -w CGO_LDFLAGS=$(make print-ldflags), which persistently adds this value to Go's environment for any future runs.

There's a handy shortcut for the 3rd method: make go-env or make go-env-test.

Running

go-spacemesh is p2p software which is designed to form a decentralized network by connecting to other instances of go-spacemesh running on remote computers.

To run go-spacemesh you need to specify the parameters shared between all instances on a specific network.

You specify these parameters by providing go-spacemesh with a json config file. Other CLI flags control local node behavior and override default values.

Joining a Testnet (without mining)
  1. Build go-spacemesh from source code.
  2. Download the testnet's json config file. Make sure your local config file suffix is .json.
  3. Start go-spacemesh with the following arguments:
./go-spacemesh --tcp-port [a_port] --config [configFileLocation] -d [nodeDataFilesPath]
Example

Assuming tn1.json is a testnet config file saved in the same directory as go-spacemesh, use the following command to join the testnet. The data folder will be created in the same directory as go-spacemesh. The node will use TCP port 7513 and UDP port 7513 for p2p connections:

./go-spacemesh --tcp-port 7513 --config ./tn1.json -d ./sm_data

  1. Build the CLI Wallet from source code and run it:

  2. Use the CLI Wallet commands to setup accounts, start smeshing and execute transactions.

./cli_wallet
Joining a Testnet (with mining)
  1. Run go-spacemesh to join a testnet without mining (see above).
  2. Run the CLI Wallet to create a coinbase account. Save your coinbase account public address - you'll need it later.
  3. Stop go-spacemesh and start it with the following params:
./go-spacemesh --tcp-port [a_port] --config [configFileLocation] -d [nodeDataFilesPath] --coinbase [coinbase_account] --start-mining --post-datadir [dir_for_post_data]
Example
./go-spacemesh --tcp-port 7513 --config ./tn1.json -d ./sm_data --coinbase 0x36168c60e06abbb4f5df6d1dd6a1b15655d71e75 --start-mining --post-datadir ./post_data
  1. Use the CLI wallet to check your coinbase account balance and to transact
Joining Spacemesh (TweedleDee) Testnet

Find the latest Testnet release in the releases and download the precompiled binary for your platform of choice (or you can compile go-spacemesh yourself, from source, using the release tag). The release notes contain a link to a config.json file that you'll need to join the testnet.

Note that you must download (or build) precisely this version (latest Testnet release) of go-spacemesh, and the compatible config file, in order to join the current testnet. Older versions of the code may be incompatible with this testnet, and a different config file will not work.

Testing

NOTE: if tests are hanging try running ulimit -n 400. some tests require that to work.

make test

or

make cover

Continuous Integration

We've enabled continuous integration on this repository in GitHub. You can read more about our CI workflows.

Docker

A Dockerfile is included in the project allowing anyone to build and run a docker image:

docker build -t spacemesh .
docker run -d --name=spacemesh spacemesh

Windows

On Windows you will need the following prerequisites:

  • Powershell - included by in Windows by default since Windows 7 and Windows Server 2008 R2
  • Git for Windows - after installation remove C:\Program Files\Git\bin from System PATH (if present) and add C:\Program Files\Git\cmd to System PATH (if not already present)
  • Make - after installation add C:\Program Files (x86)\GnuWin32\bin to System PATH
  • Golang
  • GCC. There are several ways to install gcc on Windows, including Cygwin. Instead, we recommend tdm-gcc which we've tested.

Close and reopen powershell to load the new PATH. You can then run the command make install followed by make build as on UNIX-based systems.

Running a Local Testnet

  • You can run a local Spacemesh Testnet with 6 full nodes, 6 user accounts, and 1 POET support service on your computer using docker.
  • The local testnet full nodes are built from this repo.
  • This is a great way to get a feel for the protocol and the platform and to start hacking on Spacemesh.
  • Follow the steps in our Local Testnet Guide
Next Steps...

Got Questions?

Documentation

Overview

go-spacemesh is a golang implementation of the Spacemesh node. See - https://spacemesh.io

Source Files

View all Source files

Directories

Path Synopsis
Package activation is responsible for creating activation transactions and running the mining flow, coordinating Post building, sending proofs to PoET and building NIPost structs.
 Package activation is responsible for creating activation transactions and running the mining flow, coordinating Post building, sending proofs to PoET and building NIPost structs.
api
config
Package config provides configuration for GRPC and HTTP api servers
 Package config provides configuration for GRPC and HTTP api servers
grpcserver
metrics
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
cmd
Package cmd is the base package for various sets of builds and executables created from go-spacemesh
 Package cmd is the base package for various sets of builds and executables created from go-spacemesh
hare
package hare is the tester executable running instances of hare consensus algorithm
 package hare is the tester executable running instances of hare consensus algorithm
integration
Package integration provides RPC testing harness for executing and interacting with full node
 Package integration provides RPC testing harness for executing and interacting with full node
mapstructureutil
multi_node_sim
package multi_node_sim is an implementation of a framework running multiple nodes in same executable with fast hare implementation.
 package multi_node_sim is an implementation of a framework running multiple nodes in same executable with fast hare implementation.
node
Package node contains the main executable for go-spacemesh node
 Package node contains the main executable for go-spacemesh node
p2p
package p2p cmd is the main executable for running p2p tests and simulations
 package p2p cmd is the main executable for running p2p tests and simulations
Package collector implements event collecting from pubsub
 Package collector implements event collecting from pubsub
common
types
Package types defines the types used by go-spacemesh consensus algorithms and structs
 Package types defines the types used by go-spacemesh consensus algorithms and structs
util
Package util provides common utility functions.
 Package util provides common utility functions.
Package config contains go-spacemesh node configuration definitions
 Package config contains go-spacemesh node configuration definitions
Package crypto provides funcs and types used by other packages to perform crypto related ops
 Package crypto provides funcs and types used by other packages to perform crypto related ops
sha3
Package sha3 implements the SHA-3 fixed-output-length hash functions and the SHAKE variable-output-length hash functions defined by FIPS-202.
 Package sha3 implements the SHA-3 fixed-output-length hash functions and the SHAKE variable-output-length hash functions defined by FIPS-202.
Package database defines interfaces to key value type databases used by various components in go-spacemesh node
 Package database defines interfaces to key value type databases used by various components in go-spacemesh node
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
Package eligibility defines fixed size oracle used for node testing
 Package eligibility defines fixed size oracle used for node testing
Package events defines events published by go-spacemsh node using nodes pubsub
 Package events defines events published by go-spacemsh node using nodes pubsub
Package fetch contains mechanism to fetch Data from remote peers
 Package fetch contains mechanism to fetch Data from remote peers
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
Package filesystem provides functionality for interacting with directories and files in a cross-platform manner.
 Package filesystem provides functionality for interacting with directories and files in a cross-platform manner.
Package hare implements the Hare Protocol.
 Package hare implements the Hare Protocol.
config
eligibility
eligibility/config
metrics
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
Package layerfetcher fetches layers from remote peers
 Package layerfetcher fetches layers from remote peers
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
Package layerpatrol keeps parties informed about the general progress of each layer.
 Package layerpatrol keeps parties informed about the general progress of each layer.
log
Package log provides the both file and console (general) logging capabilities to spacemesh modules such as app and identity.
 Package log provides the both file and console (general) logging capabilities to spacemesh modules such as app and identity.
logtest
Package mesh defines the main store point for all the block-mesh objects such as blocks, transactions and global state
 Package mesh defines the main store point for all the block-mesh objects such as blocks, transactions and global state
metrics
Package metrics defines telemetry primitives to be used across components.
 Package metrics defines telemetry primitives to be used across components.
Package miner is responsible for creating valid blocks that contain valid activation transactions and transactions
 Package miner is responsible for creating valid blocks that contain valid activation transactions and transactions
metrics
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
main
Package nattraversal provides tools for acquiring ports on a Network Address Translator (NAT).
 Package nattraversal provides tools for acquiring ports on a Network Address Translator (NAT).
upnp
Package upnp provides a simple and opinionated interface to UPnP-enabled routers, allowing users to forward ports and discover their external IP address.
 Package upnp provides a simple and opinionated interface to UPnP-enabled routers, allowing users to forward ports and discover their external IP address.
p2p
bootstrap
bootstrap/mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
handshake
peerexchange
peerexchange/mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
pubsub
pubsub/mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
server
server/mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
Package pendingtxs exposes the AccountPendingTxs type, which keeps track of transactions that haven't been applied to global state yet.
 Package pendingtxs exposes the AccountPendingTxs type, which keeps track of transactions that haven't been applied to global state yet.
metrics
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
Package rlp implements the RLP serialization format.
 Package rlp implements the RLP serialization format.
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
svm
state
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
systest module
Package timesync is used to check system time reliability by communicating with NTP time servers.
 Package timesync is used to check system time reliability by communicating with NTP time servers.
config
peersync
peersync/mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
metrics
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
organizer
sim
metrics
mocks
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
weakcoin
Package trie implements Merkle Patricia Tries.
 Package trie implements Merkle Patricia Tries.
Package turbohare is a component returning block ids for layer as seen by this miner, without running any consensus process
 Package turbohare is a component returning block ids for layer as seen by this miner, without running any consensus process

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.