Skip to content

Commit a364648

Browse files
authored
docs: correct the forks section where it went stale (#38)
Three claims no longer held. The varsig paragraph pointed at two issues for "the non-recursive varsig layout it will follow". Both are closed and the layout shipped in 0.2.0, so it described finished work as pending and sent readers to dead links. What is actually unresolved is the header: webauthn-varsig-header is still TODO in ChainAgnostic/varsig#11, which makes the 0x300001 marker this package writes a private-use codepoint of our own choosing. That is now what the paragraph says, with the pointer that matters. "these forks can go away, and the pnpm.overrides block with them" stopped being true when conf>ajv and ajv>fast-uri were added there to clear the production advisories. Those stay, as does iso-web. Only the three fork entries go. And the upstream proposal now exists — hugomrdias/iso-repo#543 — so it is linked rather than described as a someday.
1 parent 53b7320 commit a364648

1 file changed

Lines changed: 14 additions & 7 deletions

File tree

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -328,9 +328,12 @@ small delta that belongs upstream.
328328
| `iso-did` | [iso-did](https://github.com/hugomrdias/iso-repo/tree/main/packages/iso-did) | Kept in step with the forks above |
329329

330330
The `iso-passkeys` delta is two lines and purely additive — nothing is changed
331-
or removed, two existing internal functions are simply exported. Once that lands
332-
upstream these forks can go away, and the `pnpm.overrides` block in
333-
`package.json` with them.
331+
or removed, two existing internal functions are simply exported. It is proposed
332+
upstream as
333+
[hugomrdias/iso-repo#543](https://github.com/hugomrdias/iso-repo/pull/543); once
334+
that lands, these three forks and their entries in `pnpm.overrides` can go. The
335+
remaining entries in that block — `iso-web`, `conf>ajv`, `ajv>fast-uri` — are
336+
unrelated and stay.
334337

335338
### Not a fork
336339

@@ -339,10 +342,14 @@ existing one. It implements WebAuthn varsig signing for OrbitDB oplog entries
339342
and has no upstream equivalent. It follows `iso-repo` conventions and lives in
340343
the same lineage, which is why it is named the way it is.
341344

342-
Its format is still moving: see
343-
[#11](https://github.com/Le-Space/orbitdb-identity-provider-webauthn-did/issues/11)
344-
and [iso-repo#1](https://github.com/NiKrause/iso-repo/issues/1) for the
345-
non-recursive varsig layout it will follow.
345+
It follows the non-recursive varsig layout, which shipped in 0.2.0.
346+
347+
One thing is still open, and it is on the spec side rather than here: the
348+
WebAuthn varsig header. `webauthn-varsig-header` is `TODO` in
349+
[ChainAgnostic/varsig#11](https://github.com/ChainAgnostic/varsig/pull/11), so
350+
the `0x300001` marker this package writes is a private-use codepoint chosen
351+
here rather than an allocated one. Expect the wire format to change once that
352+
is settled.
346353

347354
### Not forked at all
348355

0 commit comments

Comments
 (0)