Owning repos: agglayer/agglayer-dev-ui + agglayer/sdk.
Problem
During the Bridge Hub → aggkit migration (agglayer/agglayer-dev-ui#24, agglayer/sdk#28), code comments were written against a local planning document — a design.md that lived only on the developer's machine and was never committed to any repository. Those comments cite its section numbers as if the reader could look them up, e.g.:
dev-ui (~43 occurrences across app/ and tests/):
// app/config.ts:50 — config.json's per-mode `aggkitBridgeApis` (design.md §6.2).
// app/services/transactions.ts:8 — has no equivalents (design.md §9 risks #1, #2).
// app/types/transaction.ts:44 — (design.md §2.4). A network failing does not fail the whole page
sdk (~86 occurrences across src/ and scripts/):
// src/aggkit/client.ts:5 — One aggkit REST instance is bound to exactly one L2 network (design.md §…)
// src/aggkit/errors.ts:20 — 502 = aggkit-proxy backend unreachable, design.md §2.5
// src/aggkit/__tests__/client.test.ts:504 — (design.md §2.3, gap G2; §3.7 regression)
A handful of sdk comments additionally cite absolute local filesystem paths (/home/...) that resolve for nobody.
For any reviewer or consumer of these repos, every one of these references is a dangling pointer: the cited document doesn't exist anywhere they can reach.
Work
Sweep both repos and replace each dangling reference with a durable one, without deleting the substantive comment content (the facts in the comments are correct and useful — only the citation is broken). Depending on the comment, the right replacement is one of:
- inline the relevant fact (usually one clause, e.g. replace "design.md §2.3, gap G2" with the actual behavior being cited: "aggkit-proxy 400s with 'missing mandatory query parameter: network_id' on unqualified requests");
- a GitHub link (upstream aggkit issue/PR, or a file in the repo);
- for test-case citations, the test name/assertion already carries the intent — the citation can often just be dropped.
The worst instances (username-leaking absolute paths in published sdk source files) were already cleaned up on the PR branches; this ticket is the remaining full sweep.
Timing
Before or shortly after agglayer/sdk#28 and agglayer/agglayer-dev-ui#24 merge — the references are in the merged code either way, so this is cleanup, not a merge blocker.
Owning repos: agglayer/agglayer-dev-ui + agglayer/sdk.
Problem
During the Bridge Hub → aggkit migration (agglayer/agglayer-dev-ui#24, agglayer/sdk#28), code comments were written against a local planning document — a
design.mdthat lived only on the developer's machine and was never committed to any repository. Those comments cite its section numbers as if the reader could look them up, e.g.:dev-ui (~43 occurrences across
app/andtests/):sdk (~86 occurrences across
src/andscripts/):A handful of sdk comments additionally cite absolute local filesystem paths (
/home/...) that resolve for nobody.For any reviewer or consumer of these repos, every one of these references is a dangling pointer: the cited document doesn't exist anywhere they can reach.
Work
Sweep both repos and replace each dangling reference with a durable one, without deleting the substantive comment content (the facts in the comments are correct and useful — only the citation is broken). Depending on the comment, the right replacement is one of:
The worst instances (username-leaking absolute paths in published sdk source files) were already cleaned up on the PR branches; this ticket is the remaining full sweep.
Timing
Before or shortly after agglayer/sdk#28 and agglayer/agglayer-dev-ui#24 merge — the references are in the merged code either way, so this is cleanup, not a merge blocker.