Skip to main content

Welcome to the Wasp

Wasp is a node software developed by the IOTA Foundation to run the IOTA Smart Contract Protocol (ISCP in short) on top of the IOTA Tangle. Please find here a high level introduction into ISCP.

A smart contract is a distributed software agent that stores its state in the UTXO ledger, and evolves with each request sent to the contract. Since the UTXO ledger is immutable, by extension the smart contract state is also immutable.

A committee of an arbitrary number of Wasp nodes runs a chain of smart contracts. The main purpose of the committee is to ensure consistent transition from the previous state to the next, according to the attached program. This ensures that the operation of smart contracts is distributed, fault-tolerant and leaderless.

The articles below explain how to run a Wasp node on the Pollen network, as well as concepts and architecture of ISCP and Wasp.

Disclaimer: Wasp node and articles is a work in progress, and most likely will always be. The software presented in this repository is not ready for use in commercial settings or whenever processing of critical data is involved.

Prerequisites#

  • Go 1.15
  • Access to a GoShimmer node for production operation

Note: The Wasp node requires the Goshimmer node to have the TXStream plugin enabled. Being an experimental plugin, it is currently disabled by default and can be enabled via configuration.

Microsoft Windows Installation Errors#

If the go install command is telling you it cannot find gcc you will need to install MinGW-w64. When you do make sure to select x86_64 architecture instead of the preselected i686 architecture. After installation make sure to add this folder to your PATH variable:

C:\Program Files\mingw-w64\x86_64-8.1.0-posix-seh-rt_v6-rev0\mingw64\bin

Compile#

  • Build the wasp binary (Wasp node): go build -tags rocksdb
  • Build the wasp-cli binary (CLI client): go build -tags rocksdb ./tools/wasp-cli

Alternatively, build and install everything with go install -tags rocksdb ./...

On Windows you will need to use go install -tags rocksdb -buildmode=exe ./... instead

Test#

  • Run all tests (including integration tests which may take several minutes): go test -tags rocksdb -timeout 20m ./...
  • Run only unit tests: go test -tags rocksdb -short ./...

Note: integration tests require the wasp and wasp-cli commands in the system path (i.e. you need to run go install ./... before running tests).

Run#

Learn#

Tools#

  • wasp-cli: A CLI client for the Wasp node.
  • wasp-cluster: allows to easily run a network of Wasp nodes, for testing.