@tokamak-private-dapps/private-state-cli 0.1.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/CHANGELOG.md +5 -0
- package/LICENSE +8 -0
- package/README.md +79 -0
- package/cli-assistant.html +1869 -0
- package/lib/private-state-cli-shared.mjs +94 -0
- package/package.json +54 -0
- package/private-state-bridge-cli.mjs +5127 -0
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# private-state CLI
|
|
2
|
+
|
|
3
|
+
Command-line client for the Tokamak private-state DApp.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @tokamak-private-dapps/private-state-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Install the local Tokamak zk-EVM runtime workspace and public private-state deployment artifacts:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
private-state-cli --install
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
`--install` downloads public deployment artifacts from the configured artifact index. It does not read repository-local
|
|
18
|
+
`deployment/` outputs by default. Repository development workflows that need local anvil artifacts can opt in explicitly:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
private-state-cli --install --include-local-artifacts
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Run the CLI with:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
private-state-cli <command> ...
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Commands
|
|
31
|
+
|
|
32
|
+
The normal private-state flow is:
|
|
33
|
+
|
|
34
|
+
1. `create-channel`
|
|
35
|
+
2. `deposit-bridge`
|
|
36
|
+
3. `join-channel`
|
|
37
|
+
4. `deposit-channel`
|
|
38
|
+
5. `mint-notes`
|
|
39
|
+
6. `transfer-notes`
|
|
40
|
+
7. `get-my-notes`
|
|
41
|
+
8. `redeem-notes`
|
|
42
|
+
9. `withdraw-channel`
|
|
43
|
+
10. `withdraw-bridge`
|
|
44
|
+
|
|
45
|
+
Use `private-state-cli --help` for the full command list and required options.
|
|
46
|
+
|
|
47
|
+
## Workspace
|
|
48
|
+
|
|
49
|
+
The CLI stores user workspaces under:
|
|
50
|
+
|
|
51
|
+
```text
|
|
52
|
+
~/tokamak-private-channels/workspace/<network>/<channel>/
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Wallet data is encrypted with the password supplied to `join-channel` or `recover-wallet`.
|
|
56
|
+
|
|
57
|
+
## Artifacts
|
|
58
|
+
|
|
59
|
+
Proof-backed commands require installed bridge, DApp, and Groth16 artifacts. Run `private-state-cli --install` before
|
|
60
|
+
using bridge-facing commands on a new machine.
|
|
61
|
+
|
|
62
|
+
Release order matters for npm publication. `@tokamak-private-dapps/common-library` and
|
|
63
|
+
`@tokamak-private-dapps/groth16` must be published before this package version.
|
|
64
|
+
|
|
65
|
+
## FAQ
|
|
66
|
+
|
|
67
|
+
### What does this package install?
|
|
68
|
+
|
|
69
|
+
It installs the `private-state-cli` terminal command and the local files needed by that command.
|
|
70
|
+
It does not install bridge contracts, app contracts, or local deployment outputs.
|
|
71
|
+
|
|
72
|
+
### When should I run `private-state-cli --install`?
|
|
73
|
+
|
|
74
|
+
Run it once on a new machine, or after public bridge, DApp, Groth16, or Tokamak zk-EVM runtime artifacts are updated.
|
|
75
|
+
|
|
76
|
+
### Does this package publish private user data?
|
|
77
|
+
|
|
78
|
+
No. User wallets and channel workspaces are created locally under `~/tokamak-private-channels/`.
|
|
79
|
+
Bridge-facing commands still submit public transactions and proof-backed state transitions to the selected network.
|