Almonte at 16:09, 19 April 2021

2021-04-19T16:09:58Z

New page

<languages />
<translate>
{{#seo:
|title=How to connect Ardor node with an IPFS node
|titlemode=replace
|keywords=IPFS, IPFS node, IPFS documentation, Ardor, Ardor node, Ardor documentation, blockchain, proof of stake, ardor, ignis, jelurida, development, ardor wiki, wiki, tutorials, advanced tutorials
|description=Detailed explanation step by step to connect IPFS to an Ardor node
}}
[[Category:Advanced_guides]]
__TOC__
== Introduction ==
This guide will show you how to connect '''IPFS node''' to '''Ardor node'''. You will also learn how to Pin files to the IPFS node, connected to the Ardor node via another IPFS node.

==== What is IPFS? ====
IPFS is a distributed system for storing and accessing files, websites, applications, and data. Refer to the IPFS [https://docs.ipfs.io official documentation] for more information.

== Installing and deploying IPFS node ==
Please refer to [https://wiki.jelurida.com/How_to_deploy_IPFS_node guide] for a detailed tutorial about how to install deploy IPFS node.

== Connecting the Ardor node to IPFS node ==
The connection between Ardor and IPFS nodes is possible via a Lightweight contract. If you are not familiar with Jelurida's Lightweight Contracts, please visit [https://wiki.jelurida.com/Lightweight_Contracts this documentation] for a detailed tutorial.

Assuming that you already have running Ardor node with enabled Contract Runner and two IPFS nodes connected to the IPFS network, the next step is to upload '''''PinToIpfs.java''''' and '''''PinFromMessage.java''''' contracts to the Ardor node. If you don't know how to deploy contracts, please visit [https://wiki.jelurida.com/Lightweight_Contracts#Contract_Deployment our tutorial] for Lightweight Contracts. After successfully uploading the contracts, you will observe the following in the Contracts menu:

[[File:Uploaded ipfs contract1.jpg|class=img-responsive|border|center]]

Your Ardor node is now connected to the IPFS node. If you are wondering which IPFS node is exactly connected, it's to the one with default IPFS settings, or you may call it the initial IPFS node (The default address of the IPFS API can be configured, please refer to the Configuring parameters section below).

Now let's see if the connection was indeed successful. Let's navigate to the Web UI of the second IPFS node,in our case that is <code>http://localhost:5002/ipfs</code> and make sure we have uploaded a file.

[[File:Ipfs uploaded file.jpg|class=img-responsive|border|center]]

The next step is to copy the CID of the uploaded file and open the Ardor app. As the name of the contract suggests, we have to issue a transaction with a message, it can be ''Send Money'', ''Send Message'', etc., as long as a message can be attached. We will simply send a message and paste the copied CID:

[[File:Send message CID.jpg|class=img-responsive|border|center]]

An important thing to remind here is that the message has to be '''''non-encrypted''''', otherwise the operation will not work.
* Wait for the transaction to be confirmed and published to the blockchain
* Open the Web UI of the initial node <code>localhost:5001/ipfs</code>
* Click on '''FILES''' on the left panel and as you already guessed, our file should be located in '''pins''' menu,
* You can open it. If you don't see the file, please refresh the page.

[[File:Ipfs pin.jpg|class=img-responsive|border|center]]

[[File:Ipfs pin1.jpg|class=img-responsive|border|center]]

== Configuring parameters ==

=== Max Pin Size ===
If you want to limit the size of the pinned files, you can do that by configuring the ''maxPinSize'' parameter.
It can be done by either adding '''''contract.PinToIpfs.param.maxPinSize=size_in_bytes''''' in ''nxt.properties'' file or editing the ''contract.uploader.json'' file and adding this code:

[[File:Max pin size.jpg|frame|none]]

As you can see, the max pin size is set to 1024 bytes.

=== IPFS API Address ===
The default IPFS API Address can be configured by changing the ''ipfsApiAddress'' parameter. It can be done by either adding <code>contract.PinToIpfs.param.ipfsApiAddress=http://127.0.0.1:5002/api/v0</code> in the <code>nxt.properties</code> file or editing the <code>contract.uploader.json</code> file and adding this code:

[[File:Api address.jpg|frame|none]]

In the example, only the ''Port'' is changed from 5001 to 5002.
</translate>

How to connect Ardor node to IPFS node - Revision history

Almonte at 16:09, 19 April 2021