zec
/
secant-android-wallet
mirror of https://github.com/zcash/secant-android-wallet.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
secant-android-wallet/docs/Architecture.md

3.2 KiB
Raw Blame History

Design and Architecture

Note: This document will continue to be updated as the app is implemented.

Gradle

  • Versions are declared in gradle.properties. There's still enough inconsistency in how versions are handled in Gradle, that this is as close as we can get to a universal system. A version catalog is used for dependencies and is configured in settings.gradle.kts, but other versions like Gradle Plug-ins, the NDK version, Java version, and Android SDK versions don't fit into the version catalog model and are read directly from the properties
  • Much of the Gradle configuration lives in build-conventions to prevent repetitive configuration as additional modules are added to the project
  • Build scripts are written in Kotlin, so that a single language is used across build and the app code bases
  • Only Gradle, Google, and JetBrains plug-ins are included in the critical path. Third party plug-ins can be used, but they're outside the critical path. For example, the Gradle Versions Plugin could be removed and wouldn't negative impact building, testing, or deploying the app

Multiplatform

While this repository is for an Android application, efforts are made to give multiplatform flexibility in the future. Specific adaptions that are being made:

  • Where possible, common code is extracted into multiplatform modules
  • In UI state management code, Kotlin Flow is often preferred over Android LiveData and Compose State to grant future flexibility

Note: test coverage for multiplatform modules behaves differently than coverage for Android modules. Coverage is only generated for a JVM target, and requires running two tasks in sequence: ./gradlew check -PIS_COVERAGE_ENABLED=true; ./gradlew jacocoTestReport -PIS_COVERAGE_ENABLED=true

App

The main entrypoints of the application are:

  • AppImpl.kt - The root Application object defined in the app module
  • MainActivity.kt - The main Activity, defined in ui-lib. Note that the Activity is NOT exported. Instead, the app module defines an activity-alias in the AndroidManifest which is what presents the actual icon on the Android home screen.

Modules

The logical components of the app are implemented as a number of Gradle modules.

  • app — Compiles all of the modules together into the final application. This module contains minimal actual code. Note that the Java package structure for this module is under cash.z.ecc.app while the Android package name is cash.z.ecc.
  • build-info-lib — Collects information from the build environment (e.g. Git SHA, Git commit count) and compiles them into the application. Can also be used for injection of API keys or other secrets.
  • ui-lib — User interface that the user interacts with. This contains 99% of the UI code, along with localizations, icons, and other assets.
  • preference
    • preference-api-lib — Multiplatform interfaces for key-value storage of preferences
    • preference-impl-android-lib — Android-specific implementation for preference storage
  • test-lib — Provides common test utilities