You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 0a0b3a6
Browse filesBrowse the repository at this point in the historyBrowse files
Dawn
committed
docs(testing): patch sharp edges found in cold-reader walkthrough
- Step 3: add port-collision callout (Sprout Desktop on :3000/:8080) and
flag that overriding relay ports requires $SPROUT_RELAY_URL on the CLI.
- Step 3: warn cold readers to `unset SPROUT_AUTH_TAG` if their shell
has it set from another relay's config.
- ACP recipe: add `channels add-member $AGENT_PUBKEY` BEFORE starting
sprout-acp. Without this the agent boots to 'discovered 0 channel(s)'
/ 'no channel subscriptions resolved — agent will sit idle' and never
picks up mentions. Verified end-to-end with goose against a local relay.
- ACP recipe: capture sender SK first so the reader can switch back to
it to send the @mention. Note that the agent log is quiet during turns;
use `sprout messages get` to confirm the reply.
- Troubleshooting: new row for the 'discovered 0 channels / sit idle' case.
>export RELAY_URL=ws://localhost:3030 # for the relay (NIP-42 advertisement)
76
+
>export SPROUT_RELAY_URL=http://localhost:3030 # for the CLI in steps 4+
77
+
>```
78
+
79
+
>**Heads up:**if your shell already has `SPROUT_AUTH_TAG`set (e.g. from a
80
+
> staging relay config), `unset SPROUT_AUTH_TAG` before testing. The local
81
+
> dev relay tolerates it, but a stale tag will trip you up the moment you
82
+
> point the CLI at a membership-gated relay.
83
+
71
84
### 4. Smoke test the CLI against the relay
72
85
73
86
End-to-end: generate an identity, create a channel, post a message, read it
@@ -132,36 +145,63 @@ agent over stdio, and the agent replies through MCP tools.
132
145
> integration. Keep it in mind if you're poking at the ACP code, but new
133
146
> tests should not depend on it.
134
147
135
-
Minimum recipe — assumes the relay from step 3 is running:
148
+
Minimum recipe — assumes the relay from step 3 is running and the channel
149
+
`$CHANNEL` from step 4 still exists. The agent identity must be **different**
150
+
from the sender identity (`SPROUT_ACP_RESPOND_TO=anyone` still skips events
151
+
the agent signed itself).
136
152
137
153
```bash
138
154
cargo build --release -p sprout-acp -p sprout-mcp
139
155
export PATH="$PWD/target/release:$PATH"
140
156
157
+
# 1. Save your sender identity from step 4 — you'll need it to @mention the agent
158
+
SENDER_SK="$SPROUT_PRIVATE_KEY"
159
+
160
+
# 2. Mint a fresh agent identity and capture its pubkey
Replies are kind:9 in the same channel;`sprout messages thread --channel <id>
204
+
--event <event_id>` fetches the reply chain for a specific mention.
165
205
166
206
---
167
207
@@ -204,5 +244,6 @@ CLI-side, only two matter for testing:
204
244
| `auth-required: verification failed` on a closed relay | NIP-OA attestation needed | Set `SPROUT_AUTH_TAG` to the owner-issued JSON, or relax `SPROUT_REQUIRE_RELAY_MEMBERSHIP` |
205
245
| `channels list` empty after `channels create` | The CLI doesn't echo the channel UUID; use the filter shown in step 4 | Or `POST /query` with `{"kinds":[39002]}`|
206
246
| ACP agent ignores all events |`SPROUT_ACP_RESPOND_TO=owner-only` (default) with no owner configured | Set `SPROUT_ACP_RESPOND_TO=anyone`for testing |
247
+
| ACP logs `discovered 0 channel(s)` / `no channel subscriptions resolved`| Agent identity isn't a member of any channel | `sprout channels add-member --channel "$CHANNEL" --pubkey "$AGENT_PUBKEY" --role member` from another identity |
207
248
| `GOOSE_MODE` warning, agent hangs | Not set | `export GOOSE_MODE=auto` |
208
249
| Tests pass locally but CI fails | Forgot to run `just ci` | `just ci` runs the gate (fmt, clippy, unit tests, desktop/web builds) |
0 commit comments