Skip to content

Commit

Permalink
feat: add doc on how to use different connection modes
Browse files Browse the repository at this point in the history
  • Loading branch information
mdmohsin7 committed Feb 6, 2024
1 parent 05c29cd commit 34c95b6
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@
- [Emulator](#emulator-android--ios)
- [Android](#android-device)
- [iOS](#ios-device)
- [How to Use](#how-to-use)
- [cln_grpc](#cln-grpc)
- [lnlambda](#lnlambda)
- [cln_rpc](#cln-rpc)
- [How to Contribute](#how-to-contribute)
- [License](#license)

Expand Down Expand Up @@ -117,6 +121,33 @@ flutter build ipa

- The Xcode build archive (.xcarchive file) generated can be found inside `[project]/build/ios/archive/` directory and an App Store app bundle (.ipa file) in `[project]/build/ios/ipa/`

## How to Use

### CLN gRPC

- Launch the app
- In connection type dropdown, select `ClientMode.grpc`
- Provide the directory path consisting of the TLS Certificate\
Example: `/ssd/home/usr/lnd`. The lnd folder consists of the TLS Cert file
- Enter the host alongside the port of your lightning node. You can find it by running `lightning-cli getinfo`\
Example: `120.154.200.80:19735`


### LN Lambda

- Launch the app
- In connection type dropdown, select `ClientMode.lnlambda`
- Type in the node id and host (alongside the port). You can find both the values by running `lightning-cli getinfo`
- For the Lambda Server field, type in `https://lnlambda.lnmetrics.info`
- Type in the rune. If you don't exactly know what a rune is, you can generate one by running `lightning-cli createrune`. If you have already generated a rune in the past and want to use that only, then you can find the past runes by running `lightning-cli showrunes`.

### CLN RPC

- Launch the app
- In connection type dropdown, select `ClientMode.unixSocket`
- Provide the directory path consisting of the lightning-rpc file. You will mostly find it in the .lightning folder\
Example: `/home/usr/xyz/.lightning/`


## How to Contribute

Expand Down

0 comments on commit 34c95b6

Please sign in to comment.