feat: support RN app migration #290

ben-kaufman · 2025-12-23T18:48:36Z

This PR adds support for migrating an existing React Native Bitkit into the Bitkit native app.
The migration passes:

Balances
Channels
Activities
Settings
Widgets
Tags and notes
Closed Channels

record.mp4

What's still needed:

New design for the loading screen and success toast of migration
Support for restoring a wallet created in RN app which was later deleted. Ie. create wallet in RN, use it, delete the app, install native, recover using mnemonic.

Copilot

Pull request overview

This PR adds support for migrating existing React Native Bitkit wallets to the native Swift app. The migration automatically detects RN wallet data on first launch and transfers wallet credentials, Lightning channels, settings, activities, widgets, and metadata to the native app format.

Key Changes:

Comprehensive RN wallet data detection and migration system with MMKV binary parsing
Channel migration support for Lightning Network state preservation
Migration loading UI with success/error toast notifications

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
Bitkit/Services/MigrationsService.swift	Implements complete RN migration logic including MMKV parsing, keychain reading, and data transformation for settings, activities, channels, and widgets
Bitkit/AppScene.swift	Adds migration detection flow on app startup and displays loading screen during migration
Bitkit/ViewModels/WalletViewModel.swift	Passes pending channel migration data to Lightning service during wallet initialization
Bitkit/ViewModels/AppViewModel.swift	Handles post-sync migration completion with metadata reapplication and success notification
Bitkit/Services/LightningService.swift	Accepts and applies channel migration data during Lightning node setup
Bitkit/Services/CoreService.swift	Adds utility to mark all unseen activities as seen after migration
Bitkit/Utilities/Keychain.swift	Removes outdated TODO comment about RN keychain migration
Bitkit.xcodeproj/.../Package.resolved	Updates ldk-node dependency revision for channel migration support

Copilot · 2025-12-24T09:19:01Z

Bitkit/Services/MigrationsService.swift

+        var jsonString = rootJson
+        if let jsonStart = rootJson.firstIndex(of: "{") {
+            jsonString = String(rootJson[jsonStart...])
+        }


The JSON extraction logic is duplicated across multiple extract methods (extractRNMetadata, extractRNWidgets, extractRNActivities, extractRNClosedChannels). Consider extracting this into a shared helper method that takes a key name and returns the parsed JSON object.

Copilot · 2025-12-24T09:19:01Z

Bitkit/Services/MigrationsService.swift

+                    var activityId = txId
+                    if let onchain = try? await CoreService.shared.activity.getOnchainActivityByTxId(txid: txId) {
+                        activityId = onchain.id
+                    }


This pattern of converting txId to activityId is duplicated in applyRNMetadata (lines 767-770, 787-790) and applyOnchainMetadata (lines 985-986). Extract this into a helper method to reduce duplication and improve maintainability.

Copilot · 2025-12-24T09:19:02Z

Bitkit/Services/MigrationsService.swift

+        func getBool(from dict: [String: Any], key: String, fallbackKey: String? = nil, defaultValue: Bool) -> Bool {
+            let keys = fallbackKey != nil ? [key, fallbackKey!] : [key]
+            for k in keys {
+                if let val = dict[k] as? Bool { return val }
+                if let val = dict[k] as? Int { return val != 0 }
+                if let val = dict[k] as? NSNumber { return val.boolValue }
+            }
+            return defaultValue
+        }


This nested helper function is quite useful and handles different boolean representations. Consider extracting it as a private method of MigrationsService so it can be reused elsewhere if needed, and add a comment explaining why multiple type checks are necessary for RN data compatibility.

Copilot · 2025-12-24T09:19:02Z

Bitkit/ViewModels/AppViewModel.swift

+                    try? await CoreService.shared.activity.syncLdkNodePayments(LightningService.shared.payments ?? [])
+                    await CoreService.shared.activity.markAllUnseenActivitiesAsSeen()
+                    await MigrationsService.shared.reapplyMetadataAfterSync()
+                    try? await LightningService.shared.restart()
+
+                    MigrationsService.shared.isShowingMigrationLoading = false
+                    self.toast(type: .success, title: "Migration Complete", description: "Your wallet has been successfully migrated")


Errors from syncLdkNodePayments and LightningService.restart are silently ignored with try?. If these operations fail during migration, the user will see a success message even though the migration may be incomplete. Consider logging these errors or handling them appropriately, potentially showing a different message if critical steps fail.

Suggested change

try? await CoreService.shared.activity.syncLdkNodePayments(LightningService.shared.payments ?? [])

await CoreService.shared.activity.markAllUnseenActivitiesAsSeen()

await MigrationsService.shared.reapplyMetadataAfterSync()

try? await LightningService.shared.restart()

MigrationsService.shared.isShowingMigrationLoading = false

self.toast(type: .success, title: "Migration Complete", description: "Your wallet has been successfully migrated")

var hadError = false

do {

let payments = LightningService.shared.payments ?? []

try await CoreService.shared.activity.syncLdkNodePayments(payments)

} catch {

hadError = true

Logger.warn("Failed to sync LDK node payments during migration: \(error)", context: "AppViewModel")

}

await CoreService.shared.activity.markAllUnseenActivitiesAsSeen()

await MigrationsService.shared.reapplyMetadataAfterSync()

