Backup file after dkg #587

kleysc · 2024-12-23T20:08:00Z

Issue #580

Implementation Summary

Objective: Encourage guardians to download a backup file automatically generated after completing the DKG process, enhancing security and ensuring the recovery of keys and configurations.

Key Changes

Backup File Generation:
- Implemented the automatic generation of a compressed file that includes the guardian’s keys and configurations upon completing the DKG process.
UI Enhancements:
- Added an interface in the administration section displaying a prominent and intuitive message to encourage downloading the backup file.
- Clear option to download the backup file directly from the interface.

Features

Proactive Notification: Notification alerts users to the importance of downloading the backup file after completing the DKG.
Automatic Backup: Automated process for creating the backup file without manual intervention.
Easy Access: Visible and accessible link to download the backup directly from the administration interface.

UI Implementation

Before: There was no encouragement to download the backup after completing the DKG process.
Now: Users receive an immediate message encouraging them to download the backup and understand its importance.

backup.mp4

Summary by CodeRabbit

New Features
- Added a backup modal for downloading Guardian application backup files
- Introduced a new custom hook for managing trimmed input arrays and single inputs
Localization
- Added "Downloaded" status messages across multiple language files
Types
- Added Backup state to setup progress
- Added optional guardianName to setup state
Dependencies
- Added Chakra UI Icons library

vercel · 2024-12-23T20:08:06Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 15, 2025 3:59pm

coderabbitai · 2024-12-23T20:10:48Z

📝 Walkthrough

Walkthrough

This pull request introduces a comprehensive backup modal feature for the Guardian application. The changes include creating a new BackupModal component, modifying the SetupComplete screen to incorporate the backup flow, adding a new custom input hook, extending the setup progress enum, and updating localization files across multiple languages to support the new backup download functionality.

Changes

File	Change Summary
`apps/router/src/guardian-ui/components/BackupModal.tsx`	New React component for handling backup file downloads
`apps/router/src/guardian-ui/components/setup/screens/setupComplete/SetupComplete.tsx`	Added `showBackupModal` state and integrated `BackupModal`
`apps/router/src/hooks/custom/useTrimmedInput.tsx`	New custom hooks for managing trimmed input
`apps/router/src/types/guardian.tsx`	Added `Backup` enum value and `guardianName` property
`apps/router/package.json`	Added `@chakra-ui/icons` dependency
`apps/router/src/languages/*.json`	Added `"downloaded"` translation across multiple languages

Possibly related issues

#Encourage downloading the backup file after DKG completion #580: This PR directly addresses the issue of encouraging guardians to download their backup file after DKG completion, implementing a modal to guide users through the backup process.

Possibly related PRs

Trim passwords input #589: Relates to input management and state handling, which is similar to the approach used in the BackupModal component.

Suggested reviewers

dpc

📜 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 1e06c7f and 49aa9c4.

📒 Files selected for processing (1)

apps/router/package.json (1 hunks)

🔇 Additional comments (1)

apps/router/package.json (1)

18-18: ⚠️ Potential issue

Fix dependency version and add missing peer dependency.

The specified version ^2.2.4 of @chakra-ui/icons has the following issues:

It's incompatible with the latest 2.1.x release line

Missing required peer dependency @chakra-ui/system

Contains known vulnerabilities

Please update to use the latest stable version and add the peer dependency:
-    "@chakra-ui/icons": "^2.2.4",
+    "@chakra-ui/icons": "^2.1.1",
+    "@chakra-ui/system": "^2.6.2",
Run this script to verify the latest versions and security advisories:

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
- 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 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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a73666e and b97ffee.

📒 Files selected for processing (1)

apps/router/src/hooks/custom/useTrimmedInput.tsx (1 hunks)

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

GitHub Check: Lint

🔇 Additional comments (1)

apps/router/src/hooks/custom/useTrimmedInput.tsx (1)

5-13: LGTM!

The hook implementation is clean and type-safe.

apps/router/src/hooks/custom/useTrimmedInput.tsx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

alexlwn123

Thanks for the contribution! Great feature addition.

I left some feedback in the PR to address before merging.

Cheers!

apps/router/src/guardian-ui/components/BackupModal.tsx

apps/router/src/guardian-ui/setup/FederationSetup.tsx

package-lock.json

package.json

apps/router/src/guardian-ui/components/BackupModal.tsx

alexlwn123 · 2025-01-13T17:36:13Z

yarn.lock

this is a bit scary... lets revert this unless we have a good reason

