add utxo id to siacoin and siafund json marshalling

Author: n8maninger

.changeset/added_utxo_ids_to_v1_transaction_json_marshalling.md

@@ -0,0 +1,5 @@
+---
+default: minor
+---
+
+# Added UTXO IDs to v1 transaction JSON marshalling

types/types.go

@@ -430,13 +430,42 @@ type Transaction struct {
 
 // MarshalJSON implements json.Marshaler.
 //
-// For convenience, the transaction's ID is also calculated and included. This field is ignored during unmarshalling.
+// The transaction and UTXO IDs are calculated and included for convenience.
+// These fields are ignored during unmarshalling.
 func (txn Transaction) MarshalJSON() ([]byte, error) {
-	type jsonTxn Transaction // prevent recursion
-	return json.Marshal(struct {
-		ID TransactionID `json:"id"`
+	type jsonTxn Transaction
+	type jsonSiacoinOutput struct {
+		ID SiacoinOutputID `json:"id"`
+		SiacoinOutput
+	}
+	type jsonSiafundOutput struct {
+		ID SiafundOutputID `json:"id"`
+		SiafundOutput
+	}
+	obj := struct {
+		ID             TransactionID       `json:"id"`
+		SiacoinOutputs []jsonSiacoinOutput `json:"siacoinOutputs,omitempty"`
+		SiafundOutputs []jsonSiafundOutput `json:"siafundOutputs,omitempty"`
 		jsonTxn
-	}{txn.ID(), jsonTxn(txn)})
+	}{
+		ID:             txn.ID(),
+		jsonTxn:        jsonTxn(txn),
+		SiacoinOutputs: make([]jsonSiacoinOutput, 0, len(txn.SiacoinOutputs)),
+		SiafundOutputs: make([]jsonSiafundOutput, 0, len(txn.SiafundOutputs)),
+	}
+	for i := range txn.SiacoinOutputs {
+		obj.SiacoinOutputs = append(obj.SiacoinOutputs, jsonSiacoinOutput{
+			ID:            txn.SiacoinOutputID(i),
+			SiacoinOutput: txn.SiacoinOutputs[i],
+		})
+	}
+	for i := range txn.SiafundOutputs {
+		obj.SiafundOutputs = append(obj.SiafundOutputs, jsonSiafundOutput{
+			ID:            txn.SiafundOutputID(i),
+			SiafundOutput: txn.SiafundOutputs[i],
+		})
+	}
+	return json.Marshal(obj)
 }
 
 // ID returns the "semantic hash" of the transaction, covering all of the

types/types_test.go

@@ -775,6 +775,20 @@ func TestTransactionJSONMarshalling(t *testing.T) {
 				},
 			},
 		},
+		SiafundInputs: []SiafundInput{
+			{
+				ParentID: frand.Entropy256(),
+				UnlockConditions: UnlockConditions{
+					PublicKeys: []UnlockKey{
+						PublicKey(frand.Entropy256()).UnlockKey(),
+					},
+					SignaturesRequired: 1,
+				},
+			},
+		},
+		SiafundOutputs: []SiafundOutput{
+			{Address: frand.Entropy256(), Value: frand.Uint64n(10000)},
+		},
 	}
 	expectedID := txn.ID()
 
@@ -790,11 +804,43 @@ func TestTransactionJSONMarshalling(t *testing.T) {
 		t.Fatalf("expected ID %q, got %q", expectedID.String(), txnMap["id"].(string))
 	}
 
+	expectedSiacoinID := txn.SiacoinOutputID(0)
+	siacoinOutputID := txnMap["siacoinOutputs"].([]any)[0].(map[string]any)["id"].(string)
+	if siacoinOutputID != expectedSiacoinID.String() {
+		t.Fatalf("expected siacoin output id  %q, got %q", expectedSiacoinID.String(), siacoinOutputID)
+	}
+
+	expectedSiafundID := txn.SiafundOutputID(0)
+	siafundOutputID := txnMap["siafundOutputs"].([]any)[0].(map[string]any)["id"].(string)
+	if siafundOutputID != expectedSiafundID.String() {
+		t.Fatalf("expected siafund output id %q, got %q", expectedSiafundID.String(), siafundOutputID)
+	}
+
+	expectedSiacoinInputAddress := txn.SiacoinInputs[0].UnlockConditions.UnlockHash()
+	siacoinInputAddress := txnMap["siacoinInputs"].([]any)[0].(map[string]any)["address"].(string)
+	if siacoinInputAddress != expectedSiacoinInputAddress.String() {
+		t.Fatalf("expected siacoin input address %q, got %q", expectedSiacoinInputAddress.String(), siacoinInputAddress)
+	}
+
+	expectedSiafundInputAddress := txn.SiafundInputs[0].UnlockConditions.UnlockHash()
+	siafundInputAddress := txnMap["siafundInputs"].([]any)[0].(map[string]any)["address"].(string)
+	if siafundInputAddress != expectedSiafundInputAddress.String() {
+		t.Fatalf("expected siafund input address %q, got %q", expectedSiafundInputAddress.String(), siafundInputAddress)
+	}
+
 	var txn2 Transaction
 	if err := json.Unmarshal(buf, &txn2); err != nil {
 		t.Fatal(err)
 	} else if txn2.ID() != expectedID {
 		t.Fatalf("expected unmarshalled ID to be %q, got %q", expectedID, txn2.ID())
+	} else if txn2.SiacoinOutputID(0) != expectedSiacoinID {
+		t.Fatalf("expected unmarshalled siacoin output id to be %q, got %q", expectedSiacoinID, txn2.SiacoinOutputID(0))
+	} else if txn2.SiafundOutputID(0) != expectedSiafundID {
+		t.Fatalf("expected unmarshalled siafund output id to be %q, got %q", expectedSiafundID, txn2.SiafundOutputID(0))
+	} else if txn2.SiacoinInputs[0].UnlockConditions.UnlockHash() != expectedSiacoinInputAddress {
+		t.Fatalf("expected unmarshalled siacoin input address to be %q, got %q", expectedSiacoinInputAddress, txn2.SiacoinInputs[0].UnlockConditions.UnlockHash())
+	} else if txn2.SiafundInputs[0].UnlockConditions.UnlockHash() != expectedSiafundInputAddress {
+		t.Fatalf("expected unmarshalled siafund input address to be %q, got %q", expectedSiafundInputAddress, txn2.SiafundInputs[0].UnlockConditions.UnlockHash())
 	}
 }