Home

Awesome

nloop-logo

What is NLoop?

It is a submarine swap client against the boltz-backend Currently it imitates the api of the lightning loop.

Read the anouncement blogpost for more detail.

Why use NLoop?

Caution:

NLoop is an open beta: Please use at your own risk. we may introduce backward incompatible changes.

How to

Quick start

nloop is published as single file executable named nloopd.

Download the latest binary from the release page and run with --help to see the possible configuration option.

nloopd must connect to following services to work correctly.

  1. bitcoind
  1. lnd
  2. EventStoreDB

Probably the best way to check its behaviour is to run it in the regtest. Check the following guide for how-to.

How-to

Check tutorial documents under docs

REST API

Check out our openapi.yml (or its rendered version) for the REST API specification.

Subscribing to events

If you want to react to the changes caused by nloop, (e.g. notify to slack/discord when the swap starts and/or finished.) we recommend subscribing to eventstoredb directly rather than long-polling the api. Please see the official documentation for how to. Actual object you get is json-encoded Events with metadata.

configuration options

You can see the complete list of startup configuration options with --help But CLI option is not the only way to specify those variables. You can also use environment variables start from NLOOP_.

e.g. for cli options --eventstoreurl, NLOOP_EVENTSTOREURL is equivalent.

Future plans