goshimmer

command module
Version: v0.7.4 Latest Latest
Warning

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

Go to latest
Published: Jul 8, 2021 License: Apache-2.0, BSD-2-Clause Imports: 5 Imported by: 0

README


Prototype node software for an IOTA network without the Coordinator

Developer documentation portal

Discord StackExchange Apache 2.0 license Go version Latest release

AboutDesignGetting startedClient-Library and HTTP API referenceSupporting the projectJoining the discussion


About

This repository, called GoShimmer, is where the IOTA Foundation's Research Department tests the IOTA 2.0 modules to study and evaluate their performance.

GoShimmer is first and foremost a research prototype. As such, breaking changes can often happen. We invite researchers and developers to make use of this project as you see fit. Running experiments, test out new ideas, build PoC are all very welcome initiatives.

For a documentation, including tutorials and resources, we refer to the Documentation (Github link).

Design

The code in GoShimmer is modular, where each module represents either one of the IOTA 2.0 components, or a basic node function such as the gossip, ledger state, and API - just to mention a few.

Layers

GoShimmer's modularity is based on a combination of event-driven and layer-based approaches.

Client-Library and HTTP API reference

You can use the Go client-library to interact with GoShimmer (located under github.com/iotaledger/goshimmer/client).

You can find more info about this on our client-lib and Web API documentation.

Getting started

You can find tutorials on how to setup a GoShimmer node, writing a dApp, obtaining tokens from the faucet and more in the GoShimmer documentation.

Compiling from source

We always recommend running your node via Docker. However, you can also compile the source and run the node from the compiled binary. GoShimmer uses RocksDB as its underlying db engine. That requires a few dependencies before building the project:

  • librocksdb
  • libsnappy
  • libz
  • liblz4
  • libzstd

Please follow this guide: https://github.com/facebook/rocksdb/blob/master/INSTALL.md to build above libs.

When compiling GoShimmer, just run the build script:

./scripts/build.sh

If you also want to link the libraries statically (only on Linux) run this instead:

./scripts/build_goshimmer_rocksdb_builtin.sh

Finally, download the latest snapshot and make sure to place it in the root folder of GoShimmer:

wget -O snapshot.bin https://dbfiles-goshimmer.s3.eu-central-1.amazonaws.com/snapshots/nectar/snapshot-latest.bin

Supporting the project

If you want to contribute to the code, consider posting a bug report, feature request or a pull request.

When creating a pull request, we recommend that you do the following:

  1. Clone the repository
  2. Create a new branch for your fix or feature. For example, git checkout -b fix/my-fix or git checkout -b feat/my-feature.
  3. Run the go fmt command to make sure your code is well formatted
  4. Document any exported packages
  5. Target your pull request to be merged with dev

Joining the discussion

If you want to get involved in the community, need help getting started, have any issues related to the repository or just want to discuss blockchain, distributed ledgers, and IoT with other people, feel free to join our Discord.

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
Package client implements a very simple wrapper for GoShimmer's web API.
Package client implements a very simple wrapper for GoShimmer's web API.
packages
ledgerstate/utxodb
Package utxodb mocks Value Tangle ledger by implementing fully synchronous in-memory database of GoShimmer value transactions.
Package utxodb mocks Value Tangle ledger by implementing fully synchronous in-memory database of GoShimmer value transactions.
ledgerstate/utxoutil
Package utxoutil is used to build value transaction Package utxoutil contains number of utility functions useful while manipulating outputs and constructing transactions.
Package utxoutil is used to build value transaction Package utxoutil contains number of utility functions useful while manipulating outputs and constructing transactions.
pow
txstream/chopper
Package chopper helps splitting messages into smaller pieces and reassemble them
Package chopper helps splitting messages into smaller pieces and reassemble them
cli
database
Package database is a plugin that manages the RocksDB database (e.g.
Package database is a plugin that manages the RocksDB database (e.g.
pow
remotelog
Package remotelog is a plugin that enables log messages being sent via UDP to a central ELK stack for debugging.
Package remotelog is a plugin that enables log messages being sent via UDP to a central ELK stack for debugging.
remotelogmetrics
Package remotelogmetrics is a plugin that enables log metrics too complex for Prometheus, but still interesting in terms of analysis and debugging.
Package remotelogmetrics is a plugin that enables log metrics too complex for Prometheus, but still interesting in terms of analysis and debugging.
tools

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL