starkfi 0.4.1 → 0.4.3

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.
Files changed (4) hide show
  1. package/README.md +60 -36
  2. package/dist/index.js +96 -96
  3. package/package.json +1 -1
  4. package/skills/staking/SKILL.md +2 -1
package/README.md CHANGED
@@ -1,14 +1,11 @@
1
1
  <p align="center">
2
2
  <a href="https://starkfi.app">
3
- <img src="landing/favicon.svg" alt="StarkFi Logo" width="100" height="100"/>
3
+ <img src="landing/readme-banner.png" alt="StarkFi — The AI-native DeFi toolkit for Starknet" width="100%" />
4
4
  </a>
5
5
  </p>
6
6
 
7
- <h1 align="center">StarkFi</h1>
8
-
9
7
  <p align="center">
10
- <strong>The AI-native DeFi toolkit for Starknet.</strong><br>
11
- A production-grade CLI and MCP server that gives both developers and AI agents full access to swaps, multi-swap, atomic batch transactions, staking, lending, portfolio management, and gasless transactions — all powered by the <a href="https://github.com/keep-starknet-strange/starkzap">Starkzap SDK</a>.
8
+ A production-grade CLI, MCP server, and Telegram bot that gives both developers and AI agents full access to swaps, multi-swap, atomic batch transactions, staking, lending, portfolio management, and gasless transactions — all powered by the <a href="https://github.com/keep-starknet-strange/starkzap">Starkzap SDK</a>.
12
9
  </p>
13
10
 
14
11
  <p align="center">
@@ -31,42 +28,43 @@ Most DeFi tools are built for humans clicking buttons. StarkFi is built for **ag
31
28
  - 💸 **Gas Abstraction Built-In** — Pay gas in STRK, ETH, USDC, USDT, or DAI via AVNU Paymaster, or let the developer sponsor gas entirely (gasfree mode)
32
29
  - 📊 **Full Portfolio** — Unified view of balances, staking positions, and lending positions with USD values
33
30
  - 🧪 **Simulate Everything** — Dry-run any transaction to estimate fees before broadcasting
31
+ - 💬 **Telegram Bot** — Chat-based DeFi via natural language, BYOAI model (OpenAI, Claude, Gemini)
34
32
 
35
33
  ---
36
34
 
37
35
  ## Architecture
38
36
 
