Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spacemeshos/go-spacemesh
Go Implementation of the Spacemesh protocol full node. 💾⏰💪
https://github.com/spacemeshos/go-spacemesh
blockchain blockmesh consensus cryptocurrencies dag decentralization go golang p2p proof-of-space proof-of-space-time proof-of-work spacemesh
Last synced: 4 days ago
JSON representation
Go Implementation of the Spacemesh protocol full node. 💾⏰💪
- Host: GitHub
- URL: https://github.com/spacemeshos/go-spacemesh
- Owner: spacemeshos
- License: mit
- Created: 2017-10-26T06:43:09.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2025-01-03T08:25:03.000Z (9 days ago)
- Last Synced: 2025-01-03T08:25:31.999Z (9 days ago)
- Topics: blockchain, blockmesh, consensus, cryptocurrencies, dag, decentralization, go, golang, p2p, proof-of-space, proof-of-space-time, proof-of-work, spacemesh
- Language: Go
- Homepage: https://spacemesh.io
- Size: 143 MB
- Stars: 768
- Watchers: 40
- Forks: 215
- Open Issues: 223
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-decentralized-storage - 3\
- best-of-crypto - GitHub - 8% open · ⏱️ 05.06.2024): (Others)
README
# [Spacemesh: A Programmable Cryptocurrency](https://spacemesh.io)
[](https://github.com/spacemeshos/go-spacemesh/blob/master/LICENSE)
[](https://github.com/spacemeshos/go-spacemesh/releases)
[](https://go.dev/)
[](https://github.com/spacemeshos/go-spacemesh/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
[](http://chat.spacemesh.io/)
[](https://spacemesh.io)
[](https://goreportcard.com/report/github.com/spacemeshos/go-spacemesh)
[](https://app.bors.tech/repositories/22421)
[](https://godoc.org/github.com/spacemeshos/go-spacemesh)
[](https://github.com/spacemeshos/go-spacemesh/blob/develop/ci.md#ci-status)
## go-spacemesh
💾⏰💪
Thanks for your interest in this open source project. This repo is the go implementation of the
[Spacemesh](https://spacemesh.io) 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](https://spacemesh.io).
To learn more about the Spacemesh protocol [watch this video](https://www.youtube.com/watch?v=jvtHFOlA1GI).
### 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.
- go-spacemesh is part of [The Spacemesh open source project](https://spacemesh.io), 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?](https://opensource.guide/how-to-contribute/#what-it-means-to-contribute)
- To get started, please read our [contributions guidelines](https://github.com/spacemeshos/go-spacemesh/blob/master/CONTRIBUTING.md).
- Browse [Good First Issues](https://github.com/spacemeshos/go-spacemesh/labels/good%20first%20issue).
- Get ethereum awards for your contribution by working on one of our [gitcoin funded issues](https://gitcoin.co/profile/spacemeshos).
### Diggin' Deeper
Please read the Spacemesh [full FAQ](https://github.com/spacemeshos/go-spacemesh/wiki/Spacemesh-FAQ).
### go-spacemesh Architecture
### Getting
```bash
git clone [email protected]:spacemeshos/go-spacemesh.git
```
or fork the project from
Since the project uses Go Modules it is best to place the code **outside** your `$GOPATH`.
Read [this](https://github.com/golang/go/wiki/Modules#how-to-install-and-activate-module-support) for alternatives.
### Setting Up Local Dev Environment
Building is supported on:
- Linux, GLIBC 2.34+ is required
- MacOS 13 (Intel) and MacOS 14 (Arm) and newer
- Windows 10 and newer
FreeBSD is not officially supported.
Install [Go 1.23 or later](https://golang.org/dl/) for your platform, if you haven't already.
On Windows you need to install `make` via [msys2](https://www.msys2.org/), [MingGW-w64](http://mingw-w64.org/doku.php)
or [mingw](https://chocolatey.org/packages/mingw).
Ensure that `$GOPATH` is set correctly and that the `$GOPATH/bin` directory appears in `$PATH`.
Ensure that you have installed [git-lfs](https://git-lfs.com/).
Before building we need to set up the golang environment. Do this by running:
```bash
make install
```
Make sure the environment is set up correctly:
```bash
make go-env-test
```
**CGO_CFLAGS** must be set to "-I/go-spacemesh/build/ -DSQLITE_ENABLE_DBSTAT_VTAB=1"
**CGO_LDFLAGS** must be set to "-L/go-spacemesh/build/ -Wl,-rpath,$ORIGIN -Wl,-rpath,/go-spacemesh/build/"
Make sure you have **OpenCL** library installed.
To check if setup was configured successfully, try to run:
```bash
make test
```
There shouldn't be any build errors, but please note that running the tests will take some time.
### How to run standalone node?
After you got a binary standalone fully functional network can be launched
with a simple command:
> ./build/go-spacemesh --preset=standalone --genesis-time=2023-06-08T5:30:00.000Z
Network will use short epochs (1 minute), and 10 layers within the epoch (each 6s). Poet is launched in the same process
in this mode. So expect that it will periodically hog 1 core. Minimal smeshing is enabled in order for consensus to work.
Public GRPC API are launched on 0.0.0.0:9092. Private - 0.0.0.0:9093.
### Building
To build `go-spacemesh` for your current system architecture, from the project root directory, use:
```bash
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.
On linux or mac you can build a binary for windows using:
```bash
make windows
```
Be aware that this will require a cross-platform gcc like `x86_64-w64-mingw32-gcc`. Platform-specific binaries are saved
to the `build/*target*` directory.
### Using `go build` and `go test` without `make`
To build or test code without using `make` some golang environment variables
must be set appropriately.
The environment variables can be printed by running either `make print-env` or
`make print-test-env`.
They can be set in 3 ways:
_Note: we need to use `eval` to interpret the commands since there are spaces in
the values of the variables so the shell can't correctly split them as
arguments._
1. Setting the variables on the same line as the `go` command (e.g., `eval $(make print-env) go build ./...`). This
affects the environment for that command invocation only.
2. Exporting the variables in the shell's environment (e.g., `eval export $(make print-env)`). The variables will
persist for the duration of that shell (and will be passed to subshells).
3. Setting the variables in the go environment (e.g., `eval go env -w $(make print-env)`). Persistently adds these
values to Go's environment for any future runs.
---
### Running
_Note: go-spacemesh relies on a gpu setup dynamic library in order to run.
`make install` puts this file in the build folder, so if you are running
spacemesh from the build folder you don't need to take any extra action.
However if you have built the binary using `go build` or moved the binary from
the build folder you need to ensure that you have the gpu setup dynamic library
(the exact name will vary based on your OS) accessible by the go-spacemesh
binary. The simplest way to do this is just copy the library file to be in the
same directory as the go-spacemesh binary. Alternatively you can modify your
system's library search paths (e.g. LD_LIBRARY_PATH) to ensure that the
library is found.
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:
```bash
./go-spacemesh --listen [a_multiaddr] --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:
```bash
./go-spacemesh --listen /ip4/0.0.0.0/tcp/7513 --config ./tn1.json -d ./sm_data
```
4. Build the [CLI Wallet](https://github.com/spacemeshos/CLIWallet) from source code and run it:
5. Use the CLI Wallet commands to setup accounts, start smeshing and execute transactions.
```bash
./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 parameters:
```bash
./go-spacemesh --listen [a_multiaddr] --config [configFileLocation] -d [nodeDataFilesPath] \
--smeshing-coinbase [coinbase_account] \
--smeshing-start --smeshing-opts-datadir [dir_for_post_data]
```
**Example:**
```bash
./go-spacemesh --listen /ip4/0.0.0.0/tcp/7513 --config ./tn1.json -d ./sm_data \
--smeshing-coinbase stest1qqqqqqp3qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqql50dsa \
--smeshing-start --smeshing-opts-datadir ./post_data
```
4. Use the CLI wallet to check your coinbase account balance and to transact
---
### Smeshing
To be able to initialize your PoST using your Graphics card you will need to install the tools necessary to enable
OpenCL support on your system. The exact steps to do this will vary based on your OS and GPU. In general you will
need to install the OpenCL runtime for your GPU and ICD loader.
A good starting point to get more info is .
If your system doesn't have a GPU or you can use a generic runtime instead. Be aware that we do not recommend this
for initialization of PoST. On Ubuntu you need to install the following packages:
```bash
apt-get update
apt-get install libpocl2
```
on Windows you can use Intel OpenAPI:
```bash
choco install opencl-intel-cpu-runtime
```
#### Using a remote machine as provider for PoST proofs
To disable the internal PoST service and disable smeshing on your node you can use the following config:
```json
"smeshing": {
"smeshing-start": false,
}
```
or use the `--smeshing-start=false` flag. Additionally rename the `local.key` in your `data/identities` folder to a
unique name for your node (e.g. `nodeA.key`). This will disable smeshing on your node causing, i.e. it will not generate
any PoST proofs until a remote post service connects. Be aware that you still need to set your coinbase via:
```json
"smeshing": {
"smeshing-coinbase": "your coinbase address",
}
```
or use the `--smeshing-coinbase` CLI parameter, otherwise your node will not be able to receive rewards.
Additionally you will have to set `grpc-post-listener` to e.g. `0.0.0.0:9094` in your `api` config to allow the remote
post service to connect to your node.
#### Merging multiple existing nodes into a single one with multiple remote PoST services
To help in the process of merging multiple nodes into a single one, you can use `merge-nodes` tool. This tool will
copy over identities and merge their local states into a single node. Ensure that all nodes are running the latest
version of `go-spacemesh` and were started at least once after upgrading. We recommend to back up the `data` directory
of the nodes you want to merge before running this tool to avoid data loss. Specifically the `local.sql` files and the
`identities` directories.
Stop the two nodes you want to merge and ensure that they have been set up for remote smeshing (i.e. `smeshing-start`
is false and `local.key` has been renamed). `src` is the node that will be merged into `dst`:
```bash
merge-nodes --src /path/to/src/data --dst /path/to/dst/data
```
This will copy over the identities from `src` to `dst` and merge the local states of both nodes. The command will tell
you if it encounters any issues merging the identities or the local states.
You can repeat this process with as many nodes as you want to merge into `dst`. After you have completed the merging
process, you can start `dst`. For every identity setup a post service to use the existing PoST data for that identity
and connect to the node. For details refer to the
[post-service README](https://github.com/spacemeshos/post-rs/blob/main/service/README.md).
#### Using a remote PoST service over insecure connections
If you want to allow connections from post services over the internet to your node, we strongly recommend not to connect
via `grpc-post-listener` but rather use the `grpc-tls-listener` configuration parameter and setup TLS for the connection.
This is useful for example if you want to run a node on a cloud provider with fewer resources and run PoST on a local
machine with more resources. The post service only needs to be online for the initial proof (i.e. when joining the
network for the first time) and during the cyclegap in every epoch.
To setup TLS-secured public connections the API config has been extended with the following options:
```json
"api": {
"grpc-tls-listener": "0.0.0.0:9094", // listen address for TLS connections
"grpc-tls-ca-cert": "/path/to/ca.pem", // CA certificate that signed the node's and the PoST service's certificates
"grpc-tls-cert": "/path/to/cert.pem", // certificate for the node
"grpc-tls-key": "/path/to/key.pem", // private key for the node
}
```
Ensure that remote PoST services are setup to connect to your node via TLS, that they trust your node's certificate and
use a certificate that is signed by the same CA as your node's certificate.
### Configuring a remote PoST service
The post service is at the moment configured exclusively via command line parameters:
- `--dir` specifies the directory containing `postdata_metadata.json` and the `postdata_xxx.bin` files; other files in
the post directory need to stay with the node!
- `--address` specifies the address the post service should connect to
- `--ca-cert`, `--cert` and `--key` specify the location of the CA certificate, the post services certificate and the
post services key respectively. For more information see below.
- `--threads`, `--nonces` and `--randomx-mode` can be adapted to optimize proof generation. They are analogous to
`smeshing-opts-proving-threads`, `smeshing-opts-proving-nonces` and `smeshing-opts-proving-randomx-mode` respectively.
- `-h` or `--help` prints a help message with all available options and more details on their usage.
### Keys and certificates
The PoST service and the node talk to each other via mTLS and have to authenticate themselves at the opposite end. For
this both need keys and certificates.
Here is a script that generates a key & certificate for a CA, a key for the client (PoST service) and a key for the
server (node). Then it uses the CAs key to generate certificates from the keys for both the client & server.
Make sure to adjust the certificate extensions & subjects for your setup accordingly.
`ca.crt` needs to be provided to both the PoST service and the node, `server.crt` & `server.key` are only needed by the
node and `client.crt` & `client.key` are only needed by the PoST service.
```bash
# create certificate extensions to allow using them for localhost
cat > server-domains.ext < client-domains.ext <