Repository navigation
docs: explain is_compatible differences between vault-registry and access-lease/subscription - #144
Merged
Busiii-adetiba merged 2 commits intoOct 17, 2026
Conversation
…cess-lease/subscription (SynapsVault#115) Add a "Version compatibility checks" section to docs/CONTRACTS.md that contrasts the two is_compatible variants: vault-registry takes a caller- supplied version and compares major.minor with the compiled version, while access-lease and subscription take no argument and require the stored version to equal the compiled version exactly. Includes signatures, failure cases, worked examples and when to use each, and links it from the Versioning convention. Closes SynapsVault#115 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
|
@adenueltech Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
…ns (SynapsVault#115) Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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
2 participants
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.
Closes #115
What changed
docs/CONTRACTS.mdlistedis_compatiblein each contract's table but never explained that the vault-registry version answers a different question. This PR adds a Version compatibility checks section under Common conventions and links it from the Versioning convention row.vault-registryaccess-lease,subscriptionis_compatible(version: String)is_compatible()major.minorprefix matchfalsewhenmajor.minorThe section also includes:
0.2.1: registry accepts"0.2.0", but a lease contract with stored0.2.0reports incompatible.initor upgrades; the lease/subscription check is for spotting a stale deployment.upgrade, access-lease and subscription reportfalseuntilmigrateruns, while vault-registry keeps accepting clients on the samemajor.minor.The behaviour described is taken from the entrypoints' rustdoc and the last commit where CI passed (
fce5c0e), including the existingis_compatibletests (VERSION→ true,"99.0.0"→ false,""→ false).Note for maintainers
CI on
mainhas been failing since Oct 16 (e.g.access-lease/src/lib.rs:195: expected ';'). On currentmainthe contracts also routeget_version/is_compatiblethroughcommonhelpers whose signatures (u32-based) don't match the calls, so CI on this PR will fail for reasons unrelated to this docs-only change. Issue #44 ("unify semantics") was closed by a README-only change, so the two behaviours documented here are still the intended ones.Docs only, no code changes. Merges cleanly with #143 (the #103 docs PR).
🤖 Generated with Claude Code