refactor(rpc): make RpcMethod DESCRIPTION mandatory

[0xDevNinja]

Summary of changes

Now that all RPC methods provide a DESCRIPTION (#6460 / #7209), this makes the constant mandatory so the documentation stays up to date going forward.

Changes introduced in this pull request:

• Changed RpcMethod::DESCRIPTION from Option<&'static str> (defaulting to None) to a required const DESCRIPTION: &'static str. Any new method that forgets a description now fails to compile.
• Converted the existing Some("...") values across all method impls to the bare string literals.
• Updated the single consumption site in the OpenRPC reflection to wrap the value in Some(...). The generated spec is unchanged.

Reference issue to close (if applicable)

Closes#7210

Other information and links

Every method already set a description, so this is a mechanical change plus the trait tweak. The OpenRPC snapshot tests (openrpc_v0/v1/v2) pass unchanged, confirming the generated spec is identical.

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.

Outside contributions

• I have read and agree to the CONTRIBUTING document.
• I have read and agree to the AI Policy document. I understand that failure to comply with the guidelines will lead to rejection of the pull request.

Summary by CodeRabbit

• Refactor
  • Simplified RPC method metadata so descriptions are now always defined as plain text values.
  • Improved consistency across many RPC endpoints, including wallet, chain, state, network, sync, gas, miner, and auth methods.
  • OpenRPC output now includes method descriptions more reliably, making API documentation clearer and more complete.

[coderabbitai]

Walkthrough

The RpcMethod trait's DESCRIPTION associated constant is changed from Option<&'static str> (defaulting to None) to a required &'static str, and the corresponding OpenRPC generation logic is updated. Every RpcMethod implementation across the RPC method files is updated to match this new required, non-optional constant type.

Changes

RPC DESCRIPTION constant type change

Layer / File(s)	Summary
Trait contract update src/rpc/reflect/mod.rs	RpcMethod::DESCRIPTION changes from Option<&'static str> = None to a required &'static str; openrpc() now always wraps it via Some(Self::DESCRIPTION.into()).
Auth, beacon, common, node, misc methods src/rpc/methods/auth.rs, beacon.rs, common.rs, node.rs, misc.rs	DESCRIPTION constants updated to plain &'static str for AuthNew, AuthVerify, BeaconGetEntry, Session, Version, Shutdown, StartTime, NodeStatus, GetActorEventsRaw.
Chain methods src/rpc/methods/chain.rs	DESCRIPTION updated across ~28 chain-related RPC methods (tipset/block/export/message queries).
Eth methods src/rpc/methods/eth.rs	DESCRIPTION updated across many Ethereum-compatible RPC methods (blocks, gas, filters, subscriptions, tracing).
F3 methods src/rpc/methods/f3.rs	DESCRIPTION updated across ~22 F3 consensus RPC methods.
Gas, market, miner, mpool, msig methods src/rpc/methods/gas.rs, market.rs, miner.rs, mpool.rs, msig.rs	DESCRIPTION updated across gas estimation, market, miner, mempool, and multisig RPC methods.
Net methods src/rpc/methods/net.rs	DESCRIPTION updated across ~14 networking RPC methods.
State methods src/rpc/methods/state.rs	DESCRIPTION updated across a large set of state query RPC methods (actors, sectors, receipts, allocations, randomness, market participants).
Sync and wallet methods src/rpc/methods/sync.rs, wallet.rs	DESCRIPTION updated across sync status/block methods and wallet management RPC methods.

Estimated code review effort: 2 (Simple) | ~12 minutes

Possibly related issues

• Add DESCRIPTION to all RPC methods #6460: Refines the same DESCRIPTION field/type for RPC methods that this PR makes mandatory.

Possibly related PRs

• ChainSafe/forest#7202: Both PRs modify DESCRIPTION for RPC methods in src/rpc/methods/eth.rs.
• ChainSafe/forest#7204: Both PRs modify DESCRIPTION constants for state RPC methods in src/rpc/methods/state.rs.
• ChainSafe/forest#7207: Both PRs touch DESCRIPTION constants for chain RPC methods in src/rpc/methods/chain.rs.

Suggested labels:RPC

Suggested reviewers:hanabi1224

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: making RpcMethod DESCRIPTION mandatory.
Linked Issues check	✅ Passed	The PR satisfies #7210 by changing DESCRIPTION from optional to required and updating implementations accordingly.
Out of Scope Changes check	✅ Passed	All changes are scoped to the DESCRIPTION-mandatory refactor and supporting reflection updates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

✨ Simplify code

• Create PR with simplified code

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/rpc/methods/eth.rs`:
- Around line 2295-2297: The DESCRIPTION string in the storage-at-position RPC
method is unintentionally embedding a newline and indentation, which will be
included in the OpenRPC output. Update the DESCRIPTION constant in the eth.rs
method definition to use a single-line literal or explicit
concatenation/continuation so the value is clean and does not contain hidden
whitespace.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: e5aec9f2-f023-40b3-9db7-71873d889e1b

📥 Commits

Reviewing files that changed from the base of the PR and between 2d4846f and 603f93e.

📒 Files selected for processing (18)

• src/rpc/methods/auth.rs
• src/rpc/methods/beacon.rs
• src/rpc/methods/chain.rs
• src/rpc/methods/common.rs
• src/rpc/methods/eth.rs
• src/rpc/methods/f3.rs
• src/rpc/methods/gas.rs
• src/rpc/methods/market.rs
• src/rpc/methods/miner.rs
• src/rpc/methods/misc.rs
• src/rpc/methods/mpool.rs
• src/rpc/methods/msig.rs
• src/rpc/methods/net.rs
• src/rpc/methods/node.rs
• src/rpc/methods/state.rs
• src/rpc/methods/sync.rs
• src/rpc/methods/wallet.rs
• src/rpc/reflect/mod.rs

🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

• filecoin-project/lotus(manual)

[LesnyRumcajs]

LGTM, thanks!