faucet-terminal 2.0.2 → 2.0.4

package/README.md

@@ -14,19 +14,42 @@ Starknet Sepolia · Ethereum Sepolia
 
 ---
 
+## Installation
+
 ```bash
 npm install -g faucet-terminal
 ```
 
+## Quick Start
+
+```bash
+# Ethereum Sepolia (ETH)
+faucet-terminal request 0xYOUR_ADDRESS --network ethereum
+faucet-terminal req 0xYOUR_ADDRESS -n eth              # short version
+
+# Starknet Sepolia (STRK - default)
+faucet-terminal request 0xYOUR_ADDRESS --network starknet
+faucet-terminal req 0xYOUR_ADDRESS -n sn               # short version
+
+# Starknet Sepolia (ETH)
+faucet-terminal request 0xYOUR_ADDRESS --network starknet --token ETH
+faucet-terminal req 0xYOUR_ADDRESS -n sn --token ETH   # short version
+```
+
+## Example Output
+
 ```
-$ faucet-terminal req 0x742d35Cc6634C0532925a3b844Bc9e7595f8fE21 -n eth-sep
+$ faucet-terminal req 0x742d35Cc6634C0532925a3b844Bc9e7595f8fE21 -n eth
 
   faucet terminal
 
   network  ethereum
 
+  [Verification] What is 5 + 7? 12
+  Correct!
+
   ✔ Challenge received
-  ✔ Challenge solved in 12.3s
+  ✔ Challenge solved in 32.1s
   ✔ Transaction submitted!
 
   ────────────────────────────────────────────────────────
@@ -41,62 +64,129 @@ $ faucet-terminal req 0x742d35Cc6634C0532925a3b844Bc9e7595f8fE21 -n eth-sep
   ✔ Tokens will arrive in ~30 seconds
 ```
 
-## Quick Start
+## Supported Networks
+
+| Network | Full Name | Aliases | Tokens |
+|:--------|:----------|:--------|:-------|
+| Starknet Sepolia | `starknet` | `sn`, `sn-sep` | STRK (default), ETH |
+| Ethereum Sepolia | `ethereum` | `eth`, `eth-sep` | ETH |
+
+## Commands
+
+### Request Tokens
 
 ```bash
-# Ethereum Sepolia
-faucet-terminal req 0xYOUR_ADDRESS -n eth-sep
+# Full command
+faucet-terminal request <ADDRESS> --network <NETWORK> [--token <TOKEN>]
 
-# Starknet Sepolia (STRK)
-faucet-terminal req 0xYOUR_ADDRESS -n sn-sep
+# Short version
+faucet-terminal req <ADDRESS> -n <NETWORK> [--token <TOKEN>]
 
-# Starknet Sepolia (ETH)
-faucet-terminal req 0xYOUR_ADDRESS -n sn-sep --token ETH
+# Shortest version
+faucet-terminal r <ADDRESS> -n <NETWORK>
+```
 
+**Examples:**
+```bash
+faucet-terminal request 0x123...abc --network ethereum           # ETH on Ethereum
+faucet-terminal req 0x123...abc -n eth                           # same, shorter
+faucet-terminal r 0x123...abc -n eth                             # same, shortest
+
+faucet-terminal request 0x123...abc --network starknet           # STRK on Starknet
+faucet-terminal req 0x123...abc -n sn                            # same, shorter
+
+faucet-terminal request 0x123...abc --network starknet --token ETH  # ETH on Starknet
+faucet-terminal req 0x123...abc -n sn --token ETH                   # same, shorter
 ```
 
-## Networks
+### Check Status
 
-| Network | Aliases | Tokens |
-|:--------|:--------|:-------|
-| Starknet Sepolia | `starknet` `sn` `sn-sep` | STRK, ETH |
-| Ethereum Sepolia | `ethereum` `eth` `eth-sep` | ETH |
+```bash
+# Full command
+faucet-terminal status <ADDRESS> --network <NETWORK>
 
-## Commands
+# Short version
+faucet-terminal s <ADDRESS> -n <NETWORK>
+```
 
+**Examples:**
+```bash
+faucet-terminal status 0x123...abc --network ethereum
+faucet-terminal s 0x123...abc -n eth
 ```
-req, r      Request testnet tokens
-status, s   Check cooldown status
-info, i     View faucet info
-quota, q    Check remaining quota
-limits, l   Show rate limits
+
+### View Faucet Info
+
+```bash
+# Full command
+faucet-terminal info --network <NETWORK>
+
+# Short version
+faucet-terminal i -n <NETWORK>
 ```
 
-## Options
+**Examples:**
+```bash
+faucet-terminal info --network ethereum
+faucet-terminal i -n eth
+```
+
+### Check Your Quota
+
+```bash
+# Full command
+faucet-terminal quota
 
+# Short version
+faucet-terminal q
 ```
--n, --network   Network (required): eth-sep, sn-sep
---token         Token type: ETH, STRK
---json          JSON output
+
+### View Rate Limits
+
+```bash
+# Full command
+faucet-terminal limits
+
+# Short version
+faucet-terminal l
 ```
 
+## Options
+
+| Option | Short | Description |
+|:-------|:------|:------------|
+| `--network` | `-n` | Network to use (required for most commands) |
+| `--token` | | Token to request: `ETH`, `STRK` |
+| `--json` | | Output in JSON format |
+| `--version` | `-v` | Show version |
+| `--help` | `-h` | Show help |
+
 ## Rate Limits
 
 ```
-5 requests/day    per IP address
-1 request/hour    per token type
-24h cooldown      after daily limit
+5 requests/day     per IP address
+1 request/hour     per token type (ETH and STRK tracked separately)
+24h cooldown       after daily limit reached
 ```
 
 ## How It Works
 
 ```
-1. Submit address    →  Validate format
-2. Verification      →  Answer simple question
-3. Proof of Work     →  Solve SHA-256 challenge (~30s)
-4. Receive tokens    →  Transaction submitted
+1. Submit address    →  Validate format for the network
+2. Verification      →  Answer a simple math question
+3. Proof of Work     →  Solve SHA-256 challenge (~30-60s)
+4. Receive tokens    →  Transaction submitted to blockchain
 ```
 
+## Error Messages
+
+The CLI provides clear error messages when you hit rate limits:
+
+- `[HOURLY LIMIT]` - You requested this token within the last hour
+- `[DAILY LIMIT]` - You've used all 5 daily requests
+- `[FAUCET LIMIT]` - Faucet has temporarily reached its distribution limit
+- `[LOW BALANCE]` - Faucet balance is too low
+
 ## License
 
 MIT

package/install.js

@@ -8,7 +8,7 @@ const stream = require('stream');
 
 const pipeline = promisify(stream.pipeline);
 
-const VERSION = 'v2.0.2';
+const VERSION = 'v2.0.4';
 const GITHUB_REPO = 'Giri-Aayush/faucet-terminal';
 
 // Detect platform and architecture

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "faucet-terminal",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "Multi-chain testnet faucet CLI - get tokens on Starknet and Ethereum testnets",
   "bin": {
     "faucet-terminal": "./bin/faucet-terminal.js"