iotaledger/iri repository overview

⁠IOTA

The IRI repository is the main IOTA Reference Implementation and the embodiment of the IOTA network specification.

This is a full-featured [IOTA]⁠ node with a convenient JSON-REST HTTP interface. It allows users to become part of the [IOTA]⁠ network as both a transaction relay and network information provider through the easy-to-use [API]⁠.

It is specially designed for users seeking a fast, efficient and fully-compatible network setup.

Running an IRI node also allows light wallet users a node to directly connect to for their own wallet transactions.

-* License: GPLv3

⁠How to get started

The IOTA network is an independent peer-to-peer network with a first-user, friend-to-friend, network structure:

• As a 'first-user' network, to access the data streams and APIs that other users provide, you must first exchange your IP and port configuration with a current user.

• As a 'friend-to-friend' network, you have the privilege of joining new users into the network through your node by adding them to your approved neighbors list — ensuring that you both broadcast to them and also receive their broadcasts.

You can find neighbors on the #nodesharing channel of our [Discord server]⁠.

Everyone will be welcoming and very happy to help you get connected. If you want to get tokens for your testcase, please just ask in one of the communication channels.

⁠Reporting Issues

If you'd like to contribute to IRI, report bugs, problems or irregularities with this release, please see CONTRIBUTING.md⁠ for guidelines.

⁠Documentation

This page contains basic instructions for setting up an IRI node. You can find the full documentation on:

• Our documentation website⁠
• IRI API reference⁠

You can also use one of these great community guides:

• IOTA Partners guide⁠
• IRI Playbook⁠

⁠Installing

The preferred option is that you compile yourself. The second option is that you utilize the provided jar, which is released whenever there is a new update here: Github Releases⁠.

⁠Compiling yourself

Make sure to have Maven and Java 8 installed on your computer.

⁠To compile & package

$ git clone https://github.com/iotaledger/iri
$ cd iri
$ mvn clean compile
$ mvn package

This will create a target directory in which you will find the executable jar file that you can use.

⁠How to run IRI

⁠Locally

Running IRI is quick and easy, and you can usually run it without admin rights. Below is a list of command line options.

At a minimum, the port must be specified on the command-line — e.g., '-p 14265' or in the iota.ini file — e.g., 'PORT = 14265'.

If the 'iota.ini' file exists, it will be read. The port and all the command line options below take precedence over values specified in the ini config file.

Here is an example script that specifies only the port, with all other settings to be read from the ini file if it exists:

java -jar iri.jar -p 14265

⁠Docker

Create an iota.ini file with all of your configuration variables set in it. Any that you don't provide in here will be assumed to be default or taken from command line arguments.

docker run -d --net=host --name iota-node -v iota.ini:/iri/iota.ini iotaledger/iri:latest

⁠Command Line Options

⁠INI File

You can also provide an ini file to store all of your command line options and easily update (especially neighbors) if needed. You can enable it via the --config flag. Here is an example INI file:

[IRI]
PORT = 14265
UDP_RECEIVER_PORT = 14600
NEIGHBORS = udp://my.favorite.com:14600
IXI_DIR = ixi
DEBUG = false
DB_PATH = db

⁠Special Thanks To

YourKit supports open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of YourKit Java Profiler⁠ and YourKit .NET Profiler⁠, innovative and intelligent tools for profiling Java and .NET applications.