tapfreighter: store asset burns

Author: GeorgeTsagk

rpcserver.go

@@ -2275,7 +2275,7 @@ func (r *rpcServer) AnchorVirtualPsbts(ctx context.Context,
 	}
 
 	resp, err := r.cfg.ChainPorter.RequestShipment(
-		tapfreighter.NewPreSignedParcel(vPackets, inputCommitments),
+		tapfreighter.NewPreSignedParcel(vPackets, inputCommitments, ""),
 	)
 	if err != nil {
 		return nil, fmt.Errorf("error requesting delivery: %w", err)
@@ -3290,7 +3290,7 @@ func (r *rpcServer) BurnAsset(ctx context.Context,
 	resp, err := r.cfg.ChainPorter.RequestShipment(
 		tapfreighter.NewPreSignedParcel(
 			[]*tappsbt.VPacket{fundResp.VPacket},
-			fundResp.InputCommitments,
+			fundResp.InputCommitments, "",
 		),
 	)
 	if err != nil {

tapfreighter/chain_porter.go

@@ -646,6 +646,34 @@ func (p *ChainPorter) storePackageAnchorTxConf(pkg *sendPackage) error {
 		)
 	}
 
+	// Now we scan through the VPacket for any burns.
+	var burns []*AssetBurn
+
+	for _, v := range pkg.VirtualPackets {
+		for _, o := range v.Outputs {
+			if !o.Asset.IsBurn() {
+				continue
+			}
+
+			assetID := o.Asset.ID()
+
+			// We prepare the burn and add it to the list.
+			b := &AssetBurn{
+				AssetID:    assetID[:],
+				Amount:     o.Amount,
+				AnchorTxid: pkg.OutboundPkg.AnchorTx.TxHash(),
+				Note:       pkg.Note,
+			}
+
+			if o.Asset.GroupKey != nil {
+				groupKey := o.Asset.GroupKey.GroupPubKey
+				b.GroupKey = groupKey.SerializeCompressed()
+			}
+
+			burns = append(burns, b)
+		}
+	}
+
 	// At this point we have the confirmation signal, so we can mark the
 	// parcel delivery as completed in the database.
 	anchorTXID := pkg.OutboundPkg.AnchorTx.TxHash()
@@ -657,7 +685,7 @@ func (p *ChainPorter) storePackageAnchorTxConf(pkg *sendPackage) error {
 		TxIndex:                int32(pkg.TransferTxConfEvent.TxIndex),
 		FinalProofs:            pkg.FinalProofs,
 		PassiveAssetProofFiles: passiveAssetProofFiles,
-	}, nil)
+	}, burns)
 	if err != nil {
 		return fmt.Errorf("unable to log parcel delivery "+
 			"confirmation: %w", err)

tapfreighter/parcel.go

@@ -258,6 +258,10 @@ type PreSignedParcel struct {
 	// inputCommitments are the commitments for the input that are being
 	// spent in the virtual transaction.
 	inputCommitments tappsbt.InputCommitments
+
+	// note is a string that provides any user defined description for this
+	// transfer.
+	note string
 }
 
 // A compile-time assertion to ensure PreSignedParcel implements the parcel
@@ -266,7 +270,8 @@ var _ Parcel = (*PreSignedParcel)(nil)
 
 // NewPreSignedParcel creates a new PreSignedParcel.
 func NewPreSignedParcel(vPackets []*tappsbt.VPacket,
-	inputCommitments tappsbt.InputCommitments) *PreSignedParcel {
+	inputCommitments tappsbt.InputCommitments,
+	note string) *PreSignedParcel {
 
 	return &PreSignedParcel{
 		parcelKit: &parcelKit{
@@ -275,6 +280,7 @@ func NewPreSignedParcel(vPackets []*tappsbt.VPacket,
 		},
 		vPackets:         vPackets,
 		inputCommitments: inputCommitments,
+		note:             note,
 	}
 }
 
@@ -290,6 +296,7 @@ func (p *PreSignedParcel) pkg() *sendPackage {
 		SendState:        SendStateAnchorSign,
 		VirtualPackets:   p.vPackets,
 		InputCommitments: p.inputCommitments,
+		Note:             p.note,
 	}
 }
 
@@ -464,6 +471,10 @@ type sendPackage struct {
 	// TransferTxConfEvent contains transfer transaction on-chain
 	// confirmation data.
 	TransferTxConfEvent *chainntnfs.TxConfirmation
+
+	// Note is a user provided description for this transfer. This is
+	// currently only used by asset burn transfers.
+	Note string
 }
 
 // ConvertToTransfer prepares the finished send data for storing to the database