be3120c935
feat: add `PrepareSendRequest` object fix: rename to `claim_tx_feerate` fix: fix reverse submarine test feat: improve prepare_send and prepare_receive interfaces fix: use v2 to broadcast lowball tx feat: finalize prepare_send and prepare_receive feat: remove manual BTC pair from response fix: remove `pair_hash` from PrepareReceive rebasing updating Cargo.lock fix: update lbtc pair method names fixing bindings fix: re-add uniffi_macros add comment to elements dependency fix: switch back to v1 fee calculation fix: revert to v1 pair hash fix: simplify migrations fix: rename `FeesExpired` to `InvalidOrExpiredFees` Log error when list_ongoing_swaps() fails Log swap ID when list_ongoing_swaps() succeeds Migrations: add missing ongoing_receive_swaps field Clarify swap type (reverse vs submarine) in logs
flutter_breez_liquid
A new Flutter FFI plugin project.
Getting Started
This project is a starting point for a Flutter FFI plugin, a specialized package that includes native code directly invoked with Dart FFI.
Project stucture
This template uses the following structure:
-
src: Contains the native source code, and a CmakeFile.txt file for building that source code into a dynamic library. -
lib: Contains the Dart code that defines the API of the plugin, and which calls into the native code usingdart:ffi. -
platform folders (
android,ios,windows, etc.): Contains the build files for building and bundling the native code library with the platform application.
Buidling and bundling native code
The pubspec.yaml specifies FFI plugins as follows:
plugin:
platforms:
some_platform:
ffiPlugin: true
This configuration invokes the native build for the various target platforms and bundles the binaries in Flutter applications using these FFI plugins.
This can be combined with dartPluginClass, such as when FFI is used for the implementation of one platform in a federated plugin:
plugin:
implements: some_other_plugin
platforms:
some_platform:
dartPluginClass: SomeClass
ffiPlugin: true
A plugin can have both FFI and method channels:
plugin:
platforms:
some_platform:
pluginClass: SomeName
ffiPlugin: true
The native build systems that are invoked by FFI (and method channel) plugins are:
- For Android: Gradle, which invokes the Android NDK for native builds.
- See the documentation in android/build.gradle.
- For iOS and MacOS: Xcode, via CocoaPods.
- See the documentation in ios/flutter_breez_liquid.podspec.
- See the documentation in macos/flutter_breez_liquid.podspec.
- For Linux and Windows: CMake.
- See the documentation in linux/CMakeLists.txt.
- See the documentation in windows/CMakeLists.txt.
Binding to native code
To use the native code, bindings in Dart are needed.
To avoid writing these by hand, they are generated from the header file
(src/flutter_breez_liquid.h) by package:ffigen.
Regenerate the bindings by running flutter pub run ffigen --config ffigen.yaml.
Invoking native code
Very short-running native functions can be directly invoked from any isolate.
For example, see sum in lib/flutter_breez_liquid.dart.
Longer-running functions should be invoked on a helper isolate to avoid
dropping frames in Flutter applications.
For example, see sumAsync in lib/flutter_breez_liquid.dart.
Flutter help
For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.