taprpc: add proof delivery status field to RPC TransferOutput message

This commit enhances the ListTransfers RPC endpoint by adding the proof
delivery status for each transfer output in its response.

Author: ffranr

rpcserver.go

@@ -3364,6 +3364,9 @@ func marshalOutboundParcel(
 			return nil, err
 		}
 
+		// Marshall the proof delivery status.
+		proofDeliveryStatus := marshalOutputProofDeliveryStatus(out)
+
 		rpcOutputs[idx] = &taprpc.TransferOutput{
 			Anchor:              rpcAnchor,
 			ScriptKey:           scriptPubKey.SerializeCompressed(),
@@ -3375,6 +3378,7 @@ func marshalOutboundParcel(
 			SplitCommitRootHash: splitCommitRoot,
 			OutputType:          rpcOutType,
 			AssetVersion:        assetVersion,
+			ProofDeliveryStatus: proofDeliveryStatus,
 		}
 	}
 
@@ -3397,6 +3401,23 @@ func marshalOutboundParcel(
 	}, nil
 }
 
+// marshalOutputProofDeliveryStatus turns the output proof delivery status into
+// the RPC counterpart.
+func marshalOutputProofDeliveryStatus(
+	out tapfreighter.TransferOutput) taprpc.ProofDeliveryStatus {
+
+	proofDeliveryStatus := taprpc.ProofDeliveryStatusNotApplicable
+	out.ProofDeliveryComplete.WhenSome(func(complete bool) {
+		if complete {
+			proofDeliveryStatus = taprpc.ProofDeliveryStatusComplete
+		} else {
+			proofDeliveryStatus = taprpc.ProofDeliveryStatusPending
+		}
+	})
+
+	return proofDeliveryStatus
+}
+
 // marshalOutputType turns the transfer output type into the RPC counterpart.
 func marshalOutputType(outputType tappsbt.VOutputType) (taprpc.OutputType,
 	error) {

taprpc/assetwalletrpc/assetwallet.swagger.json

@@ -941,6 +941,16 @@
       "default": "OUTPUT_TYPE_SIMPLE",
       "description": " - OUTPUT_TYPE_SIMPLE: OUTPUT_TYPE_SIMPLE is a plain full-value or split output that is not a\nsplit root and does not carry passive assets. In case of a split, the\nasset of this output has a split commitment.\n - OUTPUT_TYPE_SPLIT_ROOT: OUTPUT_TYPE_SPLIT_ROOT is a split root output that carries the change\nfrom a split or a tombstone from a non-interactive full value send\noutput. In either case, the asset of this output has a tx witness."
     },
+    "taprpcProofDeliveryStatus": {
+      "type": "string",
+      "enum": [
+        "PROOF_DELIVERY_STATUS_NOT_APPLICABLE",
+        "PROOF_DELIVERY_STATUS_COMPLETE",
+        "PROOF_DELIVERY_STATUS_PENDING"
+      ],
+      "default": "PROOF_DELIVERY_STATUS_NOT_APPLICABLE",
+      "description": "ProofDeliveryStatus is an enum that describes the status of the delivery of\na proof associated with an asset transfer output.\n\n - PROOF_DELIVERY_STATUS_NOT_APPLICABLE: Delivery is not applicable; the proof will not be delivered.\n - PROOF_DELIVERY_STATUS_COMPLETE: The proof has been successfully delivered.\n - PROOF_DELIVERY_STATUS_PENDING: The proof is pending delivery. This status indicates that the proof has\nnot yet been delivered successfully. One or more attempts at proof\ndelivery may have been made."
+    },
     "taprpcScriptKey": {
       "type": "object",
       "properties": {
@@ -1031,6 +1041,10 @@
         "relative_lock_time": {
           "type": "string",
           "format": "uint64"
+        },
+        "proof_delivery_status": {
+          "$ref": "#/definitions/taprpcProofDeliveryStatus",
+          "description": "The delivery status of the proof associated with this output."
         }
       }
     },

taprpc/marshal.go

@@ -20,6 +20,15 @@ import (
 	"github.com/lightningnetwork/lnd/keychain"
 )
 
+// Shorthand for the asset transfer output proof delivery status enum.
+//
+// nolint: lll
+var (
+	ProofDeliveryStatusNotApplicable = ProofDeliveryStatus_PROOF_DELIVERY_STATUS_NOT_APPLICABLE
+	ProofDeliveryStatusComplete      = ProofDeliveryStatus_PROOF_DELIVERY_STATUS_COMPLETE
+	ProofDeliveryStatusPending       = ProofDeliveryStatus_PROOF_DELIVERY_STATUS_PENDING
+)
+
 // KeyLookup is used to determine whether a key is under the control of the
 // local wallet.
 type KeyLookup interface {