Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add clearer Go-binding instructions #15

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add clearer Go-binding instructions #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/Overview-for-Developers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,11 @@ 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/master/lib/services/breezlib/breez_bridge.dart#L22) `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)
5. [Add the function in NativeMethods.swift](https://github.com/breez/breezmobile/blob/master/ios/Plugins/Breez/BreezLib/NativeMethods.swift#L20)

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