assets+loopdb: implement functionality to list asset deposits

This commit adds the necessary changes to the asset deposit
manager, the underlying sql store and the asset deposit
subserver to be able to list asset deposits.

Author: bhandras

assets/deposit/manager.go

@@ -703,3 +703,40 @@ func (m *Manager) markDepositConfirmed(ctx context.Context, d *Deposit,
 
 	return nil
 }
+
+// ListDeposits returns all deposits that are in the given range of
+// confirmations.
+func (m *Manager) ListDeposits(ctx context.Context, minConfs, maxConfs uint32) (
+	[]Deposit, error) {
+
+	bestBlock, err := m.GetBestBlock()
+	if err != nil {
+		return nil, err
+	}
+
+	deposits, err := m.store.GetAllDeposits(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	// Only filter based on confirmations if the user has set a min or max
+	// confs.
+	filterConfs := minConfs != 0 || maxConfs != 0
+
+	// Prefilter deposits based on the min/max confs.
+	filteredDeposits := make([]Deposit, 0, len(deposits))
+	for _, deposit := range deposits {
+		if filterConfs {
+			// Check that the deposit suits our min/max confs
+			// criteria.
+			confs := bestBlock - deposit.ConfirmationHeight
+			if confs < minConfs || confs > maxConfs {
+				continue
+			}
+		}
+
+		filteredDeposits = append(filteredDeposits, deposit)
+	}
+
+	return filteredDeposits, nil
+}

assets/deposit/manager_test.go

@@ -35,6 +35,11 @@ func (s *mockStore) UpdateDeposit(context.Context, *Deposit) error {
 	return nil
 }
 
+// GetAllDeposits is a mock implementation of the GetAllDeposits method.
+func (s *mockStore) GetAllDeposits(context.Context) ([]Deposit, error) {
+	return []Deposit{}, nil
+}
+
 // testAddDeposit is a helper function that (intrusively) adds a deposit to the
 // manager.
 func testAddDeposit(t *testing.T, m *Manager, d *Deposit) {

assets/deposit/server.go

@@ -83,7 +83,55 @@ func (s *Server) ListAssetDeposits(ctx context.Context,
 	in *looprpc.ListAssetDepositsRequest) (
 	*looprpc.ListAssetDepositsResponse, error) {
 
-	return nil, status.Error(codes.Unimplemented, "unimplemented")
+	if s.manager == nil {
+		return nil, ErrAssetDepositsUnavailable
+	}
+
+	if in.MinConfs < in.MaxConfs {
+		return nil, status.Error(codes.InvalidArgument,
+			"max_confs must be greater than or equal to min_confs")
+	}
+
+	deposits, err := s.manager.ListDeposits(ctx, in.MinConfs, in.MaxConfs)
+	if err != nil {
+		return nil, status.Error(codes.Internal, err.Error())
+	}
+
+	filteredDeposits := make([]*looprpc.AssetDeposit, 0, len(deposits))
+	for _, d := range deposits {
+		rpcDeposit := &looprpc.AssetDeposit{
+			DepositId:          d.ID,
+			CreatedAt:          d.CreatedAt.Unix(),
+			AssetId:            d.AssetID.String(),
+			Amount:             d.Amount,
+			DepositAddr:        d.Addr,
+			State:              d.State.String(),
+			ConfirmationHeight: d.ConfirmationHeight,
+			Expiry:             d.ConfirmationHeight + d.CsvExpiry,
+		}
+
+		if d.Outpoint != nil {
+			rpcDeposit.AnchorOutpoint = d.Outpoint.String()
+		}
+
+		if d.SweepScriptKey != nil {
+			rpcDeposit.SweepScriptKey = hex.EncodeToString(
+				d.SweepScriptKey.SerializeCompressed(),
+			)
+		}
+
+		if d.SweepInternalKey != nil {
+			rpcDeposit.SweepInternalKey = hex.EncodeToString(
+				d.SweepInternalKey.SerializeCompressed(),
+			)
+		}
+
+		filteredDeposits = append(filteredDeposits, rpcDeposit)
+	}
+
+	return &looprpc.ListAssetDepositsResponse{
+		FilteredDeposits: filteredDeposits,
+	}, nil
 }
 
 // RevealAssetDepositKey is the rpc endpoint for loop clients to reveal the

assets/deposit/sql_store.go

@@ -3,12 +3,17 @@ package deposit
 import (
 	"context"
 	"database/sql"
+	"fmt"
 
+	"github.com/btcsuite/btcd/btcec/v2"
 	"github.com/btcsuite/btcd/chaincfg"
+	"github.com/btcsuite/btcd/wire"
 	"github.com/lightninglabs/loop/loopdb"
 	"github.com/lightninglabs/loop/loopdb/sqlc"
 	"github.com/lightninglabs/taproot-assets/address"
+	"github.com/lightninglabs/taproot-assets/asset"
 	"github.com/lightningnetwork/lnd/clock"
+	"github.com/lightningnetwork/lnd/keychain"
 )
 
 // Querier is a subset of the methods we need from the postgres.querier
@@ -21,6 +26,9 @@ type Querier interface {
 
 	MarkDepositConfirmed(ctx context.Context,
 		arg sqlc.MarkDepositConfirmedParams) error
+
+	GetAssetDeposits(ctx context.Context) ([]sqlc.GetAssetDepositsRow,
+		error)
 }
 
 // DepositBaseDB is the interface that contains all the queries generated
@@ -130,3 +138,132 @@ func (s *SQLStore) UpdateDeposit(ctx context.Context, d *Deposit) error {
 		)
 	})
 }
