From 4ab83deebac27b7a6f749b8196dddbba27abc17a Mon Sep 17 00:00:00 2001 From: Erdem Yerebasmaz Date: Tue, 11 Jun 2024 09:35:21 +0300 Subject: [PATCH] Add comment for usage of Breez Server proto command --- lib/services/breez_server/server.dart | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/lib/services/breez_server/server.dart b/lib/services/breez_server/server.dart index e44c68422..fe430f0fc 100644 --- a/lib/services/breez_server/server.dart +++ b/lib/services/breez_server/server.dart @@ -9,9 +9,15 @@ import 'package:logging/logging.dart'; final _log = Logger("BreezServer"); -//proto command: -//protoc --dart_out=grpc:lib/services/breez_server/generated/ -Ilib/services/breez_server/protobuf/ lib/services/breez_server/protobuf/breez.proto -//dart format -l 110 lib/services/breez_server/generated/ +// This is the bridge to the breez server. Protobuf messages are used as the interface and to generate the classes use the command below: +// protoc --dart_out=grpc:lib/services/breez_server/generated/ -Ilib/services/breez_server/protobuf/ lib/services/breez_server/protobuf/breez.proto +// dart format -l 110 lib/services/breez_server/generated/ +// You may need to activate protoc_plugin. See [here](https://pub.dev/packages/protoc_plugin#how-to-build). +// +// Due to Flutter SDK restrictions, we need to install a strict version of protoc_plugin +// as any version above 20.0.1 requires Flutter 3.10. +// +// dart pub global activate protoc_plugin 20.0.1 class BreezServer { static final defaultCallOptions = CallOptions( timeout: const Duration(seconds: 10),