Releases/v2.1.0

[Yashk767]

Description

This is a release PR for release v2.1.0

[qodo-free-for-open-source-projects]

CI Feedback 🧐

(Feedback updated until commit c12a45a)

A test triggered by this PR failed. Here is an AI-generated analysis of the failure:

Action: test

Failed stage: Set up job [❌]

Failure summary: The action failed because it's using deprecated versions of two GitHub Actions: actions/download-artifact@v3 actions/upload-artifact@v3 These versions have been deprecated and GitHub is automatically failing workflows that use them. The workflow needs to be updated to use newer versions of these actions.

Relevant error logs: 1: ##[group]Operating System 2: Ubuntu ... 32: ##[endgroup] 33: ##[group]Download immutable action package 'actions/setup-go@v2' 34: Version: 2.2.0 35: Digest: sha256:decc21c9a7275ee14541d6c57e7999c727f6a61d50f7a0f2fb11dfb5c54506c2 36: Source commit SHA: bfdd3570ce990073878bf10f6b2d79082de49492 37: ##[endgroup] 38: Download action repository 'bissolli/gh-action-persist-workspace@v1' (SHA:d8cc100f79b61715d23f0669abedc29f81715a38) 39: Getting action download info 40: ##[error]This request has been automatically failed because it uses a deprecated version of `actions/download-artifact: v3`. Learn more: https://github.blog/changelog/2024-04-16-deprecation-notice-v3-of-the-artifact-actions/. This request has been automatically failed because it uses a deprecated version of `actions/upload-artifact: v3`. Learn more: https://github.blog/changelog/2024-04-16-deprecation-notice-v3-of-the-artifact-actions/

[qodo-free-for-open-source-projects]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Error Handling The new implementation adds error checking for GetTxnOpts and GetBestRPCClient calls, but some error handling paths might lead to unexpected behavior. For example, when errors occur in these new functions, the code often just logs the error and continues with the loop iteration. txnOpts, err := razorUtils.GetTxnOpts(rpcParameters, types.TransactionOptions{ ChainId: core.ChainId, Config: config, Account: account, }) if err != nil { log.Error(err) continue } client, err := rpcParameters.RPCManager.GetBestRPCClient() if err != nil { log.Error(err) continue } Configuration Changes The PR changes several timeout and limit values (MaxWaitTime reduced from 30 to 15, MinRPCTimeout changed from 5 to 1, MinHTTPTimeout changed from 5 to 3). These changes could affect system stability and should be validated to ensure they don't cause timeouts in production. MaxWaitTime = 15 // Maximum wait time in seconds ) waitTime, err := getConfigValue("wait", "int32", core.DefaultWaitTime, "wait") if err != nil { return core.DefaultWaitTime, err } waitTimeInt32 := waitTime.(int32) // Validate waitTime range if waitTimeInt32 < MinWaitTime || waitTimeInt32 > MaxWaitTime { log.Infof("WaitTime %d is out of the valid range (%d-%d), using default value %d", waitTimeInt32, MinWaitTime, MaxWaitTime, core.DefaultWaitTime) return core.DefaultWaitTime, nil } return waitTimeInt32, nil } //This function returns the gas price func (*UtilsStruct) GetGasPrice() (int32, error) { gasPrice, err := getConfigValue("gasprice", "int32", core.DefaultGasPrice, "gasprice") if err != nil { return core.DefaultGasPrice, err } gasPriceInt32 := gasPrice.(int32) // Validate gasPrice value if gasPriceInt32 != 0 && gasPriceInt32 != 1 { log.Infof("GasPrice %d is invalid, using default value %d", gasPriceInt32, core.DefaultGasPrice) return core.DefaultGasPrice, nil } return gasPriceInt32, nil } //This function returns the log level func (*UtilsStruct) GetLogLevel() (string, error) { logLevel, err := getConfigValue("logLevel", "string", core.DefaultLogLevel, "logLevel") if err != nil { return core.DefaultLogLevel, err } return logLevel.(string), nil } //This function returns the gas limit func (*UtilsStruct) GetGasLimit() (float32, error) { //gasLimit in the config acts as a gasLimit multiplier const ( MinGasLimit = 1.0 // Minimum gas limit MaxGasLimit = 3.0 // Maximum gas limit ) gasLimit, err := getConfigValue("gasLimit", "float32", core.DefaultGasLimit, "gasLimit") if err != nil { return core.DefaultGasLimit, err } gasLimitFloat32 := gasLimit.(float32) // Validate gasLimit range if gasLimitFloat32 < MinGasLimit || gasLimitFloat32 > MaxGasLimit { log.Warnf("GasLimit %.2f is out of the suggested range (%.1f-%.1f), using default value %.2f", gasLimitFloat32, MinGasLimit, MaxGasLimit, core.DefaultGasLimit) } return gasLimitFloat32, nil } //This function returns the gas limit to override func (*UtilsStruct) GetGasLimitOverride() (uint64, error) { const ( MinGasLimitOverride = 10000000 // Minimum gas limit override MaxGasLimitOverride = 50000000 // Maximum gas limit override ) gasLimitOverride, err := getConfigValue("gasLimitOverride", "uint64", core.DefaultGasLimitOverride, "gasLimitOverride") if err != nil { return core.DefaultGasLimitOverride, err } gasLimitOverrideUint64 := gasLimitOverride.(uint64) // Validate gasLimitOverride range if gasLimitOverrideUint64 < MinGasLimitOverride || gasLimitOverrideUint64 > MaxGasLimitOverride { log.Infof("GasLimitOverride %d is out of the valid range (%d-%d), using default value %d", gasLimitOverrideUint64, MinGasLimitOverride, MaxGasLimitOverride, core.DefaultGasLimitOverride) return core.DefaultGasLimitOverride, nil } return gasLimitOverrideUint64, nil } //This function returns the RPC timeout func (*UtilsStruct) GetRPCTimeout() (int64, error) { const ( MinRPCTimeout = 1 // Minimum RPC timeout in seconds MaxRPCTimeout = 10 // Maximum RPC timeout in seconds ) rpcTimeout, err := getConfigValue("rpcTimeout", "int64", core.DefaultRPCTimeout, "rpcTimeout") if err != nil { return core.DefaultRPCTimeout, err } rpcTimeoutInt64 := rpcTimeout.(int64) // Validate rpcTimeout range if rpcTimeoutInt64 < MinRPCTimeout || rpcTimeoutInt64 > MaxRPCTimeout { log.Infof("RPCTimeout %d is out of the valid range (%d-%d), using default value %d", rpcTimeoutInt64, MinRPCTimeout, MaxRPCTimeout, core.DefaultRPCTimeout) return core.DefaultRPCTimeout, nil } return rpcTimeoutInt64, nil } func (*UtilsStruct) GetHTTPTimeout() (int64, error) { const ( MinHTTPTimeout = 3 // Minimum HTTP timeout in seconds MaxHTTPTimeout = 8 // Maximum HTTP timeout in seconds

