README
¶
Blockmesh Operating System
go-spacemesh
💾⏰💪
Thanks for your interest in this open source project. This is the go implementation of the Spacemesh p2p node. 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 our wiki.
Motivation
SpacemeshOS 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 OS 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 cryptocoin 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.
Project Status
Development is currently focused on 3 main node core components:
- The p2p/networking - the project includes a modern and robust p2p protocol for use by components up the stack.
- The POST/blockmesh based consensus layer - Spacemesh protocol implementation, utilizing the p2p capabilities.
- App scaffolding - supporting functionality such as config, repl, cli and cross platform packaging.
Over the last few months, we had good progress on #1 and #3 and we are now starting to focus on #2.
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.
-
go-spacemesh is part of The Spacemesh open source project, and is MIT licensed open source software.
-
We welcome collaborators to the Spacemesh core dev team.
-
You don’t have to contribute code! Many important types of contributions are important for our project. See: How to Contribute to Open Source?
-
To get started, please read our contributions guidelines.
-
Browse Good First Issues.
NEW! Get crypto awarded for your contribution by working on one of our gitcoin funded issues.
Diggin' Deeper
Please read the Spacemesh full FAQ.
High Level Design
Node Software Architecture
Getting
install Go 1.9.2 or later for your platform
go get github.com/spacemeshos/go-spacemesh
or
- Fork the project from https://github.com/spacemeshos/go-spacemesh
- Checkout the
developbranch of your fork from GitHub - Move your fork from
$GOPATH/src/github.com/YOURACCOUNT/go-spacemeshto$GOPATH/src/github.com/spacemeshos/go-spacemeshThis allows GO tools to work as expected.
Building
To build go-spacemesh for your current system architecture use:
make
or
go build
from the project root directory. The binary go-spacemesh will be saved in the project root directory.
To build a binary for a specific architecture directory use:
make darwin | linux | windows
Platform-specific binaries are saved to the /build directory.
Running
./go-spacemesh
Testing
make test
or
make cover
Next Steps...
- Please visit our wiki
- Browse project go docs
- Spacemesh Protocol first AMA session
Got Questions?
- Introduce yourself and ask anything on the spacemesh gitter channel.
- DM @teamspacemesh
Documentation
¶
Overview ¶
go-spacemesh is a golang implementation of the Spacemesh node. See - https://spacemesh.io
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package accounts provides types for working with Spacemesh blockchain accounts.
|
Package accounts provides types for working with Spacemesh blockchain accounts. |
|
Package api provides the local go-spacemesh API endpoints.
|
Package api provides the local go-spacemesh API endpoints. |
|
pb
Package pb is a generated protocol buffer package.
|
Package pb is a generated protocol buffer package. |
|
Package app provides the cli app shell of a Spacemesh p2p node
|
Package app provides the cli app shell of a Spacemesh p2p node |
|
Package assert provides basic assert functions for tests
|
Package assert provides basic assert functions for tests |
|
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 |
|
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 log provides the both file and console (general) logging capabilities to spacemesh modules such as app and node.
|
Package log provides the both file and console (general) logging capabilities to spacemesh modules such as app and node. |
|
Package merkle provides a merkle tree which supports CRUD ops for user (k,v) data.
|
Package merkle provides a merkle tree which supports CRUD ops for user (k,v) data. |
|
pb
Package pb is a generated protocol buffer package.
|
Package pb is a generated protocol buffer package. |
|
Package p2p implement the core spacemesh p2p protocol and provide types for higher-level protcols such as handshake.
|
Package p2p implement the core spacemesh p2p protocol and provide types for higher-level protcols such as handshake. |
|
delimited
Package delimited implements a reader and writer for simple streams of length-delimited byte records.
|
Package delimited implements a reader and writer for simple streams of length-delimited byte records. |
|
pb
Package pb is a generated protocol buffer package.
|
Package pb is a generated protocol buffer package. |
|
timesync
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. |