[mobile] Mobile RPCs by halseth · Pull Request #3282 · lightningnetwork/lnd

halseth · 2019-07-09T13:41:08Z

This PR adds the necessary APIs and build scripts in order to compile lnd for mobile platforms.

Building mobile libraries

Prerequisites

gomobile

Follow gomobile in order to intall gomobile and dependencies.

Remember to run gomobile init! (otherwise the lnd build might just hang).

falafel

Install falafel:

go get -u -v github.com/halseth/falafel

Building `lnd` for iOS

make ios

Building `lnd` for Android

make android

make mobile will build both iOS and Android libs.

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.

API docs

TODO

ottosuess · 2019-07-10T09:54:22Z

mobile/bindings.go

splitting the extraArgs string breaks if I want to pass a path that contains a space.
e.g. /Library/Application\ Support

Can you check if this helps: 22f7b0c

seems like it's working 🙌
haven't done a lot of testing though.

cfromknecht · 2019-07-11T02:57:07Z

@halseth didn't get a chance to review the autogenerated code :(

halseth · 2019-07-11T09:29:55Z

@cfromknecht added a temp commit with the generated API!

ottosuess · 2019-07-11T10:07:00Z

mobile/router_api_generated.go

same name & package as the SendPayment method in lightning_api_generated.go.
maybe add a prefix to the methods generated by sub-services?

@ottosuess agree. But as @halseth suggested somewhere else, you can try setting usePrefex=1 on gen_bindings.sh

