Archives/loop
2
0
Fork 0
mirror of https://github.com/lightninglabs/loop synced 2024-11-04 06:00:21 +00:00
Code Issues Releases Wiki Activity
13 Commits 19 Branches 93 Tags 35 MiB
Go 98.7%
Shell 0.8%
Makefile 0.3%
Dockerfile 0.2%
04d44c3caf
Go to file
Olaoluwa Osuntokun 04d44c3caf
README: update db path naming
2019-03-06 16:41:16 -08:00
client multi: update import paths to point to new looprpc pacakge 2019-03-06 15:53:23 -08:00
cmd multi: rename swapcli to loop, swapd to loopd 2019-03-06 15:57:43 -08:00
lndclient loop: update all import paths to public repo 2019-03-06 15:29:49 -08:00
looprpc multi: update import paths to point to new looprpc pacakge 2019-03-06 15:53:23 -08:00
sweep loop: update all import paths to public repo 2019-03-06 15:29:49 -08:00
test loop: update all import paths to public repo 2019-03-06 15:29:49 -08:00
utils multi: update import paths to point to new looprpc pacakge 2019-03-06 15:53:23 -08:00
.gitignore git: update gitignore to include new loop related binaries 2019-03-06 15:57:55 -08:00
go.mod loop: update all import paths to public repo 2019-03-06 15:29:49 -08:00
go.sum Lightning Loop initial version 2019-03-06 21:30:34 +01:00
LICENSE Initial commit 2019-02-15 17:57:58 -08:00
README.md README: update db path naming 2019-03-06 16:41:16 -08:00

README.md

Lightning Loop

Loop Out Swap (off -> on-chain)

       loop out 500   
                  |
                  |
                  v
   .-----------------------------.
   | Loop CLI                    |
   | ./cmd/loop                  |
   |                             |
   |                             |
   |       .-------------------. |            .--------------.                   .---------------.
   |       | Loop Client (lib) | |            | LND node     |                   | Bitcoin node  |
   |       | ./                |<-------------|              |-------------------|               |
   |       |                   | |            |              |   on-chain        |               |
   |       |                   |------------->|              |   htlc            |               |
   |       |                   | | off-chain  |              |                   |               |
   |       '-------------------' | htlc       '--------------'                   '---------------'
   '-----------------|-----------'                    |                                  ^
                     |                                |                                  |
                     |                                v                                  |
                     |                              .--.                               .--.               
                     |                          _ -(    )- _                       _ -(    )- _           
                     |                     .--,(            ),--.             .--,(            ),--.      
             initiate|                 _.-(                       )-._    _.-(                       )-._ 
             swap    |                (       LIGHTNING NETWORK       )  (        BITCOIN NETWORK        )
                     |                 '-._(                     )_.-'    '-._(                     )_.-' 
                     |                      '__,(            ),__'             '__,(            ),__'     
                     |                           - ._(__)_. -                       - ._(__)_. -          
                     |                                |                                  ^
                     |                                |                                  |
                     v                                v                                  |
           .--------------------.  off-chain   .--------------.                  .---------------.
           | Loop Server        |  htlc        | LND node     |                  | Bitcoin node  |
           |                    |<-------------|              |                  |               |
           |                    |              |              |   on-chain       |               |
           |                    |              |              |   htlc           |               |
           |                    |--------------|              |----------------->|               |
           |                    |              |              |                  |               |
           '--------------------'              '--------------'                  '---------------'

Setup

LND and the swaplet are using go modules. Make sure that the GO111MODULE env variable is set to on.

In order to execute a swap, LND needs to be rebuilt with sub servers enabled.

LND

  • Checkout branch master

  • make install tags="signrpc walletrpc chainrpc" to build and install lnd with required sub-servers enabled.

  • Make sure there are no macaroons in the lnd dir ~/.lnd/data/chain/bitcoin/mainnet. If there are, lnd has been started before and in that case, it could be that admin.macaroon doesn't contain signer permission. Delete macaroons.db and *.macaroon.

    DO NOT DELETE wallet.db !

  • Start lnd

Loopd

Execute a swap

  • Swaps are executed by a client daemon process. Run:

    loopd

    By default loopd attempts to connect to an lnd instance running on localhost:10009 and reads the macaroon and tls certificate from ~/.lnd. This can be altered using command line flags. See loopd --help.

    loopd only listens on localhost and uses an unencrypted and unauthenticated connection.

  • To initiate a swap, run:

    loop uncharge <amt_msat>

    When the swap is initiated successfully, loopd will see the process through.

  • To query and track the swap status, run loop without arguments.

Resume

When loopd is terminated (or killed) for whatever reason, it will pickup pending swaps after a restart.

Information about pending swaps is stored persistently in the swap database. Its location is ~/.loopd/<network>/loop.db.

Multiple simultaneous swaps

It is possible to execute multiple swaps simultaneously.