Add Claim CLI document

README.md

@@ -7,6 +7,7 @@ This repository is a monorepo for essential non-contract services for the LSK To
 - [Packages](#packages)
  - [Tree Builder](#tree-builder)
  - [Token Claim Backend](#claim-backend)
+ - [Token Claim CLI](#claim-cli)
 - [Setup and Installation](#setup-and-installation)
 - [Docker](#docker)
 - [Contributing](#contributing)
@@ -26,6 +27,10 @@ Perform as a backend server, compatible with JSON RPC 2.0 Standard.
 
 The database is using PostgreSQL.
 
+### [Claim CLI](packages/claim-cli)
+
+A command-line tool to claim LSK token by submitting transaction directly on-chain.
+
 ## Setup and Installation
 
 The Node version for this project is 18. Make sure you have the correct version installed. If you are using `nvm`, run `nvm use 18`.
@@ -69,6 +74,10 @@ docker build -t lisk-claim-backend -f ./docker/claim-backend/Dockerfile .
  - Lisk Token Migration
  - Migration Airdrop
 
+- [Detailed Guide to Claim CLI Tool](./documentation/Detailed_Claim_CLI.md) - A detailed documentation for:
+ - Claiming Lisk tokens without the need for UI
+ - Detailed steps of the claim process using CLI
+
 ## Contributing
 
 If you find any issues or have suggestions for improvements,

documentation/Detailed_Claim_CLI.md

@@ -0,0 +1,19 @@
+# Detailed Guide to Claim CLI Tool
+
+1. Follow [Run](../packages/claim-cli/README.md) in Claim CLI Readme to start Claim CLI
+2. Select `Submit a Claim` 
+ ![img.png](Detailed_Claim_CLI/img.png)
+3. Select `Private Key` or `Mnemonic` as Type for Lisk v4 Wallet. 
+ ![img_1.png](Detailed_Claim_CLI/img_1.png)
+4. Paste `Private Key` or `Mnemonic` from Lisk Desktop or other Wallet App (e.g. Exodus). 
+ ![img_2.png](Detailed_Claim_CLI/img_2.png)
+5. Select the LSK Account you wanted to claim. 
+ ![img_3.png](Detailed_Claim_CLI/img_3.png)
+6. Choose and enter mnemonic or private key for Lisk L2. 
+ ![img_4.png](Detailed_Claim_CLI/img_4.png)
+7. If data is inputted correctly, the CLI will show Lisk L2 address, which can also be the destination address of the Claim. 
+ ![img_5.png](Detailed_Claim_CLI/img_5.png)
+8. Verify details and network fee before submitting the transaction. Network fee can be adjusted or using the amount suggested by the network. 
+ ![img_6.png](Detailed_Claim_CLI/img_6.png)
+9. Success, the transaction can be viewed on explorer by using the transaction hash. 
+ ![img_7.png](Detailed_Claim_CLI/img_7.png)

packages/claim-cli/README.md

@@ -18,12 +18,16 @@ cd packages/claim-cli
 yarn && yarn build
 
 # Start Claim CLI on mainnet
-./bin/run.js start
+./bin/run.js
 
 # Or start Claim CLI on testnet
-# ./bin/run.js start --network testnet
+# ./bin/run.js --network testnet
 ```
 
+## Usage
+
+Detailed guide to Claim CLI is located in [Detailed Guide to Claim CLI Tool](../../documentation/Detailed_Claim_CLI.md).
+
 ## Workflow
 
 ### Check Eligibility