(Haven't tried though, I manually changed names)

Made it possible to add directly to make (73cb325):

make ios tags="routerrpc" prefix=1

ottosuess · 2019-07-11T16:17:16Z

Would be cool to have a way to inject custom protoc plugins like protoc-gen-swift.

At zap we have a custom "falafel" plugin to generate swift apis that i'd like to inject somehow.

wbobeirne · 2019-07-17T14:35:28Z

mobile/gen_bindings.sh

Just thought I'd mention that I didn't have this command, had to run brew install protobuf to get it. Might be worth adding it as a prerequisite to the docs.

Thanks, fixed: 7d01dc5

halseth · 2019-07-19T12:25:17Z

Would be cool to have a way to inject custom protoc plugins like protoc-gen-swift.

At zap we have a custom "falafel" plugin to generate swift apis that i'd like to inject somehow.

I think this is a pro-level feature for now, so can be done by modifying gen_bindings directly 😄

halseth · 2019-08-27T06:49:49Z

This commit currently breaks the build script: golang/mobile@597adff

So need to stay on an older revision for now to successfully build.

Latest gomobile@HEAD fixes this issue.

halseth · 2019-08-27T08:33:45Z

PTAL @Roasbeef @valentinewallace

Roasbeef

LGTM 🐸

The auto generated code should be removed from this diff before we merge this PR.

Roasbeef · 2019-08-28T18:30:27Z

lnd.go

Could use a comment explaining what the empty function closure return value is.

Not totally sure what you mean, but expanded the comment to note what the default return values should be: 78bc0b1

halseth · 2019-09-02T09:28:43Z

Rebased and removed generated code. Generated code can still be inspected here: https://github.com/lightningnetwork/lnd/tree/78bc0b1128edc56f5f7d095a66e3a025d6a2d89e/mobile

valentinewallace

nits aside, LGTM 🍾 yay!

valentinewallace · 2019-09-03T23:56:48Z

mobile/README.md

Nit: s/I order/In order

Fixed: 210eeb8

mobile/gen_bindings.sh

lnd.go

halseth · 2019-09-04T08:56:42Z

Should now be ready to merge

ListenerCfg allows passing custom listeners to the main method, to be used for the wallet unlocker and rpc server. If these are set these will be used instead of the regular RPC listeners.

gen_bindings uses falafel to generate Go bindings from the lnrpc protos.

halseth force-pushed the mobile-rpcs branch from f54fe43 to 03728a1 Compare July 9, 2019 13:45

cfromknecht self-requested a review July 9, 2019 22:12

ottosuess reviewed Jul 10, 2019

View reviewed changes

halseth force-pushed the mobile-rpcs branch from 03728a1 to 986c8ff Compare July 10, 2019 10:56

halseth requested review from Roasbeef, joostjager, valentinewallace and wpaulino as code owners July 10, 2019 10:56

halseth force-pushed the mobile-rpcs branch 2 times, most recently from 98bdf6b to a68752c Compare July 10, 2019 11:32

Roasbeef removed request for Roasbeef, cfromknecht, joostjager, valentinewallace and wpaulino July 10, 2019 20:44

tanx mentioned this pull request Jul 11, 2019

[Improving] - Add the Lndmobile.aar & Lndmobile.framework files or documentation on how to construct them lightninglabs/lightning-app#1208

Open

halseth force-pushed the mobile-rpcs branch from a68752c to e7097d2 Compare July 11, 2019 09:22

ottosuess suggested changes Jul 11, 2019

View reviewed changes

wbobeirne reviewed Jul 17, 2019

View reviewed changes

halseth force-pushed the mobile-rpcs branch 3 times, most recently from 5aded27 to 3760f29 Compare July 24, 2019 06:59

wpaulino added this to the 0.8.0 milestone Jul 25, 2019

Roasbeef added enhancement Improvements to existing features / behaviour golang/build system Related to the go language and compiler mobile labels Jul 29, 2019

halseth force-pushed the mobile-rpcs branch from 3760f29 to 81fe333 Compare August 26, 2019 08:48

hsjoberg mentioned this pull request Aug 26, 2019

Docker + CircleCI BlixtWallet/blixt-wallet#19

Closed

halseth force-pushed the mobile-rpcs branch 2 times, most recently from 3093a15 to 0fb59d1 Compare August 26, 2019 13:16

halseth force-pushed the mobile-rpcs branch 2 times, most recently from 8d06494 to 742c2b5 Compare August 27, 2019 08:29

Roasbeef approved these changes Aug 28, 2019

View reviewed changes

halseth force-pushed the mobile-rpcs branch 2 times, most recently from 78bc0b1 to 85244f7 Compare September 2, 2019 09:27

wpaulino requested a review from valentinewallace September 3, 2019 19:23

valentinewallace approved these changes Sep 4, 2019

View reviewed changes

halseth force-pushed the mobile-rpcs branch from 210eeb8 to 6ad629b Compare September 4, 2019 08:56

halseth added the ready to merge LGTM'd, may need rebase to address conflicts, anyone can merge label Sep 4, 2019

halseth added 9 commits September 5, 2019 09:22

gitignore: add mobile/build

187bd29

lnd+rpcserver: extract listener setup into closure

2562fdb

lnd+cmd/lnd/main: add ListenerCfg to Main

fa21601

ListenerCfg allows passing custom listeners to the main method, to be used for the wallet unlocker and rpc server. If these are set these will be used instead of the regular RPC listeners.

make+mobile: define gen_bindings.sh

a5c6378

gen_bindings uses falafel to generate Go bindings from the lnrpc protos.

mobile/bindings: add mobile bindings

8a92ccb

make: define make ios, make vendor

4dcaea1

make: define make android, make mobile (ios+android)

3aa9f18

mobile: add sample_lnd.conf

fef2074

mobile: add README

a8cb1c8

halseth force-pushed the mobile-rpcs branch from 6ad629b to a8cb1c8 Compare September 5, 2019 07:23

hsjoberg mentioned this pull request Sep 5, 2019

config: Add norest config for disabling REST API #3467

Merged

13 tasks

Roasbeef merged commit 918fd9e into lightningnetwork:master Sep 9, 2019

halseth mentioned this pull request Nov 26, 2019

Create loopd package, allow custom listeners lightninglabs/loop#115

Merged

Conversation

halseth commented Jul 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Building mobile libraries

Prerequisites

gomobile

falafel

Building lnd for iOS

Building lnd for Android

Libraries

API docs

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cfromknecht commented Jul 11, 2019

Uh oh!

halseth commented Jul 11, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sergioabril Jul 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ottosuess commented Jul 11, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

halseth commented Jul 19, 2019

Uh oh!

halseth commented Aug 27, 2019

Uh oh!

halseth commented Aug 27, 2019

Uh oh!

Roasbeef left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

halseth commented Sep 2, 2019

Uh oh!

valentinewallace left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

halseth commented Sep 4, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

halseth commented Jul 9, 2019 •

edited

Loading

Building `lnd` for iOS

Building `lnd` for Android

sergioabril Jul 11, 2019 •

edited

Loading