lnd.xprv/mobile/README.md

68 lines
1.8 KiB
Markdown
Raw Normal View History

2019-07-09 16:36:56 +03:00
## Building mobile libraries
### Prerequisites
#### protoc
2019-11-21 14:35:52 +03:00
Install the dependencies for generating protobuf definitions as stated in
[lnrpc docs]( ../lnrpc/README.md#generate-protobuf-definitions)
2019-07-09 16:36:56 +03:00
#### gomobile
2019-11-21 14:35:52 +03:00
Follow [gomobile](https://github.com/golang/go/wiki/Mobile) in order to install
`gomobile` and dependencies.
2019-07-09 16:36:56 +03:00
Remember to run `gomobile init` (otherwise the `lnd` build might just hang).
2019-11-21 14:35:52 +03:00
Note that `gomobile` only supports building projects from `GOPATH` at this
point.
2019-07-09 16:36:56 +03:00
#### falafel
Install [`falafel`](https://github.com/lightninglabs/falafel):
2019-07-09 16:36:56 +03:00
```
go get -u -v github.com/lightninglabs/falafel
2019-07-09 16:36:56 +03:00
```
### Building `lnd` for iOS
```
make ios
```
### Building `lnd` for Android
```
make android
```
`make mobile` will build both iOS and Android libs.
### Libraries
2019-11-21 14:35:52 +03:00
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.
2019-07-09 16:36:56 +03:00
#### Generating proto definitions for your language.
2019-11-21 14:35:52 +03:00
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.
2019-07-09 16:36:56 +03:00
2019-11-21 14:35:52 +03:00
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`.
2019-07-09 16:36:56 +03:00
### Options
2019-11-21 14:35:52 +03:00
Similar to lnd, subservers can be conditionally compiled with the build by
setting the tags argument:
2019-07-09 16:36:56 +03:00
```
make ios tags="routerrpc"
```
2019-11-21 14:35:52 +03:00
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:
2019-07-09 16:36:56 +03:00
```
make ios tags="routerrpc" prefix=1
```
### API docs
TODO(halseth)