feat: add bbolt-to-SQLite migration tool for embedded LND wallets#3788
feat: add bbolt-to-SQLite migration tool for embedded LND wallets#3788kaloudis wants to merge 6 commits intoZeusLN:masterfrom
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a crucial feature allowing users to seamlessly migrate their embedded LND wallet databases from bbolt to SQLite. This change aims to enhance the underlying database performance and maintainability for embedded LND nodes by providing a guided, user-initiated migration path, complete with safeguards for configuration and user experience. Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces a valuable feature for migrating embedded LND wallets from bbolt to SQLite, including a new utility function, migration attempt tracking, and a UI in the Tools menu. A critical privacy leak was identified where the Tor setting is ignored during migration restart, potentially exposing the user's IP address. This should be addressed by passing the user's Tor preference to the migration utility. Additionally, there are areas for improvement in code robustness and maintainability, specifically regarding error handling in the core migration logic and improving type safety by replacing any types with the specific Node interface.
c5f3500 to
ce775cd
Compare
ce775cd to
02561ac
Compare
|
Pumping the brakes on this, as we have to create our own db migration tool to facilitate this or build off of code from https://github.com/lightninglabs/lndinit?tab=readme-ov-file#migrate-db |
Description
Relates to issue: ZEUS-3357
Summary
migrateBboltToSqliteutility that stops LND, rewrites the config for SQLite, restarts, and verifies themigration succeeded (rolling back on failure)
MigrationUtilsto record whether a migration has been attempted for a given walletbbolt
Test plan
isSqliteunset/falseisSqlitesetting is updated totrueafter successful migrationback
PR Type
This pull request is categorized as a:
Checklist
yarn run tscand made sure my code compiles correctlyyarn run lintand made sure my code didn’t contain any problematic patternsyarn run prettierand made sure my code is formatted correctlyyarn run testand made sure all of the tests passTesting
If you modified or added a utility file, did you add new unit tests?
I have tested this PR on the following platforms (please specify OS version and phone model/VM):
I have tested this PR with the following types of nodes (please specify node version and API version where appropriate):
Locales
Third Party Dependencies and Packages
yarnafter this PR is merged inpackage.jsonandyarn.lockhave been properly updatedOther: