zk-agent-cli 0.1.0-rc.6 → 0.1.0-rc.7
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 +63 -8
- package/dist/index.js +691 -416
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,10 +31,15 @@ zk-agent workflow pay --wallet main --to <address> --amount <amount>
|
|
|
31
31
|
zk-agent suite
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
+
`zk-agent start` is the public onboarding command that keeps the same output
|
|
35
|
+
contract as `zk-agent next`. Use `start` when you want the shortest obvious
|
|
36
|
+
first-touch command. Keep `next` as the canonical operator/runtime contract in
|
|
37
|
+
scripts and JSON examples.
|
|
38
|
+
|
|
34
39
|
If you are new, stop at the first successful `zk-agent workflow pay`. Ignore
|
|
35
40
|
remote approval and Agent Pay until that baseline path works once. Use
|
|
36
|
-
`zk-agent suite` only after that first success or when the
|
|
37
|
-
|
|
41
|
+
`zk-agent suite` only after that first success or when you want the broader
|
|
42
|
+
question-first packaged surface.
|
|
38
43
|
|
|
39
44
|
What each step is doing:
|
|
40
45
|
|
|
@@ -43,12 +48,31 @@ What each step is doing:
|
|
|
43
48
|
product question as `bootstrap`, `recover`, `operate`, or `workflow`
|
|
44
49
|
- `wallet create --await-local` is the preferred local approval path
|
|
45
50
|
- `workflow pay` is the flagship zkSync-native AA native-send path
|
|
46
|
-
- `suite` is the packaged surface
|
|
51
|
+
- `suite` is the broader question-first packaged surface
|
|
47
52
|
|
|
48
53
|
The packaged default story is payment-first: send native value now, stay on
|
|
49
54
|
the approval-based pay path when fee-token/default state matters, and recover
|
|
50
55
|
funding only when the workflow says the write path is blocked.
|
|
51
56
|
|
|
57
|
+
The three public proof paths today are:
|
|
58
|
+
|
|
59
|
+
- flagship pay: prove the default ready-wallet zkSync-native send path
|
|
60
|
+
- Agent Pay: prove local request capture plus follow-up surfaces around the
|
|
61
|
+
same wallet runtime
|
|
62
|
+
- hosted approval recovery: prove remote-browser session recovery on the
|
|
63
|
+
current single-host relay baseline
|
|
64
|
+
|
|
65
|
+
The fastest flagship proof path after wallet readiness is:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
zk-agent workflow pay --wallet main --to <address> --amount <amount>
|
|
69
|
+
zk-agent workflow next --request-id <id>
|
|
70
|
+
zk-agent workflow status --request-id <id>
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
That path proves the default ready-wallet execution route plus checkpoint
|
|
74
|
+
follow-up and status inspection without leaving the flagship workflow surface.
|
|
75
|
+
|
|
52
76
|
The current local-first Agent Pay entry surface is:
|
|
53
77
|
|
|
54
78
|
```bash
|
|
@@ -75,6 +99,25 @@ That path shows compact ingress, wallet-aware follow-up, approval readiness,
|
|
|
75
99
|
dashboard summary, single-request handoff bundling, and cross-request feed
|
|
76
100
|
export without leaving the local-first surface.
|
|
77
101
|
|
|
102
|
+
When the browser is remote, the fastest hosted approval proof path on the
|
|
103
|
+
current supported recovery baseline is:
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
zk-agent relay inspect --relay-url <relay-url>
|
|
107
|
+
zk-agent wallet reapprove --name main --relay-url <relay-url> --wait-relay --prompt-code
|
|
108
|
+
zk-agent wallet status --name main
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
That path proves outside-in relay readiness, one hosted reapproval, and the
|
|
112
|
+
post-approval wallet-readiness readout without claiming multi-host durability.
|
|
113
|
+
|
|
114
|
+
If the wallet does not exist yet, swap `wallet reapprove` for:
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
zk-agent wallet create --relay-url <relay-url> --wait-relay --prompt-code
|
|
118
|
+
zk-agent next
|
|
119
|
+
```
|
|
120
|
+
|
|
78
121
|
Use those commands for the public "start here" path:
|
|
79
122
|
|
|
80
123
|
- `submit`: capture one payment request through the compact ingress surface
|
|
@@ -115,8 +158,8 @@ If readiness is unclear before you choose a fix, use:
|
|
|
115
158
|
zk-agent doctor
|
|
116
159
|
```
|
|
117
160
|
|
|
118
|
-
When `doctor` shows local readiness is clear and
|
|
119
|
-
|
|
161
|
+
When `doctor` shows local readiness is clear and you want the broader
|
|
162
|
+
question-first packaged surface, move to:
|
|
120
163
|
|
|
121
164
|
```bash
|
|
122
165
|
zk-agent suite
|
|
@@ -129,14 +172,25 @@ the post-flagship packaged surface, use:
|
|
|
129
172
|
zk-agent suite --include-onboarding
|
|
130
173
|
```
|
|
131
174
|
|
|
175
|
+
Inside `suite`, the smallest question-first entry layer is:
|
|
176
|
+
|
|
177
|
+
- `send now`
|
|
178
|
+
- `track payments`
|
|
179
|
+
- `inspect before token action`
|
|
180
|
+
- `unstick write`
|
|
181
|
+
- `recover remote approval`
|
|
182
|
+
|
|
132
183
|
Use the surfaces this way:
|
|
133
184
|
|
|
185
|
+
- `start`: you are just beginning and want the public onboarding command that
|
|
186
|
+
mirrors `next`
|
|
134
187
|
- `next`: the CLI is still deciding the shortest path across setup, wallet
|
|
135
188
|
readiness, recovery, or workflow continuation
|
|
136
189
|
- `workflow pay`: the wallet is already ready and you want the flagship
|
|
137
190
|
native-send path now
|
|
138
|
-
- `suite`: the wallet is already ready and you want the
|
|
139
|
-
because the
|
|
191
|
+
- `suite`: the wallet is already ready and you want the broader question-first
|
|
192
|
+
packaged surface because the task is broader than one immediate flagship pay
|
|
193
|
+
step
|
|
140
194
|
- `payment`: the execution path is no longer the whole story and you need
|
|
141
195
|
local request capture, queueing, reporting, or approval tracking around it
|
|
142
196
|
- `suite --include-onboarding`: you want one combined readout from first-run
|
|
@@ -197,7 +251,8 @@ ZK_AGENT_STORAGE_DIR=
|
|
|
197
251
|
- `zk-agent workflow pay ...`: the direct flagship execution surface when you
|
|
198
252
|
already know the wallet is ready and the goal is "send value now"
|
|
199
253
|
- `zk-agent suite`: the packaged post-flagship catalog once wallet readiness is
|
|
200
|
-
no longer the blocker and
|
|
254
|
+
no longer the blocker and you want the broader question-first packaged
|
|
255
|
+
surface
|
|
201
256
|
- `zk-agent doctor`: local-only diagnosis before you choose a fix
|
|
202
257
|
- `zk-agent wallet status --name <wallet>` and
|
|
203
258
|
`zk-agent wallet next --name <wallet>`: wallet-scoped repair and readiness
|