aljaz/lspd
1
0
Fork 0
mirror of https://github.com/aljazceru/lspd.git synced 2025-12-20 15:24:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
kingonly
2019-08-15 15:28:25 +03:00
committed by GitHub
parent ec39a26b5b
commit 1e4a9bd96f
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -5,11 +5,17 @@ This server exposes LSP services to the [Breez client](https://github.com/breez/
## Installation ## Installation
1. git clone https://github.com/breez/lspd (or fork) 1. git clone https://github.com/breez/lspd (or fork)
1. Modify the code in server.go if you use different values than the default when opening channels 2. Modify the code in server.go if you use different values than the recommeded values when opening channels:
1. Compile lspd using `go build .` * **ChannelCapacity**: channel capacity is sats, defined in the channelAmount const (recommended: 1000000).
1. Define the environment variables as described in sample.env * **TargetConf**: the number of blocks that the funding transaction *should* confirm in, will be used for fee estimation (recommended: 0).
1. Run lspd * **MinHtlcMsat**: the channel_reserve value in sats (recommended: 1000000).
1. Share with Breez the TOKEN and the LISTEN_ADDRESS you defined * **BaseFeeMsat**: base tx fee in msats (recommended: 1000).
* **FeeRate**: fee rate (recommended: 0.000001).
* **TimeLockDelta**: the minimum number of blocks this node requires to be added to the expiry of HTLCs (recommended: 144).
3. Compile lspd using `go build .`
4. Define the environment variables as described in sample.env:
5. Run lspd
6. Share with Breez the TOKEN and the LISTEN_ADDRESS you defined
## Implement your own server ## Implement your own server
You can create your own server by implementing the grpc methods described [here](https://github.com/breez/lspd/blob/master/rpc/lspd.md). You can create your own server by implementing the grpc methods described [here](https://github.com/breez/lspd/blob/master/rpc/lspd.md).