You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Alex Bosworth 974da15ead
docs: move out architecture diagram
1 year ago
cmd cmd/loopd: add REST proxy 1 year ago
docs docs: move out architecture diagram 1 year ago
lndclient loopd: persistent configuration 1 year ago
loopdb multi: finalize rename from uncharge to loop out 1 year ago
looprpc looprpc: generate client REST definitions 1 year ago
swap utils: remove utils package in favor of new swap package 1 year ago
sweep multi: finalize rename from uncharge to loop out 1 year ago
test loop: extract code from client package into new loop primary package 1 year ago
.gitignore git: update gitignore to include new loop related binaries 1 year ago
.travis.yml build: add travis config 1 year ago
LICENSE Initial commit 1 year ago
Makefile build: add travis config 1 year ago
README.md docs: move out architecture diagram 1 year ago
client.go multi: finalize rename from uncharge to loop out 1 year ago
client_test.go multi: finalize rename from uncharge to loop out 1 year ago
config.go multi: finalize rename from uncharge to loop out 1 year ago
executor.go multi: finalize rename from uncharge to loop out 1 year ago
go.mod cmd/loopd: add REST proxy 1 year ago
go.sum build: tidy go mod 1 year ago
interface.go multi: finalize rename from uncharge to loop out 1 year ago
log.go loop: extract code from client package into new loop primary package 1 year ago
loopout.go multi: finalize rename from uncharge to loop out 1 year ago
loopout_test.go multi: finalize rename from uncharge to loop out 1 year ago
release.sh release: add release script 1 year ago
server_mock_test.go multi: finalize rename from uncharge to loop out 1 year ago
store_mock_test.go multi: finalize rename from uncharge to loop out 1 year ago
swap.go multi: finalize rename from uncharge to loop out 1 year ago
swap_server_client.go multi: finalize rename from uncharge to loop out 1 year ago
testcontext_test.go multi: finalize rename from uncharge to loop out 1 year ago
uncharge_state.go loop: extract code from client package into new loop primary package 1 year ago

README.md

Lightning Loop

Lightning Loop is a non-custodial service offered by Lightning Labs to bridge on-chain and off-chain Bitcoin using submarine swaps. This repository is home to the Loop client and depends on the Lightning Network daemon lnd. All of lnd’s supported chain backends are fully supported when using the Loop client: Neutrino, Bitcoin Core, and btcd.

In the current iteration of the Loop software, only off-chain to on-chain exchanges are supported, where the Loop client sends funds off-chain in exchange for the funds back on-chain.

The service can be used in various situations:

  • Acquiring inbound channel liquidity from arbitrary nodes on the Lightning network
  • Depositing funds to a Bitcoin on-chain address without closing active channels
  • Paying to on-chain fallback addresses in the case of insufficient route liquidity

Future iterations of the Loop software will also allow on-chain to off-chain swaps. These swaps can be useful for additional use-cases:

  • Refilling depleted channels with funds from cold-wallets or exchange withdrawals
  • Servicing off-chain Lightning withdrawals using on-chain payments, with no funds in channels required
  • As a failsafe payment method that can be used when channel liquidity along a route is insufficient

Development and Support

The Loop client is current in an early beta state, and offers a simple command line application. Future APIs will be added to support implementation or use of the Loop service.

The GitHub issue tracker can be used to request specific improvements or register and get help with any problems. Community support is also available in the LND Slack .

Setup and Install

LND and the loop client are using Go modules. Make sure that the GO111MODULE env variable is set to on.

In order to execute a swap, LND will need 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. Stop lnd, delete *.macaroon files, restart lnd to regenerate them with the signer permission.

    DO NOT DELETE wallet.db !

  • Start lnd

Loopd

  • git clone https://github.com/lightninglabs/loop.git
  • cd loop/cmd
  • go install ./...

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 out <amt_sat>

    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.