fix(node-api): Use the correct id in the proof endpoints routes

[calbera]

Fix the routes, from #2066

Summary by CodeRabbit

• New Features
  • Updated API endpoints for retrieving block proposer, execution number, and execution fee recipient with new path identifiers.
  • Improved clarity in route paths by replacing execution_id with timestamp_id.
• Documentation
  • Updated comments for response types to reflect the new endpoint identifiers using timestamp_id instead of execution_id.

[coderabbitai]

Walkthrough

The changes involve modifications to the RegisterRoutes function within the proof package of the node API. Specifically, the route paths for three HTTP GET requests have been updated to replace the :execution_id parameter with :timestamp_id. This alteration affects the endpoints for retrieving the block proposer, execution number, and execution fee recipient. Additionally, comments in the response types have been updated to reflect this change in identifier.

Changes

File	Change Summary
mod/node-api/handlers/proof/routes.go	Updated route paths from :execution_id to :timestamp_id for block proposer, execution number, and execution fee recipient.
mod/node-api/handlers/proof/types/response.go	Updated comments for response types to reflect the change from execution_id to timestamp_id for block proposer, execution number, and execution fee recipient.

Poem

In the land of code where rabbits play,
Paths have changed in a bright new way.
From execution to timestamp's cheer,
Hopping along, the updates are here!
With every route, we leap and bound,
In the world of APIs, joy is found! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between bcf34ac and 14a54d7.

📒 Files selected for processing (1)

• mod/node-api/handlers/proof/types/response.go (3 hunks)

🧰 Additional context used

🔇 Additional comments (4)

mod/node-api/handlers/proof/types/response.go (4)

Line range hint 30-68: Summary: Consistent updates to endpoint identifiers

The changes in this file consistently update the endpoint identifiers from execution_id to timestamp_id in the comments for all three response types. This aligns with the PR objectives and appears to be part of a larger update to standardize the API.

To ensure complete consistency across the codebase, please run the following script:

#!/bin/bash
# Description: Check for any remaining references to execution_id in proof endpoints

# Test: Search for any remaining references to execution_id in proof endpoints
rg --type go --type md --type yaml 'proof/.*\{execution_id\}'

# Test: Verify that all proof endpoints now use timestamp_id
rg --type go --type md --type yaml 'proof/.*\{timestamp_id\}'

Also, ensure that:

1. All API documentation is updated to reflect these changes.
2. Any client code or SDKs that interact with these endpoints are updated.
3. The changes are communicated to API consumers, possibly through a changelog or API version update.

---

30-30: LGTM. Verify API documentation and client code.

The update from execution_id to timestamp_id in the comment is correct and aligns with the PR objectives.

Please ensure that this change is reflected in:

1. API documentation
2. Any client code that interacts with this endpoint

Run the following script to check for any remaining references to the old endpoint:

✅ Verification successful

All references to execution_id have been successfully removed.

The update correctly replaces execution_id with timestamp_id across the codebase. No remaining references to the old endpoint were found.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining references to the old endpoint

# Test: Search for old endpoint references
rg --type go --type md --type yaml 'proof/block_proposer/\{execution_id\}'

Length of output: 734

---

68-68: LGTM. Verify API documentation and client code.

The update from execution_id to timestamp_id in the comment is correct and aligns with the PR objectives.

Please ensure that this change is reflected in:

1. API documentation
2. Any client code that interacts with this endpoint

Run the following script to check for any remaining references to the old endpoint:

✅ Verification successful

Change Verified. Please manually verify API documentation and client integrations.

The search results confirm that all references to execution_id have been updated to timestamp_id within the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining references to the old endpoint

# Test: Search for old endpoint references
rg --type go --type md --type yaml 'proof/execution_fee_recipient/\{execution_id\}'

Length of output: 734

---

50-50: LGTM. Verify API documentation and client code.

The update from execution_id to timestamp_id in the comment is correct and aligns with the PR objectives.

Please ensure that this change is reflected in:

1. API documentation
2. Any client code that interacts with this endpoint

Run the following script to check for any remaining references to the old endpoint:

✅ Verification successful

Change Verified. No remaining references to execution_id.

The update from execution_id to timestamp_id has been successfully applied across the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining references to the old endpoint

# Test: Search for old endpoint references
rg --type go --type md --type yaml 'proof/execution_number/\{execution_id\}'

Length of output: 734

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 22.23%. Comparing base (a2cce37) to head (14a54d7).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
mod/node-api/handlers/proof/routes.go	0.00%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2078   +/-   ##
=======================================
  Coverage   22.23%   22.23%           
=======================================
  Files         356      356           
  Lines       16022    16022           
  Branches       12       12           
=======================================
  Hits         3563     3563           
  Misses      12306    12306           
  Partials      153      153           

Files with missing lines	Coverage Δ
mod/node-api/handlers/proof/routes.go	0.00% <0.00%> (ø)

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between a2cce37 and bcf34ac.

📒 Files selected for processing (1)

• mod/node-api/handlers/proof/routes.go (1 hunks)

🧰 Additional context used

🔇 Additional comments (3)

mod/node-api/handlers/proof/routes.go (3)

37-47: Overall approval: Route updates look good.

The changes in this file consistently update the route paths from using :execution_id to :timestamp_id across all three relevant endpoints. This modification aligns with the PR objectives and appears to be part of a larger refactoring effort.

Summary of changes:

1. GetBlockProposer route updated
2. GetExecutionNumber route updated
3. GetExecutionFeeRecipient route updated

These changes improve the consistency of the API by using timestamp-based identifiers instead of execution-based ones.

To ensure a smooth transition, please make sure to:

1. Update all client-side code to use the new :timestamp_id parameter.
2. Modify the handler functions to process the new parameter correctly.
3. Update API documentation to reflect these changes.
4. Verify that these changes are consistent across the entire API surface.

Consider running the verification scripts provided in the individual comments to catch any potential inconsistencies or overlooked areas.

---

47-47: LGTM. Verify overall API consistency.

The change from :execution_id to :timestamp_id in this route path completes the consistent update across all three routes in this file.

To ensure overall API consistency:

1. Confirm that all related API endpoints in other files (if any) have been updated similarly.
2. Verify that the API documentation has been updated to reflect these changes across all affected endpoints.

Run the following script to check for any inconsistencies:

#!/bin/bash
# Description: Check for any inconsistencies in API route definitions

# Test: Search for any remaining 'execution_id' in route definitions. Expect: No results.
rg --type go 'Path:.*:execution_id'

# Test: Search for all routes using 'timestamp_id'. Expect: Consistent usage across all relevant routes.
rg --type go 'Path:.*:timestamp_id'

---

42-42: LGTM. Ensure handler function compatibility.

The change from :execution_id to :timestamp_id in this route path is consistent with the overall update pattern in this PR.

To ensure full compatibility:

1. Verify that the GetExecutionNumber handler function correctly processes the :timestamp_id parameter instead of :execution_id.
2. Check if any internal logic depending on execution_id needs to be updated.

Run the following script to inspect the handler function:

#!/bin/bash
# Description: Inspect the GetExecutionNumber handler function for parameter usage

# Test: Search for the GetExecutionNumber function definition and its content
ast-grep --lang go --pattern $'func ($_) GetExecutionNumber($_) {
  $$$
}'