Fix empty params handling in StateDecodeParams #5904

sudo-shashank · 2025-08-06T11:32:19Z

Summary of changes

Changes introduced in this pull request:

Fix mismatch between lotus and forest for methods with empty params and add missing test for all actors supported.

| RPC Method                       | Forest  | Lotus   | Status        |
|----------------------------------|---------|---------|---------------|
| Filecoin.StateDecodeParams (250) | 250/250 | 250/250 | ✅ All Passed |

Reference issue to close (if applicable)

Closes

Change checklist

I have performed a self-review of my own code,
I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
I have added tests that prove my fix is effective or that my feature works (if possible),
I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

Tests
- Expanded test coverage for state decode parameter API by adding new cases for reward, power, and system actors with empty parameters.
- Added corresponding new snapshot entries for these tests.
Bug Fixes
- Adjusted handling of empty parameters in RPC methods to return an empty JSON object instead of a unit type, improving consistency in responses.

coderabbitai · 2025-08-06T11:32:25Z

Walkthrough

The changes update the register_actor_methods! macro to modify the closure return type for methods with empty parameters from Result<()> to Result<serde_json::Value>, returning an empty JSON object instead of unit. Additional test cases for actor methods with empty parameters are added, and corresponding test snapshots are appended.

Changes

Cohort / File(s)	Change Summary
Macro Closure Return Type Update `src/rpc/registry/methods_reg.rs`	Changes the closure in the macro for empty parameters to return `Result<serde_json::Value>` and an empty JSON object, instead of `Result<()>` and unit.
Expanded Test Coverage for Empty Params `src/tool/subcommands/api_cmd/api_compare_tests.rs`	Adds new test cases for several actor methods with empty parameters, increasing test coverage for `REWARD_ACTOR`, `POWER_ACTOR`, and `SYSTEM_ACTOR` in state decode parameter tests.
New Test Snapshots `src/tool/subcommands/api_cmd/test_snapshots.txt`	Appends eight new snapshot file entries for the added state decode parameter tests.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite as Test Suite
    participant RPC as RPC Registry
    participant Macro as register_actor_methods! Macro

    TestSuite->>RPC: Call method with empty parameters
    RPC->>Macro: Invoke closure for method
    Macro-->>RPC: Return Result<serde_json::Value> (empty JSON object)
    RPC-->>TestSuite: Return empty JSON object as result

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

feat: add support for system actor in state decode params API #5861: Directly related to handling empty parameters and system actor support in the same macro and method registry code.
feat: add support for power actor methods in StateDecodeParams API #5875: Related through changes to the macro handling empty parameters and version-aware registration for power actor methods.
feat: add support for reward actor in state decode params API #5888: Related via macro changes and reward actor method registrations and tests using the updated macro.

Suggested reviewers

LesnyRumcajs
hanabi1224

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0d7686c and 8d037f1.

📒 Files selected for processing (2)

src/rpc/registry/methods_reg.rs (1 hunks)
src/tool/subcommands/api_cmd/test_snapshots.txt (1 hunks)

✅ Files skipped from review due to trivial changes (1)

src/rpc/registry/methods_reg.rs

🚧 Files skipped from review as they are similar to previous changes (1)

src/tool/subcommands/api_cmd/test_snapshots.txt

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)

GitHub Check: Build forest binaries on Linux AMD64
GitHub Check: Build MacOS
GitHub Check: cargo-publish-dry-run
GitHub Check: Build Ubuntu
GitHub Check: tests-release
GitHub Check: All lint checks
GitHub Check: tests
GitHub Check: Analyze (rust)
GitHub Check: Analyze (go)

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch shashank/fix-statedecodeparams

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
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 explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this 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.

src/tool/subcommands/api_cmd/test_snapshots.txt

src/rpc/registry/methods_reg.rs

src/tool/subcommands/api_cmd/test_snapshots.txt

sudo-shashank added 2 commits August 6, 2025 16:29

fix empty param in actor reg

1cc9b41

add test snapshots

0d7686c

sudo-shashank added the RPC requires calibnet RPC checks to run on CI label Aug 6, 2025

sudo-shashank closed this Aug 6, 2025

sudo-shashank reopened this Aug 6, 2025

sudo-shashank marked this pull request as ready for review August 6, 2025 12:33

sudo-shashank requested a review from a team as a code owner August 6, 2025 12:33

sudo-shashank requested review from akaladarshi and elmattic and removed request for a team August 6, 2025 12:33

akaladarshi reviewed Aug 6, 2025

View reviewed changes

src/tool/subcommands/api_cmd/test_snapshots.txt Outdated Show resolved Hide resolved

elmattic reviewed Aug 6, 2025

View reviewed changes

src/rpc/registry/methods_reg.rs Outdated Show resolved Hide resolved

elmattic suggested changes Aug 6, 2025

View reviewed changes

src/tool/subcommands/api_cmd/test_snapshots.txt Outdated Show resolved Hide resolved

sudo-shashank and others added 2 commits August 6, 2025 19:20

correct test snapshot names

8d037f1

Merge branch 'main' into shashank/fix-statedecodeparams

5350748

akaladarshi mentioned this pull request Aug 6, 2025

feat: add support for verified reg actor in state decode params #5896

Merged

4 tasks

Merge branch 'main' into shashank/fix-statedecodeparams

f98f5a6

sudo-shashank requested a review from elmattic August 6, 2025 14:44

Merge branch 'main' into shashank/fix-statedecodeparams

061af2a

sudo-shashank requested a review from akaladarshi August 7, 2025 12:34

akaladarshi approved these changes Aug 7, 2025

View reviewed changes

elmattic approved these changes Aug 7, 2025

View reviewed changes

elmattic added this pull request to the merge queue Aug 7, 2025

Merged via the queue into main with commit 5a107e9 Aug 7, 2025
43 checks passed

elmattic deleted the shashank/fix-statedecodeparams branch August 7, 2025 14:25

sudo-shashank added a commit that referenced this pull request Aug 11, 2025

Fix empty params handling in StateDecodeParams (#5904)

3de03c4

This was referenced Aug 11, 2025

Add support for cron actor in StateDecodeParams API #5804

Merged

Add support for datacap actor in state decode params API #5871

Merged

This was referenced Aug 13, 2025

test: refactor rpc_regression_tests into individual tests #5930

Merged

feat: add support for miner actor in state decode params API #5923

Merged

Add support for evm actor in state decode params API #5928

Merged

This was referenced Aug 25, 2025

feat: add support for eam actor in state decode params API #5994

Merged

feat: add support for ethaccount actor in state decode params API #5995

Merged

coderabbitai bot mentioned this pull request Sep 2, 2025

feat: add support for payment channel actor in state decode params API #5996

Merged

4 tasks

coderabbitai bot mentioned this pull request Sep 10, 2025

Add support for market actor in StateDecodeParams API #5933

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix empty params handling in StateDecodeParams #5904

Fix empty params handling in StateDecodeParams #5904

Uh oh!

sudo-shashank commented Aug 6, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 6, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Fix empty params handling in StateDecodeParams #5904

Fix empty params handling in StateDecodeParams #5904

Uh oh!

Conversation

sudo-shashank commented Aug 6, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Reference issue to close (if applicable)

Other information and links

Change checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sudo-shashank commented Aug 6, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 6, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)