Skip to main content

CLI Overview

The Findora SDK contains a CLI commands tool which enables developers to quickly perform frequently used actions using a single comand syntax.

Installing and Configuring the Findora SDK

To install the Findora SDK CLI, clone its Github repo and install its dependencies.

First, run the command below in your terminal to download the repo:

git clone https://github.com/FindoraNetwork/findora-sdk.git

Next, change the directory to the cloned version of the `Findora SDK:

cd findora-sdk

Then, install all SDK dependencies:

yarn

Finally, check if the CLI tool is installed correctly by running:

yarn cli

If installed correctly, you will see:

 ~/t/t/findora-sdk $ yarn cli
yarn run v1.22.11
$ yarn cli:build && yarn cli:run "$npm_config"
$ tsc
$ nodemon dist/cli.js --ignore cache/ "$npm_config" ''
[nodemon] 2.0.15
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: js,mjs,json
[nodemon] starting `node dist/cli.js "" ""`
"2021-12-14, 11:36:39 a.m." - please run as "yarn cli fund --address=fraXXX --amountToFund=1 "
"2021-12-14, 11:36:39 a.m." - please run as "yarn cli createWallet"
"2021-12-14, 11:36:39 a.m." - please run as "yarn cli restoreWallet --mnemonicString='XXX ... ... XXX'"
[nodemon] clean exit - waiting for changes before restart

CLI Commands

1. View All Findora SDK CLI Commands (and Options)

To see a list of all commands (and usage instructions), run the following terminal command:

yarn cli

In the output you will see a list of all available CLI commands and related options:

"2021-12-08, 12:07:09 p.m." - please run as "yarn cli fund --address=fraXXX --amountToFund=1 "
"2021-12-08, 12:07:09 p.m." - please run as "yarn cli createWallet"
"2021-12-08, 12:07:09 p.m." - please run as "yarn cli restoreWallet --mnemonicString='XXX ... ... XXX'"

As you can see, at the moment there are three available commands:

  • fund
  • createWallet
  • runRestoreWallet

2. "Fund" Command

By running yarn cli fund --address=fraXXX --amountToFund=1 you would fund an address fraXXX with the amount of 1 FRA.

Please note, the source of funding is another account (whose private key your control) and must have some funds in it. Like your own faucet.

This account would be restored from the private key, which needs to be provided in the .env file, using following format:

PKEY_LOCAL_FAUCET="XAsFsKosjY8J=XXXXXXXXXX";

So, prior to running this command, you would need to create a .env file and put the above information in there. After that, you would be able to perform a quick, one line command to send FRA to other addresses (to fund them).

2. "createWallet" command

In case of a need to quickly create a new wallet, you can use yarn cli createWallet command to create a new wallet, as well as to get its mnemonic, address, private and public keys.

This information would be displayed as a command output (similar to the below):

[nodemon] starting `node dist/cli.js "" "" createWallet`
"2021-12-08, 12:22:06 p.m." - 🚀 ~ new mnemonic: "output insect settle weather spray lava seven day rice swamp captain upgrade layer ocean century kitten feel crunch fly huge power divert amused fitness"
"2021-12-08, 12:22:06 p.m." - 🚀 ~ new wallet info: [
{
keyStore: Uint8Array(104) [
16, 51, 89, 254, 22, 53, 133, 79, 253, 182, 55, 161,
213, 15, 157, 231, 66, 7, 255, 188, 8, 122, 16, 124,
223, 86, 162, 198, 211, 51, 251, 14, 2, 140, 195, 238,
235, 184, 250, 169, 162, 97, 217, 99, 62, 117, 61, 57,
75, 167, 208, 16, 100, 199, 215, 147, 166, 40, 81, 6,
180, 194, 114, 10, 180, 77, 159, 65, 60, 254, 166, 212,
92, 246, 202, 137, 255, 243, 236, 127, 123, 228, 95, 23,
65, 224, 6, 208, 104, 131, 156, 76, 255, 201, 90, 92,
48, 147, 144, 222,
... 4 more items
],
publickey: 'C_0GxCvI8OBYZRO9mNZOhh8MykvOrOLx7F7U-ug8vUM=',
address: 'fra1p07sd3ptercwqkr9zw7e34jwsc0sejjte6kw9u0vtm2046puh4pszj0rs4',
keypair: XfrKeyPair { ptr: 2425208 },
privateStr: 'epG6XtjssaZdyCyRwijTQM92ptqyScZRtMz1lpRC-O8='
}
]

The output shows your new mnemonic (see below):

output insect settle weather spray lava seven day rice swamp captain upgrade layer ocean century kitten feel crunch fly huge power divert amused fitness

As well as, the address and both keys (see below):

    publickey: 'C_0GxCvI8OBYZRO9mNZOhh8MykvOrOLx7F7U-ug8vUM='
address: 'fra1p07sd3ptercwqkr9zw7e34jwsc0sejjte6kw9u0vtm2046puh4pszj0rs4'
privateStr: 'epG6XtjssaZdyCyRwijTQM92ptqyScZRtMz1lpRC-O8='

Store these values for later use.

3. "restoreWallet" Command

To restore a previously created wallet, (for example to use it as a sender, or to check its private key), run yarn restoreWallet --mnemonicString='XX XXXX" and provide a valid mnemonic string.

For example, to restore the wallet created in the previous example above, run the following:

yarn restoreWallet --mnemonicString="output insect settle weather spray lava seven day rice swamp captain upgrade layer ocean century kitten feel crunch fly huge power divert amused fitness"

This command's output appears below:

[nodemon] starting `node dist/cli.js "" "" restoreWallet "--mnemonicString=output insect settle weather spray lava seven day rice swamp captain upgrade layer ocean century kitten feel crunch fly huge power divert amused fitness"`
"2021-12-08, 12:29:45 p.m." - 🚀 ~ mnemonic to be used: "output insect settle weather spray lava seven day rice swamp captain upgrade layer ocean century kitten feel crunch fly huge power divert amused fitness"
"2021-12-08, 12:29:45 p.m." - 🚀 ~ restored wallet info: [
{
keyStore: Uint8Array(104) [
207, 167, 239, 154, 208, 138, 170, 153, 134, 69, 99, 225,
26, 112, 166, 57, 218, 63, 155, 38, 124, 243, 207, 226,
169, 247, 70, 67, 254, 42, 232, 28, 48, 112, 78, 83,
118, 26, 218, 25, 84, 13, 196, 172, 127, 97, 98, 100,
216, 129, 62, 98, 99, 135, 99, 25, 113, 99, 36, 134,
155, 184, 254, 153, 1, 115, 38, 213, 30, 202, 68, 166,
30, 99, 121, 118, 219, 111, 250, 202, 135, 116, 151, 66,
189, 50, 242, 140, 209, 202, 89, 252, 2, 184, 102, 205,
110, 219, 225, 60,
... 4 more items
],
publickey: 'C_0GxCvI8OBYZRO9mNZOhh8MykvOrOLx7F7U-ug8vUM=',
address: 'fra1p07sd3ptercwqkr9zw7e34jwsc0sejjte6kw9u0vtm2046puh4pszj0rs4',
keypair: XfrKeyPair { ptr: 2424840 },
privateStr: 'epG6XtjssaZdyCyRwijTQM92ptqyScZRtMz1lpRC-O8='
}
]


Here you can verify that the data from the restored wallet (its address, private and public keys) are identical to the values from the createWallet command output -- since we used the same menmonic, which was auto-generated and used to create a new wallet.