39
37
  ```
40
- ┌──────────────────────────────────────────────────────────────────────────┐
41
- │ StarkFi │
42
- │ │
43
- │ ┌──────────┐ ┌─────────────────────┐ ┌───────────────────────┐ │
44
- │ │ CLI │ │ MCP Server │ │ Agent Skills │ │
45
- │ │ (30+ │ │ (27 tools) │ │ (10 workflows) │ │
46
- │ │ commands)│ │ stdio transport │ │ npx starkfi@latest │ │
47
- │ └────┬─────┘ └──────────┬──────────┘ └──────────┬────────────┘ │
48
- │ │ │ │ │
49
- │ └──────────────────────┼───────────────────────────┘ │
50
- │ ▼ │
51
- │ ┌──────────────────────────────────────────────────────────────────┐ │
52
- │ │ Service Layer │ │
53
- │ │ ┌──────────┐ ┌──────────┐ ┌────────┐ ┌──────────┐ │ │
54
- │ │ │ Fibrous │ │ Staking │ │ Vesu │ │ Batch │ │ │
55
- │ │ │ Swap │ │ Lifecycle│ │ V2 │ │ Multicall│ │ │
56
- │ │ └────┬─────┘ └────┬─────┘ └───┬────┘ └────┬─────┘ │ │
57
- │ │ └─────────────┴────────────┴────────────┘ │ │
58
- │ │ │ │ │
59
- │ │ ┌───────────────┴───────────────────────────┐ │ │
60
- │ │ │ Starkzap SDK (starkzap v1.0.0) │ │ │
61
- │ │ │ Wallet · TxBuilder · Tokens · Paymaster │ │ │
62
- │ │ └───────────────┬───────────────────────────┘ │ │
63
- │ └───────────────────────┼──────────────────────────────────────────┘ │
64
- │ ▼ │
65
- │ ┌──────────────────────────────────────┐ ┌──────────────────────┐ │
66
- │ │ Auth Server (Hono + Privy TEE) │ │ AVNU Paymaster │ │
67
- │ │ Email OTP · Wallet · Sign · Gas │ │ Gas Abstraction │ │
68
- │ └──────────────────────────────────────┘ └──────────────────────┘ │
69
- └──────────────────────────────────────────────────────────────────────────┘
38
+ ┌─────────────────────────────────────────────────────────────────────────────────────┐
39
+ │ StarkFi │
40
+ │ │
41
+ │ ┌──────────┐ ┌───────────────┐ ┌───────────────┐ ┌──────────────────────────┐ │
42
+ │ │ CLI │ │ MCP Server │ │ Agent Skills │ │ Telegram Bot │ │
43
+ │ │ (30+ │ │ (27 tools) │ │ (10 workflows) │ │ (BYOAI · Chat DeFi) │ │
44
+ │ │ commands)│ │ stdio transport│ │ npx starkfi │ │ OpenAI / Claude / │ │
45
+ │ └────┬─────┘ └──────┬────────┘ └──────┬─────────┘ │ Gemini │ │
46
+ │ │ │ │ └────────────┬─────────────┘ │
47
+ │ └───────────────┼──────────────────┼─────────────────────────┘ │
48
+ │ ▼ ▼ │
49
+ │ ┌──────────────────────────────────────────────────────────────────────────────┐ │
50
+ │ │ Service Layer │ │
51
+ │ │ ┌──────────┐ ┌──────────┐ ┌────────┐ ┌──────────┐ ┌──────────────┐ │ │
52
+ │ │ │ Fibrous │ │ Staking │ │ Vesu │ │ Batch │ │ Portfolio │ │ │
53
+ │ │ │ Swap │ │ Lifecycle│ │ V2 │ │ Multicall│ │ Dashboard │ │ │
54
+ │ │ └────┬─────┘ └────┬─────┘ └───┬────┘ └────┬─────┘ └──────┬───────┘ │ │
55
+ │ │ └─────────────┴────────────┴────────────┴───────────────┘ │ │
56
+ │ │ │ │ │
57
+ │ │ ┌───────────────┴───────────────────────────┐ │ │
58
+ │ │ │ Starkzap SDK (starkzap v1.0.0) │ │ │
59
+ │ │ │ Wallet · TxBuilder · Tokens · Paymaster │ │ │
60
+ │ │ └───────────────┬───────────────────────────┘ │ │
61
+ │ └───────────────────────┼───────────────────────────────────────────────────────┘ │
62
+ │ ▼ │
63
+ │ ┌──────────────────────────────────────┐ ┌──────────────────────┐ │
64
+ │ │ Auth Server (Hono + Privy TEE) │ │ AVNU Paymaster │ │
65
+ │ │ Email OTP · Wallet · Sign · Gas │ │ Gas Abstraction │ │
66
+ │ └──────────────────────────────────────┘ └──────────────────────┘ │
67
+ └─────────────────────────────────────────────────────────────────────────────────────┘
70
68
  │
71
69
  ▼
72
70
  ┌──────────────────┐
@@ -314,7 +312,7 @@ npx starkfi@latest trade 10 STRK ETH # Execute
314
312
  | ----------------------------------------------------------------------------- | ---------------------- |
315
313
  | `validators [--json]` | List active validators |
316
314
  | `pools <validator> [--json]` | Show delegation pools |
317
- | `stake <amount> --validator <name> [--token <symbol>] [--simulate]` | Stake tokens |
315
+ | `stake <amount> --validator <name> [--token <symbol>] [--simulate] [--json]` | Stake tokens |
318
316
  | `stake-status [validator] [--json]` | Staking dashboard |
319
317
  | `rewards --validator <name> [--token <symbol>] <--claim\|--compound>` | Manage rewards |
320
318
  | `unstake <intent\|exit> --validator <name> [--token <symbol>] [--amount <n>]` | Unstake (2-step) |
@@ -371,6 +369,32 @@ See [`server/README.md`](server/README.md) for setup instructions.
371
369
 
372
370
  ---
373
371
 
372
+ ## Telegram Bot
373
+
374
+ StarkFi has a dedicated **[Telegram bot](https://github.com/ahmetenesdur/starkfi-telegram-bot)** that brings DeFi to chat. Users interact with natural language — the bot translates commands into StarkFi operations.
375
+
376
+ **BYOAI Model** — each user provides their own API key (OpenAI, Claude, or Gemini). No shared keys, no centralized billing.
377
+
378
+ | Feature | Description |
379
+ | --- | --- |
380
+ | **Swap** | DEX-aggregated trading via Fibrous |
381
+ | **Stake** | Multi-token staking (STRK, WBTC, tBTC, SolvBTC, LBTC) |
382
+ | **Lend** | Supply, borrow, repay, withdraw, close on Vesu V2 |
383
+ | **Portfolio** | Balances with USD valuations and position health |
384
+ | **Batch** | Combine swap + stake + supply + send in one transaction |
385
+ | **Gas Modes** | Gasless (pay in ERC-20) and gasfree (developer-sponsored) |
386
+
387
+ ```bash
388
+ git clone https://github.com/ahmetenesdur/starkfi-telegram-bot.git
389
+ cd starkfi-telegram-bot && pnpm install
390
+ cp .env.example .env # Configure TELEGRAM_BOT_TOKEN, BOT_ENCRYPTION_SECRET
391
+ pnpm dev
392
+ ```
393
+
394
+ See the [starkfi-telegram-bot](https://github.com/ahmetenesdur/starkfi-telegram-bot) repo for full setup and deployment (Docker support included).
395
+
396
+ ---
397
+
374
398
  ## Tech Stack
375
399
 
376
400
  | Layer | Technology |