feat(ledger): Add friendly string representation of TX outputs

ledger/alonzo/alonzo.go

@@ -447,6 +447,19 @@ func (o AlonzoTransactionOutput) Utxorpc() (*utxorpc.TxOutput, error) {
 		nil
 }
 
+func (o AlonzoTransactionOutput) String() string {
+	assets := ""
+	if o.OutputAmount.Assets != nil && len(o.OutputAmount.Assets.Policies()) > 0 {
+		assets = " assets=..."
+	}
+	return fmt.Sprintf(
+		"(AlonzoTransactionOutput address=%s amount=%d%s)",
+		o.OutputAddress.String(),
+		o.OutputAmount.Amount,
+		assets,
+	)
+}
+
 type AlonzoRedeemer struct {
 	cbor.StructAsArray
 	Tag     common.RedeemerTag

ledger/alonzo/alonzo_test.go

@@ -277,3 +277,23 @@ func TestAlonzoRedeemersIter(t *testing.T) {
 		iterIdx++
 	}
 }
+
+func TestAlonzoTransactionOutputString(t *testing.T) {
+	addr, _ := common.NewAddress(
+		"addr1qytna5k2fq9ler0fuk45j7zfwv7t2zwhp777nvdjqqfr5tz8ztpwnk8zq5ngetcz5k5mckgkajnygtsra9aej2h3ek5seupmvd",
+	)
+	ma := common.NewMultiAsset[common.MultiAssetTypeOutput](
+		map[common.Blake2b224]map[cbor.ByteString]uint64{
+			common.NewBlake2b224(make([]byte, 28)): {cbor.NewByteString([]byte("t")): 2},
+		},
+	)
+	out := AlonzoTransactionOutput{
+		OutputAddress: addr,
+		OutputAmount:  mary.MaryTransactionOutputValue{Amount: 456, Assets: &ma},
+	}
+	s := out.String()
+	expected := "(AlonzoTransactionOutput address=" + addr.String() + " amount=456 assets=...)"
+	if s != expected {
+		t.Fatalf("unexpected string: %s", s)
+	}
+}

ledger/babbage/babbage.go

@@ -649,6 +649,19 @@ func (o BabbageTransactionOutput) Utxorpc() (*utxorpc.TxOutput, error) {
 		nil
 }
 
+func (o BabbageTransactionOutput) String() string {
+	assets := ""
+	if o.OutputAmount.Assets != nil && len(o.OutputAmount.Assets.Policies()) > 0 {
+		assets = " assets=..."
+	}
+	return fmt.Sprintf(
+		"(BabbageTransactionOutput address=%s amount=%d%s)",
+		o.OutputAddress.String(),
+		o.OutputAmount.Amount,
+		assets,
+	)
+}
+
 type BabbageTransactionWitnessSet struct {
 	cbor.DecodeStoreCbor
 	VkeyWitnesses      []common.VkeyWitness      `cbor:"0,keyasint,omitempty"`

ledger/babbage/babbage_test.go

@@ -2970,3 +2970,23 @@ func TestBabbageTransactionOutputToPlutusDataCoinAssets(t *testing.T) {
 		)
 	}
 }
+
+func TestBabbageTransactionOutputString(t *testing.T) {
+	addr, _ := common.NewAddress(
+		"addr1qytna5k2fq9ler0fuk45j7zfwv7t2zwhp777nvdjqqfr5tz8ztpwnk8zq5ngetcz5k5mckgkajnygtsra9aej2h3ek5seupmvd",
+	)
+	ma := common.NewMultiAsset[common.MultiAssetTypeOutput](
+		map[common.Blake2b224]map[cbor.ByteString]uint64{
+			common.NewBlake2b224(make([]byte, 28)): {cbor.NewByteString([]byte("x")): 2},
+		},
+	)
+	out := BabbageTransactionOutput{
+		OutputAddress: addr,
+		OutputAmount:  mary.MaryTransactionOutputValue{Amount: 456, Assets: &ma},
+	}
+	s := out.String()
+	expected := "(BabbageTransactionOutput address=" + addr.String() + " amount=456 assets=...)"
+	if s != expected {
+		t.Fatalf("unexpected string: %s", s)
+	}
+}

ledger/byron/byron.go

@@ -462,6 +462,14 @@ func (o ByronTransactionOutput) Utxorpc() (*utxorpc.TxOutput, error) {
 		nil
 }
 
