app-monorepo
app-monorepo copied to clipboard
OneKeyHQ
feat: support attach pin on hardware
Walkthrough
This update adds support for the Attach-to-PIN feature. It introduces new UI flows, error handling, and device logic for entering a hidden wallet PIN on hardware devices. The changes include new animations, UI components, type extensions, and error classes. The wallet onboarding flow now allows users to select between standard and hidden wallets.
Changes
| Files/Paths | Change Summary |
|---|---|
package.json |
Updated five @onekeyfe hardware SDK dependencies from 1.0.37 to 1.0.39-alpha.2. |
.../ServiceHardware/ServiceHardware.ts |
Enhanced event handling for PIN/passphrase, refactored unlock logic, added getFeaturesWithUnlock method. |
.../ServiceHardwareUI/ServiceHardwareUI.ts |
Added UI method for attach PIN dialog, extended payload for passphrase dialog. |
.../atoms/hardware.ts |
Extended IHardwareUiPayload type with attach PIN, firmware, and request type fields. |
.../animations/enter-hidden-wallet-pin-touch.json |
Added new Lottie animation asset for hidden wallet PIN entry. |
.../Hardware/Hardware.tsx |
Added EnterHiddenWalletPinOnDevice component, updated passphrase UI, added attach PIN button/logic. |
.../Hardware/index.tsx |
Passed new switchOnDeviceAttachPin prop to EnterPhase component. |
.../HardwareUiStateContainer/HardwareUiStateContainer.tsx |
Conditional rendering for attach PIN, updated dialog titles, passed new props to components. |
.../ConnectHardwareWallet/ConnectYourDevice.tsx |
Added wallet type selection logic, improved device unlock and wallet creation flow. |
.../ConnectHardwareWallet/SelectAddWalletTypeDialog.tsx |
Added dialog and hook for selecting wallet type (standard/hidden). |
.../errors/errors/hardwareErrors.ts |
Added InvalidAttachPin error class. |
.../errors/utils/deviceErrorUtils.ts |
Handled new error code for invalid attach PIN in error conversion logic. |
.../ServiceAccount/ServiceAccount.ts |
Added method to check existence of standard hardware wallets. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant UI
participant ServiceHardware
participant Device
User->>UI: Start wallet onboarding
UI->>ServiceHardware: Connect to device
ServiceHardware->>Device: Request features/unlock
Device-->>ServiceHardware: Responds with lock/passphrase/attach PIN state
ServiceHardware-->>UI: Update UI with device state
alt Attach PIN required
UI->>User: Show "Enter Hidden Wallet PIN" dialog
User->>UI: Selects attach PIN option
UI->>ServiceHardware: Request attach PIN entry
ServiceHardware->>Device: Trigger attach PIN entry
Device-->>ServiceHardware: PIN entry result
ServiceHardware-->>UI: Show result
end
alt Wallet creation
UI->>User: Show wallet type selection (standard/hidden)
User->>UI: Selects wallet type
UI->>ServiceHardware: Create selected wallet type
ServiceHardware->>Device: Create wallet
Device-->>ServiceHardware: Wallet created
ServiceHardware-->>UI: Show wallet created
end
Assessment against linked issues
| Objective (Issue) | Addressed | Explanation |
|---|---|---|
| Support Attach-to-PIN feature (OK-37995) | ✅ |
Assessment against linked issues: Out-of-scope changes
No out-of-scope changes found. All changes relate directly to supporting the Attach-to-PIN feature.
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
🧪 Generate unit tests
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
- [ ] Commit unit tests in branch
feat/attachPin
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Explain this complex logic.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and explain its main purpose.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai auto-generate unit teststo generate unit tests for this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryorSummaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
![coderabbitai[bot] avatar](https://avatars.githubusercontent.com/in/347564?v=4 "Published by a pub.dev verified publisher"){kind=small}
All alerts resolved. Learn more about Socket for GitHub.
This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.
![socket-security[bot] avatar](https://avatars.githubusercontent.com/in/156372?v=4 "Published by a pub.dev verified publisher"){kind=small}
:tada: Snyk checks have passed. No issues have been found so far.
:white_check_mark: security/snyk check is complete. No issues have been found. (View Details)
:white_check_mark: license/snyk check is complete. No issues have been found. (View Details)
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
