veritaszk-cli 0.1.0 → 0.1.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/README.md +110 -0
- package/package.json +28 -4
package/README.md
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# veritaszk-cli
|
|
2
|
+
|
|
3
|
+
Command-line tool for [VeritasZK](https://veritaszk.vercel.app)
|
|
4
|
+
— the first zero-knowledge proof-of-solvency system on Aleo.
|
|
5
|
+
|
|
6
|
+
Query live solvency proofs from your terminal. No wallet
|
|
7
|
+
required for read-only verification.
|
|
8
|
+
|
|
9
|
+
## Quick Start
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx veritaszk-cli verify aleo1cdmu479q6duu327wgm3vnphqtq2n4q4vcvp66f5742gv5f8f9qxq0w9r00
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Commands
|
|
16
|
+
|
|
17
|
+
### verify
|
|
18
|
+
|
|
19
|
+
Check solvency status of any organization:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx veritaszk-cli verify aleo1cdmu479q6duu327wgm3vnphqtq2n4q4vcvp66f5742gv5f8f9qxq0w9r00
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
VeritasZK Solvency Check
|
|
27
|
+
────────────────────────────────────────────
|
|
28
|
+
Organization: aleo1cdmu479q6duu3...9qxq0w9r00
|
|
29
|
+
Status: ✓ SOLVENT
|
|
30
|
+
Proven at: block 142857
|
|
31
|
+
Expires at: block 147857
|
|
32
|
+
Verified by: 12 parties
|
|
33
|
+
Threshold: 100% buffer (assets > 2× liabilities)
|
|
34
|
+
────────────────────────────────────────────
|
|
35
|
+
Network: Aleo Testnet | veritaszk_core.aleo
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### list
|
|
39
|
+
|
|
40
|
+
Show protocol info and deployed programs:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx veritaszk-cli list
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### proof
|
|
47
|
+
|
|
48
|
+
Get full proof metadata:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
# Human-readable table (default)
|
|
52
|
+
npx veritaszk-cli proof aleo1...
|
|
53
|
+
|
|
54
|
+
# JSON output for scripting
|
|
55
|
+
npx veritaszk-cli proof aleo1... --format json
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
JSON output includes: `org_commitment`, `is_solvent`,
|
|
59
|
+
`proof_timestamp_block`, `expiry_block`, `verification_count`,
|
|
60
|
+
`threshold_level`, `audit_event_count`, `last_proof_block`.
|
|
61
|
+
|
|
62
|
+
### watch
|
|
63
|
+
|
|
64
|
+
Poll solvency status every 30 seconds:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
npx veritaszk-cli watch aleo1...
|
|
68
|
+
# Ctrl+C to stop
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Prints a timestamped line each poll cycle.
|
|
72
|
+
Flags changes with `← CHANGED` when status or
|
|
73
|
+
verification count updates.
|
|
74
|
+
|
|
75
|
+
## CI/CD Integration
|
|
76
|
+
|
|
77
|
+
Use the JSON output in scripts:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
RESULT=$(npx veritaszk-cli proof aleo1... --format json)
|
|
81
|
+
IS_SOLVENT=$(echo $RESULT | node -e "
|
|
82
|
+
let d=''; process.stdin.on('data',c=>d+=c);
|
|
83
|
+
process.stdin.on('end',()=>
|
|
84
|
+
console.log(JSON.parse(d).is_solvent))
|
|
85
|
+
")
|
|
86
|
+
echo "Solvent: $IS_SOLVENT"
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## What the CLI Does NOT Return
|
|
90
|
+
|
|
91
|
+
By design, no command returns:
|
|
92
|
+
- Asset amounts or liability amounts
|
|
93
|
+
- Wallet addresses or portfolio composition
|
|
94
|
+
- Any data that would reveal financial strategy
|
|
95
|
+
|
|
96
|
+
This is guaranteed by the underlying Leo contracts —
|
|
97
|
+
the data does not exist in any queryable public state.
|
|
98
|
+
|
|
99
|
+
## Related Packages
|
|
100
|
+
|
|
101
|
+
- [veritaszk-sdk](https://www.npmjs.com/package/veritaszk-sdk) — TypeScript SDK with React hooks and webhook support
|
|
102
|
+
- [veritaszk-mcp](https://www.npmjs.com/package/veritaszk-mcp) — MCP server for AI agent integration (Claude Desktop)
|
|
103
|
+
|
|
104
|
+
## Links
|
|
105
|
+
|
|
106
|
+
- [Live Dashboard](https://veritaszk.vercel.app)
|
|
107
|
+
- [GitHub](https://github.com/Vinaystwt/veritaszk)
|
|
108
|
+
- [Aleo Explorer](https://explorer.aleo.org/program/veritaszk_core.aleo)
|
|
109
|
+
|
|
110
|
+
Built on Aleo — privacy by default.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "veritaszk-cli",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "CLI for
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "CLI tool for VeritasZK — query zero-knowledge solvency proofs on Aleo from your terminal. Verify that organizations prove assets exceed liabilities without any private data being revealed.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"bin": { "veritaszk": "dist/index.js" },
|
|
@@ -9,9 +9,33 @@
|
|
|
9
9
|
"build": "tsc",
|
|
10
10
|
"prepublishOnly": "npm run build"
|
|
11
11
|
},
|
|
12
|
-
"keywords": [
|
|
12
|
+
"keywords": [
|
|
13
|
+
"cli",
|
|
14
|
+
"aleo",
|
|
15
|
+
"zero-knowledge",
|
|
16
|
+
"zk",
|
|
17
|
+
"solvency",
|
|
18
|
+
"proof-of-reserves",
|
|
19
|
+
"privacy",
|
|
20
|
+
"blockchain",
|
|
21
|
+
"leo",
|
|
22
|
+
"veritaszk",
|
|
23
|
+
"terminal",
|
|
24
|
+
"devtools"
|
|
25
|
+
],
|
|
26
|
+
"author": "Vinay Sharma",
|
|
13
27
|
"license": "MIT",
|
|
14
|
-
"
|
|
28
|
+
"homepage": "https://veritaszk.vercel.app",
|
|
29
|
+
"repository": {
|
|
30
|
+
"type": "git",
|
|
31
|
+
"url": "https://github.com/Vinaystwt/veritaszk"
|
|
32
|
+
},
|
|
33
|
+
"bugs": {
|
|
34
|
+
"url": "https://github.com/Vinaystwt/veritaszk/issues"
|
|
35
|
+
},
|
|
36
|
+
"dependencies": {
|
|
37
|
+
"commander": "^12.0.0"
|
|
38
|
+
},
|
|
15
39
|
"devDependencies": {
|
|
16
40
|
"typescript": "^5.4.0",
|
|
17
41
|
"@types/node": "^20.0.0"
|