Skip to content

chore: fix inconsistent method name in retryWithBackoffOnPayloadStatus comment #2889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julienrbrt merged 1 commit into from
Nov 27, 2025
Merged

chore: fix inconsistent method name in retryWithBackoffOnPayloadStatus comment #2889

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion execution/evm/execution.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ func validatePayloadStatus(status engine.PayloadStatusV1) error {
}
}

// retryWithBackoff executes a function with exponential backoff retry logic.
// retryWithBackoffOnPayloadStatus executes a function with exponential backoff retry logic.
// It implements the Engine API specification's recommendation to retry SYNCING
// status with exponential backoff. The function:
Comment on lines +70 to 72
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Since you're updating this comment, this is a good opportunity to also clarify the behavior of the maxRetries parameter. The term 'retries' can be ambiguous (e.g., total attempts vs. attempts after the first). Explicitly stating that it represents the total number of attempts improves clarity and prevents potential misuse.

Suggested change
// retryWithBackoffOnPayloadStatus executes a function with exponential backoff retry logic.
// It implements the Engine API specification's recommendation to retry SYNCING
// status with exponential backoff. The function:
// retryWithBackoffOnPayloadStatus executes a function with exponential backoff, retrying
// up to maxRetries times. It is designed to handle transient errors like the
// Engine API's SYNCING status. The function:

// - Retries only on ErrPayloadSyncing (transient failures)
Expand Down
Loading