Need help with goshimmer?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

iotaledger
210 Stars 49 Forks Apache License 2.0 1.2K Commits 55 Opened issues

Description

GoShimmer implementation of Coordicide

Services available

!
?

Need anything else?

Contributors list


Prototype node software for an IOTA network without the Coordinator

Developer documentation portal

Discord StackExchange Apache 2.0 license Go version Build status Latest release

AboutDesignImplemented Coordicide modulesWork-in-progress modulesGetting startedClient-Library and HTTP API referenceSupporting the projectJoining the discussion


About

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

The aim of this open repository is to give the community the opportunity to follow developments, take part in testing, and learn more about Coordicide.

Note: You can find details about future development plans on our roadmap.

Design

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

Layers

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

Each module is defined in the

packages
directory, with the exceptions for the dApps (e.g., value transfer, network delay and the faucet) that are under the
dapps
folder. Each module can be enabled using the
plugins
directory.

Note: See the

main.go
file to see which plugins are currently supported.

Implemented Coordicide modules

The

master
branch is the stable version of the GoShimmer software, which includes a minimal set of modules to allow you to send and gossip the following types of object:
  • Generic data object, and more in general, any non-value transfer can be supported with its own dApp/App.
  • Value objects to issue transactions.
  • Faucet funding request objects.

The

master
branch includes the following Coordicide modules:

Work-in-progress modules

Work-in-progress modules are typically kept on a different branch such as

mana
, and are not compatible with the
master
branch. Therefore, nodes that run these branches cannot join the current network because the code either is still too experimental or it includes breaking changes. The same goes for the
develop
branch.

The following Coordicide modules are a work in progress:

  • Mana: The

    mana
    branch contains a first implementation of the mana module in the
    packages
    directory.
  • Cellular Consensus: The

    ca
    branch contains a first implementation of the Cellular Consensus module in the
    packages
    directory.
  • Spam Protection: You can find the initial simulation source code of the rate control in this repository and the source code of the Adaptive Proof of Work simulator here.

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 wiki page.

Getting started

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

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.