This runnable program provides a user-interface to perform basic interactions with the Qubic Lite protocol. Create qubics, run oracles, read quorum based results etc.

Simply download the newest .jar file from the releases and put it into your favorite folder/directory. After that you can simply run the jar to start your ql-node.

You will need the JDK and Maven. A guide on how to do that on Windows or Ubuntu can be found in this section.

In the following sections we will use git to clone the repositories. But you can also download them manually or via wget.

cd /path/to/your/favourite/directory/
git clone https://github.com/iotaledger/iota.lib.java
cd iota.lib.java/
mvn install

cd /path/to/your/favourite/directory/
git clone https://github.com/qubiclite/qlite.lib.java
cd qlite.lib.java/  
mvn versions:use-latest-versions -DallowSnapshots=true -DexcludeReactor=false
mvn install

cd /path/to/your/favourite/directory/
git clone https://github.com/qubiclite/qlri
cd qlri/
mvn versions:use-latest-versions -DallowSnapshots=true -DexcludeReactor=false
mvn install

If everything went successfully, you should now find a runnable jar file called qlri-[VERSION].jar in the qlri/ directory.

Build a docker image with "qubiclite/qlri:latest" tag

docker build -t qubiclite/qlri:latest .  

Run the docker image

docker run -it -p 17733:17733  qubiclite/qlri

Open http://localhost:17733/index.html in your browser.

To run the jar file use this command (you will need the JRE or JDK):

java -jar qlri-[VERSION].jar

To make things much more intuitive, it is highly suggest to start the .jar with the -api parameter:

java -jar qlri-[VERSION].jar -api

This will start Qlite Web (a web gui, see screenshots) that you can access in your browser by visiting http://[YOUR IP]:17733/index.html. Additionally you can use -u username:password to protect your API from unauthorized access:

java -jar qlri-[VERSION].jar -api -u user:pass

You can pass certain paramters with that line

¹ … default value if you do not pass the respective parameter to your jar file. ² … https://nodes.testnet.iota.org:443

This will create a new qubic starting in 180 seconds. Write the ql code into a seperate file. The path can either be relative to the .jar file (as in the example) or absolute. Type ? qc if you want to find out what the other parameters mean.

$ qc 180 30 30 10 ../my_qubic.ql

Now go tell your friends about your awesome qubic, so they can create a new oracle to process it. Make sure to tell them your qubic's ID. Assuming is is "OCLL…", your friends can now create a new oracle just for your qubic:

$ oc OCLLCVOXXHIDWHCOCIDMUHNTWOHKVI9QUBYIWRM9EFSNBCBUFWCV9GPHNGMGDZV9MJFYLYTULMBSIX999

The assembly period is about to end so you want to publish your assembly transaction. To do this, you can first check which oracles have applied to your qubic:

$ qla OCL

After that, you can select a few and individually add them to the assembly like this:

$ qaa OCL HMSCIRTQEM9GMRENWOXEJYXARGZNUTLFBTSORUSFU9LYTOLTGGYJXCYAJYGEDTDZVUXRUTPMPSWDWO999

After you have added all, you can finally publish the assembly transaction to complete your qubic:

$ qa OCL

NOTE: The assembly transaction has to be published before the 180 seconds you set with qc are over (otherwise the oracles will abort your qubic)!

For specific information to a command (parameter details + example use), use help [command].

• official project website: http://qubiclite.org
• qApp catalog: http://qame.org