README.md

Make blockchain decentralized again™

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.

Activity

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.

Diggin' Deeper

Please read the Spacemesh full FAQ.

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 develop branch of your fork from GitHub
• Move your fork from $GOPATH/src/github.com/YOURACCOUNT/go-spacemesh to $GOPATH/src/github.com/spacemeshos/go-spacemesh This 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

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 major contributors to the spacemesh core dev team.
• Please make sure to scan the issues.
• Search the closed ones before reporting things, and help us with the open ones.
• You don’t have to contribute code! Many important types of contributions are important for our project. See: How to Contribute to Open Source??

Guidelines

• Read the Spacemesh project white paper (coming soon)

• Ask questions or talk about things in Issues or on spacemash gitter.

• Ensure you are able to contribute (no legal issues please)

• For any code contribution, please fork from the develop branch and not from master), apply your changes and submit a pull request. We follow this git workflow

• Before starting to work on large contributions please chat with the core dev team on our gitter channel to get some initial feedback prior to doing lots of work.

• Check for 3rd-party packages in the vendor folder before adding a new 3rd party dependency.

• Add new 3rd-party packages required by your code to vendor.json - don't use any other kind of deps importing.

• Add the package name to your commit comment. e.g. node: added additional tests.

• Squash your changes down to a single commit before submitting a PR and rebase on master so we can keep the commit timeline linear.

• We adhere to the go standard formatting. Run go fmt before pushing any code

• Get in touch with @avive about how best to contribute

• Your code must be commented using go commentary

• You can add your your name and email to AUTHORS when submitting a Pull Request.

• Have fun hacking away our blockchain future!

Few things you can do right now to help out:

• Check out existing open issues. This would be especially useful for modules in active development.
• Add tests. There can never be enough tests.

Next Steps...

• Please visit our wiki
• Browse project go docs

Got Questions?

• Introduce yourself and ask anything on the spacemesh gitter channel.
• DM @teamspacemesh