Implementation of Background Services & Notification System

.github/workflows/main.yml

@@ -4,9 +4,6 @@ on:
   pull_request:
     branches:
       - main
-  push:
-    branches:
-      - wip
 
 jobs:  
   build:      

CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contributing to Mostro Mobile
+
+Welcome! Thank you for your interest in contributing to the Mostro Mobile project. This guide will help you get started, understand the project architecture, and contribute effectively.
+
+---
+
+## Table of Contents
+- [How to Contribute](#how-to-contribute)
+- [Project Architecture Overview](#project-architecture-overview)
+- [Getting Started](#getting-started)
+- [Best Practices & Tips](#best-practices--tips)
+- [Contact & Further Resources](#contact--further-resources)
+
+---
+
+## How to Contribute
+
+We follow the standard GitHub workflow:
+
+1. **Fork the repository**
+2. **Create a new branch** for your feature or bugfix
+3. **Write clear, descriptive commit messages**
+4. **Push your branch** and open a Pull Request (PR)
+5. **Describe your changes** thoroughly in the PR
+6. **Participate in code review** and address feedback
+
+For bug reports and feature requests, please [open an issue](https://github.com/MostroP2P/mobile/issues) with:
+- Clear title and description
+- Steps to reproduce (for bugs)
+- Screenshots/logs if relevant
+
+---
+
+## Project Architecture Overview
+
+Mostro Mobile is a Flutter app designed with modularity and maintainability in mind. Here’s a high-level overview of the architecture and key technologies:
+
+### 1. State Management: Riverpod & Notifier Pattern
+- **Riverpod** is used for dependency injection and state management.
+- Providers are organized by feature, e.g., `features/order/providers/order_notifier_provider.dart`.
+- The **Notifier pattern** is used for complex state logic (e.g., order submission, authentication). Notifiers encapsulate business logic and expose state via providers.
+- Dedicated state providers are often used to track transient UI states, such as submission progress or error messages.
+
+### 2. Data Persistence: Sembast
+- **Sembast** is a NoSQL database used for local data persistence.
+- Database initialization is handled in `shared/providers/mostro_database_provider.dart`.
+- Data repositories (e.g., `data/repositories/base_storage.dart`) abstract CRUD operations and encode/decode models.
+- All local data access should go through repository classes, not direct database calls.
+
+### 3. Connectivity: NostrService
+- Connectivity with the Nostr protocol is handled by `services/nostr_service.dart`.
+- The `NostrService` manages relay connections, event subscriptions, and message handling.
+- All Nostr-related logic should be routed through this service or its providers.
+
+### 4. Routing: GoRouter
+- Navigation is managed using **GoRouter**.
+- The main router configuration is set up in `core/app.dart` (see the `goRouter` instance).
+- Route definitions are centralized for maintainability and deep linking.
+
+### 5. Internationalization (i18n)
+- Internationalization is handled using the `intl` package and Flutter’s localization tools.
+- Localization files are in `lib/l10n/` and generated code in `lib/generated/`.
+- Use `S.of(context).yourKey` for all user-facing strings.
+
+### 6. Other Key Patterns & Utilities
+- **Background Services:** Found in `lib/background/` for handling background tasks (e.g., notifications, data sync).
+- **Notifications:** Managed via `notifications/` and corresponding providers.
+- **Shared Utilities:** Common widgets, helpers, and providers live in `shared/`.
+- **Testing:** Tests are in the `test/` and `integration_test/` directories.
+
+---
+
+## Getting Started
+
+1. **Clone the repo:**
+   ```sh
+   git clone https://github.com/chebizarro/mobile.git
+   cd mobile
+   ```
+2. **Install dependencies:**
+   ```sh
+   flutter pub get
+   ```
+3. **Run the app:**
+   ```sh
+   flutter run
+   ```
+4. **Configure environment:**
+   - Localization: Run `flutter gen-l10n` if you add new strings.
+   - Platform-specific setup: See `README.md` for details.
+
+5. **Testing:**
+   - Unit tests: `flutter test`
+   - Integration tests: `flutter test integration_test/`
+
+6. **Linting & Formatting:**
+   - Check code style: `flutter analyze`
+   - Format code: `flutter format .`
+
+---
+
+## Best Practices & Tips
+
+- **Follow the existing folder and provider structure.**
+- **Use Riverpod for all state management.** Avoid mixing with other state solutions.
+- **Encapsulate business logic in Notifiers** and expose state via providers.
+- **Use repositories for all data access** (Sembast or Nostr).
+- **Keep UI code declarative and side-effect free.**
+- **For SnackBars, dialogs, or overlays,** always use a post-frame callback to avoid build-phase errors (see `NostrResponsiveButton` pattern).
+- **Refer to existing features** (e.g., order submission, chat) for implementation examples.
+
+---
+
+## Contact & Further Resources
+
+- **Main repo:** [https://github.com/MostroP2P/mobile](https://github.com/MostroP2P/mobile)
+- **Questions/Help:** Open a GitHub issue or discussion
+- **Docs:** See `README.md` and code comments for more details
+
+Happy contributing!

README.md

@@ -81,6 +81,8 @@ flutter run
    cargo run
    ```
 
+See the README.md in the mostro repository for more details.
+
 ## Setting up Polar for Testing
 
 1. Launch Polar and create a new Lightning Network.
@@ -106,18 +108,17 @@ This project is licensed under the MIT License. See the `LICENSE` file for detai
 - [x] Displays order list
 - [x] Take orders (Buy & Sell)
 - [x] Posts Orders (Buy & Sell)
-- [ ] Direct message with peers (use nip-17)
-- [ ] Fiat sent
-- [ ] Release
-- [ ] Maker cancel pending order
-- [ ] Cooperative cancellation
+- [x] Direct message with peers
+- [x] Fiat sent
+- [x] Release
+- [x] Maker cancel pending order
+- [x] Cooperative cancellation
 - [ ] Buyer: add new invoice if payment fails
-- [ ] Rate users
-- [ ] List own orders
+- [x] Rate users
+- [x] List own orders
 - [ ] Dispute flow (users)
 - [ ] Dispute management (for admins)
 - [ ] Conversation key management
-- [ ] Create buy orders with LN address
-- [ ] Nip-06 support (identity management)
-- [ ] Settings tab
-- [ ] Notifications
+- [x] Create buy orders with LN address
+- [x] Settings tab
+- [x] Notifications

android/app/build.gradle

@@ -11,12 +11,14 @@ android {
     ndkVersion = "26.3.11579264" //flutter.ndkVersion
 
     compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_1_8
-        targetCompatibility = JavaVersion.VERSION_1_8
+        coreLibraryDesugaringEnabled true
+
+        sourceCompatibility = JavaVersion.VERSION_11
+        targetCompatibility = JavaVersion.VERSION_11
     }
 
     kotlinOptions {
-        jvmTarget = JavaVersion.VERSION_1_8
+        jvmTarget = "11"
     }
 
     defaultConfig {
@@ -42,3 +44,7 @@ android {
 flutter {
     source = "../.."
 }
+
+dependencies {
+    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.1.4'
+}

android/app/src/main/AndroidManifest.xml

@@ -1,10 +1,13 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+	xmlns:tools="http://schemas.android.com/tools">
 	<application
 		android:label="Mostro P2P"
 		android:name="${applicationName}"
 		android:icon="@mipmap/launcher_icon"
 		android:allowBackup="false"
-		android:fullBackupContent="false">
+		android:fullBackupContent="false"
+		android:enableOnBackInvokedCallback="true">
+
 		<activity
 			android:name=".MainActivity"
 			android:exported="true"
@@ -14,35 +17,44 @@
 			android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
 			android:hardwareAccelerated="true"
 			android:windowSoftInputMode="adjustResize">
-			<!-- Specifies an Android theme to apply to this Activity as soon as
-                 the Android process has started. This theme is visible to the user
-                 while the Flutter UI initializes. After that, this theme continues
-                 to determine the Window background behind the Flutter UI. -->
 			<meta-data
 				android:name="io.flutter.embedding.android.NormalTheme"
-				android:resource="@style/NormalTheme"
-			/>
+				android:resource="@style/NormalTheme" />
 			<intent-filter>
 				<action android:name="android.intent.action.MAIN" />
 				<category android:name="android.intent.category.LAUNCHER" />
 			</intent-filter>
 		</activity>
-		<!-- Don't delete the meta-data below.
-             This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
+
+		<service
+			android:name="id.flutter.flutter_background_service.BackgroundService"
+			android:exported="false"
+			android:foregroundServiceType="dataSync"
+			android:permission="android.permission.FOREGROUND_SERVICE"
+			tools:replace="android:exported" />
+
+		<receiver
+			android:exported="false"
+			android:name="com.dexterous.flutterlocalnotifications.ActionBroadcastReceiver" />
 		<meta-data
 			android:name="flutterEmbedding"
 			android:value="2" />
+		<meta-data
+			android:name="com.google.firebase.messaging.default_notification_icon"
+			android:resource="@drawable/ic_bg_service_small" />
+
 	</application>
-	<!-- Required to query activities that can process text, see:
-         https://developer.android.com/training/package-visibility and
-         https://developer.android.com/reference/android/content/Intent#ACTION_PROCESS_TEXT.
 
-         In particular, this is used by the Flutter engine in io.flutter.plugin.text.ProcessTextPlugin. -->
+	<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+<uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
+<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+
+	<uses-permission android:name="android.permission.INTERNET" />
+
 	<queries>
 		<intent>
 			<action android:name="android.intent.action.PROCESS_TEXT" />
 			<data android:mimeType="text/plain" />
 		</intent>
 	</queries>
-	<uses-permission android:name="android.permission.INTERNET" />
 </manifest>

ios/Flutter/Debug.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"
 #include "Generated.xcconfig"

ios/Flutter/Release.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"
 #include "Generated.xcconfig"

ios/Podfile

@@ -0,0 +1,43 @@
+# Uncomment this line to define a global platform for your project
+# platform :ios, '12.0'
+
+# CocoaPods analytics sends network stats synchronously affecting flutter build latency.
+ENV['COCOAPODS_DISABLE_STATS'] = 'true'
+
+project 'Runner', {
+  'Debug' => :debug,
+  'Profile' => :release,
+  'Release' => :release,
+}
+
+def flutter_root
+  generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'Generated.xcconfig'), __FILE__)
+  unless File.exist?(generated_xcode_build_settings_path)
+    raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first"
+  end
+
+  File.foreach(generated_xcode_build_settings_path) do |line|
+    matches = line.match(/FLUTTER_ROOT\=(.*)/)
+    return matches[1].strip if matches
+  end
+  raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get"
+end
+
+require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root)
+
+flutter_ios_podfile_setup
+
+target 'Runner' do
+  use_frameworks!
+
+  flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
+  target 'RunnerTests' do
+    inherit! :search_paths
+  end
+end
+
+post_install do |installer|
+  installer.pods_project.targets.each do |target|
+    flutter_additional_ios_build_settings(target)
+  end
+end

ios/Runner/Info.plist

@@ -5,15 +5,15 @@
 		<key>CFBundleDevelopmentRegion</key>
 		<string>$(DEVELOPMENT_LANGUAGE)</string>
 		<key>CFBundleDisplayName</key>
-	<string>Mostro P2P</string>
+		<string>Mostro P2P</string>
 		<key>CFBundleExecutable</key>
 		<string>$(EXECUTABLE_NAME)</string>
 		<key>CFBundleIdentifier</key>
 		<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 		<key>CFBundleInfoDictionaryVersion</key>
 		<string>6.0</string>
 		<key>CFBundleName</key>
-	<string>Mostro P2P</string>
+		<string>Mostro P2P</string>
 		<key>CFBundlePackageType</key>
 		<string>APPL</string>
 		<key>CFBundleShortVersionString</key>
@@ -47,5 +47,11 @@
 		<true />
 		<key>NSCameraUsageDescription</key>
 		<string>This app needs camera access to scan QR codes</string>
+		<key>UIBackgroundModes</key>
+		<array>
+			<string>fetch</string>
+			<string>processing</string>
+			<string>remote-notification</string>
+		</array>
 	</dict>
 </plist>

lib/background/abstract_background_service.dart

@@ -0,0 +1,13 @@
+import 'package:dart_nostr/dart_nostr.dart';
+import 'package:mostro_mobile/features/settings/settings.dart';
+
+abstract class BackgroundService {
+  Future<void> init();
+  void subscribe(List<NostrFilter> filters);
+  void updateSettings(Settings settings);
+  Future<void> setForegroundStatus(bool isForeground);
+  Future<bool> unsubscribe(String subscriptionId);
+  Future<void> unsubscribeAll();
+  Future<int> getActiveSubscriptionCount();
+  bool get isRunning;
+}