chore(cli): annotate katana rpc subcommands with their JSON-RPC method names

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Author: kariy

bin/katana/src/cli/rpc/node.rs

@@ -6,7 +6,7 @@ use super::client::Client;
 #[derive(Debug, Subcommand)]
 #[cfg_attr(test, derive(PartialEq, Eq))]
 pub enum NodeCommands {
-    /// Get node identity and build information
+    /// Get node identity and build information [node_getInfo]
     Info,
 }
 

bin/katana/src/cli/rpc/starknet.rs

@@ -16,86 +16,86 @@ use super::client::Client;
 #[derive(Debug, Subcommand)]
 #[cfg_attr(test, derive(PartialEq, Eq))]
 pub enum StarknetCommands {
-    /// Get Starknet JSON-RPC specification version
+    /// Get Starknet JSON-RPC specification version [starknet_specVersion]
     #[command(name = "spec")]
     SpecVersion,
 
-    /// Get block with full transactions
+    /// Get block with full transactions [starknet_getBlockWithTxs]
     #[command(name = "block")]
     GetBlockWithTxs(GetBlockArgs),
 
-    /// Get state update for a block
+    /// Get state update for a block [starknet_getStateUpdate]
     #[command(name = "state-update")]
     GetStateUpdate(BlockIdArgs),
 
-    /// Get storage value at address and key
+    /// Get storage value at address and key [starknet_getStorageAt]
     #[command(name = "storage")]
     GetStorageAt(GetStorageAtArgs),
 
-    /// Get transaction by hash
+    /// Get transaction by hash [starknet_getTransactionByHash]
     #[command(name = "tx")]
     GetTransactionByHash(GetTransactionArgs),
 
-    /// Get transaction by block ID and index
+    /// Get transaction by block ID and index [starknet_getTransactionByBlockIdAndIndex]
     #[command(name = "tx-by-block")]
     GetTransactionByBlockIdAndIndex(GetTransactionByBlockIdAndIndexArgs),
 
-    /// Get transaction receipt
+    /// Get transaction receipt [starknet_getTransactionReceipt]
     #[command(name = "receipt")]
     GetTransactionReceipt(TxHashArgs),
 
-    /// Get contract class definition
+    /// Get contract class definition [starknet_getClass]
     #[command(name = "class")]
     GetClass(GetClassArgs),
 
-    /// Get contract class hash at address
+    /// Get contract class hash at address [starknet_getClassHashAt]
     #[command(name = "class-at")]
     GetClassHashAt(GetClassHashAtArgs),
 
-    /// Get contract class at address
+    /// Get contract class at address [starknet_getClassAt]
     #[command(name = "code")]
     GetClassAt(GetClassAtArgs),
 
-    /// Get number of transactions in block
+    /// Get number of transactions in block [starknet_getBlockTransactionCount]
     #[command(name = "tx-count")]
     GetBlockTransactionCount(BlockIdArgs),
 
-    /// Call contract function
+    /// Call contract function [starknet_call]
     #[command(name = "call")]
     Call(CallArgs),
 
-    /// Get latest block number
+    /// Get latest block number [starknet_blockNumber]
     #[command(name = "block-number")]
     BlockNumber,
 
-    /// Get latest block hash and number
+    /// Get latest block hash and number [starknet_blockHashAndNumber]
     BlockHashAndNumber,
 
-    /// Get chain ID
+    /// Get chain ID [starknet_chainId]
     #[command(name = "id")]
     ChainId,
 
-    /// Get sync status
+    /// Get sync status [starknet_syncing]
     #[command(name = "sync")]
     Syncing,
 
-    /// Get nonce for address
+    /// Get nonce for address [starknet_getNonce]
     #[command(name = "nonce")]
     GetNonce(GetNonceArgs),
 
-    /// Get events matching filter criteria
+    /// Get events matching filter criteria [starknet_getEvents]
     #[command(name = "events")]
     GetEvents(GetEventsArgs),
 
-    /// Get transaction execution trace
+    /// Get transaction execution trace [starknet_traceTransaction]
     #[command(name = "trace")]
     TraceTransaction(TxHashArgs),
 
-    /// Get execution traces for all transactions in a block
+    /// Get execution traces for all transactions in a block [starknet_traceBlockTransactions]
     #[command(name = "block-traces")]
     TraceBlockTransactions(TraceBlockTransactionsArg),
 
-    /// Get storage proofs for classes, contracts, and storage keys
+    /// Get storage proofs for classes, contracts, and storage keys [starknet_getStorageProof]
     #[command(name = "proof")]
     GetStorageProof(GetStorageProofArgs),
 }
