Skip to content

Commit 10374fe

Browse files
authored
Update README.md
1 parent ebf3b08 commit 10374fe

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,15 @@ $ docker-compose exec demo sh -c "node bitcoin-spam.js"
9898
$ bin/stack bitcoin estimatesmartfee 24 ECONOMICAL
9999
```
100100

101+
### Notification listener demo
101102
Start following the demo subscriber node in a separate terminal window to see invoice messages as they come through.
102103
```
103104
$ docker-compose up -d demo
104105
$ docker-compose logs -f demo
105106
$ bin/stack alice addinvoice 1000
106107
```
107108

109+
### LND MPP to LND
108110
A command is provided to easily create channels, so we can open some from `alice` to `bob` with some funding between the two `lnd` containers and do a multi part payment.
109111
```
110112
$ bin/stack alice channelto bob 5000000
@@ -117,13 +119,15 @@ $ bin/stack alice listchannels
117119
$ bin/stack bob listchannels
118120
```
119121

122+
### LND keysend to LND
120123
The `bob` container is also configured to accept `keysend` transactions so payments can be made without requiring an invoice.
121124
```
122125
# assuming channel is opened as above
123126
$ BOB_NODE=$(bin/stack bob getinfo | jq '.identity_pubkey' | tr -d '"')
124127
$ bin/stack alice sendpayment --keysend $BOB_NODE 10000
125128
```
126129

130+
### LND invoice payment to Clightning
127131
Similar commands will connect `alice` & `bob` to `carol` across the `clightning` implementation of LN on Bitcoin.
128132
```
129133
$ bin/stack alice channelto carol 2000000
@@ -134,25 +138,29 @@ $ bin/stack bob payinvoice -f $CAROL_INVOICE
134138
$ bin/stack carol listfunds
135139
```
136140

141+
### LND keysend payment to Clightning
137142
You can also receive `keysend` payments to `clightning`:
138143
```
139144
# assuming channel is opened as above (might take a minute to sync & activate)
140145
$ CAROL_NODE=$(bin/stack carol getinfo | jq '.id' | tr -d '"')
141146
$ bin/stack bob sendpayment --keysend $CAROL_NODE 10000
142147
```
143148

149+
### Clightning MPP to LND
144150
Since 0.9.0 `clightning` supports MPP by default so payments are adaptively split into random amounts.
145151
```
146152
$ ALICE_INVOICE=$(bin/stack alice addinvoice 1000000 | jq '.payment_request' | tr -d '"')
147153
$ bin/stack carol pay $ALICE_INVOICE
148154
$ bin/stack alice lookupinvoice $(bin/stack alice decodepayreq $ALICE_INVOICE | jq '.payment_hash' | tr -d '"')
149155
```
150156

157+
### Clightning plugin
151158
A `clightning` plugin example is included for more advanced feature development.
152159
```
153160
$ bin/stack carol hello yourname
154161
```
155162

163+
### LND invoice payment to Eclair
156164
Similar commands will connect `bob` to `frank` across the `eclair` implementation of LN on Bitcoin.
157165
```
158166
$ bin/stack bob channelto frank 10000000
@@ -162,12 +170,14 @@ $ bin/stack bob payinvoice -f $FRANK_INVOICE
162170
$ bin/stack frank audit
163171
```
164172

173+
### Peg-in Bitcoin to Elements
165174
Elements sidechain is available and can be pegged in from regtest Bitcoin chain using the provided script command.
166175
```
167176
$ bin/stack bitcoin pegin elements 13.37
168177
$ bin/stack elements getwalletinfo
169178
```
170179

180+
### Clightning payments on Elements
171181
You can also open a LN **L-BTC** channel on `clightning` across the Elements chain between `dave` & `emma`!
172182
```
173183
# open a 1LBTC large channel (wumbo)
@@ -180,6 +190,7 @@ $ bin/stack dave listpays
180190
$ bin/stack emma listinvoices
181191
```
182192

193+
### REST/RPC examples
183194
REST/RPC queries can be executed directly from your application to each daemon. Use standard RPC adapters to connect to these and have full control over money flow; hook into message queues for notifications B).
184195
```
185196
#bitcoin
@@ -200,6 +211,7 @@ $ curl -XPOST -u :password http://127.0.0.1:8110/getinfo
200211
Clightning exposes a JSON-RPC interface via a socket... example to follow..
201212
```
202213

214+
## Other information
203215
View daemon logs as follows:
204216
```
205217
$ docker-compose logs -f

0 commit comments

Comments
 (0)