feat: add kms_contract_id to CVM SDK schemas, deprecate kms_id#424
Open
Leechael wants to merge 1 commit into
Open
feat: add kms_contract_id to CVM SDK schemas, deprecate kms_id#424Leechael wants to merge 1 commit into
Leechael wants to merge 1 commit into
Conversation
CVM identity is moving from a single KMS node (kms_id) to the on-chain KMS contract (kms_contract_id). Add kms_contract_id alongside kms_id across the SDKs as an additive, backward-compatible transition; kms_id is marked deprecated. - JS: ProvisionCvmSchema response, CommitCvmProvisionRequestSchema, CvmBasicInfoV20251028Schema gain kms_contract_id; kms_id @deprecated. - Python: ProvisionCvmResponse gains kms_contract_id. - Go: ProvisionCVMResponse gains KMSContractID. - CLI: the deprecated --kms-id flag is now a no-op (the backend resolves the KMS by contract, not node id); the flag is retained for one more release.
Contributor
📋 Check Results✨ JS SDK - Code FormattingShow format check results🔍 JS SDK - TypeScript Type CheckShow type check output🧪 JS SDK - Test ResultsShow test output📝 JS SDK - Lint CheckShow lint results🌐 JS SDK - Browser CompatibilityShow browser test results🌐 Browser Compatibility ReportBrowser compatibility tests completed across:
The SDK has been verified to work in modern browser environments. Check run: https://github.com/Phala-Network/phala-cloud/actions/runs/26878720298 |
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.
Summary
CVM identity is moving from a single KMS node (
kms_id) to the on-chain KMS contract (kms_contract_id). This PR addskms_contract_idalongsidekms_idacross the SDKs as an additive, backward-compatible transition.kms_idis marked deprecated.This is the SDK/CLI half of the
CVM.kms_iddeprecation; the backend half lives in the monorepo (separate PR).Changes
ProvisionCvmSchema(response),CommitCvmProvisionRequestSchema, andCvmBasicInfoV20251028Schemagainkms_contract_id;kms_idannotated@deprecated.ProvisionCvmResponsegainskms_contract_id.ProvisionCVMResponsegainsKMSContractID.--kms-idflag is now a no-op (the backend resolves the KMS by contract, not node id). The flag is retained for one more release to avoid breaking existing invocations.Validation
build,type-check,lint, 725 tests passbuild, tests passtype-check,lint, deploy handler tests pass (pre-existing interface-compat spawn failures are unrelated to this change)Notes
The SDK
kms_contract_idfields are optional transition scaffolding. The backend currently conveys KMS contract identity via thekms_infoblock; consumers can migrate tokms_contract_idonce the backend populates the top-level field.