@@ -115,11 +115,11 @@ pub struct GetBlockArgs {
     #[arg(default_value = "latest")]
     block: BlockIdArg,
 
-    /// Return block with receipts
+    /// Return block with receipts [starknet_getBlockWithReceipts]
     #[arg(long)]
     receipts: bool,
 
-    /// Return only transaction hashes instead of full transactions
+    /// Return only transaction hashes instead of full transactions [starknet_getBlockWithTxHashes]
     #[arg(long, conflicts_with = "receipts")]
     tx_hashes_only: bool,
 }
@@ -139,7 +139,7 @@ pub struct GetTransactionArgs {
     #[arg(value_name = "TX_HASH")]
     tx_hash: TxHash,
 
-    /// Get only the transaction status instead of full transaction
+    /// Get only the transaction status instead of full transaction [starknet_getTransactionStatus]
     #[arg(long)]
     status: bool,
 }

bin/katana/src/cli/rpc/tee.rs

@@ -7,11 +7,11 @@ use super::client::Client;
 #[derive(Debug, Subcommand)]
 #[cfg_attr(test, derive(PartialEq, Eq))]
 pub enum TeeCommands {
-    /// Generate a TEE attestation quote for a block's state
+    /// Generate a TEE attestation quote for a block's state [tee_generateQuote]
     #[command(name = "generate-quote")]
     GenerateQuote(GenerateQuoteArgs),
 
-    /// Get the Merkle inclusion proof for an event
+    /// Get the Merkle inclusion proof for an event [tee_getEventProof]
     #[command(name = "event-proof")]
     EventProof(EventProofArgs),
 }

bin/katana/src/cli/rpc/txpool.rs

@@ -7,17 +7,17 @@ use super::client::Client;
 #[derive(Debug, Subcommand)]
 #[cfg_attr(test, derive(PartialEq, Eq))]
 pub enum TxpoolCommands {
-    /// Get pending and queued transaction counts
+    /// Get pending and queued transaction counts [txpool_status]
     Status,
 
-    /// Get all transactions in the pool, grouped by sender and nonce
+    /// Get all transactions in the pool, grouped by sender and nonce [txpool_content]
     Content,
 
-    /// Get pool contents filtered by sender address
+    /// Get pool contents filtered by sender address [txpool_contentFrom]
     #[command(name = "content-from")]
     ContentFrom(AddressArgs),
 
-    /// Get a human-readable summary of the pool
+    /// Get a human-readable summary of the pool [txpool_inspect]
     Inspect,
 }
 

crates/cli/src/args.rs

@@ -713,9 +713,7 @@ impl SequencerNodeArgs {
     }
 
     fn tee_config(&self) -> Option<TeeConfig> {
-        self.tee
-            .provider
-            .map(|provider_type| TeeConfig { provider_type, fork_block_number: None })
+        self.tee.provider.map(|provider_type| TeeConfig { provider_type, fork_block_number: None })
     }
 
     /// Parse the node config from the command line arguments and the config file,

crates/node/config/src/rpc.rs

@@ -166,8 +166,7 @@ impl Default for RpcModulesList {
 
 impl std::fmt::Display for RpcModulesList {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        let mut names: Vec<String> =
-            self.0.iter().map(|m| m.to_string().to_lowercase()).collect();
+        let mut names: Vec<String> = self.0.iter().map(|m| m.to_string().to_lowercase()).collect();
         names.sort();
         f.write_str(&names.join(","))
     }