staticaddr: interfaces

Author: hieblmi

staticaddr/interface.go renamed to staticaddr/address/interface.go

@@ -1,39 +1,38 @@
-package staticaddr
+package address
 
 import (
 	"context"
 	"fmt"
 
 	"github.com/btcsuite/btcd/btcec/v2"
+	"github.com/lightninglabs/loop/staticaddr"
 	"github.com/lightningnetwork/lnd/keychain"
 )
 
 var (
 	ErrAddressAlreadyExists = fmt.Errorf("address already exists")
-	ErrAddressNotFound      = fmt.Errorf("address not found")
 )
 
-// AddressStore is the database interface that is used to store and retrieve
+// Store is the database interface that is used to store and retrieve
 // static addresses.
-type AddressStore interface {
+type Store interface {
 	// CreateStaticAddress inserts a new static address with its parameters
 	// into the store.
-	CreateStaticAddress(ctx context.Context,
-		addrParams *AddressParameters) error
+	CreateStaticAddress(ctx context.Context, addrParams *Parameters) error
 
 	// GetStaticAddress fetches static address parameters for a given
 	// address ID.
-	GetStaticAddress(ctx context.Context,
-		pkScript []byte) (*AddressParameters, error)
+	GetStaticAddress(ctx context.Context, pkScript []byte) (*Parameters,
+		error)
 
 	// GetAllStaticAddresses retrieves all static addresses from the store.
-	GetAllStaticAddresses(ctx context.Context) (
-		[]*AddressParameters, error)
+	GetAllStaticAddresses(ctx context.Context) ([]*Parameters,
+		error)
 }
 
-// AddressParameters holds all the necessary information for the 2-of-2 multisig
+// Parameters holds all the necessary information for the 2-of-2 multisig
 // address.
-type AddressParameters struct {
+type Parameters struct {
 	// ClientPubkey is the client's pubkey for the static address. It is
 	// used for the 2-of-2 funding output as well as for the client's
 	// timeout path.
@@ -54,5 +53,5 @@ type AddressParameters struct {
 	KeyLocator keychain.KeyLocator
 
 	// ProtocolVersion is the protocol version of the static address.
-	ProtocolVersion AddressProtocolVersion
+	ProtocolVersion staticaddr.AddressProtocolVersion
 }

staticaddr/sql_store.go renamed to staticaddr/address/sql_store.go

@@ -1,13 +1,12 @@
-package staticaddr
+package address
 
 import (
 	"context"
-	"errors"
 
 	"github.com/btcsuite/btcd/btcec/v2"
-	"github.com/jackc/pgx/v4"
 	"github.com/lightninglabs/loop/loopdb"
 	"github.com/lightninglabs/loop/loopdb/sqlc"
+	"github.com/lightninglabs/loop/staticaddr"
 	"github.com/lightningnetwork/lnd/keychain"
 )
 
@@ -24,46 +23,9 @@ func NewSqlStore(db *loopdb.BaseDB) *SqlStore {
 	}
 }
 
-// ExecTx is a wrapper for txBody to abstract the creation and commit of a db
-// transaction. The db transaction is embedded in a `*sqlc.Queries` that txBody
-// needs to use when executing each one of the queries that need to be applied
-// atomically.
-func (s *SqlStore) ExecTx(ctx context.Context, txOptions loopdb.TxOptions,
-	txBody func(queries *sqlc.Queries) error) error {
-
-	// Create the db transaction.
-	tx, err := s.baseDB.BeginTx(ctx, txOptions)
-	if err != nil {
-		return err
-	}
-
-	// Rollback is safe to call even if the tx is already closed, so if the
-	// tx commits successfully, this is a no-op.
-	defer func() {
-		err := tx.Rollback()
-		switch {
-		// If the tx was already closed (it was successfully executed)
-		// we do not need to log that error.
-		case errors.Is(err, pgx.ErrTxClosed):
-			return
-
-		// If this is an unexpected error, log it.
-		case err != nil:
-			log.Errorf("unable to rollback db tx: %v", err)
-		}
-	}()
-
-	if err := txBody(s.baseDB.Queries.WithTx(tx)); err != nil {
-		return err
-	}
-
-	// Commit transaction.
-	return tx.Commit()
-}
-
 // CreateStaticAddress creates a static address record in the database.
 func (s *SqlStore) CreateStaticAddress(ctx context.Context,
-	addrParams *AddressParameters) error {
+	addrParams *Parameters) error {
 
 	createArgs := sqlc.CreateStaticAddressParams{
 		ClientPubkey:    addrParams.ClientPubkey.SerializeCompressed(),
@@ -80,7 +42,7 @@ func (s *SqlStore) CreateStaticAddress(ctx context.Context,
 
 // GetStaticAddress retrieves static address parameters for a given pkScript.
 func (s *SqlStore) GetStaticAddress(ctx context.Context,
-	pkScript []byte) (*AddressParameters, error) {
+	pkScript []byte) (*Parameters, error) {
 
 	staticAddress, err := s.baseDB.Queries.GetStaticAddress(ctx, pkScript)
 	if err != nil {
@@ -91,15 +53,15 @@ func (s *SqlStore) GetStaticAddress(ctx context.Context,
 }
 
 // GetAllStaticAddresses returns all address known to the server.
-func (s *SqlStore) GetAllStaticAddresses(ctx context.Context) (
-	[]*AddressParameters, error) {
+func (s *SqlStore) GetAllStaticAddresses(ctx context.Context) ([]*Parameters,
+	error) {
 
 	staticAddresses, err := s.baseDB.Queries.AllStaticAddresses(ctx)
 	if err != nil {
 		return nil, err
 	}
 
-	var result []*AddressParameters
+	var result []*Parameters
 	for _, address := range staticAddresses {
 		res, err := s.toAddressParameters(address)
 		if err != nil {
@@ -120,7 +82,7 @@ func (s *SqlStore) Close() {
 // toAddressParameters transforms a database representation of a static address
 // to an AddressParameters struct.
 func (s *SqlStore) toAddressParameters(row sqlc.StaticAddress) (
-	*AddressParameters, error) {
+	*Parameters, error) {
 
 	clientPubkey, err := btcec.ParsePubKey(row.ClientPubkey)
 	if err != nil {
@@ -132,7 +94,7 @@ func (s *SqlStore) toAddressParameters(row sqlc.StaticAddress) (
 		return nil, err
 	}
 
-	return &AddressParameters{
+	return &Parameters{
 		ClientPubkey: clientPubkey,
 		ServerPubkey: serverPubkey,
 		PkScript:     row.Pkscript,
@@ -141,6 +103,6 @@ func (s *SqlStore) toAddressParameters(row sqlc.StaticAddress) (
 			Family: keychain.KeyFamily(row.ClientKeyFamily),
 			Index:  uint32(row.ClientKeyIndex),
 		},
-		ProtocolVersion: AddressProtocolVersion(row.ProtocolVersion),
+		ProtocolVersion: staticaddr.AddressProtocolVersion(row.ProtocolVersion),
 	}, nil
 }

staticaddr/deposit/interface.go

@@ -0,0 +1,44 @@
+package deposit
+
+import (
+	"context"
+
+	"github.com/lightninglabs/loop/staticaddr/address"
+	"github.com/lightninglabs/loop/staticaddr/script"
+	"github.com/lightningnetwork/lnd/lnwallet"
+)
+
+const (
+	IdLength = 32
+)
+
+// Store is the database interface that is used to store and retrieve
+// static address deposits.
+type Store interface {
+	// CreateDeposit inserts a new deposit into the store.
+	CreateDeposit(ctx context.Context, deposit *Deposit) error
+
+	// UpdateDeposit updates the deposit in the database.
+	UpdateDeposit(ctx context.Context, deposit *Deposit) error
+
+	// GetDeposit retrieves a deposit with depositID from the database.
+	GetDeposit(ctx context.Context, depositID ID) (*Deposit, error)
+
+	// AllDeposits retrieves all deposits from the store.
+	AllDeposits(ctx context.Context) ([]*Deposit, error)
+}
+
+// AddressManager handles fetching of address parameters.
+type AddressManager interface {
+	// GetStaticAddressParameters returns the static address parameters.
+	GetStaticAddressParameters(ctx context.Context) (*address.Parameters,
+		error)
+
+	// GetStaticAddress returns the deposit address for the given
+	// client and server public keys.
+	GetStaticAddress(ctx context.Context) (*script.StaticAddress, error)
+
+	// ListUnspent returns a list of utxos at the static address.
+	ListUnspent(ctx context.Context, minConfs,
+		maxConfs int32) ([]*lnwallet.Utxo, error)
+}