highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-08-28 14:40:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

mobile/README: explain new API objects for sub-servers in LND v0.15+

Browse Source
This commit is contained in:
Evan Kaloudis
2022-05-11 13:18:50 -04:00
parent e9feefaba6
commit dea15d51f9
1 changed files with 3 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
mobile/README.md
View File

@@ -227,19 +227,11 @@ implementation project(":lndmobile", { "default" })
```
---
## Options
## Calling the API
Similar to lnd, subservers can be conditionally compiled with the build by setting the tags argument:
In LND v0.15+ all API methods have prefixed the generated methods with the subserver name. This is required to support subservers with name conflicts.
```shell
⛰ make ios
```
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:
```shell
⛰ make ios prefix=1
```
eg. `QueryScores` is now `AutopilotQueryScores`. `GetBlockHeader` is now `NeutrinoKitGetBlockHeader`.
## API docs