Change password by bordalix · Pull Request #134 · arkade-os/wallet

bordalix · 2025-08-05T16:29:27Z

Closes #132 and #133

@theDavidCoen please test and review

Summary by CodeRabbit

New Features
- Added a new password management option in Settings, allowing users to change their wallet password or enable biometric authentication if supported.
- Introduced a dedicated password change screen with real-time password validation and error/success feedback.
- Option to register biometric authentication from the password change screen.
Improvements
- Updated icons and text for biometric authentication prompts to use a lock icon and clearer messaging.
- Settings menu now includes a "Change password" option under Advanced settings.
Bug Fixes
- Improved password validation logic with clearer error handling during password changes.
Refactor
- Enhanced variable naming and code clarity in wallet service worker for maintainability.
- Removed unused biometric icon component and related references.
Chores
- Removed debug logging from LNURL-related functions for cleaner output.

coderabbitai · 2025-08-05T16:29:34Z

Walkthrough

The changes introduce a "Change Password" feature in the wallet application's settings. This includes a new settings option and UI for changing the password, validation of the old password, and support for biometric password registration. Supporting code includes new logic for password validation, updates to settings options, and UI adjustments for icons and text. Minor refactoring and renaming were performed for clarity in the service worker.

Changes

Cohort / File(s)	Change Summary
Wallet Service Worker Variable Renaming & Status Update `public/wallet-service-worker.mjs`	Refactored variable and parameter names for clarity; added optional `xOnlyPublicKey` to wallet status message; no logic changes.
Settings Change Password Feature `src/screens/Settings/Password.tsx`, `src/screens/Settings/Index.tsx`, `src/providers/options.tsx`, `src/lib/types.ts`	Added new `Password` settings screen, integrated it into settings navigation, updated options and enum value for password change.
Password Validation Logic `src/lib/privateKey.ts`	Added `isValidPassword` async function for password validation; updated error message in `setPrivateKey`.
UI Icon and Text Updates `src/components/NeedsPassword.tsx`, `src/screens/Init/Password.tsx`, `src/icons/Passkey.tsx`	Replaced `PasskeyIcon` with `LockIcon` in UI components; removed and deleted unused `PasskeyIcon`; updated descriptive text.
LNURL Debug Logging Cleanup `src/lib/lnurl.ts`	Removed debug `console.log` statements from `fetchInvoice` and `fetchArkAddress` functions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SettingsScreen
    participant PasswordComponent
    participant PrivateKeyLib
    participant WalletContext
    participant BiometricLib

    User->>SettingsScreen: Select "Change Password"
    SettingsScreen->>PasswordComponent: Render Password UI
    User->>PasswordComponent: Enter old password
    PasswordComponent->>PrivateKeyLib: isValidPassword(oldPassword)
    PrivateKeyLib-->>PasswordComponent: true/false
    alt Valid password
        PasswordComponent->>User: Show new password input
        User->>PasswordComponent: Enter new password
        PasswordComponent->>PrivateKeyLib: getPrivateKey(oldPassword)
        PrivateKeyLib-->>PasswordComponent: privateKey
        PasswordComponent->>PrivateKeyLib: setPrivateKey(newPassword, privateKey)
        PrivateKeyLib-->>PasswordComponent: success/failure
        PasswordComponent->>WalletContext: Update password state
        PasswordComponent->>User: Show success
        opt Biometric supported and selected
            PasswordComponent->>BiometricLib: registerBiometric()
            BiometricLib-->>PasswordComponent: passkeyId
            PasswordComponent->>WalletContext: Save biometric info
        end
    else Invalid password
        PasswordComponent->>User: Show error
    end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Add "Change Password" option in settings (#132)	✅
Implement UI for changing password, including old/new password validation (#132)	✅
Support biometric registration as alternative during password change (#132)	✅
Ensure password validation and error handling in password change flow (#132)	✅

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Variable renaming and parameter updates in wallet service worker (`public/wallet-service-worker.mjs`)	Refactoring for clarity and consistency, not directly related to the "Change Password" feature.
Removal of debug `console.log` statements in LNURL functions (`src/lib/lnurl.ts`)	Cleanup of debug logs unrelated to password change functionality.
UI icon replacement and text updates in `NeedsPassword.tsx` and `Init/Password.tsx`	Cosmetic UI changes not directly related to password change feature implementation.
Deletion of `PasskeyIcon` component (`src/icons/Passkey.tsx`)	Removal of unused icon component, unrelated to password change feature.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ab7d35d and 4eb3e23.

📒 Files selected for processing (2)

src/lib/lnurl.ts (0 hunks)
src/lib/privateKey.ts (1 hunks)

💤 Files with no reviewable changes (1)

src/lib/lnurl.ts

🚧 Files skipped from review as they are similar to previous changes (1)

src/lib/privateKey.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Cloudflare Pages: arkade-wallet

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch change_password

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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 @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
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 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@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 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.

coderabbitai

Actionable comments posted: 5

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b38e3bd and ab7d35d.

📒 Files selected for processing (9)

public/wallet-service-worker.mjs (53 hunks)
src/components/NeedsPassword.tsx (2 hunks)
src/icons/Passkey.tsx (0 hunks)
src/lib/privateKey.ts (1 hunks)
src/lib/types.ts (1 hunks)
src/providers/options.tsx (1 hunks)
src/screens/Init/Password.tsx (2 hunks)
src/screens/Settings/Index.tsx (2 hunks)
src/screens/Settings/Password.tsx (1 hunks)

💤 Files with no reviewable changes (1)

src/icons/Passkey.tsx

🧰 Additional context used

🧠 Learnings (5)

📓 Common learnings

Learnt from: bordalix
PR: arkade-os/wallet#114
File: src/lib/asp.ts:0-0
Timestamp: 2025-06-30T18:33:29.839Z
Learning: In src/lib/asp.ts, only the collaborativeExit function should accept both IWallet and ServiceWorkerWallet types. Other wallet functions (getBalance, getTxHistory, getReceivingAddresses, redeemNotes, sendOnChain, settleVtxos) should maintain their original IWallet-only signatures and not be updated for consistency.

📚 Learning: in src/screens/init/restore.tsx, the input component for private key restoration intentionally omits...

Learnt from: bordalix
PR: arkade-os/wallet#121
File: src/screens/Init/Restore.tsx:58-58
Timestamp: 2025-07-21T18:25:36.391Z
Learning: In src/screens/Init/Restore.tsx, the Input component for private key restoration intentionally omits the `value` prop to make it uncontrolled. This is a security feature to prevent the private key from being displayed if users navigate away and return to the screen, avoiding potential exposure of sensitive data in the UI.

Applied to files:

src/screens/Init/Password.tsx
src/components/NeedsPassword.tsx
src/screens/Settings/Index.tsx
src/screens/Settings/Password.tsx
src/providers/options.tsx

📚 Learning: in src/lib/asp.ts, only the collaborativeexit function should accept both iwallet and serviceworkerw...

Learnt from: bordalix
PR: arkade-os/wallet#114
File: src/lib/asp.ts:0-0
Timestamp: 2025-06-30T18:33:29.839Z
Learning: In src/lib/asp.ts, only the collaborativeExit function should accept both IWallet and ServiceWorkerWallet types. Other wallet functions (getBalance, getTxHistory, getReceivingAddresses, redeemNotes, sendOnChain, settleVtxos) should maintain their original IWallet-only signatures and not be updated for consistency.

Applied to files:

src/components/NeedsPassword.tsx
src/lib/privateKey.ts
public/wallet-service-worker.mjs

📚 Learning: do not review `public/wallet-service-worker.mjs` as it is a built file generated by vite....

Learnt from: bordalix
PR: arkade-os/wallet#114
File: public/wallet-service-worker.mjs:6350-6353
Timestamp: 2025-06-30T18:23:34.163Z
Learning: Do not review `public/wallet-service-worker.mjs` as it is a built file generated by Vite.

Applied to files:

public/wallet-service-worker.mjs

📚 Learning: in src/lib/bolt11.ts, the code is copied from the original bitcoinjs/bolt11 library (https://github....

Learnt from: bordalix
PR: arkade-os/wallet#106
File: src/lib/bolt11.ts:153-155
Timestamp: 2025-07-07T14:41:35.991Z
Learning: In src/lib/bolt11.ts, the code is copied from the original bitcoinjs/bolt11 library (https://github.com/bitcoinjs/bolt11/blob/master/payreq.js) and should be kept unchanged to maintain compatibility with the upstream source, even if there are potential improvements or syntax issues.

Applied to files:

public/wallet-service-worker.mjs

🪛 Biome (2.1.2)

src/screens/Settings/Password.tsx

[error] 2-2: Do not shadow the global "Error" property.

Consider renaming this variable. It's easy to confuse the origin of variables when they're named after a known global.

(lint/suspicious/noShadowRestrictedNames)

🪛 ESLint

public/wallet-service-worker.mjs

[error] 1084-1084: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1087-1087: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1122-1122: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1124-1124: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1126-1126: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1135-1135: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1135-1135: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1135-1135: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1144-1144: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1146-1146: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1150-1150: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1154-1154: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1233-1233: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1253-1253: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 1293-1293: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 9447-9447: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 9992-9992: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 9992-9992: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11076-11076: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11413-11413: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11413-11413: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11426-11426: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11431-11431: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11435-11435: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11435-11435: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11435-11435: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11439-11439: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11840-11840: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11840-11840: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11841-11841: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11841-11841: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11841-11841: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11843-11843: Strings must use singlequote.

(@typescript-eslint/quotes)

[error] 11893-11893: Strings must use singlequote.

(@typescript-eslint/quotes)