multi: add CoinSelectType to specify script key type

Author: guggero

tapdb/assets_store.go

@@ -23,6 +23,7 @@ import (
 	"github.com/lightninglabs/taproot-assets/tapdb/sqlc"
 	"github.com/lightninglabs/taproot-assets/tapfreighter"
 	"github.com/lightninglabs/taproot-assets/tappsbt"
+	"github.com/lightninglabs/taproot-assets/tapsend"
 	"github.com/lightningnetwork/lnd/clock"
 	"github.com/lightningnetwork/lnd/keychain"
 )
@@ -873,7 +874,11 @@ func (a *AssetStore) constraintsToDbFilter(
 		// TODO(roasbeef): only want to allow asset ID or other and not
 		// both?
 
-		if query.Bip86ScriptKeysOnly {
+		switch query.CoinSelectType {
+		case tapsend.ScriptTreesAllowed:
+			assetFilter.Bip86ScriptKeysOnly = false
+
+		default:
 			assetFilter.Bip86ScriptKeysOnly = true
 		}
 	}

tapdb/assets_store_test.go

@@ -23,6 +23,7 @@ import (
 	"github.com/lightninglabs/taproot-assets/proof"
 	"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"
@@ -758,11 +759,11 @@ func TestFetchAllAssets(t *testing.T) {
 		scriptKey:   scriptKeyWithScript,
 	}}
 	makeFilter := func(amt uint64, anchorHeight int32,
-		bip86ScriptKeysOnly bool) *AssetQueryFilters {
+		coinSelectType tapsend.CoinSelectType) *AssetQueryFilters {
 
 		constraints := tapfreighter.CommitmentConstraints{
-			MinAmt:              amt,
-			Bip86ScriptKeysOnly: bip86ScriptKeysOnly,
+			MinAmt:         amt,
+			CoinSelectType: coinSelectType,
 		}
 		return &AssetQueryFilters{
 			CommitmentConstraints: constraints,
@@ -795,41 +796,41 @@ func TestFetchAllAssets(t *testing.T) {
 		numAssets:     10,
 	}, {
 		name:      "min amount",
-		filter:    makeFilter(12, 0, false),
+		filter:    makeFilter(12, 0, tapsend.ScriptTreesAllowed),
 		numAssets: 2,
 	}, {
 		name:         "min amount, include spent",
-		filter:       makeFilter(12, 0, false),
+		filter:       makeFilter(12, 0, tapsend.ScriptTreesAllowed),
 		includeSpent: true,
 		numAssets:    4,
 	}, {
 		name:          "min amount, include leased",
-		filter:        makeFilter(12, 0, false),
+		filter:        makeFilter(12, 0, tapsend.ScriptTreesAllowed),
 		includeLeased: true,
 		numAssets:     5,
 	}, {
 		name:          "min amount, include leased, include spent",
-		filter:        makeFilter(12, 0, false),
+		filter:        makeFilter(12, 0, tapsend.ScriptTreesAllowed),
 		includeLeased: true,
 		includeSpent:  true,
 		numAssets:     8,
 	}, {
 		name:         "default min height, include spent",
-		filter:       makeFilter(0, 500, false),
+		filter:       makeFilter(0, 500, tapsend.ScriptTreesAllowed),
 		includeSpent: true,
 		numAssets:    6,
 	}, {
 		name:      "specific height",
-		filter:    makeFilter(0, 502, false),
+		filter:    makeFilter(0, 502, tapsend.ScriptTreesAllowed),
 		numAssets: 0,
 	}, {
 		name:         "default min height, include spent",
-		filter:       makeFilter(0, 502, false),
+		filter:       makeFilter(0, 502, tapsend.ScriptTreesAllowed),
 		includeSpent: true,
 		numAssets:    1,
 	}, {
 		name:      "script key with tapscript",
-		filter:    makeFilter(100, 0, true),
+		filter:    makeFilter(100, 0, tapsend.Bip86Only),
 		numAssets: 0,
 	}}
 

tapfreighter/coin_select.go

@@ -54,6 +54,7 @@ func (s *CoinSelect) SelectCoins(ctx context.Context,
 	listConstraints := CommitmentConstraints{
 		AssetSpecifier: constraints.AssetSpecifier,
 		MinAmt:         1,
+		CoinSelectType: constraints.CoinSelectType,
 	}
 	eligibleCommitments, err := s.coinLister.ListEligibleCoins(
 		ctx, listConstraints,

tapfreighter/interface.go

@@ -17,6 +17,7 @@ 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"
 )
 
@@ -34,9 +35,8 @@ type CommitmentConstraints struct {
 	// to satisfy the constraints.
 	MinAmt uint64
 
-	// Bip86ScriptKeysOnly is a flag that when set, will exclude any assets
-	// that have a script key with a tapscript tree (a non-empty tweak).
-	Bip86ScriptKeysOnly bool
+	// CoinSelectType is the type of coins that should be selected.
+	CoinSelectType tapsend.CoinSelectType
 }
 
 // String returns the string representation of the commitment constraints.

tapfreighter/wallet.go

@@ -365,9 +365,9 @@ func (f *AssetWallet) FundPacket(ctx context.Context,
 	// send request. We'll map the address to a set of constraints, so we
 	// can use that to do Taproot asset coin selection.
 	constraints := CommitmentConstraints{
-		AssetSpecifier:      fundDesc.AssetSpecifier,
-		MinAmt:              fundDesc.Amount,
-		Bip86ScriptKeysOnly: true,
+		AssetSpecifier: fundDesc.AssetSpecifier,
+		MinAmt:         fundDesc.Amount,
+		CoinSelectType: tapsend.Bip86Only,
 	}
 
 	anchorVersion, err := tappsbt.CommitmentVersion(vPkt.Version)

tapsend/send.go

@@ -161,6 +161,28 @@ 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.