Skip to main content

Storage Node - CLI


Overview​

How to interact with CLI​

The Command-Line Interface (CLI) allows users to interact with a system or application by issuing text-based commands. This interaction enables users to execute specific tasks, view system information, or modify settings, with the system providing feedback in the form of text-based responses.

To use CLI, open Terminal (Linux/Mac) or Command Prompt (Windows) and paste in the commands from the instructions on this page.


System Requirements​

Minimum System Requirements:​

  • Storage Capacity: 900 GB
  • Upload Speed: 20 Mbps or 2.5 MB/s
  • Download Speed: 20 Mbps or 2.5 MB/s
  • Read Speed: 20 Mbps or 2.5 MB/s
  • Write Speed: 20 Mbps or 2.5 MB/s
  • Uptime Percent: 90%
  • Storage Used: no minimum set, depends upon the usage
  • Demand percent: no minimum set, depends upon demand

IAG Stake Required​

Following the setup of your device as a node, the network requires storage providers to demonstrate their commitment to the network and stake a balance of IAG tokens that is proportionate to the storage they wish to provide. The number of tokens required is dynamic and changes based on the current value of IAG tokens and how much storage a user wishes to provide. The calculation is as follows:

Current Base USD Staked per GB: 0.5
Initially set at $0.5 per gigabyte (GB) committed. Represents the minimum staking requirement in USD for each GB of storage.

Current Alpha Coefficient: 0.9
Determines how sensitive the staking requirement is to the IAG token price. Subject to adjustment based on market research.

Formula:

IAG to be staked = Storage (in GBs) * (Base USD Staked per GB + Alpha * (Base USD Staked per GB / IAG Value))
note

IAG stake cannot be withdrawn until the node is retired and a 3 month retirement period has passed.


Installation and Setup​

Windows CLI​

  1. Click here to download the latest release or download the .exe application from this link:
https://github.com/Iagonorg/mainnet-node-cli/releases/latest
  1. Execute the application from Command Prompt with the following command:
iag-cli-windows.exe start
info

To call the file by its correct directory, you can drag the file into the Command Prompt window then add start after the file path, outside of any quotation marks that may have been added.

  1. Follow the on-screen instructions to complete the installation process. Once the installation is complete, Iagon Node is running. You can confirm the process is running by searching for iag-cli-windows.exe on the Details tab of the Task Manager application; or by running the following command:
iag-cli-windows.exe get:status

Linux CLI​

  1. Open a terminal window, call the directory where you'd like to store the node application file:
cd /home/User/
  1. Run the following command to download the latest version of the Linux CLI node:
wget https://github.com/Iagonorg/mainnet-node-CLI/releases/latest/download/iag-cli-linux
  1. Run the following command to make the file executable:
chmod +rwx ./iag-cli-linux
  1. Run the start command to start the node and begin the setup:
./iag-cli-linux start
  1. Follow the prompts in the CLI to complete the setup process. Once the setup is complete, Iagon Node is running. You can confirm the process is running by running the following command:
iag-cli-linux get:status

MacOS CLI​

  1. Click here to download the latest release or download the iag-cli-macos application from this link:
https://github.com/Iagonorg/mainnet-node-cli/releases/latest

OR

  • Open a terminal window, call the directory where you'd like to store the node application file:
cd /Users/your_username
  • Run the following command to download the latest version of the MacOS CLI node:
wget https://github.com/Iagonorg/mainnet-node-CLI/releases/latest/download/iag-cli-macos
  1. Run the following command to make the file executable:
chmod +rwx ./iag-cli-macos
  1. Run the start command to start the node and begin the setup:
./iag-cli-macos start
  1. Follow the prompts in the CLI to complete the setup process. Once the setup is complete, Iagon Node is running. You can confirm the process is running by running the following command:
iag-cli-macos get:status

FreeBSD CLI​

  1. Open a terminal window, call the directory where you'd like to store the node application file:
cd /home/User/
  1. Run the following command to download the latest version of the Linux CLI node:
wget https://github.com/Iagonorg/mainnet-node-CLI/releases/latest/download/iag-cli-freebsd
  1. Run the following command to make the file executable:
chmod +rwx ./iag-cli-freebsd
  1. Run the start command to start the node and begin the setup:
./iag-cli-freebsd start
  1. Follow the prompts in the CLI to complete the setup process.
  • Specify the port for the Node to operate. The default port is randomly generated. Optionally, users may choose an available alternative port.
  • Choose a file path for Iagon Node CLI to store files. Ensure that the selected path has adequate free storage space and hit Evaluate.
  • Enter the storage size in GB that you want to provide.
  • After all the configuration is setup, you will receive an authorization key. Take note of this authorization key as you will need it to register the node.
  • Once the setup is complete, Iagon Node is running. You can confirm the process is running by running the following command:
