Document the IDL versioning convention - #108
Merged
Merged
Conversation
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
1 participant
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 documents the recommended convention for versioning Codama IDLs stored in metadata accounts. Producers write their IDL to the single canonical
idlseed at whichever Codama version their tooling generates, and consumers normalise on read via the@codama/upgradepackage, which upgrades an IDL of any older major to the latest version of the standard. The new "IDL versioning" section also documents version-pinned seeds such asidl-codama-v1as an advanced escape hatch, warns that seeds are fixed 16-byte buffers which the JavaScript SDK silently truncates, and clarifies that the account header carries no kind or version information — thestandardandversionfields inside the content are the source of truth. The existing "Seeds" bullet now points at the new section.