From 5f5524538ef1cf3781c8295b081686574f9119c2 Mon Sep 17 00:00:00 2001
From: Dimitris <dimitris.grigoriou@smartcontract.com>
Date: Mon, 2 Dec 2024 17:22:45 +0200
Subject: [PATCH] Improve logs

---
 core/chains/evm/txm/txm.go               |  5 ++--
 core/chains/evm/txm/types/transaction.go | 29 ++++++++++++++++--------
 2 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/core/chains/evm/txm/txm.go b/core/chains/evm/txm/txm.go
index ba836640933..833b3111ef4 100644
--- a/core/chains/evm/txm/txm.go
+++ b/core/chains/evm/txm/txm.go
@@ -341,7 +341,7 @@ func (t *Txm) sendTransactionWithError(ctx context.Context, tx *types.Transactio
 	start := time.Now()
 	txErr := t.client.SendTransaction(ctx, tx, attempt)
 	tx.AttemptCount++
-	t.lggr.Infow("Broadcasted attempt", "tx", tx, "attempt", attempt, "duration", time.Since(start), "txErr: ", txErr)
+	t.lggr.Infow("Broadcasted attempt", "tx", tx.PrettyPrint(), "attempt", attempt.PrettyPrint(), "duration", time.Since(start), "txErr: ", txErr)
 	if txErr != nil && t.errorHandler != nil {
 		if err = t.errorHandler.HandleError(tx, txErr, t.attemptBuilder, t.client, t.txStore, t.setNonce, false); err != nil {
 			return
@@ -410,7 +410,8 @@ func (t *Txm) backfillTransactions(ctx context.Context, address common.Address)
 		if tx.AttemptCount >= maxAllowedAttempts {
 			return true, fmt.Errorf("reached max allowed attempts for txID: %d. TXM won't broadcast any more attempts."+
 				"If this error persists, it means the transaction won't be confirmed and the TXM needs to be restarted."+
-				"Look for any error messages from previous attempts that may indicate why this happened, i.e. wallet is out of funds. Tx: %v", tx.ID, tx)
+				"Look for any error messages from previous broadcasted attempts that may indicate why this happened, i.e. wallet is out of funds. Tx: %v", tx.ID,
+				tx.PrettyPrintWithAttempts())
 		}
 
 		if time.Since(tx.LastBroadcastAt) > (t.config.BlockTime*time.Duration(t.config.RetryBlockThreshold)) || tx.LastBroadcastAt.IsZero() {
diff --git a/core/chains/evm/txm/types/transaction.go b/core/chains/evm/txm/types/transaction.go
index 136b801a7e0..6ae7271ff8b 100644
--- a/core/chains/evm/txm/types/transaction.go
+++ b/core/chains/evm/txm/types/transaction.go
@@ -59,13 +59,24 @@ type Transaction struct {
 	CallbackCompleted bool
 }
 
-//	func (t *Transaction) String() string {
-//		return fmt.Sprintf(`{"ID":%d, "IdempotencyKey":%v, "ChainID":%v, "Nonce":%d, "FromAddress":%v, "ToAddress":%v, "Value":%v, `+
-//			`"Data":%v, "SpecifiedGasLimit":%d, "CreatedAt":%v, "LastBroadcastAt":%v, "State":%v, "IsPurgeable":%v, "AttemptCount":%d, `+
-//			`"Meta":%v, "Subject":%v, "PipelineTaskRunID":%v, "MinConfirmations":%v, "SignalCallback":%v, "CallbackCompleted":%v`,
-//			t.ID, *t.IdempotencyKey, t.ChainID, t.Nonce, t.FromAddress, t.ToAddress, t.Value, t.Data, t.SpecifiedGasLimit, t.CreatedAt, t.LastBroadcastAt,
-//			t.State, t.IsPurgeable, t.AttemptCount, t.Meta, t.Subject, t.PipelineTaskRunID, t.MinConfirmations, t.SignalCallback, t.CallbackCompleted)
-//	}
+func (t *Transaction) PrettyPrint() string {
+	return fmt.Sprintf(`{txID:%d, IdempotencyKey:%v, ChainID:%v, Nonce:%d, FromAddress:%v, ToAddress:%v, Value:%v, `+
+		`Data:%v, SpecifiedGasLimit:%d, CreatedAt:%v, InitialBroadcastAt:%v, LastBroadcastAt:%v, State:%v, IsPurgeable:%v, AttemptCount:%d, `+
+		`Meta:%v, Subject:%v}`,
+		t.ID, *t.IdempotencyKey, t.ChainID, t.Nonce, t.FromAddress, t.ToAddress, t.Value, t.Data, t.SpecifiedGasLimit, t.CreatedAt, t.InitialBroadcastAt,
+		t.LastBroadcastAt, t.State, t.IsPurgeable, t.AttemptCount, t.Meta, t.Subject)
+}
+
+func (t *Transaction) PrettyPrintWithAttempts() string {
+	attempts := " Attempts: ["
+	for _, a := range t.Attempts {
+		attempts += a.PrettyPrint() + ", "
+	}
+	attempts += "]"
+
+	return t.PrettyPrint() + attempts
+}
+
 func (t *Transaction) FindAttemptByHash(attemptHash common.Hash) (*Attempt, error) {
 	for _, a := range t.Attempts {
 		if a.Hash == attemptHash {
@@ -117,8 +128,8 @@ func (a *Attempt) DeepCopy() *Attempt {
 	return &txCopy
 }
 
-func (a *Attempt) String() string {
-	return fmt.Sprintf(`{"ID":%d, "TxID":%d, "Hash":%v, "Fee":%v, "GasLimit":%d, "Type":%v, "CreatedAt":%v, "BroadcastAt":%v}`,
+func (a *Attempt) PrettyPrint() string {
+	return fmt.Sprintf(`{ID:%d, TxID:%d, Hash:%v, Fee:%v, GasLimit:%d, Type:%v, CreatedAt:%v, BroadcastAt:%v}`,
 		a.ID, a.TxID, a.Hash, a.Fee, a.GasLimit, a.Type, a.CreatedAt, a.BroadcastAt)
 }