Skip to main content

Node Configuration

You can configure your node/s using the config.json configuration file. If you plan to run several nodes in the same host, you will need to adjust the port configuration.

Hornet

Wasp requires a Hornet node to communicate with the L1 Tangle.

You can use any publicly available node, or set up your own node, or create a private tangle.

Hornet Connection Settings

l1.inxAddress specifies the Hornet INX address (default port: 9029)

Authentication

By default, Wasp accepts any API request coming from 127.0.0.1. The Dashboard uses basic auth to limit access.

Both authentication methods have 'root' permissions and would allow any request.

You can disable the authentication per endpoint by setting scheme to none on any auth block such as webapi.auth or dashboard.auth . Example configuration .

The following schemes are supported:

  • none
  • ip
  • basic
  • jwt

JWT

A new authentication scheme JWT was introduced but should be treated as experimental.

With this addition, the configuration was slightly modified, and a new plugin users was introduced.

Both the basic and JWT authentication pull their valid users from the users plugin.

Furthermore, the API and the Dashboard can use one of the three authentication schemes independently.

Users are currently stored inside the configuration (under users), and the passwords are saved as clear text for the time being.

The default configuration contains one user "wasp" with API and Dashboard permissions.

While the basic authentication only validates username and password, the JWT authentication validates permissions additionally.

To enable the JWT authentication change webapi.auth.scheme and/or dashboard.auth.scheme to jwt.

If you have enabled JWT for the webapi, you need to call wasp-cli login before making any requests.

One login has a duration of exactly 24 hours by default. You can change this setting in the configuration at ( webapi/dashboard).auth.jwt.durationHours

Peering

Wasp nodes connect to other Wasp peers to form committees. There is exactly one TCP connection between two Wasp nodes participating in the same committee. Each node uses the peering.port setting to specify the port used for peering.

peering.netid must have the form host:port, with a port value equal to peering.port, and where host must resolve to the machine where the node is running and be reachable by other nodes in the committee. Each node in a committee must have a unique netid.

Publisher

nanomsg.port specifies the port for the Nanomsg event publisher. Wasp nodes publish important events in smart contracts, such as state transitions, incoming and processed requests, etc. Any Nanomsg client can subscribe to these messages.

More Information on Wasp and Nanomsg

Each Wasp node publishes important events via a Nanomsg message stream (just like ZMQ is used in IRI). In the future, Wasp will possibly support ZMQ and MQTT publishers too.

Any Nanomsg client can subscribe to the message stream. In Go, you can use the packages/subscribe package provided in Wasp for this.

You can configure the Publisher port in the config.json file using the nanomsg.port setting.

The Message format is simply a string consisting of a space-separated list of tokens; the first token is the message type. Below is a list of all message types published by Wasp (you can search for publisher.Publish in the code to see the exact places where each message is published).

MessageFormat
Chain record has been saved in the registrychainrec <chain ID> <color>
Chain committee has been activatedactive_committee <chain ID>
Chain committee dismisseddismissed_committee <chain ID>
A new SC request reached the noderequest_in <chain ID> <request tx ID> <request block index>
SC request has been processed (i.e. corresponding state update was confirmed)request_out <chain ID> <request tx ID> <request block index> <state index> <seq number in the block> <block size>
State transition (new state has been committed to DB)state <chain ID> <state index> <block size> <state tx ID> <state hash> <timestamp>
Event generated by a SCvmmsg <chain ID> <contract hname> ...

Web API

webapi.bindAddress specifies the bind address/port for the Web API used by wasp-cli and other clients to interact with the Wasp node.

Dashboard

dashboard.bindAddress specifies the bind address/port for the node dashboard, which can be accessed with a web browser.

Prometheus

prometheus.bindAddress specifies the bind address/port for the prometheus server, where it's possible to get multiple system metrics.

By default, Prometheus is disabled. You can enable it by setting prometheus.enabled to true.

Grafana

Grafana provides a dashboard to visualize system metrics. It can use the prometheus metrics as a data source.