akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

mobile: 80 char limit readme

Browse Source
This commit is contained in:
Johan T. Halseth 2019-11-21 12:35:52 +01:00
parent 27abe4a301
commit 2754f5dea0
No known key found for this signature in database
GPG Key ID: 15BAADA29DA20D26
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
mobile/README.md
View File

@ -2,15 +2,17 @@
### Prerequisites ### Prerequisites
#### protoc #### protoc
Install the dependencies for generating protobuf definitions as stated in [lnrpc docs]( Install the dependencies for generating protobuf definitions as stated in
../lnrpc/README.md#generate-protobuf-definitions) [lnrpc docs]( ../lnrpc/README.md#generate-protobuf-definitions)
#### gomobile #### gomobile
Follow [gomobile](https://github.com/golang/go/wiki/Mobile) in order to install `gomobile` and dependencies. Follow [gomobile](https://github.com/golang/go/wiki/Mobile) in order to install
`gomobile` and dependencies.
Remember to run `gomobile init` (otherwise the `lnd` build might just hang). Remember to run `gomobile init` (otherwise the `lnd` build might just hang).
Note that `gomobile` only supports building projects from `GOPATH` at this point. Note that `gomobile` only supports building projects from `GOPATH` at this
point.
#### falafel #### falafel
Install [`falafel`](https://github.com/lightninglabs/falafel): Install [`falafel`](https://github.com/lightninglabs/falafel):
@ -31,21 +33,31 @@ make android
`make mobile` will build both iOS and Android libs. `make mobile` will build both iOS and Android libs.
### Libraries ### Libraries
After the build has succeeded, the libraries will be found in `mobile/build/ios/Lndmobile.framework` and `mobile/build/android/Lndmobile.aar`. Reference your platforms' SDK documentation for how to add the library to your project. After the build has succeeded, the libraries will be found in
`mobile/build/ios/Lndmobile.framework` and
`mobile/build/android/Lndmobile.aar`. Reference your platforms' SDK
documentation for how to add the library to your project.
#### Generating proto definitions for your language. #### Generating proto definitions for your language.
In order to call the methods in the generated library, the serialized proto for the given RPC call must be provided. Similarly, the response will be a serialized proto. In order to call the methods in the generated library, the serialized proto for
the given RPC call must be provided. Similarly, the response will be a
serialized proto.
In order to generate protobuf definitions for your language of choice, add the proto plugin to the `protoc` invocations found in [`gen_protos.sh`](../lnrpc/gen_protos.sh). For instance to generate protos for Swift, add `--swift_out=.` and run `make rpc`. In order to generate protobuf definitions for your language of choice, add the
proto plugin to the `protoc` invocations found in
[`gen_protos.sh`](../lnrpc/gen_protos.sh). For instance to generate protos for
Swift, add `--swift_out=.` and run `make rpc`.
### Options ### Options
Similar to lnd, subservers can be conditionally compiled with the build by setting the tags argument: Similar to lnd, subservers can be conditionally compiled with the build by
setting the tags argument:
``` ```
make ios tags="routerrpc" make ios tags="routerrpc"
``` ```
To support subservers that have APIs with name conflicts, pass the "prefix" flag. This will add the subserver name as a prefix to each method name: To support subservers that have APIs with name conflicts, pass the "prefix"
flag. This will add the subserver name as a prefix to each method name:
``` ```
make ios tags="routerrpc" prefix=1 make ios tags="routerrpc" prefix=1