Skip to content

Add missing DESCRIPTION metadata across RPC methods#7199

Closed
Copilot wants to merge 2 commits into
mainfrom
copilot/add-description-to-rpc-methods
Closed

Add missing DESCRIPTION metadata across RPC methods#7199
Copilot wants to merge 2 commits into
mainfrom
copilot/add-description-to-rpc-methods

Conversation

Copilot AI commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Forest’s OpenRPC surface had many RpcMethod implementations without DESCRIPTION, which degraded generated API docs. This change fills that gap across the RPC method set, aligning with Lotus wording where possible.

  • Description coverage

    • Added const DESCRIPTION: Option<&'static str> to all RpcMethod impls that were missing it in src/rpc/methods/*.
    • Includes core namespaces (chain, state, wallet, net, auth, sync, eth, msig, etc.) and Forest/F3-specific methods.
  • Lotus alignment + fallback strategy

    • Reused Lotus OpenRPC summaries when available.
    • For methods without Lotus equivalents (Forest/F3/custom endpoints), added concise method-level descriptions using a consistent fallback pattern.
  • OpenRPC output updates

    • Updated OpenRPC snapshots to reflect the now-populated description fields for methods in v0/v1/v2 specs.
impl RpcMethod<2> for EthTraceReplayBlockTransactions {
    const NAME: &'static str = "Filecoin.EthTraceReplayBlockTransactions";
    const NAME_ALIAS: Option<&'static str> = Some("trace_replayBlockTransactions");
    const DESCRIPTION: Option<&'static str> = Some(
        "Replays all transactions in a block returning the requested traces for each transaction.",
    );
    // ...
}

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copilot AI changed the title [WIP] Add DESCRIPTION to all RPC methods Add missing DESCRIPTION metadata across RPC methods Jun 19, 2026
Copilot AI requested a review from LesnyRumcajs June 19, 2026 10:27
@LesnyRumcajs

Copy link
Copy Markdown
Member

my expectations were low, yet I was still let down

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants