Fix: iCloud restore duplication check OK-35645

[sidmorizon]

Summary by CodeRabbit

• New Features
  • Enhanced wallet recovery and backup restoration process with added verification steps for improved security and reliability.
  • Updated wallet setup now requires explicit secure input, ensuring a smoother and safer restoration experience for users.

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[coderabbitai]

Walkthrough

This update changes the wallet creation process. In the ServiceAccount class, the createHDWalletWithRs method now requires a walletHash parameter instead of treating it as optional. In the ServiceCloudBackup module, the restoreFromPrivateBackup method has been updated. It now converts an encoded string into a mnemonic, builds a wallet hash, and then uses that hash for wallet creation. The method also processes an isOverrideWallet flag based on the wallet creation result.

Changes

File Path	Change Summary
packages/kit-bg/src/services/ServiceAccount/ServiceAccount.ts	Updated createHDWalletWithRs method: the walletHash parameter is now required.
packages/kit-bg/src/services/ServiceCloudBackup/index.ts	Modified restoreFromPrivateBackup: imported mnemonicFromEntropy, converted rsEncoded to a mnemonic, built the wallet hash, and passed it to the updated createHDWalletWithRs, handling the isOverrideWallet flag.

Sequence Diagram(s)

sequenceDiagram
    participant SCB as ServiceCloudBackup
    participant Secret as mnemonicFromEntropy
    participant SA as ServiceAccount
    participant WB as walletHashBuilder

    SCB->>Secret: Convert rsEncoded to mnemonic
    Secret-->>SCB: Return mnemonic
    SCB->>WB: Build walletHash using mnemonic
    WB-->>SCB: Return walletHash
    SCB->>SA: Call createHDWalletWithRs with walletHash
    SA-->>SCB: Return isOverrideWallet flag

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9962130 and e756e54.

📒 Files selected for processing (2)

• packages/kit-bg/src/services/ServiceAccount/ServiceAccount.ts (1 hunks)
• packages/kit-bg/src/services/ServiceCloudBackup/index.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: unittest (20.x)
• GitHub Check: lint (20.x)

🔇 Additional comments (4)

packages/kit-bg/src/services/ServiceCloudBackup/index.ts (3)

8-8: LGTM: New import for mnemonic generation.

The addition of mnemonicFromEntropy import aligns with the new functionality for wallet restoration.

---

615-627: Improve wallet override handling.

The code now properly handles wallet overrides by checking the isOverrideWallet flag before restoring accounts. This prevents duplicate wallet creation and improves data consistency.

---

597-614:

✅ Verification successful

Verify mnemonic generation and wallet hash calculation.

The code now generates a mnemonic from the encrypted seed and uses it to build a wallet hash. This change helps prevent duplicate wallet creation.

Run this script to verify the mnemonic generation and wallet hash calculation:

---

🏁 Script executed:

#!/bin/bash
# Description: Check for any existing tests or usages of mnemonicFromEntropy and walletHashBuilder

# Search for tests
rg -A 5 "mnemonicFromEntropy|walletHashBuilder" "*test*"

# Search for other usages
rg -A 5 "mnemonicFromEntropy|walletHashBuilder"

Length of output: 19061

---

Mnemonic and Wallet Hash Functions Verified

The tests and code usage across the repository confirm that the changes in ServiceCloudBackup are working as intended. The mnemonic generation with mnemonicFromEntropy produces valid outputs (with expected word counts), and the wallet hash is correctly generated using walletHashBuilder; both functions are used consistently in several modules and tests.

• Confirmed usage in secret tests and in other service modules (e.g., ServiceAccount).
• The changes prevent duplicate wallet creation as intended.

No further action is needed on this snippet.

packages/kit-bg/src/services/ServiceAccount/ServiceAccount.ts (1)

2229-2229: Update method signature for better type safety.

The walletHash parameter is now required, which improves type safety and makes the contract clearer.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 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.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in 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 generate unit testing code.
  • @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.

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 pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary or Summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.