fibx 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -11,7 +11,7 @@ A command-line tool for DeFi operations on **Base, Citrea, HyperEVM, and Monad**
11
11
  - **Token Swaps**: Optimal routing via Fibrous aggregation with auto-slippage
12
12
  - **Transfers**: Send ETH or any ERC-20 token
13
13
  - **Aave V3**: Supply, borrow, repay, withdraw, and browse markets on Base
14
- - **MCP Server**: Built-in AI agent integration for Cursor, Claude Desktop, and Antigravity (10 tools, 4 categories)
14
+ - **MCP Server**: Built-in AI agent integration for Cursor, Claude Desktop, and Antigravity (11 tools, 4 categories)
15
15
  - **Agent Skills**: Prompt-based AI skills via [fibx-skills](https://github.com/Fibrous-Finance/fibx-skills)
16
16
  - **Privy Server Wallets**: Secure server-side signing — private keys never leave Privy's TEE
17
17
  - **Private Key Import**: Use an existing wallet with AES-256-GCM encrypted local storage
@@ -48,6 +48,42 @@ npm install -g fibx
48
48
  - Node.js >= 18
49
49
  - A running [fibx-server](https://github.com/ahmetenesdur/fibx-server) instance (required for Privy wallet operations; not needed for private key imports)
50
50
 
51
+ ## Quick Start — First Swap in 3 Minutes
52
+
53
+ ### Step 1: Get a Price Quote (no auth needed)
54
+
55
+ Try FibX instantly — no sign-up, no wallet, no keys:
56
+
57
+ ```bash
58
+ npx fibx quote 0.01 ETH USDC # Check price on Base
59
+ npx fibx quote 100 USDC DAI --chain base # Compare pairs
60
+ npx fibx quote 0.5 MON USDC --chain monad # Check Monad prices
61
+ ```
62
+
63
+ ### Step 2: Authenticate (pick one)
64
+
65
+ **Option A — Email Login** (Privy Server Wallet, no keys to manage):
66
+
67
+ ```bash
68
+ npx fibx auth login you@email.com # Sends OTP to your email
69
+ npx fibx auth verify you@email.com 123456 # Verify & create wallet
70
+ ```
71
+
72
+ **Option B — Import Private Key** (use an existing wallet):
73
+
74
+ ```bash
75
+ npx fibx auth import # Paste your key (encrypted at rest)
76
+ ```
77
+
78
+ ### Step 3: Execute
79
+
80
+ ```bash
81
+ npx fibx trade 0.01 ETH USDC # Execute the swap
82
+ npx fibx balance # Check your balances
83
+ ```
84
+
85
+ That's it. Three steps from zero to first swap.
86
+
51
87
  ## Usage
52
88
 
53
89
  ### Authentication
@@ -103,6 +139,18 @@ npx fibx send 1 0xRecipient --chain monad # Send MON on Monad
103
139
  npx fibx send 0.1 0xRecipient --simulate # Estimate gas without sending
104
140
  ```
105
141
 
142
+ ### Quote
143
+
144
+ Get swap prices without authentication:
145
+
146
+ ```bash
147
+ npx fibx quote 0.01 ETH USDC # Price check on Base
148
+ npx fibx quote 100 USDC DAI --chain monad # Compare pairs
149
+ npx fibx quote 0.1 ETH USDC --json # JSON output for scripts
150
+ ```
151
+
152
+ > **No wallet or authentication required.** Use `quote` to explore prices, then `trade` to execute.
153
+
106
154
  ### Swap
107
155
 
108
156
  ```bash
@@ -171,7 +219,7 @@ fibx includes a built-in [MCP](https://modelcontextprotocol.io) server for AI ed
171
219
  npx fibx mcp-start
172
220
  ```
173
221
 
174
- The MCP server exposes **10 tools** across 4 categories (Auth & Config, Wallet & Portfolio, Trading, DeFi). All write operations support a `simulate=true` parameter for fee estimation without execution.
222
+ The MCP server exposes **11 tools** across 4 categories (Auth & Config, Wallet & Portfolio, Trading, DeFi). All write operations support a `simulate=true` parameter for fee estimation without execution.
175
223
 
176
224
  ### Agent Skills
177
225