[qodo-free-for-open-source-projects]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Prevent nil pointer dereference The error from GetBestRPCClient() is logged but execution continues in the loop. This could lead to a nil pointer dereference when the client is used in subsequent code. Handle the error properly by returning from the function. cmd/dispute.go [98-102] client, err := rpcParameters.RPCManager.GetBestRPCClient() if err != nil { - log.Error(err) - continue + log.Error("Failed to get RPC client:", err) + return nil, err } Apply this suggestion Suggestion importance[1-10]: 9 __ Why: This suggestion correctly identifies a critical issue where a nil client could be dereferenced if GetBestRPCClient() fails. Returning the error instead of continuing prevents a potential runtime panic.	High
	Fix parameter name inconsistency The parameter name in the function signature is rpcManager but in the function body it's referred to as rpcParameters in the type assertion. This inconsistency could lead to runtime errors or unexpected behavior. utils/mocks/utils.go [228-237] -// CheckTransactionReceipt provides a mock function with given fields: rpcManager, _txHash -func (_m *Utils) CheckTransactionReceipt(rpcManager rpc.RPCParameters, _txHash string) int { - ret := _m.Called(rpcManager, _txHash) +// CheckTransactionReceipt provides a mock function with given fields: rpcParameters, _txHash +func (_m *Utils) CheckTransactionReceipt(rpcParameters rpc.RPCParameters, _txHash string) int { + ret := _m.Called(rpcParameters, _txHash) var r0 int if rf, ok := ret.Get(0).(func(rpc.RPCParameters, string) int); ok { - r0 = rf(rpcManager, _txHash) + r0 = rf(rpcParameters, _txHash) } else { r0 = ret.Get(0).(int) } return r0 } [To ensure code accuracy, apply this suggestion manually] Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies a parameter name inconsistency between the function signature and type assertion. The parameter is named 'rpcManager' in the signature but referred to as 'rpcParameters' in the type assertion, which could lead to confusion and potential errors.	Medium
General	Log error before returning The error from GetBestRPCClient() is silently ignored. This could lead to unexpected behavior as callers won't know why the function failed. Log the error before returning. cmd/dispute.go [586-590] func (*UtilsStruct) ResetDispute(rpcParameters rpc.RPCParameters, txnOpts *bind.TransactOpts, epoch uint32) { client, err := rpcParameters.RPCManager.GetBestRPCClient() if err != nil { + log.Error("Failed to get RPC client:", err) return } Apply this suggestion Suggestion importance[1-10]: 6 __ Why: The suggestion improves error handling by logging the error before returning. This makes debugging easier by providing visibility into why the ResetDispute operation failed.	Low
More