staticaddr: add swap hash to deposit structs

Author: hieblmi

loopd/swapclient_server.go

@@ -1924,6 +1924,7 @@ func filter(deposits []*deposit.Deposit, f filterFunc) []*looprpc.Deposit {
 			Outpoint:           outpoint,
 			Value:              int64(d.Value),
 			ConfirmationHeight: d.ConfirmationHeight,
+			SwapHash:           d.SwapHash[:],
 		}
 
 		clientDeposits = append(clientDeposits, deposit)

looprpc/client.pb.go

@@ -1910,6 +1910,12 @@ message Deposit {
     loop-in swap anymore.
     */
     int64 blocks_until_expiry = 6;
+
+    /*
+    The swap hash of the swap that this deposit is part of. This field is only
+    set if the deposit is part of a loop-in swap.
+    */
+    bytes swap_hash = 7;
 }
 
 message StaticAddressWithdrawal {

looprpc/client.proto

@@ -860,6 +860,11 @@
           "type": "string",
           "format": "int64",
           "description": "The number of blocks that are left until the deposit cannot be used for a\nloop-in swap anymore."
+        },
+        "swap_hash": {
+          "type": "string",
+          "format": "byte",
+          "description": "The swap hash of the swap that this deposit is part of. This field is only\nset if the deposit is part of a loop-in swap."
         }
       }
     },

looprpc/client.swagger.json

@@ -9,6 +9,7 @@ import (
 	"github.com/btcsuite/btcd/chaincfg/chainhash"
 	"github.com/btcsuite/btcd/wire"
 	"github.com/lightninglabs/loop/fsm"
+	"github.com/lightningnetwork/lnd/lntypes"
 )
 
 // ID is a unique identifier for a deposit.
@@ -54,6 +55,10 @@ type Deposit struct {
 	// ExpirySweepTxid is the transaction id of the expiry sweep.
 	ExpirySweepTxid chainhash.Hash
 
+	// SwapHash is an optional reference to a static address loop-in swap
+	// that used this deposit.
+	SwapHash lntypes.Hash
+
 	// FinalizedWithdrawalTx is the coop-signed withdrawal transaction. It
 	// is republished on new block arrivals and on client restarts.
 	FinalizedWithdrawalTx *wire.MsgTx

staticaddr/deposit/deposit.go

@@ -13,6 +13,7 @@ import (
 	"github.com/lightninglabs/loop/loopdb"
 	"github.com/lightninglabs/loop/loopdb/sqlc"
 	"github.com/lightningnetwork/lnd/clock"
+	"github.com/lightningnetwork/lnd/lntypes"
 )
 
 // SqlStore is the backing store for static address deposits.
@@ -270,6 +271,14 @@ func ToDeposit(row sqlc.Deposit, lastUpdate sqlc.DepositUpdate) (*Deposit,
 		}
 	}
 
+	var swapHash lntypes.Hash
+	if row.SwapHash != nil {
+		swapHash, err = lntypes.MakeHash(row.SwapHash)
+		if err != nil {
+			return nil, err
+		}
+	}
+
 	return &Deposit{
 		ID:    id,
 		state: fsm.StateType(lastUpdate.UpdateState),
@@ -281,6 +290,7 @@ func ToDeposit(row sqlc.Deposit, lastUpdate sqlc.DepositUpdate) (*Deposit,
 		ConfirmationHeight:    row.ConfirmationHeight,
 		TimeOutSweepPkScript:  row.TimeoutSweepPkScript,
 		ExpirySweepTxid:       expirySweepTxid,
+		SwapHash:              swapHash,
 		FinalizedWithdrawalTx: finalizedWithdrawalTx,
 	}, nil
 }

staticaddr/deposit/sql_store.go

@@ -0,0 +1,79 @@
+package deposit
+
+import (
+	"testing"
+
+	"github.com/btcsuite/btcd/wire"
+	"github.com/lightninglabs/loop/fsm"
+	"github.com/lightninglabs/loop/loopdb/sqlc"
+	"github.com/lightningnetwork/lnd/lntypes"
+	"github.com/stretchr/testify/require"
+)
+
+func TestToDeposit(t *testing.T) {
+	depositID, err := GetRandomDepositID()
+	require.NoError(t, err)
+
+	swapHash, err := lntypes.MakeHash(dummyTxHashBytes())
+	require.NoError(t, err)
+
+	tx := wire.NewMsgTx(2)
+	txHash := tx.TxHash()
+
+	tests := []struct {
+		name       string
+		row        sqlc.Deposit
+		lastUpdate sqlc.DepositUpdate
+		expectErr  bool
+	}{
+		{
+			name: "fully valid data",
+			row: sqlc.Deposit{
+				DepositID:          depositID[:],
+				TxHash:             txHash[:],
+				Amount:             100000000,
+				ConfirmationHeight: 123456,
+				SwapHash:           swapHash[:],
+			},
+			lastUpdate: sqlc.DepositUpdate{
+				UpdateState: "completed",
+			},
+			expectErr: false,
+		},
+		{
+			name: "fully valid data",
+			row: sqlc.Deposit{
+				DepositID:          depositID[:],
+				TxHash:             txHash[:],
+				Amount:             100000000,
+				ConfirmationHeight: 123456,
+			},
+			lastUpdate: sqlc.DepositUpdate{
+				UpdateState: "completed",
+			},
+			expectErr: false,
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			result, err := ToDeposit(test.row, test.lastUpdate)
+			if test.expectErr {
+				require.Error(t, err)
+				require.Nil(t, result)
+			} else {
+				require.NoError(t, err)
+				require.NotNil(t, result)
+				require.Equal(t, fsm.StateType(test.lastUpdate.UpdateState), result.state)
+				require.NotNil(t, result.SwapHash)
+			}
+		})
+	}
+}
+
+func dummyTxHashBytes() []byte {
+	return []byte{0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b,
+		0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15,
+		0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
+		0x20, 0x21, 0x22, 0x23}
+}