[2/?] Instant loop out: Add reservations #632

sputn1ck · 2023-08-25T00:14:44Z

Prior PR: #631

Skip 1st commit

This PR adds reservation functionality to loop.

Reservations are 2-of-2 musig2 taproot outputs with a single funder. The output contains an expiry path that allows the funder to spend the funds after N blocks.

Reservations can be used a new type of loop out, where the server commits funds to the 2-of-2 output and the loop client can then trustlessly and instantaneously loop out, allow for rapid rebalancing of channels.

The reservation state machine in this PR looks like this:

stateDiagram-v2
[*] --> Init: OnServerRequest
Confirmed
Confirmed --> TimedOut: OnTimedOut
Confirmed --> Confirmed: OnRecover
Failed
Init
Init --> Failed: OnError
Init --> WaitForConfirmation: OnBroadcast
Init --> Failed: OnRecover
TimedOut
WaitForConfirmation
WaitForConfirmation --> WaitForConfirmation: OnRecover
WaitForConfirmation --> Confirmed: OnConfirmed
WaitForConfirmation --> TimedOut: OnTimedOut

TODO:

SQL db
Recover reservation fsms on startup
More Unit test coverage

Next PR: #633

hieblmi

This is great work @sputn1ck. I think future features will benefit from your code structure. I've just left a couple of things that sprung to my eye so far.

reservation/script.go

reservation/actions.go

loopd/daemon.go

reservation/server.go

hieblmi

Some more comments.

reservation/server.go

reservation/manager.go

hieblmi

Some more comments

reservation/manager.go

reservation/interfaces.go

reservation/actions.go

fsm/fsm.go

bhandras

Excellent work, I added some comments, most of them are nits. Almost ready!

fsm/fsm.go

bhandras · 2023-10-31T07:44:19Z

fsm/fsm.go

@@ -117,10 +126,42 @@ type StateMachine struct {
 }

 // NewStateMachine creates a new state machine.
-func NewStateMachine(states States) *StateMachine {
+func NewStateMachine(states States,
+	withoutDefaultObserver ...bool) *StateMachine {


What's the use for the variadic argument? If it is to avoid having an arg sometimes but being able to define it other times, then I'd recommend just keeping it as a normal arg for better readability.

Another cleaner way is to use an option modifier type instead.

fsm/fsm.go

bhandras · 2023-10-31T07:46:58Z

fsm/fsm.go

+	var defaultObserver *CachedObserver
+
+	if len(withoutDefaultObserver) == 0 || !withoutDefaultObserver[0] {
+		defaultObserver = NewCachedObserver(100)


Can you add a comment why this is useful? Also is 100 just a magic large number or need to be specifically this high?

100 is just a magic large number. do you have a recommendation?

changed it to pass on a single int for the observer size

reservation/manager.go

bhandras · 2023-10-31T08:42:19Z

reservation/manager.go

+	go func() {
+		for {
+			select {
+			case <-ctx.Done():


Shouldn't this goroutine (and this whole function) use the m.runCtx instead?

I think this would be correct if the passed in ctx here was m.runCtx. RegisterReservationNotifications is called in Run().

Shouldn't this goroutine (and this whole function) use the m.runCtx instead?

I don't think so, as we can return if the client cancels the stream. There would be no more channel to send to

reservation/manager.go

loopd/daemon.go

hieblmi

Awesome work @sputn1ck, this is looking really good. I've left more code design and style nits this time and also have some clarifying questions.

cmd/loop/reservations.go

loopd/daemon.go

loopd/swapclient_server.go

reservation/fsm.go

reservation/interfaces.go

hieblmi

Great work @sputn1ck!

hieblmi · 2023-12-18T16:35:21Z

instantout/reservation/manager.go

+
+	// Create the reservation state machine. We need to pass in the runCtx
+	// of the reservation manager so that the state machine will keep on
+	// running even if the grpc conte


nit: incomplete comment

This commit adds the reservation state machine and actions to the reservation package.

bhandras

Re-reviewed due to added test coverage. LGTM 🎉 🎉

instantout/reservation/actions_test.go

This commit adds the reservation manager to the reservation package. This manager manages the lifecycle of reservations.

This commit adds the ReservationServer service to the proto definitions.

sputn1ck marked this pull request as draft August 25, 2023 00:14

This was referenced Aug 25, 2023

[3/?] Instant loop out: Add reservation spending #633

Closed

[1/?] Instant loop out: Add FSM module #631

Merged

levmi assigned sputn1ck Aug 31, 2023

sputn1ck force-pushed the instantloopout_2 branch from e645061 to 843044c Compare September 4, 2023 06:42

hieblmi reviewed Sep 8, 2023

View reviewed changes

sputn1ck force-pushed the instantloopout_2 branch from 843044c to fca0849 Compare September 12, 2023 08:27

hieblmi reviewed Sep 12, 2023

View reviewed changes

reservation/server.go Outdated Show resolved Hide resolved

reservation/manager.go Outdated Show resolved Hide resolved

hieblmi reviewed Sep 14, 2023

View reviewed changes

reservation/manager.go Outdated Show resolved Hide resolved

reservation/interfaces.go Outdated Show resolved Hide resolved

sputn1ck force-pushed the instantloopout_2 branch 2 times, most recently from a4dc78e to 76559c6 Compare September 14, 2023 11:41

sputn1ck force-pushed the instantloopout_2 branch 3 times, most recently from 94f7293 to e561c00 Compare October 12, 2023 12:58

hieblmi reviewed Oct 13, 2023

View reviewed changes

reservation/actions.go Outdated Show resolved Hide resolved

fsm/fsm.go Outdated Show resolved Hide resolved

sputn1ck force-pushed the instantloopout_2 branch 2 times, most recently from 9f6f3ae to e9a477e Compare October 24, 2023 20:33

sputn1ck requested review from hieblmi and bhandras October 24, 2023 20:34

sputn1ck marked this pull request as ready for review October 24, 2023 20:34

sputn1ck force-pushed the instantloopout_2 branch 5 times, most recently from bed3fd0 to b6a3924 Compare October 25, 2023 21:33

bhandras reviewed Oct 31, 2023

View reviewed changes

hieblmi reviewed Nov 3, 2023

View reviewed changes

sputn1ck force-pushed the instantloopout_2 branch from b6a3924 to b2d92f1 Compare November 7, 2023 14:15

sputn1ck force-pushed the instantloopout_2 branch from b2d92f1 to 039d90f Compare November 21, 2023 07:26

sputn1ck requested a review from bhandras November 21, 2023 16:49

sputn1ck force-pushed the instantloopout_2 branch from ad85206 to 5d3f91b Compare December 15, 2023 12:09

hieblmi approved these changes Dec 18, 2023

View reviewed changes

sputn1ck force-pushed the instantloopout_2 branch 2 times, most recently from ebb19d5 to 2d95c6c Compare December 19, 2023 11:58

sputn1ck force-pushed the instantloopout_2 branch from 2d95c6c to 9bbf489 Compare January 12, 2024 09:45

sputn1ck mentioned this pull request Jan 12, 2024

[4/?] Instant loop out: Add instant loop outs #651

Merged

5 tasks

sputn1ck force-pushed the instantloopout_2 branch 2 times, most recently from 8e543da to f2d5f94 Compare January 17, 2024 13:26

reservation: add reservation fsm and actions

228bf6a

This commit adds the reservation state machine and actions to the reservation package.

sputn1ck force-pushed the instantloopout_2 branch 2 times, most recently from cdf68b2 to eebf8bb Compare January 17, 2024 14:12

sputn1ck requested a review from bhandras January 17, 2024 14:15

sputn1ck force-pushed the instantloopout_2 branch 2 times, most recently from 6fdaaa4 to 19176d4 Compare January 17, 2024 14:49

bhandras approved these changes Jan 17, 2024

View reviewed changes

instantout/reservation/actions_test.go Outdated Show resolved Hide resolved

sputn1ck added 12 commits January 17, 2024 15:59

reservation add actions tests

1a75a53

loopdb: add reservation sqlc code

a29f7e4

reservations: add reservation sql store

60df5fe

reservation: add reservation manager

61a5f9d

This commit adds the reservation manager to the reservation package. This manager manages the lifecycle of reservations.

reservation: add test for manager

d527b0b

swapserverrpc add ReservationServer

73d5cf5

This commit adds the ReservationServer service to the proto definitions.

looprpc: add reservation rpcs

091c0a8

loop: expose server grpc connection

4d558b1

loopd: add reservation handling

49c40d9

loop: add reservation cli commands

30acccb

loopd: hide reservation manager behind flag.

f00329d

fsm: add reservation fsm compiling

9b178dd

sputn1ck force-pushed the instantloopout_2 branch from 19176d4 to 9b178dd Compare January 17, 2024 14:59

sputn1ck merged commit e9d374a into lightninglabs:master Jan 17, 2024
4 checks passed

sputn1ck deleted the instantloopout_2 branch January 17, 2024 15:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2/?] Instant loop out: Add reservations #632

[2/?] Instant loop out: Add reservations #632

sputn1ck commented Aug 25, 2023 •

edited

Loading

hieblmi left a comment

hieblmi left a comment

hieblmi left a comment

bhandras left a comment

bhandras Oct 31, 2023

bhandras Oct 31, 2023

bhandras Oct 31, 2023

sputn1ck Nov 7, 2023

sputn1ck Nov 7, 2023

bhandras Oct 31, 2023

hieblmi Nov 2, 2023

sputn1ck Nov 7, 2023

hieblmi left a comment

hieblmi left a comment

hieblmi Dec 18, 2023

bhandras left a comment

[2/?] Instant loop out: Add reservations #632

[2/?] Instant loop out: Add reservations #632

Conversation

sputn1ck commented Aug 25, 2023 • edited Loading

hieblmi left a comment

Choose a reason for hiding this comment

hieblmi left a comment

Choose a reason for hiding this comment

hieblmi left a comment

Choose a reason for hiding this comment

bhandras 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

hieblmi left a comment

Choose a reason for hiding this comment

hieblmi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bhandras left a comment

Choose a reason for hiding this comment

sputn1ck commented Aug 25, 2023 •

edited

Loading