chore(release): version packages - #208
Merged
Merged
Conversation
✅ Deploy Preview for openzeppelin-ui ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.
Releases
@openzeppelin/ui-types@3.5.0
Minor Changes
#206
f2d90e3Thanks @pasevin! - Add the shared write-completion vocabulary and widenIRSCapability.deployOnchainIdto acompletion-keyed result.
New exports
WriteCompletion—'submitted' | 'confirmed'. How far a write must progress before thecapability call resolves; absent ≡
'confirmed', so today's behaviour is unchanged.WriteCompletionOptions— the known keys (completion,onSubmitted) forRelayerExecutionConfig.transactionOptions.DeployOnchainIdConfirmedResult/DeployOnchainIdSubmittedResult/DeployOnchainIdOutcome— the completion-keyed union returned bydeployOnchainId.RelayerExecutionConfig.transactionOptionsis now typed as known-keys-plus-passthrough(
WriteCompletionOptions & Record<string, unknown>). Known keys become compile-checked acrossconsumers and adapters; residual keys remain passthrough, so existing callers keep compiling.
IRSCapability.deployOnchainIdnow returnsPromise<DeployOnchainIdOutcome>instead ofPromise<DeployOnchainIdResult>.This is the migration-relevant change.
DeployOnchainIdResultis unchanged and still exported —it is the confirmed arm's base — but the method's return type is now a union, because on the
submit-only path the ONCHAINID address does not exist yet. The submit-only arm therefore has
no
onchainIdproperty at all rather than an optionalonchainId?: stringon one sharedshape, so a caller cannot read a fabricated or empty address without narrowing first.
Migration — narrow on
completionbefore readingonchainId:Callers that never request submit-only still only ever receive the
'confirmed'arm at runtime,so the narrowing is the only change required. Code that already destructured
onchainIddirectly will now fail to compile until the check above is added — that is intentional, and is
what prevents a submit-only deploy from silently yielding an undefined address.
Vocabulary and result shapes only: receipt-waiting, IRS / ERC-3643 behaviour, and per-operation
semantics stay in the adapters.