Skip to content

Commit dcb31c9

Browse files
committed
Add public tester onboarding
1 parent bdd385e commit dcb31c9

10 files changed

Lines changed: 468 additions & 220 deletions

File tree

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: Public Tester Report
2+
description: Report results from public FlowMemory tester lanes.
3+
title: "[Public Tester]: "
4+
labels:
5+
- public-tester
6+
- tester-report
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for testing FlowMemory. Do not include private keys, seed phrases, RPC credentials, API keys, webhook URLs, wallet secrets, or private user data.
12+
- type: dropdown
13+
id: lane
14+
attributes:
15+
label: Tester Lane
16+
description: Which public tester lane did you run?
17+
options:
18+
- Quick JS smoke
19+
- Public-agent contracts
20+
- Local public-agent e2e
21+
- Dashboard workbench
22+
- CLI / control-plane trial
23+
- Documentation review
24+
- Other public local/test path
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: environment
29+
attributes:
30+
label: Environment
31+
description: OS, shell, Node/npm versions, Foundry version if relevant, browser if relevant.
32+
placeholder: |
33+
OS: Windows 11
34+
Shell: PowerShell 7
35+
Node: v22.x
36+
npm: 10.x
37+
Forge: 1.x
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: commands
42+
attributes:
43+
label: Commands Run
44+
description: Exact commands, in order.
45+
placeholder: |
46+
npm install
47+
npm run public:test:quick
48+
validations:
49+
required: true
50+
- type: dropdown
51+
id: result
52+
attributes:
53+
label: Result
54+
options:
55+
- Passed
56+
- Failed
57+
- Partially passed
58+
- Documentation unclear
59+
- Could not run because prerequisite was missing
60+
validations:
61+
required: true
62+
- type: textarea
63+
id: evidence
64+
attributes:
65+
label: Evidence Or First Useful Error
66+
description: Include the first useful error, short logs, screenshot notes, or returned JSON shape. Do not paste huge logs.
67+
validations:
68+
required: false
69+
- type: textarea
70+
id: expected
71+
attributes:
72+
label: Expected Or Suggested Improvement
73+
description: What should have happened, or what would make this easier to test/use?
74+
validations:
75+
required: true
76+
- type: checkboxes
77+
id: safety
78+
attributes:
79+
label: Safety Check
80+
options:
81+
- label: I did not include private keys, seed phrases, RPC credentials, API keys, webhook URLs, wallet secrets, or private user data.
82+
required: true
83+
- label: I understand this is local/test public infrastructure, not a production/mainnet readiness claim.
84+
required: true

README.md

Lines changed: 131 additions & 201 deletions
Large diffs are not rendered by default.

docs/CURRENT_STATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Repository operating system:
3737
- `AGENTS.md` with shared agent instructions.
3838
- `docs/START_HERE.md` with required reading order and local multi-agent worktree workflow.
3939
- Source-of-truth docs for context, roadmap, architecture, security model, project charter, agent roles, and current state.
40-
- Public-reader documentation now starts at `docs/PUBLIC_REPO_GUIDE.md`, with public-agent implementation details in `docs/PUBLIC_AGENT_NETWORK_TECHNICAL_GUIDE.md`, release status in `docs/PUBLIC_AGENT_NETWORK_RELEASE.md`, and tracked public gaps in `docs/PUBLIC_RELEASE_GAPS.md`.
40+
- Public-reader documentation now starts at `docs/PUBLIC_REPO_GUIDE.md`, with tester lanes in `docs/PUBLIC_TESTER_GUIDE.md`, public-agent implementation details in `docs/PUBLIC_AGENT_NETWORK_TECHNICAL_GUIDE.md`, release status in `docs/PUBLIC_AGENT_NETWORK_RELEASE.md`, and tracked public gaps in `docs/PUBLIC_RELEASE_GAPS.md`.
4141
- `docs/DECISIONS/` for durable decision records.
4242
- GitHub issue and pull request templates.
4343
- Conservative repository hygiene CI.

docs/PUBLIC_AGENT_NETWORK_RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Status: public repository release boundary, local/test implementation.
44

55
This document names what exists for the public agent network, what is intentionally not claimed, and how reviewers can verify the current stack.
66

7-
For the end-to-end reader guide, see `docs/PUBLIC_REPO_GUIDE.md`. For component-level details, see `docs/PUBLIC_AGENT_NETWORK_TECHNICAL_GUIDE.md`.
7+
For the end-to-end reader guide, see `docs/PUBLIC_REPO_GUIDE.md`. For tester lanes, see `docs/PUBLIC_TESTER_GUIDE.md`. For component-level details, see `docs/PUBLIC_AGENT_NETWORK_TECHNICAL_GUIDE.md`.
88

99
## What Exists
1010

docs/PUBLIC_AGENT_NETWORK_TECHNICAL_GUIDE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ It shows public network primitives and deterministic local projections. Live eve
124124

125125
## 7. Local Verification
126126

127+
For external tester lanes and expected results, see `docs/PUBLIC_TESTER_GUIDE.md`.
128+
127129
Public-agent contract suites:
128130

