From 1e4a9bd96f3987bdbe652b7735e1a2e21a84c99f Mon Sep 17 00:00:00 2001 From: kingonly <31890660+kingonly@users.noreply.github.com> Date: Thu, 15 Aug 2019 15:28:25 +0300 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 34f162b..bddb67a 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,17 @@ This server exposes LSP services to the [Breez client](https://github.com/breez/ ## Installation 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 -1. Compile lspd using `go build .` -1. Define the environment variables as described in sample.env -1. Run lspd -1. Share with Breez the TOKEN and the LISTEN_ADDRESS you defined +2. Modify the code in server.go if you use different values than the recommeded values when opening channels: + * **ChannelCapacity**: channel capacity is sats, defined in the channelAmount const (recommended: 1000000). + * **TargetConf**: the number of blocks that the funding transaction *should* confirm in, will be used for fee estimation (recommended: 0). + * **MinHtlcMsat**: the channel_reserve value in sats (recommended: 1000000). + * **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 You can create your own server by implementing the grpc methods described [here](https://github.com/breez/lspd/blob/master/rpc/lspd.md).