midnight-wallet-cli 0.2.5 → 0.4.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/LICENSE +201 -0
- package/README.md +95 -20
- package/dist/mcp-server.js +1130 -237
- package/dist/wallet.js +1528 -377
- package/docs/SKILL.md +136 -0
- package/package.json +34 -8
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for describing the origin of the Work and
|
|
141
|
+
reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Support. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or support.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2025 Norman Lopez
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# midnight-wallet-cli
|
|
2
2
|
|
|
3
|
-
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/midnight-wallet-cli)
|
|
6
6
|
[](https://npm-stat.com/charts.html?package=midnight-wallet-cli)
|
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
|
|
11
11
|
A standalone CLI wallet for the Midnight blockchain. Manage wallets, check balances, transfer NIGHT tokens, and run a local network — all from the terminal.
|
|
12
12
|
|
|
13
|
+
Built for two audiences: **beginners** starting their first Midnight project (localnet + funded wallets + contract deploy in under 5 minutes), and **AI agents** (Cursor, Claude Code, any MCP client) using the same primitives via a built-in MCP server.
|
|
14
|
+
|
|
13
15
|
## Install
|
|
14
16
|
|
|
15
17
|
```bash
|
|
@@ -28,19 +30,26 @@ This installs two commands: `midnight` (or `mn` for short) and `midnight-wallet-
|
|
|
28
30
|
| `midnight wallet info [name]` | Show wallet details |
|
|
29
31
|
| `midnight wallet remove <name>` | Remove a wallet |
|
|
30
32
|
| `midnight info` | Display wallet address, network, creation date |
|
|
31
|
-
| `midnight balance [address]` | Check unshielded NIGHT balance |
|
|
32
|
-
| `midnight transfer <to> <amount>` | Send NIGHT tokens
|
|
33
|
-
| `midnight airdrop <amount>` | Fund wallet from genesis (undeployed
|
|
33
|
+
| `midnight balance [address]` | Check unshielded + shielded NIGHT balance |
|
|
34
|
+
| `midnight transfer <to> <amount>` | Send NIGHT tokens (`--shielded` for shielded) |
|
|
35
|
+
| `midnight airdrop <amount>` | Fund wallet from genesis (`--shielded` for shielded, undeployed only) |
|
|
34
36
|
| `midnight dust register` | Register NIGHT UTXOs for dust (fee token) generation |
|
|
35
37
|
| `midnight dust status` | Check dust registration status and balance |
|
|
36
38
|
| `midnight address --seed <hex>` | Derive an address from a seed |
|
|
37
39
|
| `midnight genesis-address` | Show the genesis wallet address |
|
|
38
40
|
| `midnight inspect-cost` | Display current block cost limits |
|
|
39
41
|
| `midnight serve` | Start DApp Connector server (WebSocket JSON-RPC) |
|
|
40
|
-
| `midnight
|
|
42
|
+
| `midnight contract inspect` | Show circuits, witnesses, and types for a compiled contract |
|
|
43
|
+
| `midnight contract deploy` | Deploy a contract to the network |
|
|
44
|
+
| `midnight contract call` | Call a circuit on a deployed contract |
|
|
45
|
+
| `midnight contract state` | Read ledger state of a deployed contract |
|
|
46
|
+
| `midnight dev` | Contract dev loop — watcher auto-compiles on save; `[t]` runs tests, `[d]` deploys |
|
|
47
|
+
| `midnight test create/run/list/results` | Generate and run E2E tests for Midnight dApps |
|
|
48
|
+
| `midnight config get/set/unset` | Manage persistent config (network, wallet, endpoints) |
|
|
41
49
|
| `midnight cache clear` | Clear wallet state cache |
|
|
42
|
-
| `midnight localnet up/stop/down/status` | Manage a local Midnight network via Docker |
|
|
50
|
+
| `midnight localnet up/stop/down/status/logs/clean` | Manage a local Midnight network via Docker |
|
|
43
51
|
| `midnight help [command]` | Show usage for all or a specific command |
|
|
52
|
+
| `midnight manual` | Full reference manual (every command, every flag) |
|
|
44
53
|
|
|
45
54
|
## Quick Start
|
|
46
55
|
|
|
@@ -130,15 +139,15 @@ Every command supports `--json` for structured output:
|
|
|
130
139
|
|
|
131
140
|
```bash
|
|
132
141
|
midnight balance --json
|
|
133
|
-
# → {"address":"mn_addr_...","network":"undeployed","
|
|
142
|
+
# → {"address":"mn_addr_...","shieldedAddress":"mn_shield-addr_...","network":"undeployed","unshielded":{"NIGHT":"1000.000000","utxoCount":1},"shielded":{"NIGHT":"10.000000","availableCoins":1,"pendingCoins":0}}
|
|
134
143
|
|
|
135
|
-
midnight transfer
|
|
144
|
+
midnight transfer alice 100 --json
|
|
136
145
|
# → {"txHash":"00ab...","amount":100,"recipient":"mn_addr_...","network":"undeployed"}
|
|
137
146
|
```
|
|
138
147
|
|
|
139
148
|
When `--json` is active:
|
|
140
|
-
- stdout receives a single line of JSON
|
|
141
|
-
- stderr
|
|
149
|
+
- stdout receives a single line of JSON (the data)
|
|
150
|
+
- stderr keeps showing chrome (spinners, headers, progress) — pipe through `2>/dev/null` if you need it gone
|
|
142
151
|
- Errors produce: `{"error":true,"code":"...","message":"...","exitCode":N}`
|
|
143
152
|
|
|
144
153
|
Run `midnight help --json` for a full capability manifest, or `midnight help --agent` for a comprehensive AI agent reference.
|
|
@@ -222,25 +231,25 @@ Add to `~/.codeium/windsurf/mcp_config.json`:
|
|
|
222
231
|
|
|
223
232
|
### Available MCP Tools
|
|
224
233
|
|
|
225
|
-
Once connected, your AI agent gets access to
|
|
234
|
+
Once connected, your AI agent gets access to 30 tools:
|
|
226
235
|
|
|
227
236
|
| Tool | Description |
|
|
228
237
|
|------|-------------|
|
|
229
238
|
| `midnight_wallet_generate` | Create a named wallet |
|
|
230
|
-
| `midnight_wallet_list` | List all wallets |
|
|
239
|
+
| `midnight_wallet_list` | List all wallets (slim by default — see "Agent-slim responses" below) |
|
|
231
240
|
| `midnight_wallet_use` | Set active wallet |
|
|
232
|
-
| `midnight_wallet_info` | Show wallet details |
|
|
241
|
+
| `midnight_wallet_info` | Show wallet details (slim by default) |
|
|
233
242
|
| `midnight_wallet_remove` | Remove a wallet |
|
|
234
|
-
| `midnight_generate` | Generate a wallet (deprecated) |
|
|
235
243
|
| `midnight_info` | Show wallet info (no secrets) |
|
|
236
|
-
| `midnight_balance` | Check NIGHT balance |
|
|
244
|
+
| `midnight_balance` | Check NIGHT balance (slim by default) |
|
|
237
245
|
| `midnight_address` | Derive address from seed |
|
|
238
246
|
| `midnight_genesis_address` | Show genesis wallet address |
|
|
239
247
|
| `midnight_inspect_cost` | Show block cost limits |
|
|
240
248
|
| `midnight_airdrop` | Fund wallet from genesis |
|
|
241
|
-
| `midnight_transfer` | Send NIGHT tokens |
|
|
249
|
+
| `midnight_transfer` | Send NIGHT tokens (returns a pending token; confirm with `midnight_confirm_operation`) |
|
|
250
|
+
| `midnight_confirm_operation` | Execute a previously-returned pending operation (transfer/contract confirmation flow) |
|
|
242
251
|
| `midnight_dust_register` | Register UTXOs for dust generation |
|
|
243
|
-
| `midnight_dust_status` | Check dust status |
|
|
252
|
+
| `midnight_dust_status` | Check dust status (slim by default) |
|
|
244
253
|
| `midnight_config_get` | Read config value |
|
|
245
254
|
| `midnight_config_set` | Write config value |
|
|
246
255
|
| `midnight_config_unset` | Remove config value |
|
|
@@ -250,15 +259,81 @@ Once connected, your AI agent gets access to 24 tools:
|
|
|
250
259
|
| `midnight_localnet_down` | Remove local network |
|
|
251
260
|
| `midnight_localnet_status` | Show service status |
|
|
252
261
|
| `midnight_localnet_clean` | Remove conflicting containers |
|
|
262
|
+
| `midnight_localnet_logs` | Snapshot of recent logs from each service |
|
|
263
|
+
| `midnight_contract_inspect` | Read circuits, witnesses, ledger shape from a compiled contract; lists `siblings` for multi-contract projects |
|
|
264
|
+
| `midnight_contract_state` | Query a deployed contract's ledger state |
|
|
265
|
+
| `midnight_contract_deploy` | Deploy a compiled contract (returns pending token; confirm with `midnight_confirm_operation`) |
|
|
266
|
+
| `midnight_contract_call` | Call a circuit on a deployed contract (returns pending token; auto-coerces numbers/`"123n"` strings to BigInt and `[0–255]` arrays to Uint8Array) |
|
|
267
|
+
| `midnight_test_create` | Generate a CLI or browser test scaffold from the compiled contract |
|
|
253
268
|
|
|
254
|
-
|
|
269
|
+
Every response carries `_serverVersion` so a stale MCP server (CLI on disk says X, responses still say Y) is detectable — see "Stale MCP server" in `docs/SKILL.md`.
|
|
270
|
+
|
|
271
|
+
#### Agent-slim responses
|
|
272
|
+
|
|
273
|
+
`wallet_list`, `wallet_info`, `balance`, and `dust_status` return a slim JSON shape by default — agents pay roughly half the tokens of the legacy `--json` shape. Pass `{ full: true }` to get the same shape `mn <cmd> --json` emits (per-network address maps, sync internals, etc.):
|
|
274
|
+
|
|
275
|
+
```js
|
|
276
|
+
midnight_wallet_list() // slim: { name, active, network, address, shieldedAddress } per wallet
|
|
277
|
+
midnight_wallet_list({ full: true }) // full: per-network addresses + shieldedAddresses maps (legacy shape)
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
The CLI human paths (`mn wallet list --json`, etc.) are unchanged.
|
|
281
|
+
|
|
282
|
+
#### Skill resources
|
|
255
283
|
|
|
256
|
-
|
|
284
|
+
Two markdown resources teach agents how to use the CLI:
|
|
257
285
|
|
|
258
|
-
|
|
286
|
+
- `midnight-wallet://skill/core` — intent routing + safety rules. ~890 tokens. Fetch on session start.
|
|
287
|
+
- `midnight-wallet://skill/full` — canonical flows, error recovery, concept primers. ~2.4k tokens. Fetch on demand (errors, multi-step flows).
|
|
288
|
+
|
|
289
|
+
The legacy `midnight-wallet://skill` URI still works as an alias for `/full`.
|
|
290
|
+
|
|
291
|
+
#### Structured error codes
|
|
292
|
+
|
|
293
|
+
Every tool error returns `{ error: true, code: <CODE>, message: <human prose> }`. Agents should index on the stable `code` (`INSUFFICIENT_BALANCE`, `DUST_REQUIRED`, `INVALID_DUST_PROOF`, `STALE_CACHE`, `PROOF_FAILURE`, `SYNC_TIMEOUT`, `NETWORK_ERROR`, `WALLET_NOT_FOUND`, `INVALID_ARGS`, `TX_REJECTED`, `STALE_UTXO`, `PROOF_TIMEOUT`, `CANCELLED`, `UNKNOWN`) — full taxonomy + recovery recipes are in `docs/SKILL.md`.
|
|
294
|
+
|
|
295
|
+
## Issues & Feedback
|
|
296
|
+
|
|
297
|
+
Found a bug or have a feature request? [Open an issue](https://github.com/nel349/midnight-wallet-cli/issues).
|
|
259
298
|
|
|
260
299
|
## Requirements
|
|
261
300
|
|
|
262
301
|
- Node.js >= 20
|
|
263
302
|
- Docker (for `midnight localnet` commands)
|
|
264
303
|
- A running proof server on `localhost:6300` (for transactions — required on all networks)
|
|
304
|
+
|
|
305
|
+
## Development
|
|
306
|
+
|
|
307
|
+
Working on the CLI itself? Clone, install, build, test:
|
|
308
|
+
|
|
309
|
+
```bash
|
|
310
|
+
git clone https://github.com/nel349/midnight-wallet-cli.git
|
|
311
|
+
cd midnight-wallet-cli
|
|
312
|
+
npm install
|
|
313
|
+
npm run build # bun build → dist/wallet.js + dist/mcp-server.js
|
|
314
|
+
npm test # vitest run
|
|
315
|
+
npm run typecheck # tsc --noEmit
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
Run the CLI directly from source without rebuilding:
|
|
319
|
+
|
|
320
|
+
```bash
|
|
321
|
+
npx tsx src/wallet.ts <command> # or: npm run wallet -- <command>
|
|
322
|
+
npx tsx src/mcp-server.ts # or: npm run mcp
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
## Contributing
|
|
326
|
+
|
|
327
|
+
Contributions welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the workflow,
|
|
328
|
+
coding standards, and testing requirements.
|
|
329
|
+
|
|
330
|
+
Quick checklist before opening a PR:
|
|
331
|
+
|
|
332
|
+
- `npm run typecheck` clean
|
|
333
|
+
- `npm test` green
|
|
334
|
+
- New behavior covered by a test in `src/__tests__/`
|
|
335
|
+
- Commit messages follow the repo style (`feat(scope): …`, `fix(scope): …`, etc.)
|
|
336
|
+
|
|
337
|
+
## License
|
|
338
|
+
|
|
339
|
+
Apache-2.0. See [LICENSE](LICENSE).
|