iag-cli-freebsd get:status



Node Registration​

Step 1: Log into app.iagon.com with your Cardano wallet

Step 2: Navigate to the ‘Nodes’ section on the right side of your screen

Step 3: Navigate to 'Storage Nodes' on the left side of the Nodes page

Step 4: Click 'Add Node +'

  • Enter the authorization key from your node
  • Wait for the node to be evaluated
  • After the evaluation summary, you can name your node, upload a logo image, and specify your storage commitment
  • Stake the amount of IAG calculated based on your storage commitment size
info

You may resize your node and stake more IAG any time.


Advanced Features​

Command list - Windows​

Start Node Evaluation:​

This command is used to evaluate the node or start the node if it has already been evaluated.

./iag-cli-windows.exe start

Stop Node:​

Use this command to stop your node if it is already running.

./iag-cli-windows.exe stop

Regenerate Authorization Key:​

Regenerate the authorization key for your node.

./iag-cli-windows.exe key:regenerate

Get Node Information:​

Retrieve information about your node.

./iag-cli-windows.exe get:info

Check Node Status:​

Check the status of your node.

./iag-cli-windows.exe get:status

Get Node Verification Status:​

Obtain the verification status of your node.

./iag-cli-windows.exe get:verification

Display Command Help:​

Display help for commands.

./iag-cli-windows.exe help

Command list - Linux​

Start Node Evaluation:​

This command is used to evaluate the node; or start the node if it has already been evaluated.

./iag-cli-linux start

Stop Node:​

Use this command to stop your node if it is already running.

./iag-cli-linux stop

Regenerate Authorization Key:​

Regenerate the authorization key for your node.

./iag-cli-linux key:regenerate

Get Node Information:​

Retrieve information about your node.

./iag-cli-linux get:info

Check Node Status:​

Check the status of your node.

./iag-cli-linux get:status

Get Node Verification Status:​

Obtain the verification status of your node.

./iag-cli-linux get:verification

Display Command Help:​

Display help for commands.

./iag-cli-linux help

Command list - MacOS​

Start Node Evaluation:​

This command is used to evaluate the node; or start the node if it has already been evaluated.

./iag-cli-macos start

Stop Node:​

Use this command to stop your node if it is already running.

./iag-cli-macos stop

Regenerate Authorization Key:​

Regenerate the authorization key for your node.

./iag-cli-macos key:regenerate

Get Node Information:​

Retrieve information about your node.

./iag-cli-macos get:info

Check Node Status:​

Check the status of your node.

./iag-cli-macos get:status

Get Node Verification Status:​

Obtain the verification status of your node.

./iag-cli-macos get:verification

Display Command Help:​

Display help for commands.

./iag-cli-macos help

Command list - FreeBSD​

Start Node Evaluation:​

This command is used to evaluate the node or start the node if it has already been evaluated.

./iag-cli-freebsd start

Stop Node:​

Use this command to stop your node if it is already running.

./iag-cli-freebsd stop

Regenerate Authorization Key:​

Regenerate the authorization key for your node.

./iag-cli-freebsd key:regenerate

Get Node Information:​

Retrieve information about your node.

./iag-cli-freebsd get:info

Check Node Status:​

Check the status of your node.

./iag-cli-freebsd get:status

Get Node Verification Status:​

Obtain the verification status of your node.

./iag-cli-freebsd get:verification

Display Command Help:​

Display help for commands.

./iag-cli-freebsd help

Monitoring Your Node​

View Your Node Analytics​

The ‘Node’ section of the Iagon web app serves as a dashboard through which you can manage your nodes, monitor their performance and track your rewards for contributing to the network.

You can view your node info and stats history by navigating to 'Node Details' on the Node dashboard.

Your node's performance is calculated using a range of 0% - 100% based on the performance calculation.

View Fees and Rewards​

You will be able to view fees and rewards accumulated in the Node dashboard.

Claim Fees and Rewards​

You can claim fees every month for the provided storage according to the calculation. IAG staking rewards for epoch n are calculated at n+1 epoch but distributed at epoch n+73 epoch. Rewards can be claimed as they are available.

Change Authorization Key​

If you forget your node's authorization key and haven't yet registered the node or staked IAG, you will be able to generate a new authorization key from CLI command.

Windows​

./iag-cli-windows.exe key:generate

Linux​

./iag-cli-linux key:generate

MacOS​

./iag-cli-macos key:generate

FreeBSD​

./iag-cli-freebsd key:generate

Content