Merge remote-tracking branch 'origin/feat/v4'

Author: sneurlax

.gitmodules

@@ -1,10 +1,4 @@
 # `flutter_libepiccash`
-## Submodules
-Initialize submodules:
-```sh
-git submodule update --init --recursive
-```
-
 ## Dependencies
 ### Rust
 Install Rust: https://www.rust-lang.org/tools/install
@@ -18,13 +12,13 @@ rustup default 1.81
 cargo install cargo-ndk
 ```
 
-# Android
-## Add targets to rust
+## Android
+### Add targets to rust
 ```sh
 rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android
 ```
 
-## Install dependencies
+### Install dependencies
 ```sh
 # https://github.com/EpicCash/epic/blob/master/doc/build.md#requirements
 sudo apt install build-essential \
@@ -47,44 +41,57 @@ sudo apt install build-essential \
 	libc6-dev-i386
 ```
 
-## Build
+### Build
 ```sh
 cd scripts/android
 ./install_ndk.sh
 ./build_all.sh
 ```
 
-# iOS
-## Add targets to rust
+## iOS
+### Add targets to rust
 ```sh
 rustup target add aarch64-apple-ios x86_64-apple-ios aarch64-apple-ios-sim
 ```
 
-## Install dependencies
+### Install dependencies
 ```sh
 cargo install cargo-lipo
 cargo install cbindgen
 ```
 
-## Build
+### Build
 ```sh
 cd scripts/ios
 ./build_all
 ```
 
-# Windows
-## Dependencies
+## Windows
+### Dependencies
 Run `scripts/windows/deps.sh` in WSL (may need to alter permissions like with `chmod +x *.sh`) to install `x86_64-w64-mingw32-gcc` and `clang` or run
 ```sh
 sudo apt-get install clang gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64
 ```
 
-## Building for Windows
-Run `scripts/windows/build_all.sh` in WSL (Ubuntu 20.04 on WSL2 has been tested)
+### Building for Windows
+Run `scripts/windows/build_all.sh` in WSL (Ubuntu 24.04 on WSL2 has been tested)
 
 Libraries will be output to `scripts/windows/build`
 
-## Building on Windows
-Perl is required for building on Windows.  Strawberry Perl has been tested working.
+## Contributing
+### Regenerate FFI Bindings (ffigen)
+
+The Dart bindings in `lib/src/bindings_generated.dart` are auto-generated from the C header produced by the Rust crate. If you change the Rust FFI surface, regenerate as follows from `flutter_libepiccash/`:
+
+1) Ensure the C header exists/updated with cbindgen:
+- Install cbindgen, `cargo install cbindgen`.
+- Generate header: `cbindgen rust -c rust/cbindgen.toml -o rust/target/epic_cash_wallet.h`.
+
+2) Generate Dart bindings with ffigen:
+- Install Dart SDK and `ffigen` dev dependency.
+- Fetch deps: `dart pub get`.
+- Generate: `dart run ffigen --config ffigen.yaml`.
 
-Run `build_all.ps1` in Powershell.  This is not confirmed working and may need work eg. may need some missing dependencies added but has been included as a starting point or example for Windows developers.
+Notes:
+- If ffigen cannot find LLVM/Clang, adjust `llvm-path` in `ffigen.yaml` or install LLVM (e.g., `sudo apt install llvm clang`).
+- Ensure the Rust library’s exported C functions match those listed under `functions.include` in `ffigen.yaml`.

README.md

@@ -22,7 +22,7 @@ analyzer:
 linter:
   rules:
     prefer_relative_imports: true
-    avoid_relative_lib_imports: true
+    avoid_relative_lib_imports: false
     no_leading_underscores_for_local_identifiers: false
     no_leading_underscores_for_library_prefixes: false
     avoid_print: true
@@ -31,4 +31,4 @@ linter:
     constant_identifier_names: false
     prefer_final_locals: true
     prefer_final_in_for_each: true
-    require_trailing_commas: true
+    require_trailing_commas: true

analysis_options.yaml

@@ -1,3 +1,5 @@
+import 'dart:convert';
+
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_libepiccash/epic_cash.dart';
@@ -60,9 +62,19 @@ class _WalletInfoViewState extends State<WalletInfoView> {
         return;
       }
 
+      // Unwrap the JSON envelope.
+      final envelope = jsonDecode(walletResult);
+      if (envelope['ok'] != true) {
+        setState(() {
+          _resultMessage = 'Error opening wallet: ${envelope['error'] ?? 'Unknown error'}';
+        });
+        return;
+      }
+      final walletData = envelope['data'];
+
       final epicboxConfig =
           await EpicboxConfig.getDefaultConfig(widget.walletName);
-      final address = getAddressInfo(walletResult, 0, epicboxConfig);
+      final address = getAddressInfo(walletData, 0, epicboxConfig);
       setState(() {
         _resultMessage = "Address Info: $address";
       });
@@ -271,9 +283,16 @@ class _WalletInfoViewState extends State<WalletInfoView> {
         return 'Error opening wallet: $walletResult';
       }
 
+      // Unwrap the JSON envelope.
+      final envelope = jsonDecode(walletResult);
+      if (envelope['ok'] != true) {
+        return 'Error opening wallet: ${envelope['error'] ?? 'Unknown error'}';
+      }
+      final walletData = envelope['data'];
+
       final epicboxConfig =
           await EpicboxConfig.getDefaultConfig(widget.walletName);
-      final address = getAddressInfo(walletResult, 0, epicboxConfig);
+      final address = getAddressInfo(walletData, 0, epicboxConfig);
       return address;
     } catch (e) {
       return 'Error getting address: $e';

android/src/main/kotlin/com/example/flutter_libepiccash/FlutterLibepiccashPlugin.kt

@@ -6,13 +6,9 @@
 
 #include "generated_plugin_registrant.h"
 
-#include <flutter_libepiccash/flutter_libepiccash_plugin.h>
 #include <flutter_secure_storage_linux/flutter_secure_storage_linux_plugin.h>
 
 void fl_register_plugins(FlPluginRegistry* registry) {
-  g_autoptr(FlPluginRegistrar) flutter_libepiccash_registrar =
-      fl_plugin_registry_get_registrar_for_plugin(registry, "FlutterLibepiccashPlugin");
-  flutter_libepiccash_plugin_register_with_registrar(flutter_libepiccash_registrar);
   g_autoptr(FlPluginRegistrar) flutter_secure_storage_linux_registrar =
       fl_plugin_registry_get_registrar_for_plugin(registry, "FlutterSecureStorageLinuxPlugin");
   flutter_secure_storage_linux_plugin_register_with_registrar(flutter_secure_storage_linux_registrar);

example/lib/wallet_info_view.dart

@@ -3,11 +3,11 @@
 #
 
 list(APPEND FLUTTER_PLUGIN_LIST
-  flutter_libepiccash
   flutter_secure_storage_linux
 )
 
 list(APPEND FLUTTER_FFI_PLUGIN_LIST
+  flutter_libepiccash
 )
 
 set(PLUGIN_BUNDLED_LIBRARIES)

example/linux/flutter/generated_plugin_registrant.cc

@@ -5,12 +5,10 @@
 import FlutterMacOS
 import Foundation
 
-import flutter_libepiccash
 import flutter_secure_storage_macos
 import path_provider_foundation
 
 func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
-  FlutterLibepiccashPlugin.register(with: registry.registrar(forPlugin: "FlutterLibepiccashPlugin"))
   FlutterSecureStoragePlugin.register(with: registry.registrar(forPlugin: "FlutterSecureStoragePlugin"))
   PathProviderPlugin.register(with: registry.registrar(forPlugin: "PathProviderPlugin"))
 }