Thanks for the review! All suggested changes have been applied. Let me know if there's anything else to address 🫡

Thanks @alexlwn123, for making the change to yarn.lock. I understand that you decided to revert the registry change as it might cause some inconvenience or inconsistencies.

Could you confirm if there’s anything else I should review or adjust regarding this? I want to ensure that the current state of the PR meets expectations before we proceed with the merge.

Thank you again for your review and support.

Just merged! Great work! 🙌

alexlwn123

Nice! Thanks for addressing those comments. Great PR!

kleysc added 7 commits December 18, 2024 17:43

feat: trim whitespace in verification codes

d42ce8a

feat: trim leading/trailing whitespace in verification codes

9dc8bcb

feat: trim leading/trailing whitespace in verification codes/rebase

d5dcca2

fix: rebase branch

d0e882e

feat: update backup modal

e8cb54b

feat: improve backup modal UI and download flow

46a4e5e

fix: use correct setup action type in modal close

a73666e

kleysc requested review from a team as code owners December 23, 2024 20:08

vercel bot deployed to Preview December 23, 2024 20:10 View deployment

kleysc mentioned this pull request Dec 23, 2024

Encourage downloading the backup file after DKG completion #580

Open

elsirion requested a review from alexlwn123 January 3, 2025 13:20

feat: resolve conflict

bf91143

vercel bot deployed to Preview January 11, 2025 02:57 View deployment

fix: update hook usrTrimmedInput

b97ffee

vercel bot deployed to Preview January 11, 2025 03:25 View deployment

coderabbitai bot reviewed Jan 11, 2025

View reviewed changes

apps/router/src/hooks/custom/useTrimmedInput.tsx Outdated Show resolved Hide resolved

apps/router/src/hooks/custom/useTrimmedInput.tsx Outdated Show resolved Hide resolved

Update apps/router/src/hooks/custom/useTrimmedInput.tsx

c5f2d3d

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

vercel bot deployed to Preview January 11, 2025 04:01 View deployment

Merge branch 'master' into backup-file-after-DKG

3674473

vercel bot deployed to Preview January 11, 2025 04:04 View deployment

alexlwn123 requested changes Jan 13, 2025

View reviewed changes

kleysc added 3 commits January 14, 2025 14:14

feat: enhance BackupModal functionality

e4d709c

refactor: remove redundant BackupModal from FederationSetup

055a40e

feat: update downloaded translations for multiple languages

1e06c7f

vercel bot deployed to Preview January 14, 2025 17:30 View deployment

refactor: move @chakra-ui/icons to apps/router/package.json

49aa9c4

vercel bot deployed to Preview January 14, 2025 19:31 View deployment

kleysc requested a review from alexlwn123 January 14, 2025 19:35

chore: revert registry change to yarn.lock

6c8d86d

vercel bot deployed to Preview January 15, 2025 15:59 View deployment

alexlwn123 approved these changes Jan 16, 2025

View reviewed changes

alexlwn123 merged commit b3e188a into fedimint:master Jan 16, 2025
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Backup file after dkg #587

Backup file after dkg #587

kleysc commented Dec 23, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Dec 23, 2024 •

edited

Loading

coderabbitai bot commented Dec 23, 2024 •

edited

Loading

Walkthrough

Changes

Possibly related issues

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

alexlwn123 left a comment

alexlwn123 Jan 13, 2025

kleysc Jan 14, 2025

kleysc Jan 15, 2025

alexlwn123 Jan 16, 2025

alexlwn123 left a comment

Backup file after dkg #587

Backup file after dkg #587

Conversation

kleysc commented Dec 23, 2024 • edited by coderabbitai bot Loading

Implementation Summary

Summary by CodeRabbit

vercel bot commented Dec 23, 2024 • edited Loading

coderabbitai bot commented Dec 23, 2024 • edited Loading

Walkthrough

Changes

Possibly related issues

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

alexlwn123 left a comment

Choose a reason for hiding this comment

alexlwn123 Jan 13, 2025

Choose a reason for hiding this comment

kleysc Jan 14, 2025

Choose a reason for hiding this comment

kleysc Jan 15, 2025

Choose a reason for hiding this comment

alexlwn123 Jan 16, 2025

Choose a reason for hiding this comment

alexlwn123 left a comment

Choose a reason for hiding this comment

kleysc commented Dec 23, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Dec 23, 2024 •

edited

Loading

coderabbitai bot commented Dec 23, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)