How csc301-2025-f/project-9-orali-project-for-android works
Project Type and Purpose
• Type: Multi-module Android mobile wallet application with supporting libraries.
– A shared Kotlin library (“taler-kotlin-android”) providing common Taler utilities.
– A local SQLite transaction database module (“transaction-database”).
– The main Android wallet app (“wallet”) built with Jetpack Compose, MVVM, and Kotlin.
File Structure
• Top-level modules:
– taler-kotlin-android: reusable Kotlin code (HTTP utils, data models, crypto, QR code).
– transaction-database: local SQLite schema, data-access layer, database models & filters.
– wallet: Android application, MVVM structure, Compose UI, network/backend layer, local preferences via Protobuf, CI/CD scripts, Fastlane.
• Other artifacts:
– Gradle wrapper, settings.gradle, build scripts.
– GitHub Actions workflows and contrib/ci jobs for building & deploying each module.
– deliverables and planning docs (non-runtime).
Extract Architectural Insights from README
• Architecture style: Modular layered architecture on the client (library → data → UI).
• MVVM pattern: ViewModels, managers, repository-style classes.
• Core technologies: Kotlin, AndroidX, Jetpack Compose, SQLite, Protobuf, Fastlane, GitHub Actions.
• External dependency: GNU Taler backend (HTTP API called by WalletBackendApi).
Main Components & Their Relationships
A. taler-kotlin-android library
• Provides:
– Common data models (Amount, CurrencySpecification, Tranx, etc.)
– Utilities (HttpUtils, QrCodeManager, CryptoUtils)
• Dependencies: None (top-level reusable library).
B. transaction-database module
• Provides:
– SQLite database schema & data-access (Queries, TranxDatabase)
– Filter classes for history.
• Depends on: taler-kotlin-android (shared data model classes).
C. wallet Android App
• Layers:
1. UI (Jetpack Compose screens, Fragments)
2. ViewModels & Managers (BalanceManager, DepositManager, PeerManager, TransactionManager, etc.)
3. Data/Backend Layer:
– Local storage: Transaction-database, user-prefs Protobuf via SettingsManager
– Remote API: WalletBackendApi, BackendManager over NetworkInterface/RequestManager
• Depends on:
– taler-kotlin-android (models, utilities)
– transaction-database (for history)
D. External Services
• GNU Taler Backend: REST API endpoints for payment, deposit, withdraw.
• QR Code: scanning & generation within device via QrCodeManager.
E. CI/CD & Deployment
• GitHub Actions + contrib/ci jobs:
– Module builds & tests
– Fastlane for wallet’s Play Store / FDroid deployment
– From each Manager/ViewModel to either local DB module or remote API module.
– From remote API module to external GNU Taler backend.
– From wallet to Protobuf user-prefs storage.
– From taler-kotlin-android utilities to both wallet and transaction-database modules.
– CI/CD pipeline orchestrating builds of all modules and deployment of the wallet APK.
Architectural Patterns & Principles
• Modularity: clear separation into library, database, and application modules.
• Layering: UI → ViewModel → Data Repository (DB / Network).
• MVVM: Compose UI bound to ViewModels.
• Repository Pattern: Managers abstract data sources.
• Single Responsibility: Each module and class has a focused role.
• Dependency Flow: Only top-level modules depend on lower-level libraries.
Relevant Technologies & Frameworks
– Kotlin + Android Gradle Plugin
– Jetpack Compose, AndroidX (Lifecycle, Navigation)
– SQLite (via transaction-database module)
– Protobuf (user_prefs.proto)
– HTTP/REST via Retrofit-style RequestManager
– Fastlane (app distribution)
– GitHub Actions & custom CI scripts