+
+// GetAllDeposits returns all deposits known to the store.
+func (s *SQLStore) GetAllDeposits(ctx context.Context) ([]Deposit, error) {
+	sqlDeposits, err := s.db.GetAssetDeposits(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	deposits := make([]Deposit, 0, len(sqlDeposits))
+	for _, sqlDeposit := range sqlDeposits {
+		deposit, err := sqlcDepositToDeposit(
+			sqlDeposit, &s.addressParams,
+		)
+		if err != nil {
+			return nil, err
+		}
+
+		deposits = append(deposits, deposit)
+	}
+
+	return deposits, nil
+}
+
+func sqlcDepositToDeposit(sqlDeposit sqlc.GetAssetDepositsRow,
+	addressParams *address.ChainParams) (Deposit, error) {
+
+	clientScriptPubKey, err := btcec.ParsePubKey(
+		sqlDeposit.ClientScriptPubkey,
+	)
+	if err != nil {
+		return Deposit{}, err
+	}
+
+	serverScriptPubKey, err := btcec.ParsePubKey(
+		sqlDeposit.ServerScriptPubkey,
+	)
+	if err != nil {
+		return Deposit{}, err
+	}
+
+	clientInteralPubKey, err := btcec.ParsePubKey(
+		sqlDeposit.ClientInternalPubkey,
+	)
+	if err != nil {
+		return Deposit{}, err
+	}
+
+	serverInternalPubKey, err := btcec.ParsePubKey(
+		sqlDeposit.ServerInternalPubkey,
+	)
+	if err != nil {
+		return Deposit{}, err
+	}
+
+	clientKeyLocator := keychain.KeyLocator{
+		Family: keychain.KeyFamily(
+			sqlDeposit.ClientKeyFamily,
+		),
+		Index: uint32(sqlDeposit.ClientKeyIndex),
+	}
+
+	if len(sqlDeposit.AssetID) != len(asset.ID{}) {
+		return Deposit{}, fmt.Errorf("malformed asset ID for deposit: "+
+			"%v", sqlDeposit.DepositID)
+	}
+
+	depositInfo := &Info{
+		ID: sqlDeposit.DepositID,
+		Version: AssetDepositProtocolVersion(
+			sqlDeposit.ProtocolVersion,
+		),
+		CreatedAt: sqlDeposit.CreatedAt.Local(), //nolint:gosmopolitan
+		Amount:    uint64(sqlDeposit.Amount),
+		Addr:      sqlDeposit.Addr,
+		State:     State(sqlDeposit.UpdateState),
+	}
+
+	if sqlDeposit.ConfirmationHeight.Valid {
+		depositInfo.ConfirmationHeight = uint32(
+			sqlDeposit.ConfirmationHeight.Int32,
+		)
+	}
+
+	if sqlDeposit.Outpoint.Valid {
+		outpoint, err := wire.NewOutPointFromString(
+			sqlDeposit.Outpoint.String,
+		)
+		if err != nil {
+			return Deposit{}, err
+		}
+
+		depositInfo.Outpoint = outpoint
+	}
+
+	if len(sqlDeposit.SweepInternalPubkey) > 0 {
+		sweepInternalPubKey, err := btcec.ParsePubKey(
+			sqlDeposit.SweepInternalPubkey,
+		)
+		if err != nil {
+			return Deposit{}, err
+		}
+		depositInfo.SweepInternalKey = sweepInternalPubKey
+	}
+
+	if len(sqlDeposit.SweepScriptPubkey) > 0 {
+		sweepScriptPubKey, err := btcec.ParsePubKey(
+			sqlDeposit.SweepScriptPubkey,
+		)
+		if err != nil {
+			return Deposit{}, err
+		}
+		depositInfo.SweepScriptKey = sweepScriptPubKey
+	}
+
+	kit, err := NewKit(
+		clientScriptPubKey, clientInteralPubKey, serverScriptPubKey,
+		serverInternalPubKey, clientKeyLocator,
+		asset.ID(sqlDeposit.AssetID), uint32(sqlDeposit.Expiry),
+		addressParams,
+	)
+	if err != nil {
+		return Deposit{}, err
+	}
+
+	return Deposit{
+		Kit:  kit,
+		Info: depositInfo,
+	}, nil
+}

assets/deposit/store.go

@@ -10,4 +10,7 @@ type Store interface {
 	// UpdateDeposit updates the deposit state and extends the deposit
 	// update log in the SQL store.
 	UpdateDeposit(ctx context.Context, d *Deposit) error
+
+	// GetAllDeposits returns all deposits known to the store.
+	GetAllDeposits(ctx context.Context) ([]Deposit, error)
 }

loopdb/sqlc/asset_deposits.sql.go

@@ -27,3 +27,15 @@ INSERT INTO asset_deposit_updates (
 UPDATE asset_deposits 
 SET confirmation_height = $2, outpoint = $3, pk_script = $4
 WHERE deposit_id = $1;
+
+-- name: GetAssetDeposits :many
+SELECT d.*, u.update_state, u.update_timestamp
+FROM asset_deposits d
+JOIN asset_deposit_updates u ON u.id = (
+    SELECT id
+    FROM asset_deposit_updates
+    WHERE deposit_id = d.deposit_id
+    ORDER BY update_timestamp DESC
+    LIMIT 1
+)
+ORDER BY d.created_at ASC;