refactor: Migrate navigation to nav3 #554

ovitrif · 2025-12-23T13:15:28Z

Resolves #480

Description

This PR migrates the entire navigation system from legacy Compose Navigation (NavController) to the newly stable Navigation 3 (Nav3).

Key changes:

Updated all navigation usage with Nav3 primitives
Moved all navigation code to its dedicated nav package
Moved all type-safe route definitions to Routes.kt sealed interface
Introduced Navigator class centralising navigation logic
Added SheetSceneStrategy for custom bottom sheets
Replaced material3 BottomSheetScaffold with custom sheet implementation
Entry handlers in nav/entries/ for all screen and sheet routes
Removed legacy code and old sheet implementations
Updated 55+ screens from NavController to Navigator pattern
Net reduction of +3k lines of code
TabBar now slides out below the viewport when showing sheets or non-wallet screens

Preview

nav3.mp4

QA Notes

ovitrif · 2025-12-24T13:02:02Z

re-drafted because it's not yet ready

Copilot

Pull request overview

This PR migrates Bitkit's navigation system from Jetpack Navigation Compose to Navigation 3, replacing legacy navigation patterns with a custom implementation. The migration centralizes navigation logic in a dedicated Navigator class and implements type-safe routes using a sealed interface structure. A custom SheetSceneStrategy replaces Material3's BottomSheetScaffold, providing more control over bottom sheet behavior. The refactor eliminates approximately 3,000 lines of code while maintaining all existing navigation flows.

Key changes:

Replaced Jetpack Navigation with Navigation 3 primitives (NavBackStack, EntryProviderScope)
Introduced Navigator class for centralized navigation operations
Migrated all routes to type-safe sealed interface hierarchy in Routes.kt
Implemented custom bottom sheet system via SheetSceneStrategy and SheetHost

Reviewed changes

Copilot reviewed 100 out of 100 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`gradle/libs.versions.toml`	Updated dependency versions: Kotlin 2.3.0, Navigation3 1.0.0, removed old navigation libraries
`app/build.gradle.kts`	Replaced navigation-compose with navigation3-runtime and navigation3-ui
`WalletViewModel.kt`	Added receive flow state management for CJIT entries and invoices
`TransferViewModel.kt`	Added regtest auto-mining support, renamed timing constants
`AppViewModel.kt`	Removed sheet management logic, simplified effect types, added timed sheet route mapping
`Bip21Utils.kt`	Migrated Bitcoin URI scheme to use `UriScheme` enum
`WipeWalletUseCase.kt`	Removed redundant `Companion` qualifier
`ui/utils/Transitions.kt`	Deleted legacy transition utilities (replaced by Nav3 approach)
`ui/theme/Defaults.kt`	Removed unused transition timing constants
`ui/sheets/*.kt`	Deleted legacy sheet files (SendSheet, PinSheet, BackupSheet, GiftSheet, ReceiveSheet)
`ui/settings/*.kt`	Updated all settings screens to use `Navigator` instead of `NavController`
`ui/screens/wallets/*.kt`	Migrated wallet screens to use `Navigator` and updated activity handling
`ui/screens/transfer/*.kt`	Updated transfer screens with `Navigator` pattern
`ui/screens/scanner/QrScanningScreen.kt`	Removed result-passing pattern in favor of direct callback
`ui/scaffold/AppTopBar.kt`	Minor formatting fixes
`ui/onboarding/TermsOfUseScreen.kt`	Removed extra blank line
`ui/nav/entries/*.kt`	New entry provider files organizing navigation destinations
`ui/nav/Transitions.kt`	New file with Nav3-compatible transition definitions
`ui/nav/SheetSceneStrategy.kt`	Custom sheet implementation for Nav3
`ui/nav/Routes.kt`	Type-safe route definitions using sealed interface
`ui/nav/Navigator.kt`	Centralized navigation operations wrapper
`ui/nav/DeepLinks.kt`	Deep link pattern matching system
`ui/components/SheetHost.kt`	Custom bottom sheet implementation replacing Material3 scaffold
`ui/components/*.kt`	Minor formatting and import updates

Copilot · 2025-12-28T23:03:30Z

app/src/main/java/to/bitkit/viewmodels/AppViewModel.kt

            }
            refreshOnchainSendIfNeeded()
-            setSendEffect(SendEffect.PopBack(SendRoute.Confirm))
+            setSendEffect(SendEffect.PopBack(Routes.Send.Confirm))


The PopBack effect expects a Routes type but Routes.Send.Confirm is being passed. This appears to be correct after the migration, but the naming PopBack is misleading since it now takes a complete route rather than indicating which route to pop back to.

Copilot · 2025-12-28T23:03:31Z

app/src/main/java/to/bitkit/ui/screens/wallets/receive/ReceiveQrScreen.kt

+    val showingQrCode = !showDetails && !(showingCjitOnboarding && selectedTab == ReceiveTab.SPENDING)
+    if (showingQrCode) {
+        SetMaxBrightness()
    }


The SetMaxBrightness() call is now conditional based on showingQrCode, but previously it was called unconditionally at the top of the composable. Verify this conditional logic correctly handles all cases where the QR code should be displayed at max brightness.

Suggested change

val showingQrCode = !showDetails && !(showingCjitOnboarding && selectedTab == ReceiveTab.SPENDING)

if (showingQrCode) {

SetMaxBrightness()

}

SetMaxBrightness()

Copilot · 2025-12-28T23:03:31Z

app/src/main/java/to/bitkit/ui/nav/entries/SheetEntries.kt

