Etherless-cli

Module through which users can interact with the Etherless platform.

Installation

Open a terminal and run the command npm i @roundabout-team/etherless-cli -g (Depending on your OS, administrator privileges may be required)

Settings

Change Ethereum network used

To change the Ethereum network used by the cli, open the .env file and modify the NETWORK field.

Update the contract of Etherless-smart module

If the contract of Etherless-smart module change, to update the CLI you have to:

• Update the abi file inside the contracts directory
• If the address of the smart contract has changed, update the field SMART_ADDRESS inside .env file

Commands

To use a command from inside the repository run: etherless <command> [params...]

Init

Command: etherless init
The init command shows a brief introduction to the Etherless-cli module.

Signup

Command: etherless signup [--save]
Will create an Ethereum account for you, and show its: address, private key and mnemonic phrase. You can request to save these informations inside a file of the current directory with the flag --save.

Login

Login with private key

Command: etherless login <private_key>
It will log the user in an Ethereum wallet with the private key inserted.
A password to encrypt the wallet will be requested after executing this command.

Login with mnemonic phrase

Command: etherless login -m <mnemonic_phrase>
It will log the user in an Ethereum wallet with the mnemonich phrase you inserted.
A password to encrypt the wallet will be requested after executing this command.

Logout

Command: etherless logout
After executing this command all the saved credentials will be deleted.

List

List all functions

Command: etherless list
After executing this command a list of all functions available in the platform will be shown.

List owned functions

Command: etherless list -m
After executing this command a list of all functions owned by the current user will be shown.

Info

Command: etherless info <function_name>
After executing this command, all details about the functioin will be shown.

Run

Command: etherless run <function_name> [params...]
After executing this command, the function result will be shown.

Deploy

Command: etherless deploy <function_name> <source_path> <description>
After executing this command a success or error message will be shown. The "source_path" parameter can be:

• a directory, if your function has dependencies. The directory must contain the following files: index.js, package.json and package_lock.json
• a javascript file, if your function has no dependencies

Delete

Command: etherless delete <function_name>
After executing this command the considered function will be deleted

History

Command: etherless history [--limit]
Following the execution of this command, a list of the user's past execution requests will be shown, with the relative results. The limit parameter indicates the maximum number of elements in this list.

Search

Command: etherless search <keyword>
A list of all functions containing the "keyword" parameter inside their name will be shown.

Whoami

Command: etherless whoami
If there is a user logged inside the Etherless-cli module, his address will be shown.