From 0b191d0ea94d13a0c02799ce49294f7e23826350 Mon Sep 17 00:00:00 2001
From: Supun Induwara <induwarabas@gmail.com>
Date: Mon, 6 Jan 2025 17:57:52 +0530
Subject: [PATCH] Fixed #422 : Add IsHexTxID method to determine TxID format in
 wallets

This change introduces an IsHexTxID method to the Wallet interface, with implementations for privateKeyWallet, fireblocksWallet, and MockWallet. The method is used to handle differing TxID formats (hexadecimal or custom) when processing transaction receipts. Adjustments were made to the SimpleTxManager to incorporate this new method for better compatibility.
---
 chainio/clients/mocks/wallet.go             |  4 ++++
 chainio/clients/wallet/fireblocks_wallet.go |  4 ++++
 chainio/clients/wallet/privatekey_wallet.go |  4 ++++
 chainio/clients/wallet/wallet.go            |  4 ++++
 chainio/txmgr/simple.go                     | 18 ++++++++++++------
 5 files changed, 28 insertions(+), 6 deletions(-)

diff --git a/chainio/clients/mocks/wallet.go b/chainio/clients/mocks/wallet.go
index e44e719f..0d5da5ed 100644
--- a/chainio/clients/mocks/wallet.go
+++ b/chainio/clients/mocks/wallet.go
@@ -36,6 +36,10 @@ func NewMockWallet(ctrl *gomock.Controller) *MockWallet {
 	return mock
 }
 
+func (m *MockWallet) IsHexTxID() bool {
+	return true
+}
+
 // EXPECT returns an object that allows the caller to indicate expected use.
 func (m *MockWallet) EXPECT() *MockWalletMockRecorder {
 	return m.recorder
diff --git a/chainio/clients/wallet/fireblocks_wallet.go b/chainio/clients/wallet/fireblocks_wallet.go
index ea8a9f1e..861570eb 100644
--- a/chainio/clients/wallet/fireblocks_wallet.go
+++ b/chainio/clients/wallet/fireblocks_wallet.go
@@ -91,6 +91,10 @@ func NewFireblocksWallet(
 	}, nil
 }
 
+func (t *fireblocksWallet) IsHexTxID() bool {
+	return false
+}
+
 func (t *fireblocksWallet) getAccount(ctx context.Context) (*fireblocks.VaultAccount, error) {
 	if t.account == nil {
 		accounts, err := t.fireblocksClient.ListVaultAccounts(ctx)
diff --git a/chainio/clients/wallet/privatekey_wallet.go b/chainio/clients/wallet/privatekey_wallet.go
index f98a4225..f04cf766 100644
--- a/chainio/clients/wallet/privatekey_wallet.go
+++ b/chainio/clients/wallet/privatekey_wallet.go
@@ -39,6 +39,10 @@ func NewPrivateKeyWallet(
 	}, nil
 }
 
+func (t *privateKeyWallet) IsHexTxID() bool {
+	return true
+}
+
 func (t *privateKeyWallet) SendTransaction(ctx context.Context, tx *types.Transaction) (TxID, error) {
 
 	t.logger.Debug("Getting signer for tx")
diff --git a/chainio/clients/wallet/wallet.go b/chainio/clients/wallet/wallet.go
index ff300704..36a3fc15 100644
--- a/chainio/clients/wallet/wallet.go
+++ b/chainio/clients/wallet/wallet.go
@@ -20,4 +20,8 @@ type Wallet interface {
 	GetTransactionReceipt(ctx context.Context, txID TxID) (*types.Receipt, error)
 	// SenderAddress returns the address of the wallet
 	SenderAddress(ctx context.Context) (common.Address, error)
+
+	// IsHexTxID returns true if the transaction ID (TxID) is represented as a hexadecimal string; otherwise, false.
+	// Some wallets use custom formats like uuid for representing the TxID instead of raw hex
+	IsHexTxID() bool
 }
diff --git a/chainio/txmgr/simple.go b/chainio/txmgr/simple.go
index 6c732ad2..f7ace7bb 100644
--- a/chainio/txmgr/simple.go
+++ b/chainio/txmgr/simple.go
@@ -74,7 +74,7 @@ func (m *SimpleTxManager) Send(
 	waitForReceipt bool,
 ) (*types.Receipt, error) {
 
-	r, err := m.send(ctx, tx)
+	r, txID, err := m.send(ctx, tx)
 	if err != nil {
 		return nil, errors.Join(errors.New("send: failed to estimate gas and nonce"), err)
 	}
@@ -82,7 +82,13 @@ func (m *SimpleTxManager) Send(
 		return r, nil
 	}
 
-	receipt, err := m.waitForReceipt(ctx, r.TxHash.Hex())
+	var receipt *types.Receipt
+	if m.wallet.IsHexTxID() {
+		receipt, err = m.waitForReceipt(ctx, r.TxHash.Hex())
+	} else {
+		receipt, err = m.waitForReceipt(ctx, txID)
+	}
+
 	if err != nil {
 		log.Info("Transaction receipt not found", "err", err)
 		return nil, err
@@ -91,14 +97,14 @@ func (m *SimpleTxManager) Send(
 	return receipt, nil
 }
 
-func (m *SimpleTxManager) send(ctx context.Context, tx *types.Transaction) (*types.Receipt, error) {
+func (m *SimpleTxManager) send(ctx context.Context, tx *types.Transaction) (*types.Receipt, string, error) {
 	// Estimate gas and nonce
 	// can't print tx hash in logs because the tx changes below when we complete and sign it
 	// so the txHash is meaningless at this point
 	m.logger.Debug("Estimating gas and nonce")
 	tx, err := m.estimateGasAndNonce(ctx, tx)
 	if err != nil {
-		return nil, err
+		return nil, "", err
 	}
 	bumpedGasTx := &types.DynamicFeeTx{
 		To:        tx.To(),
@@ -111,11 +117,11 @@ func (m *SimpleTxManager) send(ctx context.Context, tx *types.Transaction) (*typ
 	}
 	txID, err := m.wallet.SendTransaction(ctx, types.NewTx(bumpedGasTx))
 	if err != nil {
-		return nil, errors.Join(errors.New("send: failed to estimate gas and nonce"), err)
+		return nil, "", errors.Join(errors.New("send: failed to estimate gas and nonce"), err)
 	}
 	return &types.Receipt{
 		TxHash: common.HexToHash(txID),
-	}, nil
+	}, txID, nil
 }
 
 func NoopSigner(addr common.Address, tx *types.Transaction) (*types.Transaction, error) {