# factom-identity-cli ## Installation ```bash sudo npm install -g factom-identity-cli ``` ## Usage **Important note: It is highly recommended that you run all `factom-identity-cli` commands with a leading space to prevent writing secrets (SK1 key, entry credit private key) to the command line history.** All the commands support the option `-s http://localhost:8088/v2` that allows to specify the factomd API endpoint. ### Get identity information #### Get current efficiency and coinbase address ```bash # Parameter: factom-identity-cli get -s http://localhost:8088/v2 888888b2e7c7c63655fa85e0b0c43b4b036a6bede51d38964426f122f61c5584 ``` #### Get history of efficiencies and coinbase addresses Use `--history` option. ```bash # Parameter: factom-identity-cli get -s http://localhost:8088/v2 --history 888888b2e7c7c63655fa85e0b0c43b4b036a6bede51d38964426f122f61c5584 ``` ### Update coinbase address ```bash --identity, --id Identity root chain id. --fctaddress, --fct Public Factoid address (starts with FA...) that will receive coinbase payouts. --sk1 Secret level 1 key (starts with sk1...) to sign the update. --secaddress, --sec Private EC address (starts with Es...) to pay the update. --offline Generate offline a script to be excuted at a later time on a machine connected to the Internet. ``` ```bash factom-identity-cli update-coinbase-address -s http://localhost:8088/v2 \ --id 888888aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \ --sk1 sk1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ --fct FAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ --secaddress EsXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ``` ### Update efficiency ```bash --identity, --id Identity root chain id. --efficiency, --eff Efficiency value. Decimal number between 0 and 100. --sk1 Secret level 1 key (starts with sk1...) to sign the update. --secaddress, --sec Private EC address (starts with Es...) to pay the update. --smchainid Identity server management subchain id (only required for offline mode). --offline Generate offline a script to be excuted at a later time on a machine connected to the Internet. ``` ```bash factom-identity-cli update-efficiency -s http://localhost:8088/v2 \ --id 888888aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \ --sk1 sk1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ --efficiency 19.89 \ --secaddress EsXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ``` ### Add a coinbase cancel message ```bash --identity, --id Identity root chain id. --height Block height containing the Admin block with the output to cancel. --index Index in the coinbase descriptor of the specific output to be canceled (0 origin indexed). --sk1 Secret level 1 key (starts with sk1...) to sign the update. --secaddress, --sec Private EC address (starts with Es...) to pay the update. --smchainid Identity server management subchain id (only required for offline mode). --offline Generate offline a script to be excuted at a later time on a machine connected to the Internet. ``` ```bash factom-identity-cli add-coinbase-cancel -s http://localhost:8088/v2 \ --id 888888aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \ --sk1 sk1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ --height 39945 \ --index 4 \ --secaddress EsXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ``` ## Offline mode You can use this tool to generate offline a bash script that can later be executed on a machine connected to the Internet (the scripts only require curl command to be installed). The use is mainly intended for Authority Servers operators who require maximum security. Your offline machine will need Node.js (>=8) installed and this tool with all its dependencies available. You are strongly encouraged to audit the content of the generated scripts. **Important: the scripts generated contain timestamped data. This has 2 consequences:** - The clock of the machine you are using to generate the scripts must be on time. It is not uncommon for the clock of an offline machine to not be synced so please verify and adjust it before generating the scripts. It only needs to be accurate to the minute. - The scripts are only valid for a limited time. You must execute the scripts within 1 hour of their creation to be certain that the entries contained in them will be accepted by the network. ### To generate a script to update the coinbase address ```bash node bin/factom-identity-cli update-coinbase-address --offline -s https://api.factomd.net/v2 \ --id 888888aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \ --sk1 sk1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ --fctaddress FAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ --secaddress EsXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ``` A script named `update-coinbase-address..sh` is generated and avaible in the folder after successful execution (_short_id_ is the short id of your identity: the first 6 characters after the leading 888888). ### To generate a script to update the efficiency ```bash node bin/factom-identity-cli update-efficiency --offline -s https://api.factomd.net/v2 \ --id 888888aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \ --sk1 sk1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ --efficiency 50.1 \ --secaddress EsXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ --smchainid 888888bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb ``` A script named `update-efficiency..sh` is generated and avaible in the folder after successful execution (_short_id_ is the short id of your identity: the first 6 characters after the leading 888888). Value of the _Server Management Subchain ID_ can be found by looking at the identity root chain id in a Factom explorer: it is the value of the 3rd external id of the entry whose 2nd external id is equal to 'Register Server Management'. ### To generate a script to add a coinbase cancel message ```bash node bin/factom-identity-cli add-coinbase-cancel --offline -s https://api.factomd.net/v2 \ --id 888888aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \ --sk1 sk1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ --height 39945 \ --index 4 \ --secaddress EsXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \ --smchainid 888888bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb ``` A script named `add-coinbase-cancel..sh` is generated and avaible in the folder after successful execution (_short_id_ is the short id of your identity: the first 6 characters after the leading 888888). Value of the _Server Management Subchain ID_ can be found by looking at the identity root chain id in a Factom explorer: it is the value of the 3rd external id of the entry whose 2nd external id is equal to 'Register Server Management'. ## Run in Docker container ``` docker build -t factom-identity-cli github.com/PaulBernier/factom-identity-cli docker run -it --rm factom-identity-cli ...... ```