starkfi 0.6.0 → 0.6.1
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/MCP.md +7 -7
- package/README.md +58 -101
- package/dist/index.js +96 -96
- package/package.json +6 -6
- package/skills/confidential/SKILL.md +19 -17
- package/skills/dca/SKILL.md +3 -2
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "starkfi",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.1",
|
|
4
4
|
"description": "AI-native Starknet DeFi CLI + MCP Server + Agent Skills — Swaps, multi-swap, batch (multicall), staking, lending, DCA, confidential transfers, simulation, portfolio, gas abstraction",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -76,12 +76,12 @@
|
|
|
76
76
|
},
|
|
77
77
|
"devDependencies": {
|
|
78
78
|
"@eslint/js": "^10.0.1",
|
|
79
|
-
"@modelcontextprotocol/sdk": "^1.
|
|
80
|
-
"@types/node": "^25.5.
|
|
79
|
+
"@modelcontextprotocol/sdk": "^1.29.0",
|
|
80
|
+
"@types/node": "^25.5.2",
|
|
81
81
|
"chalk": "^5.6.2",
|
|
82
82
|
"commander": "^14.0.3",
|
|
83
83
|
"env-paths": "^3.0.0",
|
|
84
|
-
"eslint": "^10.
|
|
84
|
+
"eslint": "^10.2.0",
|
|
85
85
|
"eslint-config-prettier": "^10.1.8",
|
|
86
86
|
"globals": "^17.4.0",
|
|
87
87
|
"jiti": "^2.6.1",
|
|
@@ -91,10 +91,10 @@
|
|
|
91
91
|
"tsup": "^8.5.1",
|
|
92
92
|
"tsx": "^4.21.0",
|
|
93
93
|
"typescript": "^5.9.3",
|
|
94
|
-
"typescript-eslint": "^8.
|
|
94
|
+
"typescript-eslint": "^8.58.0",
|
|
95
95
|
"zod": "^4.3.6"
|
|
96
96
|
},
|
|
97
97
|
"dependencies": {
|
|
98
|
-
"@fatsolutions/tongo-sdk": "^1.
|
|
98
|
+
"@fatsolutions/tongo-sdk": "^1.4.0"
|
|
99
99
|
}
|
|
100
100
|
}
|
|
@@ -47,6 +47,8 @@ Privacy-preserving token transfers using ZK proofs on Starknet. Amounts are hidd
|
|
|
47
47
|
|
|
48
48
|
## Setup (One-Time)
|
|
49
49
|
|
|
50
|
+
The user first needs a Tongo Private Key. They can generate or export this key through the [Tongo Cash](https://tongo.cash/) or refer to the [Tongo Documentation](https://docs.tongo.cash/protocol/contracts.html).
|
|
51
|
+
|
|
50
52
|
```bash
|
|
51
53
|
npx starkfi@latest conf-setup --key <TONGO_PRIVATE_KEY> --contract 0x1234…
|
|
52
54
|
```
|
|
@@ -103,17 +105,17 @@ npx starkfi@latest conf-rollover [--json]
|
|
|
103
105
|
|
|
104
106
|
## Parameters
|
|
105
107
|
|
|
106
|
-
| Parameter
|
|
107
|
-
|
|
|
108
|
-
| `amount`
|
|
109
|
-
| `--key`
|
|
110
|
-
| `--contract`
|
|
111
|
-
| `--recipient-x`
|
|
112
|
-
| `--recipient-y`
|
|
113
|
-
| `--token`
|
|
114
|
-
| `--to`
|
|
115
|
-
| `--simulate`
|
|
116
|
-
| `--json`
|
|
108
|
+
| Parameter | Type | Description | Required |
|
|
109
|
+
| --------------- | ------ | ---------------------------------- | -------------- |
|
|
110
|
+
| `amount` | number | Amount for fund/transfer/withdraw | Yes |
|
|
111
|
+
| `--key` | string | Tongo private key (setup only) | Yes (setup) |
|
|
112
|
+
| `--contract` | string | Tongo contract address | Yes (setup) |
|
|
113
|
+
| `--recipient-x` | string | Recipient public key X coordinate | Yes (transfer) |
|
|
114
|
+
| `--recipient-y` | string | Recipient public key Y coordinate | Yes (transfer) |
|
|
115
|
+
| `--token` | string | Token symbol (default: `USDC`) | No |
|
|
116
|
+
| `--to` | string | Recipient Starknet address | No |
|
|
117
|
+
| `--simulate` | flag | Estimate fees without broadcasting | No |
|
|
118
|
+
| `--json` | flag | Output as JSON | No |
|
|
117
119
|
|
|
118
120
|
## Examples
|
|
119
121
|
|
|
@@ -168,12 +170,12 @@ npx starkfi@latest tx-status <hash>
|
|
|
168
170
|
|
|
169
171
|
## Error Handling
|
|
170
172
|
|
|
171
|
-
| Error
|
|
172
|
-
|
|
|
173
|
-
| `CONFIDENTIAL_NOT_CONFIGURED`
|
|
174
|
-
| `CONFIDENTIAL_FAILED`
|
|
175
|
-
| `Insufficient balance`
|
|
176
|
-
| `Not authenticated`
|
|
173
|
+
| Error | Action |
|
|
174
|
+
| ----------------------------- | ----------------------------------------------------------- |
|
|
175
|
+
| `CONFIDENTIAL_NOT_CONFIGURED` | Run `conf-setup` with valid Tongo key and contract address. |
|
|
176
|
+
| `CONFIDENTIAL_FAILED` | Check balance, credentials, and retry. |
|
|
177
|
+
| `Insufficient balance` | Check `conf-balance` for active balance before operations. |
|
|
178
|
+
| `Not authenticated` | Run `authenticate-wallet` skill first. |
|
|
177
179
|
|
|
178
180
|
## Related Skills
|
|
179
181
|
|
package/skills/dca/SKILL.md
CHANGED
|
@@ -64,7 +64,7 @@ npx starkfi@latest dca-list [--status <ACTIVE|CLOSED|INDEXING>] [--provider <avn
|
|
|
64
64
|
### Cancel a DCA Order
|
|
65
65
|
|
|
66
66
|
```bash
|
|
67
|
-
npx starkfi@latest dca-cancel <
|
|
67
|
+
npx starkfi@latest dca-cancel <order_id_or_address> [--provider <avnu|ekubo>] [--json]
|
|
68
68
|
```
|
|
69
69
|
|
|
70
70
|
## Parameters
|
|
@@ -74,6 +74,7 @@ npx starkfi@latest dca-cancel <order_id> [--provider <avnu|ekubo>] [--json]
|
|
|
74
74
|
| `amount` | string | Total sell amount (create) or per-cycle amount (preview) | **Yes** |
|
|
75
75
|
| `sell_token` | string | Token to sell (e.g. `STRK`, `ETH`) | **Yes** |
|
|
76
76
|
| `buy_token` | string | Token to buy (e.g. `USDC`, `ETH`) | **Yes** |
|
|
77
|
+
| `order_id_or_address` | string | The UUID OR on-chain contract address (`0x...`) from `dca-list` | **Yes** (cancel) |
|
|
77
78
|
| `--per-cycle` | string | Amount to sell per cycle | **Yes** (create) |
|
|
78
79
|
| `--frequency` | string | ISO 8601 duration (default: `P1D`=daily) | No |
|
|
79
80
|
| `--provider` | string | DCA provider: `avnu` (default) or `ekubo` | No |
|
|
@@ -113,7 +114,7 @@ npx starkfi@latest dca-list --status ACTIVE --json
|
|
|
113
114
|
|
|
114
115
|
```bash
|
|
115
116
|
npx starkfi@latest dca-list --status ACTIVE
|
|
116
|
-
npx starkfi@latest dca-cancel <
|
|
117
|
+
npx starkfi@latest dca-cancel <order_id_or_address>
|
|
117
118
|
npx starkfi@latest tx-status <hash>
|
|
118
119
|
```
|
|
119
120
|
|