reservation: update reservation state machine

This commit updates the reservation statemachine to
allow for locking and spending of the
initial reservation.

Author: sputn1ck

instantout/reservation/actions.go

@@ -86,8 +86,8 @@ func (r *FSM) SubscribeToConfirmationAction(_ fsm.EventContext) fsm.EventType {
 		r.reservation.InitiationHeight)
 
 	confChan, errConfChan, err := r.cfg.ChainNotifier.RegisterConfirmationsNtfn(
-		r.ctx, nil, pkscript, DefaultConfTarget,
-		r.reservation.InitiationHeight,
+		r.ctx, nil, pkscript, 1,
+		r.reservation.InitiationHeight-1,
 	)
 	if err != nil {
 		r.Errorf("unable to subscribe to conf notification: %v", err)

instantout/reservation/fsm.go

@@ -96,7 +96,14 @@ var (
 	// Failed is the state where the reservation has failed.
 	Failed = fsm.StateType("Failed")
 
-	// Swept is the state where the reservation has been swept by the server.
+	// SpendBroadcasted is the state where a spend tx has been broadcast.
+	SpendBroadcasted = fsm.StateType("SpendBroadcasted")
+
+	// SpendConfirmed is the state where a spend tx has been confirmed.
+	SpendConfirmed = fsm.StateType("SpendConfirmed")
+
+	// Swept is the state where the reservation has been swept by the
+	// server.
 	Swept = fsm.StateType("Swept")
 )
 
@@ -125,6 +132,14 @@ var (
 	// OnRecover is the event that is triggered when the reservation FSM
 	// recovers from a restart.
 	OnRecover = fsm.EventType("OnRecover")
+
+	// OnSpendBroadcasted is the event that is triggered when the spend
+	// tx has been broadcast.
+	OnSpendBroadcasted = fsm.EventType("OnSpendBroadcasted")
+
+	// OnSpendConfirmed is the event that is triggered when the spend
+	// tx has been confirmed.
+	OnSpendConfirmed = fsm.EventType("OnSpendConfirmed")
 )
 
 // GetReservationStates returns the statemap that defines the reservation
@@ -155,14 +170,25 @@ func (f *FSM) GetReservationStates() fsm.States {
 		},
 		Confirmed: fsm.State{
 			Transitions: fsm.Transitions{
-				OnTimedOut: TimedOut,
-				OnRecover:  Confirmed,
+				OnSpendBroadcasted: SpendBroadcasted,
+				OnTimedOut:         TimedOut,
+				OnRecover:          Confirmed,
 			},
 			Action: f.ReservationConfirmedAction,
 		},
 		TimedOut: fsm.State{
 			Action: fsm.NoOpAction,
 		},
+		SpendBroadcasted: fsm.State{
+			Transitions: fsm.Transitions{
+				OnSpendConfirmed: SpendConfirmed,
+			},
+			Action: fsm.NoOpAction,
+		},
+		SpendConfirmed: fsm.State{
+			Action: fsm.NoOpAction,
+		},
+
 		Failed: fsm.State{
 			Action: fsm.NoOpAction,
 		},

instantout/reservation/manager.go

@@ -249,3 +249,22 @@ func (m *Manager) RecoverReservations(ctx context.Context) error {
 func (m *Manager) GetReservations(ctx context.Context) ([]*Reservation, error) {
 	return m.cfg.Store.ListReservations(ctx)
 }
+
+// GetReservation returns the reservation for the given id.
+func (m *Manager) GetReservation(ctx context.Context, id ID) (*Reservation,
+	error) {
+
+	return m.cfg.Store.GetReservation(ctx, id)
+}
+
+// LockReservation locks the reservation for the given id.
+func (m *Manager) LockReservation(ctx context.Context, id ID) error {
+	// TODO(sputn1ck): implement
+	return nil
+}
+
+// UnlockReservation unlocks the reservation for the given id.
+func (m *Manager) UnlockReservation(ctx context.Context, id ID) error {
+	// TODO(sputn1ck): implement
+	return nil
+}

instantout/reservation/reservation_fsm.md

@@ -2,13 +2,17 @@
 stateDiagram-v2
 [*] --> Init: OnServerRequest
 Confirmed
+Confirmed --> SpendBroadcasted: OnSpendBroadcasted
 Confirmed --> TimedOut: OnTimedOut
 Confirmed --> Confirmed: OnRecover
 Failed
 Init
 Init --> Failed: OnError
 Init --> WaitForConfirmation: OnBroadcast
 Init --> Failed: OnRecover
+SpendBroadcasted
+SpendBroadcasted --> SpendConfirmed: OnSpendConfirmed
+SpendConfirmed
 TimedOut
 WaitForConfirmation
 WaitForConfirmation --> WaitForConfirmation: OnRecover