Skip to content

paulhandy/iri

 
 

Repository files navigation

IOTA

This is the testnet branch of the main IRI repository, as this is a IOTA reference implementation that is utilized specifically for the testnet we have setup. It is a complete [IOTA] Node with a JSON-REST HTTP interface.

It allows to connect easily using java directly to a local or a remote [IOTA node].

  • Latest release: 1.2.0 Testnet Release
  • License: GPLv3

Purpose of this repository

Because the IOTA Testnet runs under different condtions than the main network, we have had to create a specific client just for the testnet. For one, there is no snapshot with the original holder's balances (see below for how to get tokens), and for another we have lowered the minWeightMagnitude minimum from 18 to 15. This means that doing Proof of Work in this environment is executed much faster.

The IOTA Foundation will also utilize this testnet to thoroughly review and test more experimental features (automated snapshotting and IXI for example will be tested soon). As such, you shouldn't just treat the testnet as an environment where you can roam freely without having to worry, you should also see it as a testbed, for the core team to improve the protocols, libraries and tools.

How to get started

Obviously, because this is its own, independent network, you have to go through the same process as in the main network: find neighbors. You can find neighbors in the #testnet Slack channel, or on our forum. Community members are usually very happy to help you out and get you connected. If you want to get tokens for your testcase, please just ask in one of the communication channels as well.

Reporting Issues

If you notice any issues or irregularities in this release. Please make sure to submit an issue on github.

Installing

You have two options, the preferred option is that you compile yourself. The second option is that you utilize the provided jar, which is released regularly (when new updates occur) here: Github Releases. Make sure to utilize the testnet versions!

Compiling yourself

Make sure to have Maven and Java 8 installed on your computer. When cloning the project from github, also make sure to get the testnet branch.

To compile & package

$ git clone https://github.com/iotaledger/iri -b testnet
$ mvn clean compile
$ mvn package

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

How to run IRI

Running IRI is pretty simple, and you don't even have to run it under admin rights. Below is a list of command line options. Here is an example script:

java -jar iri.jar -p 14265

Command Line Options

Option Shortened version Description Example Input
--port -p This is a mandatory option that defines the port to be used to send API commands to your node -p 14800
--neighbors -n Neighbors that you are connected with will be added via this option. -n "udp://148.148.148.148:14265 udp://[2001:db8:a0b:12f0::1]:14265"
--config -c Config INI file that can be used instead of CLI options. See more below -c iri.ini
--udp-receiver-port -u UDP receiver port -u 14800
--tcp-receiver-port -t TCP receiver port -t 14800
--testnet Makes it possible to run IRI with the IOTA testnet --testnet
--remote Remotely access your node and send API commands --remote
--remote-auth Require authentication password for accessing remotely. Requires a correct username:hashedpassword combination --remote-auth iotatoken:LL9EZFNCHZCMLJLVUBCKJSWKFEXNYRHHMYS9XQLUZRDEKUUDOCMBMRBWJEMEDDXSDPHIGQULENCRVEYMO
--remote-limit-api   Exclude certain API calls from being able to be accessed remotely --remote-limit-api "attachToTangle, addNeighbors"
--send-limit   Limit the outbound bandwidth consumption. Limit is set to mbit/s --send-limit 1.0
--max-peers     Limit the number of max accepted peers. Default is set to 0 (mutual tethering) --max-peers 8

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 = 14700
UDP_RECEIVER_PORT = 14700
NEIGHBORS = udp://my.favorite.com:15600
IXI_DIR = ixi
HEADLESS = true
DEBUG = true
TESTNET = true
DB_PATH = db

About

IOTA Reference Implementation

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%