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 12d8fd0b76
Merge pull request #398 from lightninglabs/update-to-v0.14.1-beta
4 days ago
.github GitHub: add issue templates 3 months ago
cmd multi: use aperture instead of local lsat library 1 month ago
docs docs: typo 1 week ago
labels multi: update autoloop labels to support both swap types 4 months ago
liquidity liquidity: add peers to swap interface and include in set reason 2 months ago
loopd multi: bump lnd min version to v0.11.1-beta 3 weeks ago
loopdb looprpc: add server cancelation rpc to server.proto 2 weeks ago
looprpc looprpc: prefix server and lnd enums to create unique names 1 week ago
regtest regtest: add demo/quick start regtest environment 2 months ago
swap test: spend tests for the new v2 htlc 9 months ago
sweep sweeper: set sequence to be able to sweep htlc v2 utxo 9 months ago
test loop/test: simplify preimage push test to be less dependent on height 1 month ago
.gitignore makefile+travis: add install and build commands 1 year ago
.golangci.yml lint: allow init functions 1 year ago
.travis.yml multi: bump minimum golang version to 1.15 1 month ago
DOCKER.md docs: remove weird character in DOCKER.md 4 months ago
Dockerfile multi: bump minimum golang version to 1.15 1 month ago
LICENSE Initial commit 2 years ago
Makefile make: fix commit ldflag 7 months ago
README.md Merge branch 'master' into patch-1 2 months ago
client.go multi: add cancel swap function to execute config 2 weeks ago
client_test.go loopout: cancel swap with server when off-chain fails 2 weeks ago
config.go multi: use aperture instead of local lsat library 1 month ago
executor.go executor: fix linter error 2 weeks ago
go.mod go.mod: bump to lndclient version that handles EOF 5 days ago
go.sum go.mod: bump to lndclient version that handles EOF 5 days ago
interface.go loop: add initiator string to user agent 7 months ago
log.go multi: add persistent logger 1 year ago
loopin.go loopin: handle EOF case for SubscribeSingleInvoice 5 days ago
loopin_test.go loopin/test: move invoice updates to loopin test context 6 days ago
loopin_testcontext_test.go loopin: handle EOF case for SubscribeSingleInvoice 5 days ago
loopout.go loopout: cancel swap with server when off-chain fails 2 weeks ago
loopout_test.go loopout: cancel swap with server when off-chain fails 2 weeks ago
release.sh release: remove support for darwin 386 9 months ago
release_notes.md version: bump version to v0.14.1-beta 4 days ago
server_mock_test.go loopout: cancel swap with server when off-chain fails 2 weeks ago
store_mock_test.go loopin: record htlx tx hash 11 months ago
swap.go multi: integrate the new htlc v2 scripts to loop in/out 9 months ago
swap_server_client.go loop: add cancel swap to server interface 2 weeks ago
testcontext_test.go multi: add cancel swap function to execute config 2 weeks ago
uncharge_state.go loop: extract code from client package into new loop primary package 2 years ago
updates.go multi: consume and log sever state updates 11 months ago
version.go version: bump version to v0.14.1-beta 4 days ago

README.md

Lightning Loop

Lightning Loop is a non-custodial service offered by Lightning Labs that makes it easy to move bitcoin into and out of the Lightning Network.

Features

  • Automated channel balancing
  • Privacy-forward non-custodial swaps
  • Opportunistic transaction batching to save on fees
  • Progress monitoring of in-flight swaps

Use Cases

  • Automate channel balancing with AutoLoop (Learn more)
  • Deposit to a Bitcoin address without closing channels with Loop In
  • Convert outbound liquidity into inbound liquidity with Loop Out
  • Refill depleted Lightning channels with Loop In

Installation

Download the latest binaries from the releases page.

Execution

The Loop client needs its own short-lived daemon to facilitate swaps. To start loopd:

loopd

To use Loop in testnet, simply pass the network flag:

loopd --network=testnet

By default loopd attempts to connect to the 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.

Usage

AutoLoop

AutoLoop makes it easy to keep your channels balanced. Checkout our autoloop documentation for details.

Loop Out

Use Loop Out to move bitcoins on Lightning into an on-chain Bitcoin address.

To execute a Loop Out:

loop out <amt_in_satoshis>

Other notable options:

  • Use the --fast flag to swap immediately (Note: This opts-out of fee savings made possible by transaction batching)
  • Use the --channel flag to loop out on specific channels
  • Use the --addr flag to specify the address the looped out funds should be sent to (Note: By default funds are sent to the lnd wallet)

Run loop monitor to monitor the status of a swap.

Loop In

Use Loop In to convert on-chain bitcoin into spendable Lightning funds.

To execute a Loop In:

loop in <amt_in_satoshis>

More info

For more information about using Loop checkout our Loop FAQs.

Development

Regtest

To get started with local development against a stripped down dummy Loop server running in a local regtest Bitcoin network, take a look at the regtest server environment example documentation.

Testnet

To use Loop in testnet, simply pass the network flag:

loopd --network=testnet

Submit feature requests

The GitHub issue tracker can be used to request specific improvements or report bugs.

Join us on Slack

Join us on the LND Slack and join the #loop channel to ask questions and interact with the community.

LND

Note that Loop requires lnd to be built with all of its subservers. Download the latest official release binary or build lnd from source by following the installation instructions. If you choose to build lnd from source, use the following command to enable all the relevant subservers:

make install tags="signrpc walletrpc chainrpc invoicesrpc"

API

The Loop daemon exposes a gRPC API (defaults to port 11010) and a REST API (defaults to port 8081).

The gRPC and REST connections of loopd are encrypted with TLS and secured with macaroon authentication the same way lnd is.

If no custom loop directory is set then the TLS certificate is stored in ~/.loop/<network>/tls.cert and the base macaroon in ~/.loop/<network>/loop.macaroon.

The loop command will pick up these file automatically on mainnet if no custom loop directory is used. For other networks it should be sufficient to add the --network flag to tell the CLI in what sub directory to look for the files.

For more information on macaroons, see the macaroon documentation of lnd.

NOTE: Loop's macaroons are independent from lnd's. The same macaroon cannot be used for both loopd and lnd.

Build from source

If you’d prefer to build from source:

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