test: add function-level comments to tests

Author: Monika-Bitfly

backend/pkg/commons/rpc/utils_test.go

@@ -17,6 +17,8 @@ var (
 	token2       = common.HexToAddress("0xabcdef1234567890abcdef1234567890abcdef12")
 )
 
+// TestGetReceiver tests the getReceiver function, which extracts the recipient
+// address from a transaction.
 func TestGetReceiver(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -45,6 +47,8 @@ func TestGetReceiver(t *testing.T) {
 	}
 }
 
+// TestGetBlockWithdrawals tests the getBlockWithdrawals function, which
+// converts a list of withdrawals from a block into a list of Eth1Withdrawal type.
 func TestGetBlockWithdrawals(t *testing.T) {
 	tests := []struct {
 		name           string
@@ -132,6 +136,8 @@ func TestGetBlockWithdrawals(t *testing.T) {
 	}
 }
 
+// TestGetLogsFromReceipts tests the getLogsFromReceipts function, which converts
+// a list of logs from a receipt into a list of Eth1Log type
 func TestGetLogsFromReceipts(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -240,6 +246,8 @@ func TestGetLogsFromReceipts(t *testing.T) {
 	}
 }
 
+// TestGetTokens tests the getTokens function, which converts a list of token
+// addresses from a transaction into a list of common.Address type
 func TestGetTokens(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -278,6 +286,9 @@ func TestGetTokens(t *testing.T) {
 	}
 }
 
+// TestParseAddressBalance tests the parseAddressBalance function, which converts
+// a list of token addresses, address and a list of balances into a list of
+// Eth1AddressBalance type
 func TestParseAddressBalance(t *testing.T) {
 	tests := []struct {
 		name   string

backend/pkg/executionlayer/transformer_test.go

@@ -1216,6 +1216,8 @@ func TestTransformer_FromList(t *testing.T) {
 	}
 }
 
+// TestIsValidERC20Log tests the isValidERC20Log function to verify
+// if the log is a valid ERC20 transfer log
 func TestIsValidERC20Log(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1278,6 +1280,8 @@ func TestIsValidERC20Log(t *testing.T) {
 	}
 }
 
+// TestIsValidERC721Log tests the isValidERC721Log function to verify
+// if the log is a valid ERC721 transfer log
 func TestIsValidERC721Log(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1344,6 +1348,8 @@ func TestIsValidERC721Log(t *testing.T) {
 	}
 }
 
+// TestIsValidERC1155Log tests the isValidERC1155Log function to verify
+// if the log is a valid ERC1155 transfer log
 func TestIsValidERC1155Log(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1446,6 +1452,8 @@ func TestIsValidERC1155Log(t *testing.T) {
 	}
 }
 
+// TestIsValidItx tests the isValidItx function to verify
+// if the internal transactions are valid and can be indexed
 func TestIsValidItx(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1496,6 +1504,8 @@ func TestIsValidItx(t *testing.T) {
 	}
 }
 
+// TestGetLogTopics tests the getLogTopics function to verify
+// if the function correctly extracts the topics from the log
 func TestGetLogTopics(t *testing.T) {
 	topic1 := "0x1234"
 	topic2 := "0x2345"
@@ -1544,6 +1554,8 @@ func TestGetLogTopics(t *testing.T) {
 	}
 }
 
+// TestGetTxRecipient tests the getTxRecipient function to verify
+// if the function correctly extracts the recipients from the transaction
 func TestGetTxRecipient(t *testing.T) {
 	tests := []struct {
 		name               string
@@ -1592,6 +1604,8 @@ func TestGetTxRecipient(t *testing.T) {
 	}
 }
 
+// TestGetTokenID tests the getTokenID function to verify
+// if the function correctly extracts the token ID from the transfer
 func TestGetTokenID(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1624,6 +1638,8 @@ func TestGetTokenID(t *testing.T) {
 	}
 }
 
+// TestGetMethodsSignature tests the getMethodSignature function to verify
+// if the function correctly extracts the method signature from the transaction
 func TestGetMethodSignature(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1670,6 +1686,8 @@ func TestGetMethodSignature(t *testing.T) {
 	}
 }
 
+// TestGetContractAddress tests the getContractAddress function to verify
+// if the function correctly extracts the contract address from the internal transaction
 func TestGetContractAddress(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1715,6 +1733,8 @@ func TestGetContractAddress(t *testing.T) {
 	}
 }
 
+// TestGetERC20TransferValue tests getERC20TransferValue function to verify
+// if the function correctly extracts the ERC20 transfer value from the ERC20 transfer contract
 func TestGetERC20TransferValue(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1747,6 +1767,8 @@ func TestGetERC20TransferValue(t *testing.T) {
 	}
 }
 
+// TestGetERC1155TransferIDs tests getERC1155TransferIDs function to verify
+// if the function correctly extracts the ERC1155 transfer IDs from the ID list
 func TestGetERC1155TransferIDs(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1797,6 +1819,8 @@ func TestGetERC1155TransferIDs(t *testing.T) {
 	}
 }
 
+// TestGetERC1155TransferValues tests getERC1155TransferValues function to verify
+// if the function correctly extracts the ERC1155 transfer values from the value list
 func TestGetERC1155TransferValues(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1847,6 +1871,8 @@ func TestGetERC1155TransferValues(t *testing.T) {
 	}
 }
 
+// TestUpdateITxStatus tests the updateITxStatus function to verify
+// if the function correctly updates the status of the internal transaction
 func TestUpdateITxStatus(t *testing.T) {
 	tests := []struct {
 		name             string
@@ -1921,6 +1947,8 @@ func TestUpdateITxStatus(t *testing.T) {
 	}
 }
 
+// TestCalculateTxFee tests the calculateTxFee function to verify
+// if the function correctly calculates the transaction fee
 func TestCalculateTxFee(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -1960,6 +1988,8 @@ func TestCalculateTxFee(t *testing.T) {
 	}
 }
 
+// TestCalculateMevFromBlock tests the calculateMevFromBlock function to verify
+// if the function correctly calculates the MEV from the block
 func TestCalculateMevFromBlock(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -2014,6 +2044,8 @@ func TestCalculateMevFromBlock(t *testing.T) {
 	}
 }
 
+// TestCalculateBlockUncleReward tests the calculateBlockUncleReward function to verify
+// if the function correctly calculates the uncle reward from the block
 func TestCalculateBlockUncleReward(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -2086,6 +2118,8 @@ func TestCalculateBlockUncleReward(t *testing.T) {
 	}
 }
 
+// TestCalculateUncleReward tests the calculateUncleReward function to verify
+// if the function correctly calculates the single uncle reward
 func TestCalculateUncleReward(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -2138,6 +2172,8 @@ func TestCalculateUncleReward(t *testing.T) {
 	}
 }
 
+// TestVerifyName tests the verifyName function to verify
+// if the function correctly validates the name based on the length
 func TestVerifyName(t *testing.T) {
 	tests := []struct {
 		name     string