129131
```powershell

docs/PUBLIC_REPO_GUIDE.md

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,21 @@
22

33
Status: public-reader guide for the current local/test repository release.
44

5-
FlowMemory is a Base-native AI memory, Rootflow, public-agent-network, FlowChain local/test, and FlowRouter research repository. It is public so builders, reviewers, and operators can inspect the work, reproduce the local flows, and see the exact gaps that remain. It is not a production deployment, not an audited network, and not a mainnet-readiness claim.
5+
FlowMemory is a Base-native agent memory and accountability protocol workbench. It is public so builders, reviewers, and operators can inspect the agent-memory, Agent Bonds, public-agent, service, SDK, and dashboard surfaces; reproduce the local flows; and see the exact gaps that remain. Separate chain-devnet research also exists in this repository, but it is not the public-reader starting point.
66

77
## The Short Version
88

9-
FlowMemory makes agent memory explicit and replayable without pretending heavy AI state belongs on-chain.
9+
FlowMemory makes agent work explicit, replayable, and economically accountable without pretending heavy AI state belongs on-chain.
1010

1111
The repository currently contains:
1212

1313
- local/test Solidity contracts for FlowPulse, Rootfield, Base on-chain agent memory, Agent Bonds, and the public-agent network;
1414
- fixture-first indexer, verifier, Flow Memory, control-plane, SDK, and dashboard packages;
1515
- deterministic Rootflow and Flow Memory V0 fixtures;
16-
- a local no-value FlowChain devnet prototype;
16+
- signed Agent Bonds quote attestations, recourse-policy fixtures, and requester quote/create SDK helpers;
1717
- a public-agent launch and swarm stack with Foundry tests and a local e2e script;
18-
- public docs that describe what exists, what does not, and what must be verified before broader claims are allowed.
18+
- FlowRouter hardware/resilience research materials;
19+
- public docs that describe what exists, what works locally, and what must be verified before broader value-bearing claims are allowed.
1920

2021
## How The Pieces Fit Together
2122

@@ -47,24 +48,46 @@ registered class + approved tool set
4748
| --- | --- |
4849
| Understand the repo boundary | `README.md`, `docs/CURRENT_STATE.md`, `docs/MARKETING_CLAIMS_GUARDRAILS.md` |
4950
| Understand the public-agent release | `docs/PUBLIC_AGENT_NETWORK_RELEASE.md`, `docs/PUBLIC_AGENT_NETWORK_TECHNICAL_GUIDE.md` |
51+
| Test what works locally | `docs/PUBLIC_TESTER_GUIDE.md` |
5052
| See exactly what is still missing | `docs/PUBLIC_RELEASE_GAPS.md` and GitHub issues #164-#168 |
5153
| Understand Base on-chain agent memory | `docs/base-onchain-agent-memory/README.md` |
5254
| Understand Rootflow and Flow Memory V0 | `docs/ROOTFLOW_V0.md`, `docs/FLOW_MEMORY_V0.md`, `docs/V0_LAUNCH_ACCEPTANCE.md` |
5355
| Operate or contribute safely | `AGENTS.md`, `docs/START_HERE.md`, `CONTRIBUTING.md`, `SECURITY.md` |
5456
| Check deployment and claim boundaries | `docs/PRODUCTION_READINESS_CHECKLIST.md`, `contracts/DEPLOYMENT_BOUNDARY.md`, `contracts/ACCESS_CONTROL_REVIEW.md` |
5557

58+
## Public Tester Commands
59+
60+
Start with the low-friction lane:
61+
62+
```powershell
63+
npm run public:test:quick
64+
```
65+
66+
Then add the lanes that match your local tools:
67+
68+
```powershell
69+
npm run public:test:contracts
70+
npm run public:test:e2e
71+
npm run public:test:dashboard
72+
```
73+
74+
The full public local pass is:
75+
76+
```powershell
77+
npm run public:test:all
78+
```
79+
80+
See `docs/PUBLIC_TESTER_GUIDE.md` for expected results, CLI/control-plane commands, dashboard review prompts, and the tester-report template.
81+
5682
## Verification Commands
5783

58-
Run the checks for the area you are inspecting. The broad local/test confidence path is:
84+
Run the checks for the area you are inspecting. The broad public confidence path is:
5985

6086
```powershell
6187
npm test
62-
npm run contracts:hardening
63-
npm run launch:candidate
64-
npm run public-agent-network:contracts
65-
npm run public-agent-network:local-e2e
66-
npm test --prefix apps/dashboard
67-
npm run build --prefix apps/dashboard
88+
npm run build:production
89+
npm run flowmemory:agent-bonds:phase2
90+
npm run flowmemory:agent-bonds:readiness
6891
node infra/scripts/check-unsafe-claims.mjs
6992
git diff --check
7093
```
@@ -82,7 +105,7 @@ Some checks require local tools such as Foundry, Rust, dashboard dependencies, o
82105
| `services/verifier/` | Local/test verifier reports and status projection. |
83106
| `services/flowmemory/` | Launch-core generation, public-agent helpers, Agent Bonds helpers, and deterministic fixture builders. |
84107
| `services/control-plane/` | Local JSON-RPC style control-plane methods and smoke client. |
85-
| `services/flowchain-sdk/` | FlowChain client and CLI wrappers. |
108+
| `services/flowchain-sdk/` | Client and CLI wrappers for the separate chain-devnet research track; not required for the main public quickstart. |
86109
| `services/agent-memory-sdk/` | Agent-memory client for fixture-backed and local control-plane flows. |
87110
| `apps/dashboard/` | Vite/React fixture-backed dashboard and public-network projection views. |
88111
| `fixtures/` | Deterministic local/test outputs used by services and dashboard. |

0 commit comments

Comments
 (0)