improve readme for easy setup and network interactions

README.md

@@ -12,11 +12,57 @@ For more info, please checkout our [Whitepaper](https://liberdus.com/Liberdus-Wh
 
 ## Installation
 
+### Prerequisites
+
+1. **Node.js v20.19.3** (recommended via [nvm](https://github.com/nvm-sh/nvm)):
+   ```bash
+   nvm install 20.19.3
+   ```
+2. **Build tools** (Linux):
+   ```bash
+   sudo apt-get install -y build-essential libssl-dev pkg-config
+   ```
+3. **Rust 1.82** – [rustup](https://www.rust-lang.org/tools/install):
+   ```bash
+   rustup default 1.82
+   ```
+   Or install the latest Rust and use `rustup default 1.82` if you need this exact version.
+4. **npm** (included with Node.js; update with `npm install -g npm` if needed)
+5. **Shardus CLI**: `npm install -g shardus@4.3.1`
+
+### Clone, install, and run (quick start)
+
+```bash
+git clone https://github.com/Liberdus/server.git
+cd server
+npm install
+```
+
+**Start the network** (e.g. with 10 nodes):
+
+```bash
+shardus create 10
+```
+
+**Stop the network:**
+
+```bash
+shardus stop
+```
+
+**Clean the network** (remove residual files and instance data):
+
+```bash
+shardus clean
+rm -rf instances
+```
+
 ### For demos, testing, etc.
 
 1. Clone this repository with `git clone https://gitlab.com/liberdus/server.git`
 2. Checkout the `dist` branch with `git checkout dist`
-3. Install dependencies with `npm install`
+3. Install dependencies with `npm i`
+4. Compile with `npm run compile`
 
 ### For Liberdus/Shardus development:
 
@@ -25,19 +71,77 @@ For more info, please checkout our [Whitepaper](https://liberdus.com/Liberdus-Wh
 3. Force git to prompt for credentials by cloning [`shardus-global-server`](https://gitlab.com/shardus/global/shardus-global-server):  
    `git clone https://gitlab.com/shardus/global/shardus-global-server.git`
 4. In another directory, clone this repository with `git clone https://gitlab.com/liberdus/server.git`
-5. Install dependencies with `npm install`
+5. Install dependencies with `npm i`
+6. Compile with `npm run compile`
 
 ## Usage
 
-`shardus create {# of nodes}` will start a network of local Liberdus nodes and apps to interact with the nodes:
-`shardus stop` will stop all nodes and apps.
-`shadrus clean` cleans the residual files and folders left by archiver and monitor-server.
-
-After running a network, and `instances` folder will be created. To run a new network, you must run `rm -rf instances` to delete this folder.
+- **Start a network:** `shardus create {# of nodes}` (e.g. `shardus create 10`) – starts local Liberdus nodes and apps.
+- **Stop the network:** `shardus stop` – stops all nodes and apps.
+- **Clean the network:** `shardus clean` – cleans residual files and folders from archiver and monitor-server. Then run `rm -rf instances` to remove the `instances` folder so you can start a fresh network.
 
 [Shardus Monitor](https://gitlab.com/shardus/monitor-server) - http://localhost:3000
 [Liberdus Client](https://gitlab.com/liberdus/web-client/liberdus-web-client) - http://localhost:3333
 [Archive Server](https://gitlab.com/shardus/archive/archive-server) - http://localhost:4000
-[Liberdus Explorer](https://gitlab.com/liberdus/explorer-server) - http://localhost:4444    
+[Liberdus Explorer](https://gitlab.com/liberdus/explorer-server) - http://localhost:4444
+
+### Interacting with the network via client.js
+
+Run the client script to connect to a node and interact with the network:
+
+```bash
+node client.js localhost:9002
+```
+
+Replace `localhost:9002` with the host and port of any node in your network (e.g. `localhost:9001`, `localhost:9003`).
+
+**For detailed instructions on how to play around** (creating accounts, registering, transfers, messages between two accounts, and using the HTTP API), see the comment block at the top of **`client.js`**.
+
+### Creating a key pair for testing
+
+Create a public/private key pair and add the **public key** to the server config so you can use the client for testing:
+
+1. Generate a key pair:
+
+```bash
+node -e "
+const crypto = require('@shardus/lib-crypto-utils');
+crypto.init('69fa4195670576c0160d660c3be36556ff8d504725be8a59b5a96509e0c994bc');
+const pair = crypto.generateKeypair();
+console.log('PUBLIC_KEY:', pair.publicKey);
+console.log('SECRET_KEY:', pair.secretKey);
+" 2>&1
+```
+
+2. Add the **PUBLIC_KEY** to `src/config/index.ts` in the `devPublicKeys` object (and `multisigKeys` if needed) with `DevSecurityLevel.High`.
+
+3. Set environment variables for the client script (use the values from step 1):
+
+   - `DEV_PUBLIC_KEY` – your public key  
+   - `DEV_PRIVATE_KEY` – your secret key  
+
+Then run `node client.js localhost:9002` to interact with the network.
+
+### Querying the node via HTTP (account, transactions, chatId / messages)
+
+You can query account data, transactions, and messages directly from any node using HTTP (e.g. in a browser or with `curl`).
+
+- **Account** – get account info by account ID (address):
+  ```bash
+  curl "http://localhost:9002/account/7e79d53c067e9d0a095c9675db38330ec72ffd5b000000000000000000000000"
+  ```
+  Replace the long hex string with the account ID (public key / address) you want to look up.
+
+- **Account transactions** – list transactions for an account:
+  ```bash
+  curl "http://localhost:9004/account/f43eb22eb9ca0afe5f0fc620ba1ac932711eefe000000000000000000000000/transactions"
+  ```
+  Use your node host/port and the account ID.
+
+- **Messages (chat)** – get messages for a chat; the **chatId** is the first path segment after `/messages/`:
+  ```bash
+  curl "http://localhost:9002/messages/7569adbc2fd289d0e613eb488c7968988c41a5d8c2a1e1c4c038038d7c957955/0"
+  ```
+  The response is JSON with a `messages` array; each message includes `chatId`, `from`, `message` (body/handle/timestamp), and signature fields. The chatId is derived from the two participants’ addresses (sorted and hashed). You can obtain it from the client when using `message poll <alias>` or from a previous message response.
 
 

client.js

@@ -1,6 +1,71 @@
 /* eslint-disable @typescript-eslint/no-use-before-define */
 /* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable @typescript-eslint/explicit-function-return-type */
+/**
+ * =============================================================================
+ * Liberdus/Shardus client – interact with a node via the command line
+ * =============================================================================
+ *
+ * USAGE
+ *   node client.js [host:port] [archiveServer] [monitorServer] [faucetServer]
+ *   Example: node client.js localhost:9002
+ *
+ * TESTING SETUP (dev keys)
+ *   Create a key pair (see README "Creating a key pair for testing"), add the
+ *   public key to src/config/index.ts in devPublicKeys (and multisigKeys),
+ *   then set DEV_PUBLIC_KEY and DEV_PRIVATE_KEY in your environment or .env.
+ *
+ * -----------------------------------------------------------------------------
+ * HOW TO USE THE CLIENT – step by step
+ * -----------------------------------------------------------------------------
+ *
+ * 1. CREATE AN ACCOUNT (first terminal)
+ *    - Run: node client.js localhost:9002
+ *    - On "Enter wallet name:", type a name (e.g. alice) and press Enter.
+ *    - Run: register
+ *    - When prompted "Enter the alias you want:", use the SAME name as the
+ *      wallet (e.g. alice). This keeps wallet name and account alias in sync.
+ *    - After registration, the account is eligible for faucet funding (e.g. 50 LIB).
+ *    - Run: faucet
+ *    - Follow the prompts; your account will be funded.
+ *
+ * 2. SECOND ACCOUNT (for transfers and messages)
+ *    - Open a second terminal in the same project directory.
+ *    - Run: node client.js localhost:9002  (or another node, e.g. localhost:9004)
+ *    - Enter a different wallet name (e.g. bob), then run: register
+ *    - Use the same alias as the wallet name (e.g. bob).
+ *    - Run: faucet to fund the second account.
+ *
+ * 3. USE THE CURRENT WALLET
+ *    - use <name>   – switch to wallet <name> (e.g. use alice, use bob).
+ *
+ * 4. TRANSFER LIB BETWEEN ACCOUNTS
+ *    - transfer
+ *    - Enter target: alias or address (e.g. bob or the full public key).
+ *    - Enter amount and memo as prompted.
+ *
+ * 5. SEND MESSAGES BETWEEN ACCOUNTS
+ *    - message
+ *    - Enter the alias or publicKey of the recipient (e.g. bob).
+ *    - Enter your message when prompted.
+ *    - read – read messages from another user (you may send a "read" tx).
+ *
+ * 6. QUERY VIA NODE HTTP API (e.g. from browser or curl)
+ *    - Account:  GET http://localhost:9002/account/<accountId>
+ *      Example:  http://localhost:9002/account/7e79d53c067e9d0a095c9675db38330ec72ffd5b000000000000000000000000
+ *    - Transactions for an account:
+ *      GET http://localhost:9002/account/<accountId>/transactions
+ *      Example:  http://localhost:9004/account/f43eb22eb9ca0afe5f0fc620ba1ac932711eefe000000000000000000000000/transactions
+ *    - Messages (chat) – the chatId is the first path segment after /messages/:
+ *      GET http://localhost:9002/messages/<chatId>/0
+ *      Example:  http://localhost:9002/messages/7569adbc2fd289d0e613eb488c7968988c41a5d8c2a1e1c4c038038d7c957955/0
+ *      The response JSON includes a "messages" array; each message has chatId, from, message, etc.
+ *      To derive chatId for two accounts: it is the hash of the sorted concatenation of the two
+ *      account addresses (the client uses this for the "message poll" and "read" flows).
+ *
+ * Other useful commands: query, get, transactions, wallet list, use host <host>.
+ * =============================================================================
+ */
 const fs = require('fs')
 const { resolve } = require('path')
 const path = require('path')