Skip to content

Commit a10015f

Browse files
committed
README: update readme with loop in+out instructions
1 parent ca26413 commit a10015f

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,39 @@ This can be altered using command line flags. See `loopd --help`.
129129
`loopd` only listens on localhost and uses an unencrypted and unauthenticated
130130
connection.
131131

132+
### Loop Out Swaps
133+
132134
Now that loopd is running, you can initiate a simple Loop Out. This will pay
133135
out Lightning off-chain funds and you will receive Bitcoin on-chain funds in
134136
return. There will be some chain and routing fees associated with this swap.
137+
```
138+
NAME:
139+
loop out - perform an off-chain to on-chain swap (looping out)
140+
141+
USAGE:
142+
loop out [command options] amt [addr]
143+
144+
DESCRIPTION:
145+
146+
Attempts loop out the target amount into either the backing lnd's
147+
wallet, or a targeted address.
148+
149+
The amount is to be specified in satoshis.
150+
151+
Optionally a BASE58/bech32 encoded bitcoin destination address may be
152+
specified. If not specified, a new wallet address will be generated.
153+
154+
OPTIONS:
155+
--channel value the 8-byte compact channel ID of the channel to loop out (default: 0)
156+
--addr value the optional address that the looped out funds should be sent to, if let blank the funds will go to lnd's wallet
157+
--amt value the amount in satoshis to loop out (default: 0)
158+
```
159+
160+
It's possible to receive more inbound capacity on a particular channel
161+
(`--channel`), and also have the `loop` daemon send the coins to a target
162+
address (`addr`). The latter option allows ones to effectively send on-chain
163+
from their existing channels!
164+
135165

136166
```
137167
loop out <amt_in_satoshis>
@@ -142,6 +172,35 @@ swap is initiated successfully, `loopd` will see the process through.
142172

143173
To query in-flight swap statuses, run `loop monitor`.
144174

175+
### Loop In Swaps
176+
177+
Additionally, Loop In is now also supported for mainnet as well. A Loop In swap
178+
lets one refill their channel (ability to send more coins) by sending to a
179+
special script on-chain.
180+
```
181+
NAME:
182+
loop in - perform an on-chain to off-chain swap (loop in)
183+
184+
USAGE:
185+
loop in [command options] amt
186+
187+
DESCRIPTION:
188+
189+
Send the amount in satoshis specified by the amt argument off-chain.
190+
191+
OPTIONS:
192+
--amt value the amount in satoshis to loop in (default: 0)
193+
--external expect htlc to be published externally
194+
```
195+
196+
The `--external` argument allows the on-chain HTLC transacting to be published
197+
_externally_. This allows for a number of use cases like using this address to
198+
withdraw from an exchange _into_ your Lightning channel!
199+
200+
A Loop In swap can be executed a follows:
201+
```
202+
loop in <amt_in_satoshis>
203+
```
145204
## Resume
146205

147206
When `loopd` is terminated (or killed) for whatever reason, it will pickup

0 commit comments

Comments
 (0)