+func (o ByronTransactionOutput) String() string {
+	return fmt.Sprintf(
+		"(ByronTransactionOutput address=%s amount=%d)",
+		o.OutputAddress.String(),
+		o.OutputAmount,
+	)
+}
+
 type ByronBlockVersion struct {
 	cbor.StructAsArray
 	Major   uint16

ledger/byron/byron_test.go

@@ -104,3 +104,23 @@ func TestByronTransaction_Utxorpc_Empty(t *testing.T) {
 		t.Errorf("Expected fee = 0, got %d", result.Fee)
 	}
 }
+
+func TestByronTransactionOutputString(t *testing.T) {
+	addr, err := common.NewByronAddressFromParts(
+		0,
+		make([]byte, common.AddressHashSize),
+		common.ByronAddressAttributes{},
+	)
+	if err != nil {
+		t.Fatalf("address: %v", err)
+	}
+	out := byron.ByronTransactionOutput{
+		OutputAddress: addr,
+		OutputAmount:  456,
+	}
+	s := out.String()
+	expected := "(ByronTransactionOutput address=" + addr.String() + " amount=456)"
+	if s != expected {
+		t.Fatalf("unexpected string: %s", s)
+	}
+}

ledger/common/tx.go

@@ -77,6 +77,7 @@ type TransactionOutput interface {
 	Utxorpc() (*utxorpc.TxOutput, error)
 	ScriptRef() Script
 	ToPlutusData() data.PlutusData
+	String() string
 }
 
 type TransactionWitnessSet interface {

ledger/mary/errors.go

@@ -15,7 +15,6 @@
 package mary
 
 import (
-	"fmt"
 	"strings"
 
 	"github.com/blinklabs-io/gouroboros/ledger/common"
@@ -28,7 +27,7 @@ type OutputTooBigUtxoError struct {
 func (e OutputTooBigUtxoError) Error() string {
 	tmpOutputs := make([]string, len(e.Outputs))
 	for idx, tmpOutput := range e.Outputs {
-		tmpOutputs[idx] = fmt.Sprintf("%#v", tmpOutput)
+		tmpOutputs[idx] = tmpOutput.String()
 	}
 	return "output value too large: " + strings.Join(tmpOutputs, ", ")
 }

ledger/mary/mary.go

@@ -490,6 +490,19 @@ func (o MaryTransactionOutput) Utxorpc() (*utxorpc.TxOutput, error) {
 		err
 }
 
+func (o MaryTransactionOutput) String() string {
+	assets := ""
+	if o.OutputAmount.Assets != nil && len(o.OutputAmount.Assets.Policies()) > 0 {
+		assets = " assets=..."
+	}
+	return fmt.Sprintf(
+		"(MaryTransactionOutput address=%s amount=%d%s)",
+		o.OutputAddress.String(),
+		o.OutputAmount.Amount,
+		assets,
+	)
+}
+
 type MaryTransactionOutputValue struct {
 	cbor.StructAsArray
 	Amount uint64

ledger/mary/mary_test.go

@@ -16,6 +16,7 @@ package mary
 
 import (
 	"encoding/hex"
+	"fmt"
 	"reflect"
 	"testing"
 
@@ -115,3 +116,34 @@ func TestMaryTransactionOutputValueEncodeDecode(t *testing.T) {
 		}
 	}
 }
+
+func TestMaryTransactionOutputString(t *testing.T) {
+	addr, _ := common.NewAddress("addr1qytna5k2fq9ler0fuk45j7zfwv7t2zwhp777nvdjqqfr5tz8ztpwnk8zq5ngetcz5k5mckgkajnygtsra9aej2h3ek5seupmvd")
+	ma := common.NewMultiAsset[common.MultiAssetTypeOutput](
+		map[common.Blake2b224]map[cbor.ByteString]uint64{
+			common.NewBlake2b224(make([]byte, 28)): {cbor.NewByteString([]byte("token")): 2},
+		},
+	)
+	out := MaryTransactionOutput{
+		OutputAddress: addr,
+		OutputAmount:  MaryTransactionOutputValue{Amount: 456, Assets: &ma},
+	}
+	s := out.String()
+	expected := fmt.Sprintf("(MaryTransactionOutput address=%s amount=456 assets=...)", addr.String())
+	if s != expected {
+		t.Fatalf("unexpected string: %s", s)
+	}
+}
+
+func TestMaryOutputTooBigErrorFormatting(t *testing.T) {
+	addr, _ := common.NewAddress("addr1qytna5k2fq9ler0fuk45j7zfwv7t2zwhp777nvdjqqfr5tz8ztpwnk8zq5ngetcz5k5mckgkajnygtsra9aej2h3ek5seupmvd")
+	out := &MaryTransactionOutput{
+		OutputAddress: addr,
+		OutputAmount:  MaryTransactionOutputValue{Amount: 456},
+	}
+	errStr := OutputTooBigUtxoError{Outputs: []common.TransactionOutput{out}}.Error()
+	expected := fmt.Sprintf("output value too large: (MaryTransactionOutput address=%s amount=456)", addr.String())
+	if errStr != expected {
+		t.Fatalf("unexpected error: %s", errStr)
+	}
+}

ledger/shelley/errors.go

@@ -111,7 +111,7 @@ type OutputTooSmallUtxoError struct {
 func (e OutputTooSmallUtxoError) Error() string {
 	tmpOutputs := make([]string, len(e.Outputs))
 	for idx, tmpOutput := range e.Outputs {
-		tmpOutputs[idx] = fmt.Sprintf("%#v", tmpOutput)
+		tmpOutputs[idx] = tmpOutput.String()
 	}
 	return "output too small: " + strings.Join(tmpOutputs, ", ")
 }
@@ -123,7 +123,7 @@ type OutputBootAddrAttrsTooBigError struct {
 func (e OutputBootAddrAttrsTooBigError) Error() string {
 	tmpOutputs := make([]string, len(e.Outputs))
 	for idx, tmpOutput := range e.Outputs {
-		tmpOutputs[idx] = fmt.Sprintf("%#v", tmpOutput)
+		tmpOutputs[idx] = tmpOutput.String()
 	}
 	return "output bootstrap address attributes too big: " + strings.Join(
 		tmpOutputs,

ledger/shelley/shelley.go

@@ -444,6 +444,14 @@ func (o ShelleyTransactionOutput) Utxorpc() (*utxorpc.TxOutput, error) {
 	}, nil
 }
 
+func (o ShelleyTransactionOutput) String() string {
+	return fmt.Sprintf(
+		"(ShelleyTransactionOutput address=%s amount=%d)",
+		o.OutputAddress.String(),
+		o.OutputAmount,
+	)
+}
+
 type ShelleyTransactionWitnessSet struct {
 	cbor.DecodeStoreCbor
 	VkeyWitnesses      []common.VkeyWitness      `cbor:"0,keyasint,omitempty"`

ledger/shelley/shelley_test.go

@@ -0,0 +1,35 @@
+package shelley_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/blinklabs-io/gouroboros/ledger/common"
+	"github.com/blinklabs-io/gouroboros/ledger/shelley"
+)
+
+func TestShelleyTransactionOutputString(t *testing.T) {
+	addr, _ := common.NewAddress("addr1qytna5k2fq9ler0fuk45j7zfwv7t2zwhp777nvdjqqfr5tz8ztpwnk8zq5ngetcz5k5mckgkajnygtsra9aej2h3ek5seupmvd")
+	out := shelley.ShelleyTransactionOutput{
+		OutputAddress: addr,
+		OutputAmount:  456,
+	}
+	s := out.String()
+	expected := fmt.Sprintf("(ShelleyTransactionOutput address=%s amount=456)", addr.String())
+	if s != expected {
+		t.Fatalf("unexpected string: %s", s)
+	}
+}
+
+func TestShelleyOutputTooSmallErrorFormatting(t *testing.T) {
+	addr, _ := common.NewAddress("addr1qytna5k2fq9ler0fuk45j7zfwv7t2zwhp777nvdjqqfr5tz8ztpwnk8zq5ngetcz5k5mckgkajnygtsra9aej2h3ek5seupmvd")
+	out := &shelley.ShelleyTransactionOutput{
+		OutputAddress: addr,
+		OutputAmount:  456,
+	}
+	errStr := shelley.OutputTooSmallUtxoError{Outputs: []common.TransactionOutput{out}}.Error()
+	expected := fmt.Sprintf("output too small: (ShelleyTransactionOutput address=%s amount=456)", addr.String())
+	if errStr != expected {
+		t.Fatalf("unexpected error: %s", errStr)
+	}
+}