docs: update package README links and deprecate keepSession - #922
Closed
wabicai wants to merge 1 commit into
Closed
Conversation
Member
Author
|
Folded into #920 — README + keepSession deprecation now live on docs/developer-portal-1.2.0. |
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.
Summary
Point published package READMEs at the 1.2.x Getting Started path, omit the stale iframe
connectSrcsample, and mark publickeepSessionas deprecated.Intent and context
The developer portal 1.2.0 docs (see #920) tell integrators to:
/en/hardware-sdk/getting-startedconnectSrcso@onekeyfe/hd-web-sdkfillshttps://jssdk.onekey.so/<installed-version>/useEmptyPassphrase/openWalletSession+passphraseStateinstead ofkeepSessionnpm READMEs and
CommonParamsstill taught the old contract.Root cause
Package-surface docs were not updated when Hardware SDK 1.2.0 shipped Protocol V2 wallet sessions.
Design decisions
https://developer.onekey.so/en/hardware-sdk/getting-started.hd-web-sdkinit sample omitsconnectSrc; the SDK default is alreadyDEFAULT_DOMAINfromgetSDKVersion().@deprecatedis on publicCommonParams.keepSessiononly. Transportrelease(..., keepSession)stays internal.getPassphraseStatestays compatibility, not deprecated.Compatibility and risk
No runtime change. Existing
keepSession: truecalls still work. TypeScript consumers see a deprecation warning.Hardware coverage
Not applicable.
Test plan
yarn agent:check --profile commitlint/whitespace/agent-context passed@onekeyfe/hd-coretest: 1 unrelated failure inevmSignTypedData.test.ts(BigNumberparse of0x89). This PR only touches README + a JSDoc block onkeepSession.packages/core/src/types/params.ts