@aibtc/mcp-server 1.0.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 +340 -0
- package/dist/api.d.ts +9 -0
- package/dist/api.d.ts.map +1 -0
- package/dist/api.js +79 -0
- package/dist/api.js.map +1 -0
- package/dist/config/contracts.d.ts +169 -0
- package/dist/config/contracts.d.ts.map +1 -0
- package/dist/config/contracts.js +250 -0
- package/dist/config/contracts.js.map +1 -0
- package/dist/config/index.d.ts +3 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +3 -0
- package/dist/config/index.js.map +1 -0
- package/dist/config/networks.d.ts +11 -0
- package/dist/config/networks.d.ts.map +1 -0
- package/dist/config/networks.js +21 -0
- package/dist/config/networks.js.map +1 -0
- package/dist/endpoints/index.d.ts +2 -0
- package/dist/endpoints/index.d.ts.map +1 -0
- package/dist/endpoints/index.js +2 -0
- package/dist/endpoints/index.js.map +1 -0
- package/dist/endpoints/registry.d.ts +38 -0
- package/dist/endpoints/registry.d.ts.map +1 -0
- package/dist/endpoints/registry.js +935 -0
- package/dist/endpoints/registry.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +79 -0
- package/dist/index.js.map +1 -0
- package/dist/services/bitflow.service.d.ts +159 -0
- package/dist/services/bitflow.service.d.ts.map +1 -0
- package/dist/services/bitflow.service.js +325 -0
- package/dist/services/bitflow.service.js.map +1 -0
- package/dist/services/bns.service.d.ts +87 -0
- package/dist/services/bns.service.d.ts.map +1 -0
- package/dist/services/bns.service.js +312 -0
- package/dist/services/bns.service.js.map +1 -0
- package/dist/services/defi.service.d.ts +146 -0
- package/dist/services/defi.service.d.ts.map +1 -0
- package/dist/services/defi.service.js +461 -0
- package/dist/services/defi.service.js.map +1 -0
- package/dist/services/hiro-api.d.ts +438 -0
- package/dist/services/hiro-api.d.ts.map +1 -0
- package/dist/services/hiro-api.js +376 -0
- package/dist/services/hiro-api.js.map +1 -0
- package/dist/services/nft.service.d.ts +70 -0
- package/dist/services/nft.service.d.ts.map +1 -0
- package/dist/services/nft.service.js +148 -0
- package/dist/services/nft.service.js.map +1 -0
- package/dist/services/sbtc.service.d.ts +44 -0
- package/dist/services/sbtc.service.d.ts.map +1 -0
- package/dist/services/sbtc.service.js +100 -0
- package/dist/services/sbtc.service.js.map +1 -0
- package/dist/services/scaffold.service.d.ts +41 -0
- package/dist/services/scaffold.service.d.ts.map +1 -0
- package/dist/services/scaffold.service.js +1055 -0
- package/dist/services/scaffold.service.js.map +1 -0
- package/dist/services/stacking.service.d.ts +58 -0
- package/dist/services/stacking.service.d.ts.map +1 -0
- package/dist/services/stacking.service.js +153 -0
- package/dist/services/stacking.service.js.map +1 -0
- package/dist/services/tokens.service.d.ts +62 -0
- package/dist/services/tokens.service.d.ts.map +1 -0
- package/dist/services/tokens.service.js +119 -0
- package/dist/services/tokens.service.js.map +1 -0
- package/dist/services/wallet-manager.d.ts +107 -0
- package/dist/services/wallet-manager.d.ts.map +1 -0
- package/dist/services/wallet-manager.js +389 -0
- package/dist/services/wallet-manager.js.map +1 -0
- package/dist/services/x402.service.d.ts +26 -0
- package/dist/services/x402.service.d.ts.map +1 -0
- package/dist/services/x402.service.js +125 -0
- package/dist/services/x402.service.js.map +1 -0
- package/dist/tools/bitflow.tools.d.ts +3 -0
- package/dist/tools/bitflow.tools.d.ts.map +1 -0
- package/dist/tools/bitflow.tools.js +501 -0
- package/dist/tools/bitflow.tools.js.map +1 -0
- package/dist/tools/bns.tools.d.ts +3 -0
- package/dist/tools/bns.tools.d.ts.map +1 -0
- package/dist/tools/bns.tools.js +164 -0
- package/dist/tools/bns.tools.js.map +1 -0
- package/dist/tools/contract.tools.d.ts +3 -0
- package/dist/tools/contract.tools.d.ts.map +1 -0
- package/dist/tools/contract.tools.js +126 -0
- package/dist/tools/contract.tools.js.map +1 -0
- package/dist/tools/defi.tools.d.ts +3 -0
- package/dist/tools/defi.tools.d.ts.map +1 -0
- package/dist/tools/defi.tools.js +425 -0
- package/dist/tools/defi.tools.js.map +1 -0
- package/dist/tools/endpoint.tools.d.ts +3 -0
- package/dist/tools/endpoint.tools.d.ts.map +1 -0
- package/dist/tools/endpoint.tools.js +157 -0
- package/dist/tools/endpoint.tools.js.map +1 -0
- package/dist/tools/index.d.ts +6 -0
- package/dist/tools/index.d.ts.map +1 -0
- package/dist/tools/index.js +52 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/nft.tools.d.ts +3 -0
- package/dist/tools/nft.tools.d.ts.map +1 -0
- package/dist/tools/nft.tools.js +154 -0
- package/dist/tools/nft.tools.js.map +1 -0
- package/dist/tools/openrouter.tools.d.ts +3 -0
- package/dist/tools/openrouter.tools.d.ts.map +1 -0
- package/dist/tools/openrouter.tools.js +664 -0
- package/dist/tools/openrouter.tools.js.map +1 -0
- package/dist/tools/query.tools.d.ts +3 -0
- package/dist/tools/query.tools.d.ts.map +1 -0
- package/dist/tools/query.tools.js +209 -0
- package/dist/tools/query.tools.js.map +1 -0
- package/dist/tools/sbtc.tools.d.ts +3 -0
- package/dist/tools/sbtc.tools.d.ts.map +1 -0
- package/dist/tools/sbtc.tools.js +103 -0
- package/dist/tools/sbtc.tools.js.map +1 -0
- package/dist/tools/scaffold.tools.d.ts +3 -0
- package/dist/tools/scaffold.tools.d.ts.map +1 -0
- package/dist/tools/scaffold.tools.js +216 -0
- package/dist/tools/scaffold.tools.js.map +1 -0
- package/dist/tools/stacking.tools.d.ts +3 -0
- package/dist/tools/stacking.tools.d.ts.map +1 -0
- package/dist/tools/stacking.tools.js +112 -0
- package/dist/tools/stacking.tools.js.map +1 -0
- package/dist/tools/tokens.tools.d.ts +3 -0
- package/dist/tools/tokens.tools.d.ts.map +1 -0
- package/dist/tools/tokens.tools.js +154 -0
- package/dist/tools/tokens.tools.js.map +1 -0
- package/dist/tools/transfer.tools.d.ts +3 -0
- package/dist/tools/transfer.tools.d.ts.map +1 -0
- package/dist/tools/transfer.tools.js +62 -0
- package/dist/tools/transfer.tools.js.map +1 -0
- package/dist/tools/wallet-management.tools.d.ts +6 -0
- package/dist/tools/wallet-management.tools.d.ts.map +1 -0
- package/dist/tools/wallet-management.tools.js +390 -0
- package/dist/tools/wallet-management.tools.js.map +1 -0
- package/dist/tools/wallet.tools.d.ts +3 -0
- package/dist/tools/wallet.tools.d.ts.map +1 -0
- package/dist/tools/wallet.tools.js +105 -0
- package/dist/tools/wallet.tools.js.map +1 -0
- package/dist/transactions/builder.d.ts +56 -0
- package/dist/transactions/builder.d.ts.map +1 -0
- package/dist/transactions/builder.js +134 -0
- package/dist/transactions/builder.js.map +1 -0
- package/dist/transactions/clarity-values.d.ts +67 -0
- package/dist/transactions/clarity-values.d.ts.map +1 -0
- package/dist/transactions/clarity-values.js +169 -0
- package/dist/transactions/clarity-values.js.map +1 -0
- package/dist/transactions/post-conditions.d.ts +27 -0
- package/dist/transactions/post-conditions.d.ts.map +1 -0
- package/dist/transactions/post-conditions.js +101 -0
- package/dist/transactions/post-conditions.js.map +1 -0
- package/dist/utils/encryption.d.ts +33 -0
- package/dist/utils/encryption.d.ts.map +1 -0
- package/dist/utils/encryption.js +110 -0
- package/dist/utils/encryption.js.map +1 -0
- package/dist/utils/errors.d.ts +84 -0
- package/dist/utils/errors.d.ts.map +1 -0
- package/dist/utils/errors.js +132 -0
- package/dist/utils/errors.js.map +1 -0
- package/dist/utils/formatting.d.ts +51 -0
- package/dist/utils/formatting.d.ts.map +1 -0
- package/dist/utils/formatting.js +114 -0
- package/dist/utils/formatting.js.map +1 -0
- package/dist/utils/index.d.ts +6 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/index.js +6 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/storage.d.ts +90 -0
- package/dist/utils/storage.d.ts.map +1 -0
- package/dist/utils/storage.js +196 -0
- package/dist/utils/storage.js.map +1 -0
- package/dist/utils/validation.d.ts +67 -0
- package/dist/utils/validation.d.ts.map +1 -0
- package/dist/utils/validation.js +74 -0
- package/dist/utils/validation.js.map +1 -0
- package/dist/wallet.d.ts +86 -0
- package/dist/wallet.d.ts.map +1 -0
- package/dist/wallet.js +279 -0
- package/dist/wallet.js.map +1 -0
- package/package.json +58 -0
package/README.md
ADDED
|
@@ -0,0 +1,340 @@
|
|
|
1
|
+
# @aibtc/mcp-server
|
|
2
|
+
|
|
3
|
+
An MCP (Model Context Protocol) server that gives Claude its own Stacks wallet to interact with the blockchain and x402 paid API endpoints.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Agent's Own Wallet** - Claude gets its own wallet to perform blockchain transactions
|
|
8
|
+
- **Secure Storage** - Wallets encrypted with AES-256-GCM and stored locally
|
|
9
|
+
- **50+ Tools** - Comprehensive Stacks blockchain operations
|
|
10
|
+
- **sBTC Support** - Native Bitcoin on Stacks operations
|
|
11
|
+
- **Token Operations** - SIP-010 fungible token transfers and queries
|
|
12
|
+
- **NFT Support** - SIP-009 NFT holdings, transfers, and metadata
|
|
13
|
+
- **DeFi Trading** - ALEX DEX swaps and Zest Protocol lending/borrowing
|
|
14
|
+
- **Stacking/PoX** - Stacking status and delegation
|
|
15
|
+
- **BNS Domains** - .btc domain lookups and management (V1 + V2)
|
|
16
|
+
- **x402 Payments** - Automatic payment handling for paid APIs
|
|
17
|
+
|
|
18
|
+
## Quick Start
|
|
19
|
+
|
|
20
|
+
### One-Command Install
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx @aibtc/mcp-server@latest --install
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
That's it! This automatically configures Claude Code. Restart your terminal and start chatting.
|
|
27
|
+
|
|
28
|
+
**For mainnet:**
|
|
29
|
+
```bash
|
|
30
|
+
npx @aibtc/mcp-server@latest --install --mainnet
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
> **Why npx?** Using `npx @aibtc/mcp-server@latest` ensures you always get the newest version automatically. Global installs (`npm install -g`) won't auto-update.
|
|
34
|
+
|
|
35
|
+
## Giving Claude a Wallet
|
|
36
|
+
|
|
37
|
+
When you first use @aibtc/mcp-server, Claude doesn't have a wallet. Here's the smooth onboarding flow:
|
|
38
|
+
|
|
39
|
+
### Example Conversation
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
You: What's your wallet address?
|
|
43
|
+
|
|
44
|
+
Claude: I don't have a wallet yet. Would you like to assign me one?
|
|
45
|
+
I can either create a fresh wallet or you can import an existing one.
|
|
46
|
+
|
|
47
|
+
You: Create a new wallet called "agent-wallet"
|
|
48
|
+
|
|
49
|
+
Claude: What password should I use to protect the wallet?
|
|
50
|
+
|
|
51
|
+
You: use "secure123password"
|
|
52
|
+
|
|
53
|
+
Claude: I now have a wallet! My address is ST1ABC...XYZ
|
|
54
|
+
|
|
55
|
+
IMPORTANT: Please save this recovery phrase securely:
|
|
56
|
+
"word1 word2 word3 ... word24"
|
|
57
|
+
|
|
58
|
+
This phrase will NOT be shown again. It's the only way to recover
|
|
59
|
+
the wallet if the password is forgotten.
|
|
60
|
+
|
|
61
|
+
You: Send 10 STX to ST2DEF...
|
|
62
|
+
|
|
63
|
+
Claude: Done! I've sent 10 STX to ST2DEF...
|
|
64
|
+
Transaction: 0x123...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Wallet States
|
|
68
|
+
|
|
69
|
+
| State | What Claude Says | What To Do |
|
|
70
|
+
|-------|-----------------|------------|
|
|
71
|
+
| No wallet | "I don't have a wallet yet" | Use `wallet_create` or `wallet_import` |
|
|
72
|
+
| Locked | "My wallet is locked" | Use `wallet_unlock` with password |
|
|
73
|
+
| Ready | "My address is ST..." | Claude can perform transactions |
|
|
74
|
+
|
|
75
|
+
### Session Management
|
|
76
|
+
|
|
77
|
+
- By default, the wallet auto-locks after 15 minutes
|
|
78
|
+
- You can change this with `wallet_set_timeout` (set to 0 to disable)
|
|
79
|
+
- Use `wallet_lock` to manually lock the wallet
|
|
80
|
+
- Use `wallet_unlock` when you need Claude to transact again
|
|
81
|
+
|
|
82
|
+
## Wallet Storage
|
|
83
|
+
|
|
84
|
+
Claude's wallets are stored locally on your machine:
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
~/.aibtc/
|
|
88
|
+
├── wallets.json # Wallet index (names, addresses - no secrets)
|
|
89
|
+
├── config.json # Active wallet, settings
|
|
90
|
+
└── wallets/
|
|
91
|
+
└── [wallet-id]/
|
|
92
|
+
└── keystore.json # Encrypted mnemonic (AES-256-GCM + Scrypt)
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
**Security:**
|
|
96
|
+
- AES-256-GCM encryption with Scrypt key derivation
|
|
97
|
+
- Password required to unlock
|
|
98
|
+
- Mnemonics never stored in plaintext
|
|
99
|
+
- File permissions set to owner-only (0600)
|
|
100
|
+
|
|
101
|
+
## Available Tools (50+ total)
|
|
102
|
+
|
|
103
|
+
### Wallet Management
|
|
104
|
+
| Tool | Description |
|
|
105
|
+
|------|-------------|
|
|
106
|
+
| `wallet_create` | Create a new wallet for Claude |
|
|
107
|
+
| `wallet_import` | Import an existing wallet for Claude |
|
|
108
|
+
| `wallet_unlock` | Unlock Claude's wallet |
|
|
109
|
+
| `wallet_lock` | Lock Claude's wallet |
|
|
110
|
+
| `wallet_list` | List Claude's available wallets |
|
|
111
|
+
| `wallet_switch` | Switch Claude to a different wallet |
|
|
112
|
+
| `wallet_delete` | Delete a wallet |
|
|
113
|
+
| `wallet_export` | Export wallet mnemonic |
|
|
114
|
+
| `wallet_status` | Check if Claude's wallet is ready |
|
|
115
|
+
| `wallet_set_timeout` | Set how long wallet stays unlocked |
|
|
116
|
+
|
|
117
|
+
### Wallet & Balance
|
|
118
|
+
| Tool | Description |
|
|
119
|
+
|------|-------------|
|
|
120
|
+
| `get_wallet_info` | Get Claude's wallet address and status |
|
|
121
|
+
| `get_stx_balance` | Get STX balance for any address |
|
|
122
|
+
|
|
123
|
+
### STX Transfers
|
|
124
|
+
| Tool | Description |
|
|
125
|
+
|------|-------------|
|
|
126
|
+
| `transfer_stx` | Send STX to a recipient |
|
|
127
|
+
| `broadcast_transaction` | Broadcast a pre-signed transaction |
|
|
128
|
+
|
|
129
|
+
### sBTC Operations
|
|
130
|
+
| Tool | Description |
|
|
131
|
+
|------|-------------|
|
|
132
|
+
| `sbtc_get_balance` | Get sBTC balance |
|
|
133
|
+
| `sbtc_transfer` | Send sBTC |
|
|
134
|
+
| `sbtc_get_deposit_info` | Get BTC deposit instructions |
|
|
135
|
+
| `sbtc_get_peg_info` | Get peg ratio and TVL |
|
|
136
|
+
|
|
137
|
+
### Token Operations (SIP-010)
|
|
138
|
+
| Tool | Description |
|
|
139
|
+
|------|-------------|
|
|
140
|
+
| `get_token_balance` | Get balance of any SIP-010 token |
|
|
141
|
+
| `transfer_token` | Send any SIP-010 token |
|
|
142
|
+
| `get_token_info` | Get token metadata |
|
|
143
|
+
| `list_user_tokens` | List tokens owned by an address |
|
|
144
|
+
| `get_token_holders` | Get top holders of a token |
|
|
145
|
+
|
|
146
|
+
### NFT Operations (SIP-009)
|
|
147
|
+
| Tool | Description |
|
|
148
|
+
|------|-------------|
|
|
149
|
+
| `get_nft_holdings` | List NFTs owned by an address |
|
|
150
|
+
| `get_nft_metadata` | Get NFT metadata |
|
|
151
|
+
| `transfer_nft` | Send an NFT |
|
|
152
|
+
| `get_nft_owner` | Get NFT owner |
|
|
153
|
+
| `get_collection_info` | Get NFT collection details |
|
|
154
|
+
| `get_nft_history` | Get NFT transfer history |
|
|
155
|
+
|
|
156
|
+
### Stacking / PoX
|
|
157
|
+
| Tool | Description |
|
|
158
|
+
|------|-------------|
|
|
159
|
+
| `get_pox_info` | Get current PoX cycle info |
|
|
160
|
+
| `get_stacking_status` | Check stacking status |
|
|
161
|
+
| `stack_stx` | Lock STX for stacking |
|
|
162
|
+
| `extend_stacking` | Extend stacking period |
|
|
163
|
+
|
|
164
|
+
### BNS Domains (V1 + V2)
|
|
165
|
+
| Tool | Description |
|
|
166
|
+
|------|-------------|
|
|
167
|
+
| `lookup_bns_name` | Resolve .btc domain to address |
|
|
168
|
+
| `reverse_bns_lookup` | Get .btc domain for an address |
|
|
169
|
+
| `get_bns_info` | Get domain details |
|
|
170
|
+
| `check_bns_availability` | Check if domain is available |
|
|
171
|
+
| `get_bns_price` | Get registration price |
|
|
172
|
+
| `list_user_domains` | List domains owned |
|
|
173
|
+
|
|
174
|
+
### Smart Contracts
|
|
175
|
+
| Tool | Description |
|
|
176
|
+
|------|-------------|
|
|
177
|
+
| `call_contract` | Call a smart contract function |
|
|
178
|
+
| `deploy_contract` | Deploy a Clarity smart contract |
|
|
179
|
+
| `get_transaction_status` | Check transaction status |
|
|
180
|
+
| `call_read_only_function` | Call read-only function |
|
|
181
|
+
|
|
182
|
+
### DeFi - ALEX DEX (Mainnet)
|
|
183
|
+
|
|
184
|
+
Uses the official `alex-sdk` for swap operations. Supports simple token symbols like "STX", "ALEX".
|
|
185
|
+
|
|
186
|
+
| Tool | Description |
|
|
187
|
+
|------|-------------|
|
|
188
|
+
| `alex_list_pools` | Discover all available trading pools |
|
|
189
|
+
| `alex_get_swap_quote` | Get expected output for a token swap |
|
|
190
|
+
| `alex_swap` | Execute a token swap (SDK handles routing) |
|
|
191
|
+
| `alex_get_pool_info` | Get liquidity pool reserves |
|
|
192
|
+
|
|
193
|
+
### DeFi - Zest Protocol (Mainnet)
|
|
194
|
+
|
|
195
|
+
Supports 10 assets: sBTC, aeUSDC, stSTX, wSTX, USDH, sUSDT, USDA, DIKO, ALEX, stSTX-BTC
|
|
196
|
+
|
|
197
|
+
| Tool | Description |
|
|
198
|
+
|------|-------------|
|
|
199
|
+
| `zest_list_assets` | List all supported lending assets |
|
|
200
|
+
| `zest_get_position` | Get user's supply/borrow position |
|
|
201
|
+
| `zest_supply` | Supply assets to earn interest |
|
|
202
|
+
| `zest_withdraw` | Withdraw supplied assets |
|
|
203
|
+
| `zest_borrow` | Borrow against collateral |
|
|
204
|
+
| `zest_repay` | Repay borrowed assets |
|
|
205
|
+
|
|
206
|
+
### Blockchain Queries
|
|
207
|
+
| Tool | Description |
|
|
208
|
+
|------|-------------|
|
|
209
|
+
| `get_account_info` | Get account nonce, balance |
|
|
210
|
+
| `get_account_transactions` | List transaction history |
|
|
211
|
+
| `get_block_info` | Get block details |
|
|
212
|
+
| `get_mempool_info` | Get pending transactions |
|
|
213
|
+
| `get_contract_info` | Get contract ABI and source |
|
|
214
|
+
| `get_contract_events` | Get contract event history |
|
|
215
|
+
| `get_network_status` | Get network health status |
|
|
216
|
+
|
|
217
|
+
### x402 API Endpoints
|
|
218
|
+
| Tool | Description |
|
|
219
|
+
|------|-------------|
|
|
220
|
+
| `list_x402_endpoints` | Discover x402 endpoints |
|
|
221
|
+
| `execute_x402_endpoint` | Execute x402 endpoint with auto-payment |
|
|
222
|
+
|
|
223
|
+
## Usage Examples
|
|
224
|
+
|
|
225
|
+
**Wallet management:**
|
|
226
|
+
> "What's your wallet address?"
|
|
227
|
+
> "Create a wallet for yourself"
|
|
228
|
+
> "Unlock your wallet"
|
|
229
|
+
> "Keep your wallet unlocked for 1 hour"
|
|
230
|
+
|
|
231
|
+
**Check balances:**
|
|
232
|
+
> "How much STX do you have?"
|
|
233
|
+
> "What's your sBTC balance?"
|
|
234
|
+
|
|
235
|
+
**Transfer tokens:**
|
|
236
|
+
> "Send 2 STX to ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM"
|
|
237
|
+
> "Transfer 0.001 sBTC to muneeb.btc"
|
|
238
|
+
|
|
239
|
+
**NFTs:**
|
|
240
|
+
> "What NFTs do you own?"
|
|
241
|
+
> "Send this NFT to alice.btc"
|
|
242
|
+
|
|
243
|
+
**BNS domains:**
|
|
244
|
+
> "What address is satoshi.btc?"
|
|
245
|
+
> "Is myname.btc available?"
|
|
246
|
+
|
|
247
|
+
**DeFi trading (mainnet):**
|
|
248
|
+
> "What pools are available on ALEX?"
|
|
249
|
+
> "Swap 0.1 STX for ALEX"
|
|
250
|
+
> "Get a quote for 100 STX to ALEX"
|
|
251
|
+
> "What assets can I lend on Zest?"
|
|
252
|
+
> "Supply 100 stSTX to Zest"
|
|
253
|
+
> "Borrow 50 aeUSDC from Zest"
|
|
254
|
+
> "Check my Zest position"
|
|
255
|
+
|
|
256
|
+
**x402 endpoints:**
|
|
257
|
+
> "Get trending liquidity pools"
|
|
258
|
+
> "Tell me a dad joke"
|
|
259
|
+
|
|
260
|
+
## Supported Tokens
|
|
261
|
+
|
|
262
|
+
Well-known tokens can be referenced by symbol:
|
|
263
|
+
- **sBTC** - Native Bitcoin on Stacks
|
|
264
|
+
- **USDCx** - USD Coin on Stacks
|
|
265
|
+
- **ALEX** - ALEX governance token
|
|
266
|
+
- **wSTX** - Wrapped STX
|
|
267
|
+
|
|
268
|
+
**ALEX DEX tokens:** STX, ALEX, and any token from `alex_list_pools`
|
|
269
|
+
|
|
270
|
+
**Zest Protocol assets:** sBTC, aeUSDC, stSTX, wSTX, USDH, sUSDT, USDA, DIKO, ALEX, stSTX-BTC
|
|
271
|
+
|
|
272
|
+
Or use any SIP-010 token by contract ID: `SP2X...::token-name`
|
|
273
|
+
|
|
274
|
+
## Configuration
|
|
275
|
+
|
|
276
|
+
| Environment Variable | Description | Default |
|
|
277
|
+
|---------------------|-------------|---------|
|
|
278
|
+
| `NETWORK` | `mainnet` or `testnet` | `testnet` |
|
|
279
|
+
| `API_URL` | Default x402 API base URL | `https://x402.biwas.xyz` |
|
|
280
|
+
| `CLIENT_MNEMONIC` | (Optional) Pre-configured mnemonic | - |
|
|
281
|
+
|
|
282
|
+
**Note:** `CLIENT_MNEMONIC` is optional. The recommended approach is to let Claude create its own wallet.
|
|
283
|
+
|
|
284
|
+
## Architecture
|
|
285
|
+
|
|
286
|
+
```
|
|
287
|
+
You ←→ Claude ←→ aibtc-mcp-server
|
|
288
|
+
↓
|
|
289
|
+
Claude's Wallet (~/.aibtc/)
|
|
290
|
+
↓
|
|
291
|
+
┌─────────┴─────────┐
|
|
292
|
+
↓ ↓
|
|
293
|
+
Hiro Stacks API x402 Endpoints
|
|
294
|
+
↓ ↓
|
|
295
|
+
Stacks Blockchain Paid API Services
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
## Security Notes
|
|
299
|
+
|
|
300
|
+
- Claude's wallet is stored encrypted on YOUR machine
|
|
301
|
+
- Password is never stored - only the encrypted keystore
|
|
302
|
+
- Mnemonics shown only once at creation
|
|
303
|
+
- Auto-lock after 15 minutes (configurable)
|
|
304
|
+
- Transactions signed locally before broadcast
|
|
305
|
+
- For mainnet: Fund with small amounts first
|
|
306
|
+
|
|
307
|
+
## Advanced: Pre-configured Mnemonic
|
|
308
|
+
|
|
309
|
+
For automated setups where Claude needs immediate wallet access, set the `CLIENT_MNEMONIC` environment variable in your `~/.claude.json`:
|
|
310
|
+
|
|
311
|
+
```json
|
|
312
|
+
{
|
|
313
|
+
"mcpServers": {
|
|
314
|
+
"aibtc": {
|
|
315
|
+
"command": "npx",
|
|
316
|
+
"args": ["@aibtc/mcp-server@latest"],
|
|
317
|
+
"env": {
|
|
318
|
+
"CLIENT_MNEMONIC": "your twenty four word mnemonic phrase",
|
|
319
|
+
"NETWORK": "testnet"
|
|
320
|
+
}
|
|
321
|
+
}
|
|
322
|
+
}
|
|
323
|
+
}
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
This bypasses the wallet creation flow - Claude has immediate access to transact.
|
|
327
|
+
|
|
328
|
+
## Development
|
|
329
|
+
|
|
330
|
+
```bash
|
|
331
|
+
git clone https://github.com/aibtcdev/aibtc-mcp-server.git
|
|
332
|
+
cd aibtc-mcp-server
|
|
333
|
+
npm install
|
|
334
|
+
npm run build
|
|
335
|
+
npm run dev # Run with tsx (development)
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
## License
|
|
339
|
+
|
|
340
|
+
MIT
|
package/dist/api.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import "dotenv/config";
|
|
2
|
+
import { type AxiosInstance } from "axios";
|
|
3
|
+
import { type Network } from "./wallet.js";
|
|
4
|
+
export declare const NETWORK: Network;
|
|
5
|
+
export declare const API_URL: string;
|
|
6
|
+
export declare function createApiClient(baseUrl?: string): Promise<AxiosInstance>;
|
|
7
|
+
export declare function getWalletAddress(): Promise<string>;
|
|
8
|
+
export declare function getAccount(): Promise<import("./wallet.js").Account>;
|
|
9
|
+
//# sourceMappingURL=api.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AACvB,OAAc,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC;AAElD,OAAO,EAAqB,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AAE9D,eAAO,MAAM,OAAO,EAAE,OACqC,CAAC;AAC5D,eAAO,MAAM,OAAO,QAAkD,CAAC;AAKvE,wBAAsB,eAAe,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAgE9E;AAED,wBAAgB,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC,CAMlD;AAED,wBAAsB,UAAU,2CAM/B"}
|
package/dist/api.js
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import "dotenv/config";
|
|
2
|
+
import axios from "axios";
|
|
3
|
+
import { withPaymentInterceptor } from "x402-stacks";
|
|
4
|
+
import { mnemonicToAccount } from "./wallet.js";
|
|
5
|
+
export const NETWORK = process.env.NETWORK === "mainnet" ? "mainnet" : "testnet";
|
|
6
|
+
export const API_URL = process.env.API_URL || "https://x402.biwas.xyz";
|
|
7
|
+
// Cache clients by base URL
|
|
8
|
+
const clientCache = new Map();
|
|
9
|
+
export async function createApiClient(baseUrl) {
|
|
10
|
+
const url = baseUrl || API_URL;
|
|
11
|
+
// Check cache
|
|
12
|
+
const cached = clientCache.get(url);
|
|
13
|
+
if (cached) {
|
|
14
|
+
return cached;
|
|
15
|
+
}
|
|
16
|
+
const mnemonic = process.env.CLIENT_MNEMONIC || "";
|
|
17
|
+
if (!mnemonic) {
|
|
18
|
+
throw new Error("CLIENT_MNEMONIC is required in environment variables");
|
|
19
|
+
}
|
|
20
|
+
const account = await mnemonicToAccount(mnemonic, NETWORK);
|
|
21
|
+
const axiosInstance = axios.create({
|
|
22
|
+
baseURL: url,
|
|
23
|
+
timeout: 60000,
|
|
24
|
+
transformResponse: [
|
|
25
|
+
(data) => {
|
|
26
|
+
if (typeof data !== "string") {
|
|
27
|
+
return data;
|
|
28
|
+
}
|
|
29
|
+
const trimmed = data.trim();
|
|
30
|
+
if (!trimmed) {
|
|
31
|
+
return data;
|
|
32
|
+
}
|
|
33
|
+
try {
|
|
34
|
+
return JSON.parse(trimmed);
|
|
35
|
+
}
|
|
36
|
+
catch {
|
|
37
|
+
return data;
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
],
|
|
41
|
+
});
|
|
42
|
+
// Ensure 402 payloads are parsed before x402-stacks validates them
|
|
43
|
+
axiosInstance.interceptors.response.use((response) => response, (error) => {
|
|
44
|
+
const data = error?.response?.data;
|
|
45
|
+
if (error?.response?.status === 402) {
|
|
46
|
+
console.error("x402 debug 402 payload", typeof data === "string" ? data : JSON.stringify(data));
|
|
47
|
+
}
|
|
48
|
+
if (typeof data === "string") {
|
|
49
|
+
const trimmed = data.trim();
|
|
50
|
+
if (trimmed) {
|
|
51
|
+
try {
|
|
52
|
+
error.response.data = JSON.parse(trimmed);
|
|
53
|
+
}
|
|
54
|
+
catch {
|
|
55
|
+
// Leave as-is if it's not JSON
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
return Promise.reject(error);
|
|
60
|
+
});
|
|
61
|
+
const client = withPaymentInterceptor(axiosInstance, account);
|
|
62
|
+
clientCache.set(url, client);
|
|
63
|
+
return client;
|
|
64
|
+
}
|
|
65
|
+
export function getWalletAddress() {
|
|
66
|
+
const mnemonic = process.env.CLIENT_MNEMONIC || "";
|
|
67
|
+
if (!mnemonic) {
|
|
68
|
+
throw new Error("CLIENT_MNEMONIC is required in environment variables");
|
|
69
|
+
}
|
|
70
|
+
return mnemonicToAccount(mnemonic, NETWORK).then((account) => account.address);
|
|
71
|
+
}
|
|
72
|
+
export async function getAccount() {
|
|
73
|
+
const mnemonic = process.env.CLIENT_MNEMONIC || "";
|
|
74
|
+
if (!mnemonic) {
|
|
75
|
+
throw new Error("CLIENT_MNEMONIC is required in environment variables");
|
|
76
|
+
}
|
|
77
|
+
return mnemonicToAccount(mnemonic, NETWORK);
|
|
78
|
+
}
|
|
79
|
+
//# sourceMappingURL=api.js.map
|
package/dist/api.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AACvB,OAAO,KAA6B,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAgB,MAAM,aAAa,CAAC;AAE9D,MAAM,CAAC,MAAM,OAAO,GAClB,OAAO,CAAC,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;AAC5D,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,wBAAwB,CAAC;AAEvE,4BAA4B;AAC5B,MAAM,WAAW,GAA+B,IAAI,GAAG,EAAE,CAAC;AAE1D,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAgB;IACpD,MAAM,GAAG,GAAG,OAAO,IAAI,OAAO,CAAC;IAE/B,cAAc;IACd,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC;IACnD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC;QACjC,OAAO,EAAE,GAAG;QACZ,OAAO,EAAE,KAAK;QACd,iBAAiB,EAAE;YACjB,CAAC,IAAI,EAAE,EAAE;gBACP,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC7B,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC5B,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,IAAI,CAAC;oBACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC7B,CAAC;gBAAC,MAAM,CAAC;oBACP,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;SACF;KACF,CAAC,CAAC;IAEH,mEAAmE;IACnE,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CACrC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,EACtB,CAAC,KAAK,EAAE,EAAE;QACR,MAAM,IAAI,GAAG,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC;QACnC,IAAI,KAAK,EAAE,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;YACpC,OAAO,CAAC,KAAK,CACX,wBAAwB,EACxB,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACvD,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,CAAC;oBACH,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC5C,CAAC;gBAAC,MAAM,CAAC;oBACP,+BAA+B;gBACjC,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC,CACF,CAAC;IAEF,MAAM,MAAM,GAAG,sBAAsB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC9D,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC7B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC;IACnD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU;IAC9B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC;IACnD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAC9C,CAAC"}
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
import { Network } from "./networks.js";
|
|
2
|
+
/**
|
|
3
|
+
* Known contract addresses for mainnet
|
|
4
|
+
*/
|
|
5
|
+
export declare const MAINNET_CONTRACTS: {
|
|
6
|
+
readonly SBTC_TOKEN: "SM3VDXK3WZZSA84XXFQ5FDMR6S8N5XQSEK4KMR5E5.sbtc-token";
|
|
7
|
+
readonly SBTC_DEPOSIT: "SM3VDXK3WZZSA84XXFQ5FDMR6S8N5XQSEK4KMR5E5.sbtc-deposit";
|
|
8
|
+
readonly SBTC_REGISTRY: "SM3VDXK3WZZSA84XXFQ5FDMR6S8N5XQSEK4KMR5E5.sbtc-registry";
|
|
9
|
+
readonly USDCX: "SP2XD7417HGPRTREMKF748VNEQPDRR0RMANB7X1NK.token-usdcx";
|
|
10
|
+
readonly BNS: "SP000000000000000000002Q6VF78.bns";
|
|
11
|
+
readonly POX_4: "SP000000000000000000002Q6VF78.pox-4";
|
|
12
|
+
readonly ALEX_AMM_POOL: "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.amm-swap-pool-v1-1";
|
|
13
|
+
readonly ALEX_TOKEN: "SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM.token-alex";
|
|
14
|
+
readonly ALEX_WSTX: "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx-v2";
|
|
15
|
+
readonly ZEST_POOL_BORROW: "SP2VCQJGH7PHP2DJK7Z0V48AGBHQAW3R3ZW1QF4N.pool-borrow-v2-3";
|
|
16
|
+
readonly ZEST_POOL_RESERVE: "SP2VCQJGH7PHP2DJK7Z0V48AGBHQAW3R3ZW1QF4N.pool-0-reserve";
|
|
17
|
+
readonly ZEST_FEES_CALCULATOR: "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.fees-calculator";
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* Zest Protocol asset configuration
|
|
21
|
+
* Each asset has: token, lpToken, oracle, decimals, symbol
|
|
22
|
+
*/
|
|
23
|
+
export interface ZestAssetConfig {
|
|
24
|
+
token: string;
|
|
25
|
+
lpToken: string;
|
|
26
|
+
oracle: string;
|
|
27
|
+
decimals: number;
|
|
28
|
+
symbol: string;
|
|
29
|
+
name: string;
|
|
30
|
+
}
|
|
31
|
+
export declare const ZEST_ASSETS: Record<string, ZestAssetConfig>;
|
|
32
|
+
/**
|
|
33
|
+
* Ordered list of Zest assets for building the assets-list parameter
|
|
34
|
+
* Order matters for contract calls
|
|
35
|
+
*/
|
|
36
|
+
export declare const ZEST_ASSETS_LIST: ZestAssetConfig[];
|
|
37
|
+
/**
|
|
38
|
+
* Known contract addresses for testnet
|
|
39
|
+
*/
|
|
40
|
+
export declare const TESTNET_CONTRACTS: {
|
|
41
|
+
readonly SBTC_TOKEN: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.sbtc-token";
|
|
42
|
+
readonly SBTC_DEPOSIT: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.sbtc-deposit";
|
|
43
|
+
readonly SBTC_REGISTRY: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.sbtc-registry";
|
|
44
|
+
readonly USDCX: "ST2XD7417HGPRTREMKF748VNEQPDRR0RMANB7X1NK.token-usdcx";
|
|
45
|
+
readonly BNS: "ST000000000000000000002AMW42H.bns";
|
|
46
|
+
readonly POX_4: "ST000000000000000000002AMW42H.pox-4";
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* Get contract addresses for the specified network
|
|
50
|
+
*/
|
|
51
|
+
export declare function getContracts(network: Network): {
|
|
52
|
+
readonly SBTC_TOKEN: "SM3VDXK3WZZSA84XXFQ5FDMR6S8N5XQSEK4KMR5E5.sbtc-token";
|
|
53
|
+
readonly SBTC_DEPOSIT: "SM3VDXK3WZZSA84XXFQ5FDMR6S8N5XQSEK4KMR5E5.sbtc-deposit";
|
|
54
|
+
readonly SBTC_REGISTRY: "SM3VDXK3WZZSA84XXFQ5FDMR6S8N5XQSEK4KMR5E5.sbtc-registry";
|
|
55
|
+
readonly USDCX: "SP2XD7417HGPRTREMKF748VNEQPDRR0RMANB7X1NK.token-usdcx";
|
|
56
|
+
readonly BNS: "SP000000000000000000002Q6VF78.bns";
|
|
57
|
+
readonly POX_4: "SP000000000000000000002Q6VF78.pox-4";
|
|
58
|
+
readonly ALEX_AMM_POOL: "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.amm-swap-pool-v1-1";
|
|
59
|
+
readonly ALEX_TOKEN: "SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM.token-alex";
|
|
60
|
+
readonly ALEX_WSTX: "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx-v2";
|
|
61
|
+
readonly ZEST_POOL_BORROW: "SP2VCQJGH7PHP2DJK7Z0V48AGBHQAW3R3ZW1QF4N.pool-borrow-v2-3";
|
|
62
|
+
readonly ZEST_POOL_RESERVE: "SP2VCQJGH7PHP2DJK7Z0V48AGBHQAW3R3ZW1QF4N.pool-0-reserve";
|
|
63
|
+
readonly ZEST_FEES_CALCULATOR: "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.fees-calculator";
|
|
64
|
+
} | {
|
|
65
|
+
readonly SBTC_TOKEN: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.sbtc-token";
|
|
66
|
+
readonly SBTC_DEPOSIT: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.sbtc-deposit";
|
|
67
|
+
readonly SBTC_REGISTRY: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.sbtc-registry";
|
|
68
|
+
readonly USDCX: "ST2XD7417HGPRTREMKF748VNEQPDRR0RMANB7X1NK.token-usdcx";
|
|
69
|
+
readonly BNS: "ST000000000000000000002AMW42H.bns";
|
|
70
|
+
readonly POX_4: "ST000000000000000000002AMW42H.pox-4";
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* Parse a contract identifier into address and name
|
|
74
|
+
*/
|
|
75
|
+
export declare function parseContractId(contractId: string): {
|
|
76
|
+
address: string;
|
|
77
|
+
name: string;
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* Fallback token contract IDs (used only when dynamic resolution fails)
|
|
81
|
+
* Prefer using resolveTokenSymbol() which checks user balances first
|
|
82
|
+
*/
|
|
83
|
+
export declare const WELL_KNOWN_TOKENS: {
|
|
84
|
+
readonly mainnet: {
|
|
85
|
+
readonly STX: "native";
|
|
86
|
+
readonly sBTC: "SM3VDXK3WZZSA84XXFQ5FDMR6S8N5XQSEK4KMR5E5.sbtc-token";
|
|
87
|
+
readonly USDCx: "SP2XD7417HGPRTREMKF748VNEQPDRR0RMANB7X1NK.token-usdcx";
|
|
88
|
+
readonly ALEX: "SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM.token-alex";
|
|
89
|
+
readonly wSTX: "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx-v2";
|
|
90
|
+
};
|
|
91
|
+
readonly testnet: {
|
|
92
|
+
readonly STX: "native";
|
|
93
|
+
readonly sBTC: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.sbtc-token";
|
|
94
|
+
readonly USDCx: "ST2XD7417HGPRTREMKF748VNEQPDRR0RMANB7X1NK.token-usdcx";
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
/**
|
|
98
|
+
* Get ALEX DEX contract addresses for the network
|
|
99
|
+
* Note: Most ALEX operations use the alex-sdk, but we need the pool contract for queries
|
|
100
|
+
*/
|
|
101
|
+
export declare function getAlexContracts(network: Network): {
|
|
102
|
+
ammPool: "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.amm-swap-pool-v1-1";
|
|
103
|
+
} | null;
|
|
104
|
+
/**
|
|
105
|
+
* Get Zest Protocol contract addresses for the network
|
|
106
|
+
*/
|
|
107
|
+
export declare function getZestContracts(network: Network): {
|
|
108
|
+
poolBorrow: "SP2VCQJGH7PHP2DJK7Z0V48AGBHQAW3R3ZW1QF4N.pool-borrow-v2-3";
|
|
109
|
+
poolReserve: "SP2VCQJGH7PHP2DJK7Z0V48AGBHQAW3R3ZW1QF4N.pool-0-reserve";
|
|
110
|
+
feesCalculator: "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.fees-calculator";
|
|
111
|
+
} | null;
|
|
112
|
+
export declare function getWellKnownTokens(network: Network): {
|
|
113
|
+
readonly STX: "native";
|
|
114
|
+
readonly sBTC: "SM3VDXK3WZZSA84XXFQ5FDMR6S8N5XQSEK4KMR5E5.sbtc-token";
|
|
115
|
+
readonly USDCx: "SP2XD7417HGPRTREMKF748VNEQPDRR0RMANB7X1NK.token-usdcx";
|
|
116
|
+
readonly ALEX: "SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM.token-alex";
|
|
117
|
+
readonly wSTX: "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx-v2";
|
|
118
|
+
} | {
|
|
119
|
+
readonly STX: "native";
|
|
120
|
+
readonly sBTC: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.sbtc-token";
|
|
121
|
+
readonly USDCx: "ST2XD7417HGPRTREMKF748VNEQPDRR0RMANB7X1NK.token-usdcx";
|
|
122
|
+
};
|
|
123
|
+
/**
|
|
124
|
+
* Bitflow DEX contract addresses
|
|
125
|
+
*/
|
|
126
|
+
export declare const BITFLOW_CONTRACTS: {
|
|
127
|
+
readonly mainnet: {
|
|
128
|
+
readonly PRIMARY: "SPQC38PW542EQJ5M11CR25P7BS1CA6QT4TBXGB3M";
|
|
129
|
+
readonly XYK: "SM1793C4R5PZ4NS4VQ4WMP7SKKYVH8JZEWSZ9HCCR";
|
|
130
|
+
};
|
|
131
|
+
readonly testnet: {
|
|
132
|
+
readonly PRIMARY: "STRP7MYBHSMFH5EGN3HGX6KNQ7QBHVTBPF1669DW";
|
|
133
|
+
readonly XYK: null;
|
|
134
|
+
};
|
|
135
|
+
};
|
|
136
|
+
/**
|
|
137
|
+
* Bitflow configuration
|
|
138
|
+
*/
|
|
139
|
+
export interface BitflowConfig {
|
|
140
|
+
apiHost: string;
|
|
141
|
+
apiKey: string | undefined;
|
|
142
|
+
readOnlyCallApiHost: string;
|
|
143
|
+
keeperApiHost?: string;
|
|
144
|
+
keeperApiKey?: string;
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* Get Bitflow configuration from environment
|
|
148
|
+
*
|
|
149
|
+
* TODO: Once API keys are obtained from Bitflow team:
|
|
150
|
+
* 1. Set BITFLOW_API_KEY and BITFLOW_API_HOST environment variables
|
|
151
|
+
* 2. Optionally set BITFLOW_KEEPER_API_KEY and BITFLOW_KEEPER_API_HOST for Keeper features
|
|
152
|
+
* 3. Consider moving keys to Cloudflare Worker proxy for secure npm distribution
|
|
153
|
+
*/
|
|
154
|
+
export declare function getBitflowConfig(): BitflowConfig | null;
|
|
155
|
+
/**
|
|
156
|
+
* Get Bitflow contract addresses for the network
|
|
157
|
+
*/
|
|
158
|
+
export declare function getBitflowContracts(network: Network): {
|
|
159
|
+
readonly PRIMARY: "SPQC38PW542EQJ5M11CR25P7BS1CA6QT4TBXGB3M";
|
|
160
|
+
readonly XYK: "SM1793C4R5PZ4NS4VQ4WMP7SKKYVH8JZEWSZ9HCCR";
|
|
161
|
+
} | {
|
|
162
|
+
readonly PRIMARY: "STRP7MYBHSMFH5EGN3HGX6KNQ7QBHVTBPF1669DW";
|
|
163
|
+
readonly XYK: null;
|
|
164
|
+
};
|
|
165
|
+
/**
|
|
166
|
+
* Bitflow public API base URL (no API key required)
|
|
167
|
+
*/
|
|
168
|
+
export declare const BITFLOW_PUBLIC_API = "https://bitflow-sdk-api-gateway-7owjsmt8.uc.gateway.dev";
|
|
169
|
+
//# sourceMappingURL=contracts.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../../src/config/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;CAwBpB,CAAC;AAEX;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAiFvD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,eAAe,EAW7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;CAcpB,CAAC;AAEX;;GAEG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO;;;;;;;;;;;;;;;;;;;;EAE5C;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAMrF;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;CAapB,CAAC;AAEX;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO;;SAQhD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO;;;;SAUhD;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO;;;;;;;;;;EAElD;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;CAWpB,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,IAAI,aAAa,GAAG,IAAI,CAiBvD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO;;;;;;EAEnD;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,4DAA4D,CAAC"}
|