Flutter plugin (preview)

From v0.30.0 the SDK has a Flutter plugin, offline_protocol, that hosts the engine on iOS and Android from Dart. It is a preview. It compiles the same native bridge sources as the React Native module, so a transport fix reaches both, but it exposes a smaller API. For a phone app you ship today, use React Native. The plugin is not on pub.dev. Depend on it by path from a checkout of the SDK repository at the release tag.

Requirements

Requirement	Value
Flutter	3.10 or later
iOS	13.0 or later
Android	API 24 (Android 7.0) or later
Build tools	The Rust toolchain (1.91 or newer) and a one-time build of the mobile native libraries

Add the plugin

Check out the SDK at the release tag and build the mobile libraries, the same steps as the React Native module:

git clone --branch v0.30.0 --depth 1 https://github.com/Offline-Protocol/offline-protocol-sdk.git
cd offline-protocol-sdk
./scripts/generate-bindings.sh
cd bindings/react-native
npm run build:uniffi:all

Then depend on the plugin by path in your app’s pubspec.yaml:

dependencies:
  offline_protocol:
    path: ../offline-protocol-sdk/bindings/flutter/offline_protocol   # adjust for your layout

Use the same permissions and manifest entries as React Native: Bluetooth usage descriptions and the bluetooth-central and bluetooth-peripheral background modes on iOS, and the Bluetooth, location and nearby Wi-Fi runtime permissions on Android. See React Native installation. On iOS, pod install copies the shared Swift bridge sources into the plugin. If you change those sources, run bindings/flutter/offline_protocol/ios/sync_bridge_rn.sh and pod install again, or the build compiles the old copy.

Quick start

Subscribe to events before createFromConfig if you need every event, including gap recovery through native replay:

import 'package:offline_protocol/offline_protocol.dart';

final sub = OfflineProtocol.events.listen((e) {
  final type = e.decodeEvent()['type'];
  // message_received, diagnostics, …
});

await OfflineProtocol.createFromConfig({
  'appId': 'com.example.app',
  'profile': 'default',
  'bleEnabled': true,
  'internetEnabled': true,
  'transports': {
    'internet': {
      'enabled': true,
      'serverAddress': 'wss://relay.example.com',
    },
    'wifiDirect': {'enabled': true},
  },
});
await OfflineProtocol.initializeMlsWithSecureStorage();
await OfflineProtocol.start();

final messageId = await OfflineProtocol.sendMessage(
  recipient: 'off1…',
  content: 'Hello',
);

Configuration fields and transport behaviour match React Native; see configuration. The engine runs on a dedicated thread, and method-channel results and events are delivered on the main isolate’s platform thread.

What the plugin covers

Area	Dart API
Lifecycle	`createFromConfig`, `initializeMlsWithSecureStorage`, `start`, `stop`, `destroy`
Identity	`localAddress`
Messaging	`sendMessage`
Events	`OfflineProtocol.events`, with the same sequence numbers and gap replay as React Native
Internet relay	`enableInternetTransport`, or enabled after `start()` when `transports.internet` has a `serverAddress`
Bluetooth LE	Started when `bleEnabled` is true; `enableTransport('ble', …)`
Wi-Fi Direct and peer streams	`enableTransport('wifiDirect', …)`, or enabled when configured

Not in the plugin yet: Nostr, Reticulum, telemetry and the React Native foreground mesh service. createFromConfig refuses a configuration with reticulumEnabled or nostrEnabled set. Groups, shared documents, services and file transfer are not in the Dart API in this release; use React Native for those. CI runs the plugin’s Dart tests and builds its Android library. No CI job compiles the iOS plugin yet.

Reference

Flutter plugin README, including the example app.
Flutter bridge contract: threading, shared sources and event delivery.

The SDK is AGPL-3.0-only with a commercial license available; see licensing.

SDK setup

API by task

Types and events

Architecture

Requirements

Add the plugin

Quick start

What the plugin covers

Reference

​Requirements

​Add the plugin

​Quick start

​What the plugin covers

​Reference

Requirements

Add the plugin

Quick start

What the plugin covers

Reference