Skip to content

Commit

Permalink
Add clearer Go-binding instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
PeteClubSeven committed Jan 17, 2024
1 parent e6a04f3 commit d840688
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/Overview-for-Developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ Communication (calling functions) between Flutter to golang occurs via [this bri
5. [Add the endpoint to the binding package](https://github.com/breez/breez/blob/master/bindings/api.go)

#### Define the caller in Breez Mobile (flutter):
1. Compile the protobuf files in Flutter: `protoc --dart_out=grpc:lib/services/breezlib/data/ -I<path to messages.proto>`
2. [Add the function in breez_bridge.dart](https://github.com/breez/breezmobile/blob/master/lib/services/breezlib/breez_bridge.dart)
1. Use protoc_plugin v20.0.1: `dart pub global activate protoc_plugin v20.0.1`
2. [Create a symbol link:](https://github.com/breez/breezmobile/blob/master/lib/services/breezlib/protobuf/README.md) `ln -s <path/to/breez/data/messages.proto> lib/services/breezlib/protobuf/messages.proto`
3. [Compile the protobuf files in Flutter:](https://github.com/breez/breezmobile/blob/d8c36ed06db3cacf322450235524df272ca83a2d/lib/services/breezlib/breez_bridge.dart#L23) `protoc --dart_out=grpc:lib/services/breezlib/data/ -Ilib/services/breezlib/protobuf/ lib/services/breezlib/protobuf/messages.proto`
4. [Add the function in breez_bridge.dart](https://github.com/breez/breezmobile/blob/master/lib/services/breezlib/breez_bridge.dart)

### Your Development Environment
We recommend you [setup a simnet environment](Running-Breez-in-simnet.md) before testing your code on mainnet.

0 comments on commit d840688

Please sign in to comment.