Notify for utxos spent with and without confirmation (#80)

* Update core & utxo repo impls to handle utxos spent and utxo spent with confirmation

* Make electrum client notifiy for "spent" and "spent with confirmation" utxos

* Update interface

api-spec/protobuf/ocean/v1/types.proto

@@ -150,6 +150,7 @@ enum UtxoEventType {
   UTXO_EVENT_TYPE_LOCKED = 3;
   UTXO_EVENT_TYPE_UNLOCKED = 4;
   UTXO_EVENT_TYPE_SPENT = 5;
+  UTXO_EVENT_TYPE_CONFIRMED_SPENT = 6;
 }
 
 enum WebhookEventType {

internal/core/application/account_service.go

@@ -283,9 +283,26 @@ func (as *AccountService) listenToUtxoChannel(
 		for _, u := range utxos {
 			utxoKeys = append(utxoKeys, u.Key())
 		}
+
+		if utxos[0].IsConfirmedSpent() {
+			count, err := as.repoManager.UtxoRepository().ConfirmSpendUtxos(
+				context.Background(), utxoKeys, utxos[0].SpentStatus,
+			)
+			if err != nil {
+				as.warn(
+					err, "error while updating utxos status to confirmed spend for account %s",
+					accountName,
+				)
+			}
+			if count > 0 {
+				as.log("confirmed spend of %d utxos for account %s", count, accountName)
+			}
+			continue
+		}
+
 		if utxos[0].IsSpent() {
 			count, err := as.repoManager.UtxoRepository().SpendUtxos(
-				context.Background(), utxoKeys, utxos[0].SpentStatus,
+				context.Background(), utxoKeys, utxos[0].SpentStatus.Txid,
 			)
 			if err != nil {
 				as.warn(

internal/core/application/account_service_test.go

@@ -65,8 +65,8 @@ func TestAccountService(t *testing.T) {
 
 	// Simulate withdrawing all funds by spending every spendable utxo coming
 	// from ListUtxosForAccount.
-	status := domain.UtxoStatus{hex.EncodeToString(make([]byte, 32)), 1, 0, ""}
-	_, err = repoManager.UtxoRepository().SpendUtxos(ctx, utxos.Spendable.Keys(), status)
+	txid := hex.EncodeToString(make([]byte, 32))
+	_, err = repoManager.UtxoRepository().SpendUtxos(ctx, utxos.Spendable.Keys(), txid)
 	require.NoError(t, err)
 
 	// Now deleting the account should work without errors.

internal/core/application/notification_service.go

@@ -177,10 +177,18 @@ func (ns *NotificationService) listenToUtxoChannel(
 	ns.log("start listening to utxo channel for script %s", scriptHash)
 
 	for utxos := range chUtxos {
-		eventType := domain.UtxoAdded
-		if utxos[0].IsSpent() {
+		var eventType domain.UtxoEventType
+		switch {
+		case utxos[0].IsConfirmedSpent():
+			eventType = domain.UtxoConfirmedSpend
+		case utxos[0].IsSpent():
 			eventType = domain.UtxoSpent
+		case utxos[0].IsConfirmed():
+			eventType = domain.UtxoConfirmed
+		default:
+			eventType = domain.UtxoAdded
 		}
+
 		utxoInfo := make([]domain.UtxoInfo, 0, len(utxos))
 		for _, u := range utxos {
 			utxoInfo = append(utxoInfo, u.Info())

internal/core/application/notification_service_test.go

@@ -53,8 +53,8 @@ func testGetUtxoChannel(t *testing.T) {
 
 	time.Sleep(time.Second)
 
-	status := domain.UtxoStatus{hex.EncodeToString(make([]byte, 32)), 1, 0, ""}
-	repoManager.UtxoRepository().SpendUtxos(ctx, keys, status)
+	txid := hex.EncodeToString(make([]byte, 32))
+	repoManager.UtxoRepository().SpendUtxos(ctx, keys, txid)
 
 	time.Sleep(time.Second)
 

internal/core/domain/utxo.go

@@ -86,11 +86,16 @@ type Utxo struct {
 	ConfirmedStatus     UtxoStatus
 }
 
-// IsSpent returns whether the utxo have been spent.
+// IsSpent returns whether the utxo is spent by a tx in mempool.
 func (u *Utxo) IsSpent() bool {
 	return u.SpentStatus != UtxoStatus{}
 }
 
+// IsConfirmedSpent returns whether the utxo is spent by a tx in blockchain.
+func (u *Utxo) IsConfirmedSpent() bool {
+	return u.IsSpent() && len(u.SpentStatus.BlockHash) > 0
+}
+
 // IsConfirmed returns whether the utxo is confirmed.
 func (u *Utxo) IsConfirmed() bool {
 	return u.ConfirmedStatus != UtxoStatus{}
@@ -133,12 +138,28 @@ func (u *Utxo) Info() UtxoInfo {
 	}
 }
 
-// Spend marks the utxos as spent.
-func (u *Utxo) Spend(status UtxoStatus) error {
+// Spend marks the utxos as spent and resets the lock timestamp.
+func (u *Utxo) Spend(txid string) error {
 	if u.IsSpent() {
 		return nil
 	}
 
+	if len(txid) <= 0 {
+		return fmt.Errorf("missing txid")
+	}
+	u.SpentStatus = UtxoStatus{
+		Txid: txid,
+	}
+	u.LockTimestamp = 0
+	return nil
+}
+
+// ConfirmSpend adds confirmation (block) info to a spent utxo.
+func (u *Utxo) ConfirmSpend(status UtxoStatus) error {
+	if u.IsConfirmedSpent() {
+		return nil
+	}
+
 	emptyStatus := UtxoStatus{}
 	if status == emptyStatus {
 		return fmt.Errorf("status must not be empty")
@@ -149,8 +170,8 @@ func (u *Utxo) Spend(status UtxoStatus) error {
 	if status.BlockHeight == 0 && status.BlockTime == 0 && status.BlockHash == "" {
 		return fmt.Errorf("missing block info")
 	}
+
 	u.SpentStatus = status
-	u.LockTimestamp = 0
 	return nil
 }
 

internal/core/domain/utxo_repository.go

@@ -10,15 +10,17 @@ const (
 	UtxoLocked
 	UtxoUnlocked
 	UtxoSpent
+	UtxoConfirmedSpend
 )
 
 var (
 	utxoTypeString = map[UtxoEventType]string{
-		UtxoAdded:     "UtxoAdded",
-		UtxoConfirmed: "UtxoConfirmed",
-		UtxoLocked:    "UtxoLocked",
-		UtxoUnlocked:  "UtxoUnlocked",
-		UtxoSpent:     "UtxoSpent",
+		UtxoAdded:          "UtxoAdded",
+		UtxoConfirmed:      "UtxoConfirmed",
+		UtxoLocked:         "UtxoLocked",
+		UtxoUnlocked:       "UtxoUnlocked",
+		UtxoSpent:          "UtxoSpent",
+		UtxoConfirmedSpend: "UtxoConfirmedSpend",
 	}
 )
 
@@ -60,9 +62,12 @@ type UtxoRepository interface {
 	// GetBalanceForAccount returns the confirmed, unconfirmed and locked
 	// balances per each asset for the given account.
 	GetBalanceForAccount(ctx context.Context, account string) (map[string]*Balance, error)
-	// SpendUtxos updates the status of the given list of utxos to "spent".
+	// SpendUtxos updates the status of the given list of utxos to "spent" by the given txid.
 	// Generates a UtxoSpent event if successfull.
-	SpendUtxos(ctx context.Context, utxoKeys []UtxoKey, status UtxoStatus) (int, error)
+	SpendUtxos(ctx context.Context, utxoKeys []UtxoKey, txid string) (int, error)
+	// ConfirmSpendUtxos updates the status of the given list of utxos to "confirmed spend".
+	// Generates a UtxoConfirmedSpend event if successfull.
+	ConfirmSpendUtxos(ctx context.Context, utxoKeys []UtxoKey, status UtxoStatus) (int, error)
 	// ConfirmUtxos updates the status of the given list of utxos to "confirmed".
 	// Generates a UtxoConfirmed event if successfull.
 	ConfirmUtxos(ctx context.Context, utxoKeys []UtxoKey, status UtxoStatus) (int, error)

internal/core/domain/utxo_test.go

@@ -15,11 +15,33 @@ func TestSpendUtxo(t *testing.T) {
 	u := domain.Utxo{}
 	require.False(t, u.IsSpent())
 
-	err := u.Spend(domain.UtxoStatus{hex.EncodeToString(make([]byte, 32)), 1, 0, ""})
+	err := u.Spend(hex.EncodeToString(make([]byte, 32)))
 	require.NoError(t, err)
 	require.True(t, u.IsSpent())
 }
 
+func TestConfirmSpendUtxo(t *testing.T) {
+	t.Parallel()
+
+	u := domain.Utxo{}
+	require.False(t, u.IsConfirmedSpent())
+
+	err := u.Spend(hex.EncodeToString(make([]byte, 32)))
+	require.NoError(t, err)
+	require.True(t, u.IsSpent())
+	require.False(t, u.IsConfirmedSpent())
+
+	err = u.ConfirmSpend(domain.UtxoStatus{
+		Txid:        hex.EncodeToString(make([]byte, 32)),
+		BlockHeight: 1,
+		BlockTime:   time.Now().Unix(),
+		BlockHash:   hex.EncodeToString(make([]byte, 32)),
+	})
+	require.NoError(t, err)
+	require.True(t, u.IsSpent())
+	require.True(t, u.IsConfirmedSpent())
+}
+
 func TestConfirmUtxo(t *testing.T) {
 	t.Parallel()