+        val walletUiState by walletViewModel.uiState.collectAsStateWithLifecycle()
+
+        SendConfirmScreen(
+            savedStateHandle = remember { androidx.lifecycle.SavedStateHandle() },


Creating a new SavedStateHandle instance will not preserve state across configuration changes. This should use the SavedStateHandle from the entry's arguments or a properly scoped ViewModel.

Copilot · 2025-12-28T23:03:31Z

app/src/main/java/to/bitkit/ui/nav/DeepLinks.kt

+    }
+}
+
+// TODO Temporary fix while these schemes can't be decoded via bitkit-core


This function is marked as TODO temporary fix but is now part of the public API. Consider adding KDoc explaining why this is temporary and what the long-term solution should be.

Suggested change

// TODO Temporary fix while these schemes can't be decoded via bitkit-core

// TODO Temporary fix while these schemes can't be decoded via bitkit-core

/**

* Removes known Lightning-related URI schemes from this [String].

*

* This is a temporary workaround used to normalize incoming Lightning- and LNURL-style

* identifiers before they are processed by the app's deep-link handling. At the moment,

* `bitkit-core` cannot reliably decode the LNURL-related schemes defined in [UriScheme],

* so we strip these prefixes here to allow downstream parsing to continue.

*

* Long-term, this helper should be removed once `bitkit-core` (for example

* [com.synonym.bitkitcore.decode]) supports decoding LNURL and related Lightning schemes

* directly. At that point, callers should rely on the canonical `bitkit-core` parser

* instead of manually manipulating the URI string.

*/

Copilot · 2025-12-28T23:03:32Z

app/src/main/java/to/bitkit/ui/components/SheetHost.kt

-            }
+        // Fixed background extension - covers gap when sheet drags up
+        val density = LocalDensity.current
+        if (sheetVisible && sheetHeightPx > 0f) {


The fixed background extension box is added conditionally, but the comment suggests it covers a gap when the sheet drags up. Consider extracting this logic into a separate composable function for better readability.

ovitrif self-assigned this Dec 23, 2025

ovitrif force-pushed the feat/nav3 branch 10 times, most recently from 232e470 to a72fc22 Compare December 24, 2025 12:49

ovitrif requested a review from jvsena42 December 24, 2025 12:58

ovitrif marked this pull request as ready for review December 24, 2025 12:58

ovitrif removed the request for review from jvsena42 December 24, 2025 13:01

ovitrif marked this pull request as draft December 24, 2025 13:01

ovitrif force-pushed the feat/nav3 branch 3 times, most recently from 5b5fe6e to e73fbef Compare December 24, 2025 13:25

jvsena42 mentioned this pull request Dec 24, 2025

fix: unify timed sheets behavior #556

Open

9 tasks

ovitrif force-pushed the feat/nav3 branch 2 times, most recently from 0ce73a0 to 595dfbb Compare December 26, 2025 14:13

ovitrif added 4 commits December 26, 2025 19:08

refactor: migrate navigation to nav3

e24de5c

chore: update deps

9dc383e

refactor: implement custom sheet component

84c4c59

fix: polish navigation

8e6f857

ovitrif force-pushed the feat/nav3 branch from 595dfbb to e57eef3 Compare December 26, 2025 18:09

ovitrif added 2 commits December 26, 2025 20:08

refactor: introduce nav routes hierarchy

5bd99b5

chore: cleanup

1eb159f

ovitrif force-pushed the feat/nav3 branch from e57eef3 to 1eb159f Compare December 26, 2025 19:08

ovitrif added 5 commits December 26, 2025 21:25

fix: sheet dismiss on fast swipe

b357b6f

fix: sheet bg gap on sheet upward drag

5e19b1a

fix: sheet dismiss sensitivity

342365d

fix: apply receive brightness only when seeing QR

46d7e73

fix: drawer menu positioning

fd95f09

ovitrif marked this pull request as ready for review December 27, 2025 12:08

fix: move regtest mining to viewmodel

1065fac

ovitrif force-pushed the feat/nav3 branch from 8d74297 to 1065fac Compare December 27, 2025 13:38

jvsena42 requested a review from Copilot December 28, 2025 23:02

Copilot AI reviewed Dec 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: Migrate navigation to nav3 #554

refactor: Migrate navigation to nav3 #554

Uh oh!

ovitrif commented Dec 23, 2025 •

edited

Loading

Uh oh!

ovitrif commented Dec 24, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 28, 2025

Uh oh!

Copilot AI Dec 28, 2025

Uh oh!

Copilot AI Dec 28, 2025

Uh oh!

Copilot AI Dec 28, 2025

Uh oh!

Copilot AI Dec 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-// TODO Temporary fix while these schemes can't be decoded via bitkit-core
+// TODO Temporary fix while these schemes can't be decoded via bitkit-core
+/**
+ * Removes known Lightning-related URI schemes from this [String].
+ *
+ * This is a temporary workaround used to normalize incoming Lightning- and LNURL-style
+ * identifiers before they are processed by the app's deep-link handling. At the moment,
+ * `bitkit-core` cannot reliably decode the LNURL-related schemes defined in [UriScheme],
+ * so we strip these prefixes here to allow downstream parsing to continue.
+ *
+ * Long-term, this helper should be removed once `bitkit-core` (for example
+ * [com.synonym.bitkitcore.decode]) supports decoding LNURL and related Lightning schemes
+ * directly. At that point, callers should rely on the canonical `bitkit-core` parser
+ * instead of manually manipulating the URI string.
+ */

refactor: Migrate navigation to nav3 #554

Are you sure you want to change the base?

refactor: Migrate navigation to nav3 #554

Uh oh!

Conversation

ovitrif commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Preview

QA Notes

Uh oh!

ovitrif commented Dec 24, 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 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 28, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ovitrif commented Dec 23, 2025 •

edited

Loading