multi: turn coin selection type into script key filter

Author: guggero

rpcserver.go

@@ -1060,9 +1060,8 @@ func (r *rpcServer) ListAssets(ctx context.Context,
 	}
 
 	constraints := tapfreighter.CommitmentConstraints{
-		MinAmt:         req.MinAmount,
-		MaxAmt:         req.MaxAmount,
-		CoinSelectType: tapsend.DefaultCoinSelectType,
+		MinAmt: req.MinAmount,
+		MaxAmt: req.MaxAmount,
 	}
 
 	if len(req.GroupKey) > 0 {
@@ -2203,7 +2202,7 @@ func (r *rpcServer) FundVirtualPsbt(ctx context.Context,
 	req *wrpc.FundVirtualPsbtRequest) (*wrpc.FundVirtualPsbtResponse,
 	error) {
 
-	coinSelectType, err := unmarshalCoinSelectType(req.CoinSelectType)
+	scriptKeyType, err := unmarshalCoinSelectType(req.CoinSelectType)
 	if err != nil {
 		return nil, fmt.Errorf("error parsing coin select type: %w",
 			err)
@@ -2230,7 +2229,7 @@ func (r *rpcServer) FundVirtualPsbt(ctx context.Context,
 				"recipients: %w", err)
 		}
 
-		desc.CoinSelectType = coinSelectType
+		desc.ScriptKeyType = scriptKeyType
 		fundedVPkt, err = r.cfg.AssetWallet.FundPacket(ctx, desc, vPkt)
 		if err != nil {
 			return nil, fmt.Errorf("error funding packet: %w", err)
@@ -2300,7 +2299,7 @@ func (r *rpcServer) FundVirtualPsbt(ctx context.Context,
 		}
 
 		fundedVPkt, err = r.cfg.AssetWallet.FundAddressSend(
-			ctx, coinSelectType, prevIDs, addr,
+			ctx, scriptKeyType, prevIDs, addr,
 		)
 		if err != nil {
 			return nil, fmt.Errorf("error funding address send: "+
@@ -2349,23 +2348,24 @@ func (r *rpcServer) FundVirtualPsbt(ctx context.Context,
 	return response, nil
 }
 
-// unmarshalCoinSelectType converts an RPC select type into a native one.
+// unmarshalCoinSelectType converts an RPC select type into a script key type
+// that can be used to select the appropriate inputs.
 func unmarshalCoinSelectType(
-	coinSelectType wrpc.CoinSelectType) (tapsend.CoinSelectType, error) {
+	coinSelectType wrpc.CoinSelectType) (fn.Option[asset.ScriptKeyType],
+	error) {
 
 	switch coinSelectType {
-	case wrpc.CoinSelectType_COIN_SELECT_DEFAULT:
-		return tapsend.DefaultCoinSelectType, nil
+	case wrpc.CoinSelectType_COIN_SELECT_DEFAULT,
+		wrpc.CoinSelectType_COIN_SELECT_SCRIPT_TREES_ALLOWED:
 
-	case wrpc.CoinSelectType_COIN_SELECT_BIP86_ONLY:
-		return tapsend.Bip86Only, nil
+		return fn.None[asset.ScriptKeyType](), nil
 
-	case wrpc.CoinSelectType_COIN_SELECT_SCRIPT_TREES_ALLOWED:
-		return tapsend.ScriptTreesAllowed, nil
+	case wrpc.CoinSelectType_COIN_SELECT_BIP86_ONLY:
+		return fn.Some(asset.ScriptKeyBip86), nil
 
 	default:
-		return 0, fmt.Errorf("unknown coin select type: %d",
-			coinSelectType)
+		return fn.None[asset.ScriptKeyType](), fmt.Errorf("unknown "+
+			"coin select type: %d", coinSelectType)
 	}
 }
 

tapdb/assets_store_test.go

@@ -24,7 +24,6 @@ import (
 	"github.com/lightninglabs/taproot-assets/tapdb/sqlc"
 	"github.com/lightninglabs/taproot-assets/tapfreighter"
 	"github.com/lightninglabs/taproot-assets/tapscript"
-	"github.com/lightninglabs/taproot-assets/tapsend"
 	"github.com/lightningnetwork/lnd/input"
 	"github.com/lightningnetwork/lnd/keychain"
 	"github.com/stretchr/testify/require"
@@ -730,12 +729,6 @@ func filterMaxAmt(amt uint64) filterOpt {
 	}
 }
 
-func filterCoinSelectType(typ tapsend.CoinSelectType) filterOpt {
-	return func(f *AssetQueryFilters) {
-		f.CoinSelectType = typ
-	}
-}
-
 func filterDistinctSpecifier() filterOpt {
 	return func(f *AssetQueryFilters) {
 		f.DistinctSpecifier = true
@@ -760,6 +753,12 @@ func filterScriptKey(key *asset.ScriptKey) filterOpt {
 	}
 }
 
+func filterScriptKeyType(keyType asset.ScriptKeyType) filterOpt {
+	return func(f *AssetQueryFilters) {
+		f.ScriptKeyType = fn.Some(keyType)
+	}
+}
+
 // TestFetchAllAssets tests that the different AssetQueryFilters work as
 // expected.
 func TestFetchAllAssets(t *testing.T) {
@@ -889,30 +888,26 @@ func TestFetchAllAssets(t *testing.T) {
 		name: "min amount",
 		filter: makeFilter(
 			filterMinAmt(12),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		numAssets: 2,
 	}, {
 		name: "min amount, include spent",
 		filter: makeFilter(
 			filterMinAmt(12),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		includeSpent: true,
 		numAssets:    4,
 	}, {
 		name: "min amount, include leased",
 		filter: makeFilter(
 			filterMinAmt(12),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		includeLeased: true,
 		numAssets:     5,
 	}, {
 		name: "min amount, include leased, include spent",
 		filter: makeFilter(
 			filterMinAmt(12),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		includeLeased: true,
 		includeSpent:  true,
@@ -921,30 +916,26 @@ func TestFetchAllAssets(t *testing.T) {
 		name: "max amount",
 		filter: makeFilter(
 			filterMaxAmt(100),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		numAssets: 6,
 	}, {
 		name: "max amount, include spent",
 		filter: makeFilter(
 			filterMaxAmt(100),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		includeSpent: true,
 		numAssets:    7,
 	}, {
 		name: "max amount, include leased",
 		filter: makeFilter(
 			filterMaxAmt(100),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		includeLeased: true,
 		numAssets:     8,
 	}, {
 		name: "max amount, include leased, include spent",
 		filter: makeFilter(
 			filterMaxAmt(100),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		includeLeased: true,
 		includeSpent:  true,
@@ -953,44 +944,39 @@ func TestFetchAllAssets(t *testing.T) {
 		name: "default min height, include spent",
 		filter: makeFilter(
 			filterAnchorHeight(500),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		includeSpent: true,
 		numAssets:    8,
 	}, {
 		name: "specific height",
 		filter: makeFilter(
 			filterAnchorHeight(512),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		numAssets: 0,
 	}, {
 		name: "specific height, include spent",
 		filter: makeFilter(
 			filterAnchorHeight(502),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		includeSpent: true,
 		numAssets:    3,
 	}, {
 		name: "script key with tapscript",
 		filter: makeFilter(
 			filterMinAmt(100),
-			filterCoinSelectType(tapsend.Bip86Only),
+			filterScriptKeyType(asset.ScriptKeyBip86),
 		),
 		numAssets: 0,
 	}, {
 		name: "query by script key",
 		filter: makeFilter(
 			filterScriptKey(scriptKeyWithScript),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		numAssets: 1,
 	}, {
 		name: "query by script key, include leased",
 		filter: makeFilter(
 			filterScriptKey(scriptKeyWithScript),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		includeLeased: true,
 		numAssets:     2,
@@ -1022,7 +1008,6 @@ func TestFetchAllAssets(t *testing.T) {
 		name: "query by anchor point",
 		filter: makeFilter(
 			filterAnchorPoint(&assetGen.anchorPoints[0]),
-			filterCoinSelectType(tapsend.ScriptTreesAllowed),
 		),
 		numAssets: 3,
 	}}

tapfreighter/chain_porter.go

@@ -1239,7 +1239,8 @@ func (p *ChainPorter) stateStep(currentPkg sendPackage) (*sendPackage, error) {
 				"address parcel")
 		}
 		fundSendRes, err := p.cfg.AssetWallet.FundAddressSend(
-			ctx, tapsend.Bip86Only, nil, addrParcel.destAddrs...,
+			ctx, fn.Some(asset.ScriptKeyBip86), nil,
+			addrParcel.destAddrs...,
 		)
 		if err != nil {
 			return nil, fmt.Errorf("unable to fund address send: "+

tapfreighter/coin_select.go

@@ -54,7 +54,6 @@ func (s *CoinSelect) SelectCoins(ctx context.Context,
 	listConstraints := CommitmentConstraints{
 		AssetSpecifier:    constraints.AssetSpecifier,
 		MinAmt:            1,
-		CoinSelectType:    constraints.CoinSelectType,
 		ScriptKeyType:     constraints.ScriptKeyType,
 		PrevIDs:           constraints.PrevIDs,
 		DistinctSpecifier: constraints.DistinctSpecifier,

tapfreighter/interface.go

@@ -21,7 +21,6 @@ import (
 	"github.com/lightninglabs/taproot-assets/tapgarden"
 	"github.com/lightninglabs/taproot-assets/tappsbt"
 	"github.com/lightninglabs/taproot-assets/tapscript"
-	"github.com/lightninglabs/taproot-assets/tapsend"
 	"github.com/lightningnetwork/lnd/keychain"
 )
 
@@ -52,9 +51,6 @@ type CommitmentConstraints struct {
 	// PrevIDs are the set of inputs allowed to be used.
 	PrevIDs []asset.PrevID
 
-	// CoinSelectType is the type of coins that should be selected.
-	CoinSelectType tapsend.CoinSelectType
-
 	// DistinctSpecifier indicates whether we _only_ look at either the
 	// group key _or_ the asset ID but not both. That means, if the group
 	// key is set, we ignore the asset ID and allow multiple inputs of the

tapfreighter/wallet.go

@@ -69,7 +69,8 @@ type Wallet interface {
 	// asset re-anchors and the Taproot Asset level commitment of the
 	// selected assets.
 	FundAddressSend(ctx context.Context,
-		coinSelectType tapsend.CoinSelectType, prevIDs []asset.PrevID,
+		scriptKeyType fn.Option[asset.ScriptKeyType],
+		prevIDs []asset.PrevID,
 		receiverAddrs ...*address.Tap) (*FundedVPacket, error)
 
 	// FundPacket funds a virtual transaction, selecting assets to spend
@@ -240,8 +241,7 @@ type FundedVPacket struct {
 //
 // NOTE: This is part of the Wallet interface.
 func (f *AssetWallet) FundAddressSend(ctx context.Context,
-	coinSelectType tapsend.CoinSelectType,
-	prevIDs []asset.PrevID,
+	scriptKeyType fn.Option[asset.ScriptKeyType], prevIDs []asset.PrevID,
 	receiverAddrs ...*address.Tap) (*FundedVPacket, error) {
 
 	// We start by creating a new virtual transaction that will be used to
@@ -264,7 +264,7 @@ func (f *AssetWallet) FundAddressSend(ctx context.Context,
 		fundDesc.PrevIDs = prevIDs
 	}
 
-	fundDesc.CoinSelectType = coinSelectType
+	fundDesc.ScriptKeyType = scriptKeyType
 	fundedVPkt, err := f.FundPacket(ctx, fundDesc, vPkt)
 	if err != nil {
 		return nil, err
@@ -413,7 +413,6 @@ func (f *AssetWallet) FundPacket(ctx context.Context,
 	constraints := CommitmentConstraints{
 		AssetSpecifier:    fundDesc.AssetSpecifier,
 		MinAmt:            fundDesc.Amount,
-		CoinSelectType:    fundDesc.CoinSelectType,
 		ScriptKeyType:     fundDesc.ScriptKeyType,
 		PrevIDs:           fundDesc.PrevIDs,
 		DistinctSpecifier: fundDesc.DistinctSpecifier,

tapsend/send.go

@@ -171,28 +171,6 @@ type AssetGroupQuerier interface {
 	QueryAssetGroup(context.Context, asset.ID) (*asset.AssetGroup, error)
 }
 
-// CoinSelectType is a type that indicates the type of coins that should be
-// selected. This type is defined in the tapsend package to avoid a circular
-// dependency with the freighter package.
-type CoinSelectType uint8
-
-const (
-	// Bip86Only indicates that only coins that have a BIP-086 script key
-	// should be selected.
-	Bip86Only CoinSelectType = 0
-
-	// ScriptTreesAllowed indicates that coins with any script key type
-	// should be selected.
-	ScriptTreesAllowed CoinSelectType = 1
-
-	// DefaultCoinSelectType is the default coin selection type that should
-	// be used when no specific type is specified. We default to allowing
-	// any script key type to be in line with the RPC values, which are
-	// intended to be backward compatible with clients that didn't specify
-	// the type (when funding a vPSBT for example).
-	DefaultCoinSelectType = ScriptTreesAllowed
-)
-
 // FundingDescriptor describes the information that is needed to select and
 // verify input assets in order to send to a specific recipient. It is a subset
 // of the information contained in a Taproot Asset address.
@@ -206,9 +184,6 @@ type FundingDescriptor struct {
 	// PrevIDs is the set of inputs that can be used to fund the transfer.
 	PrevIDs []asset.PrevID
 
-	// CoinSelectType specifies the type of coins that should be selected.
-	CoinSelectType CoinSelectType
-
 	// DistinctSpecifier indicates whether we _only_ look at either the
 	// group key _or_ the asset ID but not both. That means, if the group
 	// key is set, we ignore the asset ID and allow multiple inputs of the