docs(changesets): fix the pending release notes - #305
Merged
Conversation
📦 Bundle size impactComparing No size changes detected. 🟢 |
valentinfernandez1
self-requested a review
August 19, 2026 11:41
valentinfernandez1
approved these changes
Aug 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: declaresringVrfSignas a required member ofthe exported
AccountsProvider. Wording and wrapping copied fromaccounts-sign-vrf.md,which documents the same kind of break for
signVrf.pending-changesets/host-chain-discovery.md: the explicitgetChainAPI(env)form isunchanged only on legacy hosts. On a discovery-capable host it throws
EnvironmentMismatchErrorwhen the host's asset hub genesis matches a different bundledenvironment, and
GenesisMismatchErrorwhen it matches none and the bundled asset hubdescriptor disagrees. Both surface at the call, not at the first storage read.
pending-changesets/truapi-09-ring-vrf-keys.md:findRingVrfKeyHandleis exported from@parity/product-sdk-host, not from@parity/product-sdk-signer, which re-exports thering-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
chainIdcan pick a key registered for a different ring on the samechain.
pending-changesets/README.md: newDeclare required-member additionssubsection, so thenext 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 isconsumed.
Why these changes
Four members became required on
AccountsProvidersince host 0.15.1:listRingVrfKeys,registerRingVrfKey,ringVrfSignandsignVrf. Three were documented,ringVrfSignwasnot. 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.