🐧Checker Client Linux CLI Guide

Please note the minimum system requirements are:

Centos >=7, Ubuntu >=18.04

Quick Start

  1. Download and install the Checker Client Linux CLI application from Node Owner Hub.

  2. Install

    1. cd into the directory

    2. Copy the current working directory

    3. Add to system environment variables

  3. Create Burner Wallet

kipnode wallet create

  1. Once the Checker Node Owners start the delegation process, you can check the list of pending licenses by wallet address

kipnode license list --address <wallet address>

  1. Get the license ID of the KIP Checker node, and use the wallet address to approve:

kipnode license approve --license <License ID> --address <wallet address>

You can also use below command to approve all license:

kipnode license approve --all

  1. Start the task and get rewards

kipnode license start --license <License ID> --address <wallet address>

  1. Quit the application.

(Attention!) If you quit the application, the node owner will stop earning rewards!

Commands

Burner Wallet

Create Burner Wallet

kipnode wallet create

Create a burner wallet and store the address and private key in user's current working directory.

Import Burner Wallet

kipnode wallet import --privatekey <private key>

Generate a burner wallet by importing a private key. The burner wallet address must be generated using KIP Node CLI.

Export burner Wallet

kipnode wallet export --address <wallet address>

Export the private key of the specified burner wallet address. The burner wallet address must be generated using KIP Node CLI.

Caution! Exporting private key of a wallet is risky.

List Burner Wallet

kipnode wallet list

List all the burner wallet addresses you created

Checker Node License

List Checker Node License

kipnode license list --address <wallet address>

List the status of all the Checker node License that are delegated to the burner wallet address

Each of the following display lists in the form of: License ID ｜ Status

Approve Checker Node License

kipnode license approve --license <License ID> --address <wallet address>

  1. The parameters must include the node's License ID and burner wallet address

  2. The node's License ID must be in the License List corresponding to the burner wallet address

  3. If license ID is approved successfully, it will display: success

You can also use below command to approve all license:

kipnode license approve --all

Deny Checker Node License

kipnode license deny --license <License ID> --address <wallet address>

  1. The parameters must include License ID and burner wallet address

  2. If license ID does not correspond to one in the pending list, an error will be reported:

Invalid license ID

  1. A message will be displayed:

Are you sure you want to deny delegation for [License ID]?

  1. Upon successful confirmation by user, another message will be displayed:

[License ID] denied.

Un-delegate Checker Node License

kipnode license undelegate --license <License ID> --address <wallet address>

  1. The parameters must include License ID and burner wallet address

  2. If license ID does not correspond to one in the confirmed list, an error will be reported:

Invalid license ID

  1. A message will be displayed:

Are you sure you want to revoke delegation for [License ID]?

  1. Upon successful confirmation by user, another message will be displayed:

[License ID] undelegated.

Start Running Checker Node License

kipnode license start --license <License ID> --address <wallet address>

  1. The parameters must include License ID and burner wallet address

  2. The License ID must be in the License List corresponding to the burner wallet address

  3. If the License ID has not been approved, it will be automatically approved before starting

  4. After successful execution, the checker node owners will get rewards

  5. The process will execute continuously, unless the process is terminated proactively or an abnormal situation occurs.

You can also use below command to start running all the approved licenses:

kipnode license start --all

Review License Status

kipnode license status --address <wallet address>

List the license's running status of the wallet address

Each of the following display lists in the form of: License ID ｜ Status

Advanced Features

To support NaaS providers to provide one-click deployment features to their users, we also support below advanced features:

1. Export owner wallets' signature

Use below command to export the signature of the checker node owners' wallet, using a burner wallet. 

kipnode signature export --type <claim | withdraw> --license <License ID> --address <wallet address>

  1. The parameters must include License ID and burner wallet address

  2. The types of signatures are limited to claim and withdraw.

  3. Checker node owners need to complete KYC verification process on Node Owner Hub, before they can export the withdraw signature.

2. View owners' reward statistics

kipnode reward --address <wallet address>

Use the burner wallet to the rewards statistics, including current total rewards, the total rewards claimed, and the total rewards withdrawn.

You can use the following command to view the detail rewards statistics for each checker node licenses, and output the data in JSON format:

kipnode reward --address <wallet address> --json

Additional feature request

  1. If you wish to integrate with our Checker Client in Linux using API, please kindly contact us for Checker Client Linux API Guide.

  2. If you have additional feature requests in CLI, please kindly contact us.

PreviousChecker Client Windows GUI GuideNextKYC before rewards withdrawal

Last updated