tapgarden: show asset group info in ListBatches

Author: jharveyb

monitoring/garden_collector.go

@@ -73,7 +73,9 @@ func (a *gardenCollector) Collect(ch chan<- prometheus.Metric) {
 	a.completedBatches.Set(0)
 
 	// Get the number of pending batches.
-	batches, err := a.cfg.AssetMinter.ListBatches(nil)
+	batches, err := a.cfg.AssetMinter.ListBatches(
+		tapgarden.ListBatchesParams{},
+	)
 	if err != nil {
 		log.Errorf("unable to list batches: %v", err)
 		return

tapgarden/batch.go

@@ -10,6 +10,7 @@ import (
 	"github.com/btcsuite/btcd/txscript"
 	"github.com/lightninglabs/taproot-assets/asset"
 	"github.com/lightninglabs/taproot-assets/commitment"
+	"github.com/lightninglabs/taproot-assets/fn"
 	"github.com/lightninglabs/taproot-assets/proof"
 	"github.com/lightninglabs/taproot-assets/tapscript"
 	"github.com/lightninglabs/taproot-assets/tapsend"
@@ -75,6 +76,62 @@ type MintingBatch struct {
 	taprootAssetScriptRoot []byte
 }
 
+type VerboseBatch struct {
+	// CreationTime is the time that this batch was created.
+	CreationTime time.Time
+
+	// HeightHint is the recorded block height at time of creating this
+	// batch. We use it to know where to start looking for the signed batch
+	// transaction.
+	HeightHint uint32
+
+	// batchState is the state of the batch.
+	batchState atomic.Uint32
+
+	// BatchKey is the unique identifier for a batch.
+	BatchKey keychain.KeyDescriptor
+
+	// Seedlings is the set of unsealed seedlings for this batch. This maps
+	// an asset's name to the seedling itself.
+	//
+	// NOTE: This field is only set if the state is BatchStateFrozen or
+	// BatchStatePending.
+	Seedlings map[string]*UnsealedSeedling
+
+	// GenesisPacket is the funded genesis packet that may or may not be
+	// fully signed. When broadcast, this will create all assets stored
+	// within this batch.
+	GenesisPacket *tapsend.FundedPsbt
+
+	// RootAssetCommitment is the root Taproot Asset commitment for all the
+	// assets contained in this batch.
+	//
+	// NOTE: This field is only set if the state is beyond
+	// BatchStateCommitted.
+	RootAssetCommitment *commitment.TapCommitment
+
+	// AssetMetas maps the serialized script key of an asset to the meta
+	// reveal for that asset, if it has one.
+	AssetMetas AssetMetas
+
+	// mintingPubKey is the top-level Taproot output key that will be used
+	// to commit to the Taproot Asset commitment above.
+	mintingPubKey *btcec.PublicKey
+
+	// tapSibling is an optional root hash of a tapscript tree that will be
+	// used with the taprootAssetScriptRoot to construct the mintingPubKey.
+	tapSibling *chainhash.Hash
+
+	// taprootAssetScriptRoot is the root hash of the Taproot Asset
+	// commitment. If this is nil, then the mintingPubKey will be as well.
+	taprootAssetScriptRoot []byte
+}
+
+type MinterBatch interface {
+	*MintingBatch | *VerboseBatch
+	State() BatchState
+}
+
 // validateGroupAnchor checks if the group anchor for a seedling is valid.
 // A valid anchor must already be part of the batch and have emission enabled.
 func (m *MintingBatch) validateGroupAnchor(s *Seedling) error {
@@ -173,6 +230,84 @@ func (m *MintingBatch) UpdateTapSibling(sibling *chainhash.Hash) {
 	m.tapSibling = sibling
 }
 
+// IsFunded checks if the batch already has a funded genesis packet.
 func (m *MintingBatch) IsFunded() bool {
 	return m.GenesisPacket != nil
 }
+
+// HasSeedlings checks if the batch has any seedlings. A batch with no seedlings
+// cannot be sealed nor finalized.
+func (m *MintingBatch) HasSeedlings() bool {
+	return len(m.Seedlings) != 0
+}
+
+func (m *MintingBatch) ToVerbose() *VerboseBatch {
+	newBatch := &VerboseBatch{
+		CreationTime:           m.CreationTime,
+		HeightHint:             m.HeightHint,
+		BatchKey:               m.BatchKey,
+		GenesisPacket:          m.GenesisPacket,
+		RootAssetCommitment:    m.RootAssetCommitment,
+		AssetMetas:             m.AssetMetas,
+		mintingPubKey:          m.mintingPubKey,
+		tapSibling:             m.tapSibling,
+		taprootAssetScriptRoot: m.taprootAssetScriptRoot,
+	}
+	newBatch.batchState.Store(uint32(m.State()))
+	seedlings := make(map[string]*UnsealedSeedling, len(m.Seedlings))
+	toUnsealed := func(seedlingName string, seedling *Seedling) {
+		seedlings[seedlingName] = &UnsealedSeedling{
+			seedling,
+			nil,
+		}
+	}
+	fn.ForEachMapItem(m.Seedlings, toUnsealed)
+
+	newBatch.Seedlings = seedlings
+
+	return newBatch
+}
+
+func (v *VerboseBatch) ToMintingBatch() *MintingBatch {
+	newBatch := &MintingBatch{
+		CreationTime:           v.CreationTime,
+		HeightHint:             v.HeightHint,
+		BatchKey:               v.BatchKey,
+		GenesisPacket:          v.GenesisPacket,
+		RootAssetCommitment:    v.RootAssetCommitment,
+		AssetMetas:             v.AssetMetas,
+		mintingPubKey:          v.mintingPubKey,
+		tapSibling:             v.tapSibling,
+		taprootAssetScriptRoot: v.taprootAssetScriptRoot,
+	}
+	newBatch.batchState.Store(uint32(v.State()))
+	seedlings := make(map[string]*Seedling, len(v.Seedlings))
+	toUnsealed := func(seedlingName string, seedling *UnsealedSeedling) {
+		seedlings[seedlingName] = seedling.Seedling
+	}
+	fn.ForEachMapItem(v.Seedlings, toUnsealed)
+
+	newBatch.Seedlings = seedlings
+
+	return newBatch
+}
+
+// State returns the private state of the batch.
+func (v *VerboseBatch) State() BatchState {
+	currentBatchState := v.batchState.Load()
+
+	// Drop the error when converting the stored state to a BatchState, as
+	// we verify the batch state before storing it.
+	batchStateCopy, _ := NewBatchState(uint8(currentBatchState))
+	return batchStateCopy
+}
+
+// TapSibling returns the optional tapscript sibling for the batch, which is a
+// root hash of a tapscript tree.
+func (v *VerboseBatch) TapSibling() []byte {
+	if v.tapSibling == nil {
+		return nil
+	}
+
+	return v.tapSibling.CloneBytes()
+}

tapgarden/interface.go

@@ -35,7 +35,7 @@ type Planter interface {
 
 	// ListBatches lists the set of batches submitted for minting, or the
 	// details of a specific batch.
-	ListBatches(batchKey *btcec.PublicKey) ([]*MintingBatch, error)
+	ListBatches(params ListBatchesParams) ([]*VerboseBatch, error)
 
 	// CancelSeedling attempts to cancel the creation of a new asset
 	// identified by its name. If the seedling has already progressed to a