do {

try await LightningService.shared.restart()

} catch {

hadError = true

Logger.warn("Failed to restart LightningService after migration: \(error)", context: "AppViewModel")

}

MigrationsService.shared.isShowingMigrationLoading = false

if hadError {

self.toast(

type: .warning,

title: "Migration Completed With Issues",

description: "Your wallet migration completed, but some background tasks may not have finished correctly."

)

} else {

self.toast(

type: .success,

title: "Migration Complete",

description: "Your wallet has been successfully migrated"

)

}

Copilot · 2025-12-24T09:19:02Z

Bitkit/Services/MigrationsService.swift

+        var result: [String: Data] = [:]
+
+        func getBool(from dict: [String: Any], key: String, fallbackKey: String? = nil, defaultValue: Bool) -> Bool {
+            let keys = fallbackKey != nil ? [key, fallbackKey!] : [key]


Force unwrapping fallbackKey with ! is unsafe. Use optional unwrapping instead: let keys = [key] + (fallbackKey.map { [$0] } ?? []) or a more explicit check.

Suggested change

let keys = fallbackKey != nil ? [key, fallbackKey!] : [key]

let keys = [key] + (fallbackKey.map { [$0] } ?? [])

Copilot · 2025-12-24T09:19:02Z

Bitkit/Services/MigrationsService.swift

+                channelId: channel.channel_id,
+                counterpartyNodeId: channel.counterparty_node_id ?? "",
+                fundingTxoTxid: fundingTxid,
+                fundingTxoIndex: 0,


The fundingTxoIndex is hardcoded to 0, but RN channels may have used different output indices. The correct index should be extracted from the RN channel data or the funding transaction if available, otherwise channel identification may be incorrect.

Bitkit/Services/MigrationsService.swift

Bitkit/AppScene.swift

jvsena42 · 2025-12-26T16:20:10Z

Bitkit/Services/CoreService.swift

+                    try await ServiceQueue.background(.core) {
+                        try BitkitCore.markActivityAsSeen(activityId: id, seenAt: timestamp)
+                    }


nit: maybe could apply some parallelization in case the wallet has many activities, but I'm not sure if it would make a big difference

feat: support RN app migration

3a9b188

ben-kaufman requested review from jvsena42, ovitrif and pwltr December 23, 2025 18:48

jvsena42 requested a review from Copilot December 24, 2025 09:17

Copilot AI reviewed Dec 24, 2025

View reviewed changes

jvsena42 reviewed Dec 24, 2025

View reviewed changes

Bitkit/Services/MigrationsService.swift Show resolved Hide resolved

jvsena42 reviewed Dec 26, 2025

View reviewed changes

Bitkit/Services/MigrationsService.swift Show resolved Hide resolved

jvsena42 reviewed Dec 26, 2025

View reviewed changes

Bitkit/AppScene.swift Show resolved Hide resolved

jvsena42 reviewed Dec 26, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: support RN app migration #290

feat: support RN app migration #290

ben-kaufman commented Dec 23, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 24, 2025

Uh oh!

Copilot AI Dec 24, 2025

Uh oh!

Copilot AI Dec 24, 2025

Uh oh!

Copilot AI Dec 24, 2025

Uh oh!

Copilot AI Dec 24, 2025

Uh oh!

Copilot AI Dec 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jvsena42 Dec 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-                    try? await CoreService.shared.activity.syncLdkNodePayments(LightningService.shared.payments ?? [])
-                    await CoreService.shared.activity.markAllUnseenActivitiesAsSeen()
-                    await MigrationsService.shared.reapplyMetadataAfterSync()
-                    try? await LightningService.shared.restart()
-                    MigrationsService.shared.isShowingMigrationLoading = false
-                    self.toast(type: .success, title: "Migration Complete", description: "Your wallet has been successfully migrated")
+                    var hadError = false
+                    do {
+                        let payments = LightningService.shared.payments ?? []
+                        try await CoreService.shared.activity.syncLdkNodePayments(payments)
+                    } catch {
+                        hadError = true
+                        Logger.warn("Failed to sync LDK node payments during migration: \(error)", context: "AppViewModel")
+                    }
+                    await CoreService.shared.activity.markAllUnseenActivitiesAsSeen()
+                    await MigrationsService.shared.reapplyMetadataAfterSync()
+                    do {
+                        try await LightningService.shared.restart()
+                    } catch {
+                        hadError = true
+                        Logger.warn("Failed to restart LightningService after migration: \(error)", context: "AppViewModel")
+                    }
+                    MigrationsService.shared.isShowingMigrationLoading = false
+                    if hadError {
+                        self.toast(
+                            type: .warning,
+                            title: "Migration Completed With Issues",
+                            description: "Your wallet migration completed, but some background tasks may not have finished correctly."
+                        )
+                    } else {
+                        self.toast(
+                            type: .success,
+                            title: "Migration Complete",
+                            description: "Your wallet has been successfully migrated"
+                        )
+                    }

	let keys = fallbackKey != nil ? [key, fallbackKey!] : [key]
	let keys = [key] + (fallbackKey.map { [$0] } ?? [])

feat: support RN app migration #290

Are you sure you want to change the base?

feat: support RN app migration #290

Conversation

ben-kaufman commented Dec 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jvsena42 Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants