Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 4.78 KB

README.md

File metadata and controls

108 lines (73 loc) · 4.78 KB
Raw


The official node software that runs on the IOTA Mainnet and Devnet

Developer documentation portal

Discord StackExchange GPL-3.0 license Build status

About ◈ Prerequisites ◈ Installation ◈ Getting started ◈ API reference ◈ Supporting the project ◈ Joining the discussion

About

The IRI (IOTA reference implementation) is open-source Java software that runs on the IOTA Mainnet as well as the Devnet. This software defines the current IOTA protocol, which allows nodes to do the following:

  • Validate transactions
  • Store valid transactions in a ledger
  • Allow clients to interact with the them through a an HTTP API

This is beta software, so there may be performance and stability issues. Please report any issues in our issue tracker.

Prerequisites

To run IRI, you need the following:

  • 4GB RAM
  • 64-bit processor
  • A public IP address that's either static or connected to a dynamic DNS service such as duckdns.org
  • Java
  • Maven
  • Ports 15600 and 14265 must be open

Installation

You can do one of the following:

  • Download the pre-built Java file
  • Compile the Java file yourself

Or, if you use Docker, you can run the pre-built Docker image

Downloading the pre-built Java file

After every release, we upload a pre-built Java file onto the GitHub Releases page.

You can simply download the latest .jar file.

Compiling the Java file

To compile the Java file yourself, do the following on a Linux operating system:

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

Your .jar file is in the target directory.

Getting started

For instructions on running IRI, see the documentation portal.

API reference

For an API reference, see the documentation portal.

Supporting the project

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

Please read the following before contributing:

Joining the discussion

If you want to get involved in the community, need help with getting set up, have any issues related to IRI, or just want to discuss IOTA, Distributed Registry Technology (DRT) and IoT with other people, feel free to join our Discord.

Special thanks

alt text

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.