Skip to content

regtest: adding aperture docker instance #907

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 31, 2025
Merged

regtest: adding aperture docker instance #907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3083297
regtest: adding aperture docker instance
hieblmi Feb 20, 2025
64b1aed
regtest: add static loop-in to README.md
hieblmi Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 146 additions & 0 deletions regtest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,152 @@ $ ./regtest.sh mine 1
2021-03-19T17:19:21Z LOOP_IN SUCCESS 0.005 BTC - P2WSH: bcrt1q4p0pead4tfepm683fff8fl8g3kpx8spjztuquu2sctfzed9rufls2z0g2f (cost: server 71, onchain 7650, offchain 0)
```

# Static Address Loop In

Static Address Loop In is a new loop-in mode that, like Loop In, allows you to
swap your on-chain balance for off-chain (channel) balance, but in contrast to
the legacy loop-in, you can receive the off-chain balance instantly (after funds
were deposited to a static address).
To do so a two-step process is required, the setup and the swap phase.

To setup a static address and deposit funds to it, do the following:

```shell
./regtest.sh loop static new  ✔  11:59:12

WARNING: Be aware that loosing your l402.token file in .loop under your home directory will take your ability to spend funds sent to the static address via loop-ins or withdrawals. You will have to wait until the deposit expires and your loop client sweeps the funds back to your lnd wallet. The deposit expiry could be months in the future.

CONTINUE WITH NEW ADDRESS? (y/n): y
Received a new static loop-in address from the server: bcrt1pzgdmxftg3t6wghl2t72ewqyf3jvy2t85ud6pqsagx0zm9mj8f3aq23v3t4
```
A static address has been created. You can send funds to it across different
transactions. Each transaction output to this address is considered a deposit
that can be used individually or in combination with other deposits to be
swapped for an off-chain payment. Let's create a few deposits and confirm them:
```shell
./regtest.sh lndclient sendcoins --addr bcrt1pzgdmxftg3t6wghl2t72ewqyf3jvy2t85ud6pqsagx0zm9mj8f3aq23v3t4 --amt 250000 --min_confs 0 -f
{
"txid": "86ccc85449957c3472a259e447a9180aff49848f0b957a85c24819a5f432eda7"
}
./regtest.sh lndclient sendcoins --addr bcrt1pzgdmxftg3t6wghl2t72ewqyf3jvy2t85ud6pqsagx0zm9mj8f3aq23v3t4 --amt 250000 --min_confs 0 -f
{
"txid": "09d72c89b2346dc068bb57621463e53637f3c0cca3ba8ebb7fcb2773d7f32ae3"
}
./regtest.sh lndclient sendcoins --addr bcrt1pzgdmxftg3t6wghl2t72ewqyf3jvy2t85ud6pqsagx0zm9mj8f3aq23v3t4 --amt 250000 --min_confs 0 -f
{
"txid": "5405e5cae38f9e4e193f7b5442dd005273e2e1fab8687c42a505c1a333e8884f"
}

./regtest.sh mine 6
```
The loop client logs should show the deposits being confirmed:
```shell
[DBG] SADDR: Received deposit: 5405e5cae38f9e4e193f7b5442dd005273e2e1fab8687c42a505c1a333e8884f:0
[DBG] SADDR: Deposit 5405e5cae38f9e4e193f7b5442dd005273e2e1fab8687c42a505c1a333e8884f:0: NextState: Deposited, PreviousState: , Event: OnStart
[DBG] SADDR: Received deposit: 86ccc85449957c3472a259e447a9180aff49848f0b957a85c24819a5f432eda7:1
[DBG] SADDR: Deposit 86ccc85449957c3472a259e447a9180aff49848f0b957a85c24819a5f432eda7:1: NextState: Deposited, PreviousState: , Event: OnStart
[DBG] SADDR: Received deposit: 09d72c89b2346dc068bb57621463e53637f3c0cca3ba8ebb7fcb2773d7f32ae3:1
[DBG] SADDR: Deposit 09d72c89b2346dc068bb57621463e53637f3c0cca3ba8ebb7fcb2773d7f32ae3:1: NextState: Deposited, PreviousState: , Event: OnStart
```
Let's list the deposits in the loop client:
```shell
./regtest.sh loop static listdeposits --filter deposited  ✔  12:03:37
{
"filtered_deposits": [
{
"id": "5afc81a72464881e66aa6a5d7476b75cae26ea4c74c70424e4a68e63b9708e0c",
"state": "DEPOSITED",
"outpoint": "5405e5cae38f9e4e193f7b5442dd005273e2e1fab8687c42a505c1a333e8884f:0",
"value": "250000",
"confirmation_height": "126",
"blocks_until_expiry": "715"
},
{
"id": "0bf419bb047922afc186021fc186970b0b71db83444b39b0dcad4550014e0ba3",
"state": "DEPOSITED",
"outpoint": "86ccc85449957c3472a259e447a9180aff49848f0b957a85c24819a5f432eda7:1",
"value": "250000",
"confirmation_height": "126",
"blocks_until_expiry": "715"
},
{
"id": "ea969e2ca53b608d4cf9ca8def249d77ee1db444bd3384ae1150ea03bb03dbbd",
"state": "DEPOSITED",
"outpoint": "09d72c89b2346dc068bb57621463e53637f3c0cca3ba8ebb7fcb2773d7f32ae3:1",
"value": "250000",
"confirmation_height": "126",
"blocks_until_expiry": "715"
}
]
}
```
These deposits can now be instantly swapped. Let's use the first one:
```shell
./regtest.sh loop static in --utxo 5405e5cae38f9e4e193f7b5442dd005273e2e1fab8687c42a505c1a333e8884f:0
On-chain fees for static address loop-ins are not included.
They were already paid when the deposits were created.

Previously deposited on-chain: 250000 sat
Receive off-chain: 249614 sat
Estimated total fee: 386 sat

CONTINUE SWAP? (y/n): y
{
"swap_hash": "43ed16958d5a5bf0e6cb9a36eefb1493f39741238f06d6c7b5365c1c5c22d29e",
"state": "SignHtlcTx",
"amount": "250000",
"htlc_cltv": 431,
"quoted_swap_fee_satoshis": "386",
"max_swap_fee_satoshis": "386",
"initiation_height": 131,
"protocol_version": "V0",
"label": "",
"initiator": "loop-cli",
"payment_timeout_seconds": 60
}
```
We see in the client log that the swap instantly succeeds:
```shell
[INF] LOOPD: Loop in quote request received
[INF] LOOPD: Static loop-in request received
[INF] SADDR: StaticAddr loop-in 0000000000000000000000000000000000000000000000000000000000000000: Current: InitHtlcTx
[DBG] SADDR: Deposit 5405e5cae38f9e4e193f7b5442dd005273e2e1fab8687c42a505c1a333e8884f:0: NextState: LoopingIn, PreviousState: Deposited, Event: OnLoopInInitiated
[INF] SADDR: StaticAddr loop-in 43ed16958d5a5bf0e6cb9a36eefb1493f39741238f06d6c7b5365c1c5c22d29e: Current: SignHtlcTx
[INF] SADDR: StaticAddr loop-in 43ed16958d5a5bf0e6cb9a36eefb1493f39741238f06d6c7b5365c1c5c22d29e: Current: MonitorInvoiceAndHtlcTx
[DBG] SADDR: StaticAddr loop-in 43ed16958d5a5bf0e6cb9a36eefb1493f39741238f06d6c7b5365c1c5c22d29e: received off-chain payment update Settled
[INF] SADDR: StaticAddr loop-in 43ed16958d5a5bf0e6cb9a36eefb1493f39741238f06d6c7b5365c1c5c22d29e: Current: PaymentReceived
[DBG] SADDR: Deposit 5405e5cae38f9e4e193f7b5442dd005273e2e1fab8687c42a505c1a333e8884f:0: NextState: LoopedIn, PreviousState: LoopingIn, Event: OnLoopedIn
[INF] SADDR: StaticAddr loop-in 43ed16958d5a5bf0e6cb9a36eefb1493f39741238f06d6c7b5365c1c5c22d29e: Current: Succeeded
```
We can combine the remaining two deposits in another instant swap by specifying
the `--all` flag:
```shell
./regtest.sh loop static in --all  ✔  12:07:28
On-chain fees for static address loop-ins are not included.
They were already paid when the deposits were created.

Previously deposited on-chain: 500000 sat
Receive off-chain: 499302 sat
Estimated total fee: 698 sat

CONTINUE SWAP? (y/n): y
{
"swap_hash": "950a4c0017831dc9934e93faacde1819ed5801d1c7abf6b555dc36908a3b3ca8",
"state": "SignHtlcTx",
"amount": "500000",
"htlc_cltv": 431,
"quoted_swap_fee_satoshis": "698",
"max_swap_fee_satoshis": "698",
"initiation_height": 131,
"protocol_version": "V0",
"label": "",
"initiator": "loop-cli",
"payment_timeout_seconds": 60
}
```
For more information on the static address loop-in feature, see the
https://docs.lightning.engineering/lightning-network-tools/loop/static-loop-in-addresses

# Using the Loop server in an existing setup

This `docker-compose` is only meant as a demo and quick start help. You can of
Expand Down
59 changes: 54 additions & 5 deletions regtest/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ services:
- bitcoind:/home/bitcoin/.bitcoin

lndserver:
image: lightninglabs/lnd:v0.17.0-beta
image: lightninglabs/lnd:v0.18.5-beta
container_name: lndserver
restart: unless-stopped
networks:
Expand Down Expand Up @@ -68,6 +68,7 @@ services:
- loopserver
volumes:
- "lndserver:/root/.lnd"
- "loopserver:/root/loopserver"
depends_on:
- lndserver
command:
Expand All @@ -82,8 +83,34 @@ services:
- "--bitcoin.zmqpubrawblock=tcp://bitcoind:28332"
- "--bitcoin.zmqpubrawtx=tcp://bitcoind:28333"

aperture:
build:
context: https://github.com/lightninglabs/aperture.git
dockerfile: Dockerfile
args:
checkout: v0.3.8-beta
container_name: aperture
restart: unless-stopped
depends_on:
- loopserver
- etcd
networks:
regtest:
aliases:
- aperture
volumes:
- "lndserver:/root/.lnd"
- "loopserver:/root/loopserver"
- "aperture:/root/.aperture"
ports:
- "11018:11018"
entrypoint: [ "/bin/aperture" ]
command:
- "--configfile=/root/.aperture/aperture.yaml"


Copy link
Member

@bhandras bhandras Mar 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we also bump the client to 0.18.5 pls.

Copy link
Collaborator Author

@hieblmi hieblmi Mar 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, I updated it.

lndclient:
image: lightninglabs/lnd:v0.17.0-beta
image: lightninglabs/lnd:v0.18.5-beta
container_name: lndclient
restart: unless-stopped
networks:
Expand Down Expand Up @@ -124,22 +151,44 @@ services:
- loopclient
volumes:
- "lndclient:/root/.lnd"
- "aperture:/root/.aperture"
- "loopclient:/root/.loop"
depends_on:
- lndclient
- aperture
command:
- "loopd"
- "--experimental"
- "--network=regtest"
- "--debuglevel=debug"
- "--server.host=loopserver:11009"
- "--server.notls"
- "--server.host=aperture:11018"
- "--server.tlspath=/root/.loop/aperture-tls.cert"
- "--lnd.host=lndclient:10009"
- "--lnd.macaroonpath=/root/.lnd/data/chain/bitcoin/regtest/admin.macaroon"
- "--lnd.tlspath=/root/.lnd/tls.cert"

etcd:
image: bitnami/etcd:3.3.12
platform: linux/amd64
container_name: etcd
hostname: etcd
networks:
regtest:
aliases:
- etcd
restart: unless-stopped
ports:
- "2379:2379"
- "2380:2380"
environment:
- ALLOW_NONE_AUTHENTICATION=yes

networks:
regtest:

volumes:
bitcoind:
lndserver:
lndclient:
loopserver:
loopclient:
aperture:
56 changes: 55 additions & 1 deletion regtest/regtest.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ function setup() {

lndclient openchannel --node_key $LNDSERVER --local_amt 16000000
mine 6

docker cp aperture:/root/.aperture/tls.cert /tmp/aperture-tls.cert
chmod 644 /tmp/aperture-tls.cert
docker cp -a /tmp/aperture-tls.cert loopclient:/root/.loop/aperture-tls.cert

}

function stop() {
Expand Down Expand Up @@ -111,7 +116,6 @@ function copy_loopserver_files() {
chmod 644 /tmp/loopserver-admin.macaroon
docker cp -a /tmp/loopserver-admin.macaroon loopserver:/home/loopserver/admin.macaroon


# copy invoices macaroon to loopserver
docker cp lndserver:/root/.lnd/data/chain/bitcoin/regtest/invoices.macaroon /tmp/loopserver-invoices.macaroon
chmod 644 /tmp/loopserver-invoices.macaroon
Expand All @@ -137,8 +141,58 @@ function copy_loopserver_files() {
chmod 644 /tmp/loopserver-walletkit.macaroon
docker cp -a /tmp/loopserver-walletkit.macaroon loopserver:/home/loopserver/walletkit.macaroon

docker cp loopserver:/home/loopserver/tls.cert /tmp/loopserver-tls.cert
chmod 644 /tmp/loopserver-tls.cert
docker cp -a /tmp/loopserver-tls.cert aperture:/root/.aperture/loopserver-tls.cert

# create the aperture config and copy it to the aperture container.
write_aperture_config

docker cp /tmp/aperture.yaml aperture:/root/.aperture/aperture.yaml
}


function write_aperture_config() {
rm -rf /tmp/aperture.yaml
touch /tmp/aperture.yaml && cat > /tmp/aperture.yaml <<EOF
listenaddr: '0.0.0.0:11018'
staticroot: '/root/.aperture/static'
servestatic: true
debuglevel: trace
insecure: false
writetimeout: 0s

servername: aperture
autocert: false

authenticator:
lndhost: lndserver:10009
tlspath: /root/.lnd/tls.cert
macdir: /root/.lnd/data/chain/bitcoin/regtest
network: regtest

etcd:
host: 'etcd:2379'
user:
password:

services:
- name: loop
hostregexp: '^.*$'
pathregexp: '^/looprpc.*$'
address: 'loopserver:11009'
protocol: https
tlscertpath: /root/.aperture/loopserver-tls.cert
price: 1000
authwhitelistpaths:
- '^/looprpc.SwapServer/LoopOutTerms.*$'
- '^/looprpc.SwapServer/LoopOutQuote.*$'
- '^/looprpc.SwapServer/LoopInTerms.*$'
- '^/looprpc.SwapServer/LoopInQuote.*$'
EOF
}


if [[ $# -lt 1 ]]; then
echo "Usage: $0 start|stop|restart|info|loop"
fi
Expand Down