Merge pull request lightninglabs#1133 from 0xfandom/refactor/1056-move-parameters-to-script

staticaddr: move address.Parameters to script package

Author: hieblmi

loopd/swapclient_server_test.go

@@ -19,6 +19,7 @@ import (
 	"github.com/lightninglabs/loop/looprpc"
 	"github.com/lightninglabs/loop/staticaddr/address"
 	"github.com/lightninglabs/loop/staticaddr/deposit"
+	"github.com/lightninglabs/loop/staticaddr/script"
 	"github.com/lightninglabs/loop/swap"
 	mock_lnd "github.com/lightninglabs/loop/test"
 	"github.com/lightningnetwork/lnd/lntypes"
@@ -947,18 +948,18 @@ func TestListSwapsFilterAndPagination(t *testing.T) {
 
 // mockAddressStore is a minimal in-memory store for address parameters.
 type mockAddressStore struct {
-	params []*address.Parameters
+	params []*script.Parameters
 }
 
 func (s *mockAddressStore) CreateStaticAddress(_ context.Context,
-	p *address.Parameters) error {
+	p *script.Parameters) error {
 
 	s.params = append(s.params, p)
 	return nil
 }
 
 func (s *mockAddressStore) GetStaticAddress(_ context.Context, _ []byte) (
-	*address.Parameters, error) {
+	*script.Parameters, error) {
 
 	if len(s.params) == 0 {
 		return nil, nil
@@ -968,7 +969,7 @@ func (s *mockAddressStore) GetStaticAddress(_ context.Context, _ []byte) (
 }
 
 func (s *mockAddressStore) GetAllStaticAddresses(_ context.Context) (
-	[]*address.Parameters, error) {
+	[]*script.Parameters, error) {
 
 	return s.params, nil
 }
@@ -1019,14 +1020,14 @@ func TestListUnspentDeposits(t *testing.T) {
 	_, client := mock_lnd.CreateKey(1)
 	_, server := mock_lnd.CreateKey(2)
 	pkScript := []byte("pkscript")
-	addrParams := &address.Parameters{
+	addrParams := &script.Parameters{
 		ClientPubkey: client,
 		ServerPubkey: server,
 		Expiry:       10,
 		PkScript:     pkScript,
 	}
 
-	addrStore := &mockAddressStore{params: []*address.Parameters{addrParams}}
+	addrStore := &mockAddressStore{params: []*script.Parameters{addrParams}}
 
 	// Build an address manager using our mock lnd and fake address store.
 	addrMgr, err := address.NewManager(&address.ManagerConfig{

staticaddr/address/interface.go

@@ -3,48 +3,18 @@ package address
 import (
 	"context"
 
-	"github.com/btcsuite/btcd/btcec/v2"
-	"github.com/lightninglabs/loop/staticaddr/version"
-	"github.com/lightningnetwork/lnd/keychain"
+	"github.com/lightninglabs/loop/staticaddr/script"
 )
 
 // Store is the database interface that is used to store and retrieve
 // static addresses.
 type Store interface {
 	// CreateStaticAddress inserts a new static address with its parameters
 	// into the store.
-	CreateStaticAddress(ctx context.Context, addrParams *Parameters) error
+	CreateStaticAddress(ctx context.Context,
+		addrParams *script.Parameters) error
 
 	// GetAllStaticAddresses retrieves all static addresses from the store.
-	GetAllStaticAddresses(ctx context.Context) ([]*Parameters,
+	GetAllStaticAddresses(ctx context.Context) ([]*script.Parameters,
 		error)
 }
-
-// Parameters holds all the necessary information for the 2-of-2 multisig
-// address.
-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.
-	ClientPubkey *btcec.PublicKey
-
-	// ServerPubkey is the server's pubkey for the static address. It is
-	// used for the 2-of-2 funding output.
-	ServerPubkey *btcec.PublicKey
-
-	// Expiry is the CSV timout value at which the client can claim the
-	// static address's timout path.
-	Expiry uint32
-
-	// PkScript is the unique static address's output script.
-	PkScript []byte
-
-	// KeyLocator is the locator of the client's key.
-	KeyLocator keychain.KeyLocator
-
-	// ProtocolVersion is the protocol version of the static address.
-	ProtocolVersion version.AddressProtocolVersion
-
-	// InitiationHeight is the height at which the address was initiated.
-	InitiationHeight int32
-}

staticaddr/address/manager.go

@@ -195,7 +195,7 @@ func (m *Manager) NewAddress(ctx context.Context) (*btcutil.AddressTaproot,
 
 	// Create the static address from the parameters the server provided and
 	// store all parameters in the database.
-	addrParams := &Parameters{
+	addrParams := &script.Parameters{
 		ClientPubkey: clientPubKey.PubKey,
 		ServerPubkey: serverPubKey,
 		PkScript:     pkScript,
@@ -338,8 +338,8 @@ func (m *Manager) ListUnspentRaw(ctx context.Context, minConfs,
 }
 
 // GetStaticAddressParameters returns the parameters of the static address.
-func (m *Manager) GetStaticAddressParameters(ctx context.Context) (*Parameters,
-	error) {
+func (m *Manager) GetStaticAddressParameters(ctx context.Context) (
+	*script.Parameters, error) {
 
 	params, err := m.cfg.Store.GetAllStaticAddresses(ctx)
 	if err != nil {

staticaddr/address/sql_store.go

@@ -6,6 +6,7 @@ import (
 	"github.com/btcsuite/btcd/btcec/v2"
 	"github.com/lightninglabs/loop/loopdb"
 	"github.com/lightninglabs/loop/loopdb/sqlc"
+	"github.com/lightninglabs/loop/staticaddr/script"
 	"github.com/lightninglabs/loop/staticaddr/version"
 	"github.com/lightningnetwork/lnd/keychain"
 )
@@ -25,7 +26,7 @@ func NewSqlStore(db *loopdb.BaseDB) *SqlStore {
 
 // CreateStaticAddress creates a static address record in the database.
 func (s *SqlStore) CreateStaticAddress(ctx context.Context,
-	addrParams *Parameters) error {
+	addrParams *script.Parameters) error {
 
 	createArgs := sqlc.CreateStaticAddressParams{
 		ClientPubkey:     addrParams.ClientPubkey.SerializeCompressed(),
@@ -42,15 +43,15 @@ func (s *SqlStore) CreateStaticAddress(ctx context.Context,
 }
 
 // GetAllStaticAddresses returns all address known to the server.
-func (s *SqlStore) GetAllStaticAddresses(ctx context.Context) ([]*Parameters,
-	error) {
+func (s *SqlStore) GetAllStaticAddresses(ctx context.Context) (
+	[]*script.Parameters, error) {
 
 	staticAddresses, err := s.baseDB.Queries.AllStaticAddresses(ctx)
 	if err != nil {
 		return nil, err
 	}
 
-	var result []*Parameters
+	var result []*script.Parameters
 	for _, address := range staticAddresses {
 		res, err := s.toAddressParameters(address)
 		if err != nil {
@@ -66,7 +67,7 @@ func (s *SqlStore) GetAllStaticAddresses(ctx context.Context) ([]*Parameters,
 // toAddressParameters transforms a database representation of a static address
 // to an AddressParameters struct.
 func (s *SqlStore) toAddressParameters(row sqlc.StaticAddress) (
-	*Parameters, error) {
+	*script.Parameters, error) {
 
 	clientPubkey, err := btcec.ParsePubKey(row.ClientPubkey)
 	if err != nil {
@@ -78,7 +79,7 @@ func (s *SqlStore) toAddressParameters(row sqlc.StaticAddress) (
 		return nil, err
 	}
 
-	return &Parameters{
+	return &script.Parameters{
 		ClientPubkey: clientPubkey,
 		ServerPubkey: serverPubkey,
 		PkScript:     row.Pkscript,

staticaddr/deposit/fsm.go

@@ -9,7 +9,6 @@ import (
 	"github.com/btcsuite/btcd/wire"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightninglabs/loop/fsm"
-	"github.com/lightninglabs/loop/staticaddr/address"
 	"github.com/lightninglabs/loop/staticaddr/script"
 	"github.com/lightninglabs/loop/staticaddr/version"
 	"github.com/lightningnetwork/lnd/input"
@@ -155,7 +154,7 @@ type FSM struct {
 
 	deposit *Deposit
 
-	params *address.Parameters
+	params *script.Parameters
 
 	address *script.StaticAddress
 

staticaddr/deposit/interface.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/btcsuite/btcd/btcec/v2"
 	"github.com/btcsuite/btcd/btcutil"
-	"github.com/lightninglabs/loop/staticaddr/address"
 	"github.com/lightninglabs/loop/staticaddr/script"
 	"github.com/lightningnetwork/lnd/lnwallet"
 )
@@ -37,7 +36,7 @@ type Store interface {
 // AddressManager handles fetching of address parameters.
 type AddressManager interface {
 	// GetStaticAddressParameters returns the static address parameters.
-	GetStaticAddressParameters(ctx context.Context) (*address.Parameters,
+	GetStaticAddressParameters(ctx context.Context) (*script.Parameters,
 		error)
 
 	// GetStaticAddress returns the deposit address for the given

staticaddr/deposit/manager_test.go

@@ -11,7 +11,6 @@ import (
 	"github.com/btcsuite/btcd/chaincfg/chainhash"
 	"github.com/btcsuite/btcd/wire"
 	"github.com/lightninglabs/lndclient"
-	"github.com/lightninglabs/loop/staticaddr/address"
 	"github.com/lightninglabs/loop/staticaddr/script"
 	"github.com/lightninglabs/loop/swap"
 	"github.com/lightninglabs/loop/swapserverrpc"
@@ -109,11 +108,11 @@ type mockAddressManager struct {
 }
 
 func (m *mockAddressManager) GetStaticAddressParameters(ctx context.Context) (
-	*address.Parameters, error) {
+	*script.Parameters, error) {
 
 	args := m.Called(ctx)
 
-	return args.Get(0).(*address.Parameters),
+	return args.Get(0).(*script.Parameters),
 		args.Error(1)
 }
 
@@ -365,7 +364,7 @@ func newManagerTestContext(t *testing.T) *ManagerTestContext {
 
 	mockAddressManager.On(
 		"GetStaticAddressParameters", mock.Anything,
-	).Return(&address.Parameters{
+	).Return(&script.Parameters{
 		Expiry: defaultExpiry,
 	}, nil)
 

staticaddr/loopin/actions_test.go

@@ -11,7 +11,6 @@ import (
 	"github.com/btcsuite/btcd/wire"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightninglabs/loop/fsm"
-	"github.com/lightninglabs/loop/staticaddr/address"
 	"github.com/lightninglabs/loop/staticaddr/deposit"
 	"github.com/lightninglabs/loop/staticaddr/script"
 	"github.com/lightninglabs/loop/staticaddr/version"
@@ -62,7 +61,7 @@ func TestMonitorInvoiceAndHtlcTxReRegistersOnConfErr(t *testing.T) {
 
 	cfg := &Config{
 		AddressManager: &mockAddressManager{
-			params: &address.Parameters{
+			params: &script.Parameters{
 				ClientPubkey:    clientKey.PubKey(),
 				ServerPubkey:    serverKey.PubKey(),
 				ProtocolVersion: version.ProtocolVersion_V0,
@@ -274,12 +273,12 @@ func testValidateLoopInContract(_ int32, _ int32) error {
 // mockAddressManager is a minimal AddressManager implementation used by the
 // test FSM setup.
 type mockAddressManager struct {
-	params *address.Parameters
+	params *script.Parameters
 }
 
 // GetStaticAddressParameters returns the configured address parameters.
 func (m *mockAddressManager) GetStaticAddressParameters(_ context.Context) (
-	*address.Parameters, error) {
+	*script.Parameters, error) {
 
 	return m.params, nil
 }

staticaddr/loopin/interface.go

@@ -6,7 +6,6 @@ import (
 	"github.com/btcsuite/btcd/btcutil"
 	"github.com/lightninglabs/loop"
 	"github.com/lightninglabs/loop/fsm"
-	"github.com/lightninglabs/loop/staticaddr/address"
 	"github.com/lightninglabs/loop/staticaddr/deposit"
 	"github.com/lightninglabs/loop/staticaddr/script"
 	"github.com/lightninglabs/loop/swapserverrpc"
@@ -35,7 +34,7 @@ type (
 // AddressManager handles fetching of address parameters.
 type AddressManager interface {
 	// GetStaticAddressParameters returns the static address parameters.
-	GetStaticAddressParameters(ctx context.Context) (*address.Parameters,
+	GetStaticAddressParameters(ctx context.Context) (*script.Parameters,
 		error)
 
 	// GetStaticAddress returns the deposit address for the given client and

staticaddr/loopin/loopin.go

@@ -18,7 +18,6 @@ import (
 	"github.com/btcsuite/btcd/wire"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightninglabs/loop/fsm"
-	"github.com/lightninglabs/loop/staticaddr/address"
 	"github.com/lightninglabs/loop/staticaddr/deposit"
 	"github.com/lightninglabs/loop/staticaddr/script"
 	"github.com/lightninglabs/loop/staticaddr/staticutil"
@@ -134,7 +133,7 @@ type StaticAddressLoopIn struct {
 
 	// AddressParams are the parameters of the address that is used for the
 	// swap.
-	AddressParams *address.Parameters
+	AddressParams *script.Parameters
 
 	// Address is the address script that is used for the swap.
 	Address *script.StaticAddress