Skip to content

docs(changesets): fix the pending release notes - #305

Merged
valentinfernandez1 merged 4 commits into
mainfrom
domi/changeset-prose
Aug 19, 2026
Merged

docs(changesets): fix the pending release notes#305
valentinfernandez1 merged 4 commits into
mainfrom
domi/changeset-prose

Conversation

@Imod7

@Imod7 Imod7 commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Description

Fixes the prose in three of the seven changesets parked for the 0.22.0 wave, and records the
convention that would have caught the main omission. No code. Nothing is promoted to
.changeset/, so this publishes nothing.

Changes

pending-changesets/host-ring-vrf-sign.md: declares ringVrfSign as a required member of
the exported AccountsProvider. Wording and wrapping copied from accounts-sign-vrf.md,
which documents the same kind of break for signVrf.

pending-changesets/host-chain-discovery.md: the explicit getChainAPI(env) form is
unchanged only on legacy hosts. On a discovery-capable host it throws
EnvironmentMismatchError when the host's asset hub genesis matches a different bundled
environment, and GenesisMismatchError when it matches none and the bundled asset hub
descriptor disagrees. Both surface at the call, not at the first storage read.

pending-changesets/truapi-09-ring-vrf-keys.md: findRingVrfKeyHandle is exported from
@parity/product-sdk-host, not from @parity/product-sdk-signer, which re-exports the
ring-VRF types only. Also why the inline comparison is a trap: the helper matches the
junction path in order and compares chain and collection ids case-insensitively, so a
shortcut checking only chainId can pick a key registered for a different ring on the same
chain.

pending-changesets/README.md: new Declare required-member additions subsection, so the
next author states the break instead of rediscovering the need for it. Quotes the pattern
inline rather than pointing at accounts-sign-vrf.md, which is deleted once the wave is
consumed.

Why these changes

Four members became required on AccountsProvider since host 0.15.1: listRingVrfKeys,
registerRingVrfKey, ringVrfSign and signVrf. Three were documented, ringVrfSign was
not. Implementations and hand-rolled test doubles break at compile time even though no
caller changes, so the break is invisible to anyone reading only call sites.

The chain-discovery changeset said calls passing an environment keep the previous behaviour
on legacy hosts, which is true, and said nothing about discovery-capable hosts, where an
unchanged call site can now fail earlier and with a different error type.

@Imod7 Imod7 changed the title Domi/changeset prose docs(changesets): fix the pending release notes Aug 19, 2026
@github-actions

Copy link
Copy Markdown

📦 Bundle size impact

Comparing 2026-08-19T09:22:13.671Z2026-08-19T09:21:21.543Z

No size changes detected. 🟢

@valentinfernandez1
valentinfernandez1 self-requested a review August 19, 2026 11:41
@valentinfernandez1
valentinfernandez1 merged commit 62b08d1 into main Aug 19, 2026
12 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants