feat: Onboarding through a hodl invoice #2560

holzeis · 2024-05-22T19:06:52Z

Introduces a lightning onboarding by leveraging an external lnd instance to manage a hodl invoice flow.

TODO:

Submit pre image when posting the order after the lightning funding event has been received.
Settle the invoice with the pre image received from the app.
Initiate a one sided channel opening with the app.
Add minimum trader reserve (e.g. 10k sats) to cover for price movements.
Add e2e test

In the next step we should look into the following issues.

Separate dlc channel creation from opening a position #2567: Prevents settling an invoice even if the order fails to get matched.
Add margin order for executing external funded positions #2566: Prevents executing an order without sufficient margin.

Additionally we should look into adding an HTLC to our buffer transaction to make this swap trust less.

crates/lnd-bridge/Dockerfile

crates/xxi-node/src/commons/mod.rs

bonomat · 2024-05-23T05:11:27Z

Simulator.Screen.Recording.-.iPhone.15.-.2024-05-23.at.15.14.45.mp4

🚀

holzeis · 2024-05-23T16:17:13Z

@bonomat I continued working on this and mainly tested the feature.

Added a way to cancel running watch tasks
Fixed the hash encoding (needs to be url safe as otherwise it could be interpreted as path)
Moved the pre-image argument also to the channel opening params (combined it with the flag)
Reworked the channel opening params addressing the todo to introduce an internal model. This model can now hold the external funding amount. Based on that amount I've added a check when opening the position to reject if the amount is not sufficient. I think this is crucial as everything else would be a huge vulnerability.

However, we need to introduce a minimum trader reserve for that as otherwise price movements could also result into a rejected order. (we need margin orders). I tried to add this to the ui, but failed, would be great if you could take over.

holzeis · 2024-05-23T17:11:00Z

@luckysori probably best to review the changed files.

coordinator/migrations/2024-05-23-000406_hodl_invoice_table/up.sql

crates/lnd-bridge/examples/create_invoice_api.rs

crates/xxi-node/src/commons/pre_image.rs

holzeis · 2024-05-23T17:20:54Z

crates/xxi-node/src/commons/pre_image.rs

+use sha2::Sha256;
+
+pub struct PreImage {
+    // TODO(bonomat): instead of implementing `PreImage` we should create our


Note, only the hash needs to be url safe.

mobile/native/src/event/api.rs

holzeis · 2024-05-23T17:40:08Z

mobile/native/src/hodl_invoice.rs

+}
+
+pub async fn get_hodl_invoice_from_coordinator(amount: Amount) -> Result<HodlInvoice> {
+    // TODO(bonomat): we might want to store this in the db so.


🤔I don't think it's necessary..

mobile/native/src/hodl_invoice.rs

luckysori

I reviewed d81a770 and the logic seems sound.

If the external funding is insufficient, I think we should fail the whole thing earlier though. It seems to me like we have all the information available as soon as we get the match from the orderbook in process_new_market_order, so we don't have to wait until we call open_dlc_channel.

coordinator/src/trade/mod.rs

This will allow us to generically wrap a api model into a signed value model which covers the signature creation and verification.

holzeis · 2024-05-24T18:25:11Z

I reviewed d81a770 and the logic seems sound.

If the external funding is insufficient, I think we should fail the whole thing earlier though. It seems to me like we have all the information available as soon as we get the match from the orderbook in process_new_market_order, so we don't have to wait until we call open_dlc_channel.

Thanks for you feedback, I've adapted the code, moved the check early and also now subtract the funding tx reserve and the channel fee reserve from the trader reserve.

I think this is now ready to go, but I will wait for your final review and approval.

luckysori

LGTM, I think this should work!

coordinator/src/cli.rs

luckysori · 2024-05-27T03:16:58Z

coordinator/src/lib.rs

+pub struct ChannelOpeningParams {
+    pub trader_reserve: Amount,
+    pub coordinator_reserve: Amount,
+    pub external_funding: Option<Amount>,


🔧 It might be simpler to just use Amount, becase a zero amount and a None are the same.

hmm.. I kind of like the option better because it is a bit more expressive than automatically implying that a zero amount is a OpenSingleFundedChannel

match params.external_funding { Some(external_funding) => { TradeAction::OpenSingleFundedChannel { external_funding } } None => TradeAction::OpenDlcChannel, }

But what does it mean to have a 0-valued external_funding then?

Probably a bug. Any value below 250k is probably a bug.

coordinator/src/node/invoice.rs

coordinator/src/orderbook/async_match.rs

coordinator/src/routes.rs

crates/xxi-node/src/commons/message.rs

luckysori · 2024-05-27T04:11:46Z

mobile/native/src/backup.rs

-            EventType::PaymentClaimed,
-            EventType::PaymentSent,
-            EventType::PaymentFailed,


luckysori · 2024-05-27T04:13:01Z

mobile/native/src/lib.rs

 mod position;
+mod unfunded_channel_opening_order;


🙃 Hmmm, we should align the terminology between coordinator and app.

what do you mean? the coordinator doesn't know of an unfunded channel opening order.

Yeah, I think you are right. I was confused at first because this is implicitly about a single-funded channel, which is a different name.

Maybe it would be clearer with unfunded_wallet_channel_opening_order? The name would be annoyingly long though.

mobile/native/src/unfunded_channel_opening_order.rs

mobile/native/src/watcher.rs

Creates a hodl invoices, subscribes to updates to it and returns the invoice to the app.

Co-authored-by: Richard Holzeis <richard@holzeis.me>

Before the button was jumping depending on whether the slider or the button was shown. I also changed the button text from "Confirm" to "Next" since there wouldn't be any semantical difference between funding with internal wallet or external.

The asterix was just not clear enough. I also did some minor styling improvements and removed the unused label argument from the fee expansion widget.

This will submit the order once a hodl invoice is paid. In the next step we have to extend the post order api to revail the pre image so that the coordinator can claim the payment and open a single sided channel.

api.rs should remain as a thin proxy to the flutter frontend.

we need to store the pre image to be able to refer to it later again. Also, it will help us get a good overview of who asked for what.

if the trader receives the note that the ln invoice has been funded, he shares the preimage with him when creating a new order. Upon receiving said preimage, the coordinator checks if the preimage fits to a known hash in the db. Next: redeem payment before matching the order

this is needed because we send a url_safe base64 version over the via.

If we received the lightning payment from the user we open the channel to the user with only the coordinator's funds. Co-authored-by: Richard Holzeis <richard@holzeis.me>

Otherwise, we might end up with "/" in the hash what will result in an endpoint not found error as the "/" is interpreted as path.

That should be enough to pay the lightning invoice and reduces the risk of price movements.

luckysori · 2024-05-27T09:52:25Z

coordinator/src/trade/mod.rs

-            TraderRequiredLiquidity::None => (
-                margin_coordinator
-                    + collateral_reserve_coordinator.to_sat()
-                    + margin_trader
-                    + collateral_reserve_trader
-                    // If the trader doesn't bring their own UTXOs, including the order matching fee
-                    // is not strictly necessary, but it's simpler to do so.
-                    + order_matching_fee,
-                0,
-                dlc::FeeConfig::AllOffer,
-            ),
+            TraderRequiredLiquidity::None => {
+                (
+                    margin_coordinator
+                        + collateral_reserve_coordinator.to_sat()
+                        + margin_trader
+                        + collateral_reserve_trader
+                        // If the trader doesn't bring their own UTXOs, including the order matching fee
+                        // is not strictly necessary, but it's simpler to do so.
+                        + order_matching_fee,
+                    0,
+                    dlc::FeeConfig::AllOffer,
+                )
+            }


🙃 I think nothing actually changed here.

jap only the brakets have been added 🙈

luckysori · 2024-05-27T09:57:58Z

coordinator/src/trade/mod.rs

-                let collateral_reserve_trader = params
-                    .trader_reserve
-                    .context("Missing trader collateral reserve")?;


I guess it's debatable, so none of this is a deal breaker at all.

What I dislike is leaking the knowledge of the external funding any further than necessary, and the fact that the trader_reserve field is ignored, when it could be used to carry this information from the outside.

And I think we could avoid code duplication by reusing a helper function.

holzeis requested a review from bonomat May 22, 2024 19:06

bonomat reviewed May 23, 2024

View reviewed changes

crates/lnd-bridge/Dockerfile Outdated Show resolved Hide resolved

bonomat reviewed May 23, 2024

View reviewed changes

crates/xxi-node/src/commons/mod.rs Show resolved Hide resolved

bonomat force-pushed the feat/setup-lnd-and-get-inbound-liquidity branch from d8e5b52 to 0bdeea6 Compare May 23, 2024 05:21

bonomat marked this pull request as ready for review May 23, 2024 05:21

bonomat requested review from bonomat and luckysori May 23, 2024 05:21

holzeis self-assigned this May 23, 2024

holzeis force-pushed the feat/setup-lnd-and-get-inbound-liquidity branch from 31b2351 to e113a8b Compare May 23, 2024 12:22

holzeis commented May 23, 2024

View reviewed changes

holzeis force-pushed the feat/setup-lnd-and-get-inbound-liquidity branch 2 times, most recently from a026c96 to 81d6e17 Compare May 24, 2024 11:29

holzeis added 3 commits May 24, 2024 14:30

chore: Remove deprecated p2p announcement address argument

80d2916

chore: Remove empty todo

81a3116

chore: Remove unused liquidity request

e7bc782

holzeis force-pushed the feat/setup-lnd-and-get-inbound-liquidity branch 4 times, most recently from 67a2bb4 to 4824f28 Compare May 24, 2024 13:23

luckysori reviewed May 24, 2024

View reviewed changes

coordinator/src/trade/mod.rs Outdated Show resolved Hide resolved

holzeis added 2 commits May 24, 2024 20:05

feat: Add lnd bridge

19ced8d

feat: Add generic signed value model

d34edf1

This will allow us to generically wrap a api model into a signed value model which covers the signature creation and verification.

holzeis force-pushed the feat/setup-lnd-and-get-inbound-liquidity branch from 4824f28 to 19a23f6 Compare May 24, 2024 18:22

holzeis requested a review from luckysori May 24, 2024 18:25

luckysori approved these changes May 27, 2024

View reviewed changes

feat: Add create invoice api

39f2b4c

Creates a hodl invoices, subscribes to updates to it and returns the invoice to the app.

bonomat and others added 22 commits May 27, 2024 09:48

feat: Generate pre image and hash

f9bfa82

Co-authored-by: Richard Holzeis <richard@holzeis.me>

chore: Improve custom framed container styling

4c87af0

chore: Fix typo in funding type enum

2909b7f

feat: Add icon to show collapsable fees

40eaf91

The asterix was just not clear enough. I also did some minor styling improvements and removed the unused label argument from the fee expansion widget.

chore: Formatted code

83330cc

feat: Watch for lightning invoice payment

67454ed

This will submit the order once a hodl invoice is paid. In the next step we have to extend the post order api to revail the pre image so that the coordinator can claim the payment and open a single sided channel.

chore: extract function back into own module

ef02faf

api.rs should remain as a thin proxy to the flutter frontend.

feat: store hodl invoice hash in db

ac3b549

we need to store the pre image to be able to refer to it later again. Also, it will help us get a good overview of who asked for what.

feat(dev): added pay ln invoice shortcut in just file

4cec0b4

chore: provide convenient methods to deserialize pre_images

698f718

this is needed because we send a url_safe base64 version over the via.

feat: settle invoice upon receiving it

58407aa

feat: Open one sided channel from coordinator

c1555d5

If we received the lightning payment from the user we open the channel to the user with only the coordinator's funds. Co-authored-by: Richard Holzeis <richard@holzeis.me>

chore: fix text when receiving payment via lightning

d40fc68

chore: Abort watch task when leaving funding screen

6af5cbc

fix: Generate a url safe pre image hash

3418850

Otherwise, we might end up with "/" in the hash what will result in an endpoint not found error as the "/" is interpreted as path.

fix: Add minimum trader reserve to cover price movements

4306159

chore(test): Add simple open position with external funding e2e test

4f7546e

chore: Expire the hodl invoice after 5 minutes

911094c

That should be enough to pay the lightning invoice and reduces the risk of price movements.

chore: Truncate subtitle of qr code on funding screen

89fa6fe

chore: Spawn blocking around database transactions

06909be

holzeis force-pushed the feat/setup-lnd-and-get-inbound-liquidity branch from 19a23f6 to 06909be Compare May 27, 2024 08:14

holzeis added this pull request to the merge queue May 27, 2024

luckysori approved these changes May 27, 2024

View reviewed changes

Merged via the queue into main with commit a4f12f7 May 27, 2024
23 checks passed

holzeis deleted the feat/setup-lnd-and-get-inbound-liquidity branch May 27, 2024 10:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Onboarding through a hodl invoice #2560

feat: Onboarding through a hodl invoice #2560

holzeis commented May 22, 2024 •

edited

Loading

bonomat commented May 23, 2024 •

edited

Loading

holzeis commented May 23, 2024

holzeis commented May 23, 2024 •

edited

Loading

holzeis May 23, 2024

holzeis May 23, 2024

luckysori left a comment

holzeis commented May 24, 2024

luckysori left a comment

luckysori May 27, 2024

holzeis May 27, 2024

luckysori May 27, 2024

holzeis May 27, 2024

luckysori May 27, 2024

luckysori May 27, 2024

holzeis May 27, 2024

luckysori May 27, 2024

luckysori May 27, 2024

holzeis May 27, 2024

luckysori May 27, 2024

feat: Onboarding through a hodl invoice #2560

feat: Onboarding through a hodl invoice #2560

Conversation

holzeis commented May 22, 2024 • edited Loading

bonomat commented May 23, 2024 • edited Loading

holzeis commented May 23, 2024

holzeis commented May 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luckysori left a comment

Choose a reason for hiding this comment

holzeis commented May 24, 2024

luckysori left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holzeis commented May 22, 2024 •

edited

Loading

bonomat commented May 23, 2024 •

edited

Loading

holzeis commented May 23, 2024 •

edited

Loading