Add a `cast rpc` method for raw JSON-RPC reqs #2030

jpopesculian · 2022-06-20T13:10:40Z

Motivation

Cast doesn't have any way to interact with non-standard RPC endpoints. The main use case here would be something like anvil_mine

Solution

Implement a cast request subcommand to send raw JSON-RPC requests.

cast-request 
Perform a raw JSON-RPC request

USAGE:
    cast request [OPTIONS] <METHOD> [PARAMS]...

ARGS:
    <METHOD>
            RPC method name

    <PARAMS>...
            RPC parameters
            
            Parameters are interpreted as strings. If you wish to pass a JSON value you can prepend
            the value with a ':'. To start a string with a ':' prepend with '::'. For example:
            
            request doThing 123   => {"method": "doThing", "params": ["123"] ... }
            request doThing :123  => {"method": "doThing", "params": [123] ... }
            request doThing ::123 => {"method": "doThing", "params": [":123"] ... }

OPTIONS:
    -h, --help
            Print help information

    -r, --rpc-url <URL>
            [env: ETH_RPC_URL=]

For example running anvil_mine for 100 blocks would be as simple as cast rq anvil_mine :100. Of course, I think there can be some discussion about incorporating the anvil commands directly into cast as a subcommand tree itself.

mattsse

this is a great command.

a cast integration test for this would be nice

cli/src/opts/cast.rs

mds1 · 2022-06-20T13:56:23Z

cli/src/cast.rs

@@ -680,6 +680,25 @@ async fn main() -> eyre::Result<()> {
            generate(shell, &mut Opts::command(), "cast", &mut std::io::stdout())
        }
        Subcommands::Run(cmd) => cmd.run()?,
+        Subcommands::Request { rpc_url, method, params } => {


Do want to call this cast rpc instead to match seth rpc?

ah nice! haha I was debating which to call it actually but I didn't realize the matching here...

jpopesculian · 2022-06-20T16:31:10Z

Okay @mattsse I fixed it up per our convo and it now looks like this

cast-rpc 
Perform a raw JSON-RPC request

USAGE:
    cast rpc [OPTIONS] <METHOD> [PARAMS]...

ARGS:
    <METHOD>
            RPC method name

    <PARAMS>...
            RPC parameters
            
            Parameters are interpreted as JSON and then fall back to string. For example:
            
            rpc eth_getBlockByNumber 0x123 false
                => {"method": "eth_getBlockByNumber", "params": ["0x123", false] ... }

OPTIONS:
    -d, --direct-params
            Do not put parameters in an array
            
            If --direct-params is passed the first PARAM will be taken as the value of "params". For
            example:
            
            rpc --direct-params eth_getBlockByNumber '["0x123", false]'
                => {"method": "eth_getBlockByNumber", "params": ["0x123", false] ... }

    -h, --help
            Print help information

    -r, --rpc-url <URL>
            [env: ETH_RPC_URL=]

tynes · 2022-06-20T19:56:22Z

seth uses the command seth rpc for this, would prefer to keep the name 1:1 with seth if possible for backwards compat if possible

#29 (comment)

edit: just noticed this was already called out

mattsse

nice, this is great!

a couple of smol nits :)

mattsse · 2022-06-21T19:04:35Z

cli/src/opts/cast.rs

+    Rpc {
+        #[clap(short, long, env = "ETH_RPC_URL", value_name = "URL")]
+        rpc_url: Option<String>,
+        #[clap(
+            short,
+            long,
+            help = "Do not put parameters in an array",
+            long_help = r#"Do not put parameters in an array
+
+If --direct-params is passed the first PARAM will be taken as the value of "params". For example:
+
+rpc --direct-params eth_getBlockByNumber '["0x123", false]'
+    => {"method": "eth_getBlockByNumber", "params": ["0x123", false] ... }"#
+        )]
+        direct_params: bool,
+        #[clap(value_name = "METHOD", help = "RPC method name")]
+        method: String,
+        #[clap(
+            value_name = "PARAMS",
+            help = "RPC parameters",
+            long_help = r#"RPC parameters
+
+Parameters are interpreted as JSON and then fall back to string. For example:
+
+rpc eth_getBlockByNumber 0x123 false
+    => {"method": "eth_getBlockByNumber", "params": ["0x123", false] ... }"#
+        )]
+        params: Vec<String>,
+    },


can we make this a standalone struct please and move to new cmd/cast/rpc.rs, same for the code in cast.rs?

mattsse · 2022-06-21T19:11:13Z

cli/src/opts/cast.rs

+            help = "Do not put parameters in an array",
+            long_help = r#"Do not put parameters in an array
+
+If --direct-params is passed the first PARAM will be taken as the value of "params". For example:


hmm not sure about the naming yet, maybe --raw would be an alternative?

Also, I would like to change the position in the example and move it after the array so that it is better distinguished from the example of the "params" field.

mattsse · 2022-06-21T19:18:09Z

cli/src/cast.rs

+                    eyre::bail!(r#"Expected exactly one argument for "params""#);
+                }
+                let param = params.into_iter().next().unwrap();
+                serde_json::from_str(&param).unwrap_or(serde_json::Value::String(param))


nit: turn into local closure/fn, maybe let to_value = |param:&str| ...;

mattsse · 2022-06-21T19:19:45Z

cli/src/opts/cast.rs

+        #[clap(
+            short,
+            long,
+            help = "Do not put parameters in an array",


maybe something like: Pass the "params" as is

mattsse · 2022-06-21T19:20:35Z

cli/src/opts/cast.rs

+        rpc_url: Option<String>,
+        #[clap(
+            short,
+            long,


I believe we can try adding requires = params here

Signed-off-by: Julian Popescu <[email protected]>

Fix and add tests as well Signed-off-by: Julian Popescu <[email protected]>

Params are parsed as a JSON first and fallback to string. In addition --direct-params was added to handle non-array params Signed-off-by: Julian Popescu <[email protected]>

And add stdin parsing Signed-off-by: Julian Popescu <[email protected]>

Signed-off-by: Julian Popescu <[email protected]>

mattsse

lgtm,

good to merge?

mattsse · 2022-06-22T12:27:11Z

cli/test-utils/src/util.rs

+    pub fn stdin(&mut self, fun: impl FnOnce(process::ChildStdin) + 'static) -> &mut TestCommand {
+        self.stdin_fun = Some(Box::new(fun));
+        self
+    }


this is quite neat!

mattsse reviewed Jun 20, 2022

View reviewed changes

cli/src/opts/cast.rs Outdated Show resolved Hide resolved

mattsse added T-feature Type: feature C-cast Command: cast labels Jun 20, 2022

mds1 reviewed Jun 20, 2022

View reviewed changes

jpopesculian changed the title ~~Add a request method to cast for raw JSON-RPC reqs~~ Add a cast rpc method to cast for raw JSON-RPC reqs Jun 21, 2022

jpopesculian changed the title ~~Add a cast rpc method to cast for raw JSON-RPC reqs~~ Add a cast rpc method for raw JSON-RPC reqs Jun 21, 2022

jpopesculian force-pushed the cast-rpc branch from a72a3a1 to 1d293f8 Compare June 21, 2022 09:12

jpopesculian requested a review from mattsse June 21, 2022 12:00

mattsse requested changes Jun 21, 2022

View reviewed changes

jpopesculian added 4 commits June 22, 2022 13:43

Add a request method to cast for raw JSON-RPC reqs

f792815

Signed-off-by: Julian Popescu <[email protected]>

Change name from cast request to cast rpc

a505f66

Fix and add tests as well Signed-off-by: Julian Popescu <[email protected]>

Change how params are parsed in cast rpc

4fb22a7

Params are parsed as a JSON first and fallback to string. In addition --direct-params was added to handle non-array params Signed-off-by: Julian Popescu <[email protected]>

Put cast rpc implementation into its own file

8159b09

And add stdin parsing Signed-off-by: Julian Popescu <[email protected]>

jpopesculian force-pushed the cast-rpc branch from 11892fe to 8159b09 Compare June 22, 2022 11:43

Better handling of raw parameters for cast rpc

8b88c23

Signed-off-by: Julian Popescu <[email protected]>

mattsse approved these changes Jun 22, 2022

View reviewed changes

gakonst approved these changes Jun 23, 2022

View reviewed changes

gakonst merged commit d89f6af into foundry-rs:master Jun 23, 2022

onbjerg mentioned this pull request Jun 24, 2022

Document cast rpc foundry-rs/book#400

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a `cast rpc` method for raw JSON-RPC reqs #2030

Add a `cast rpc` method for raw JSON-RPC reqs #2030

jpopesculian commented Jun 20, 2022

mattsse left a comment •

edited

Loading

mds1 Jun 20, 2022

jpopesculian Jun 20, 2022

jpopesculian commented Jun 20, 2022

tynes commented Jun 20, 2022 •

edited

Loading

mattsse left a comment

mattsse Jun 21, 2022

mattsse Jun 21, 2022

mattsse Jun 21, 2022

mattsse Jun 21, 2022

mattsse Jun 21, 2022

mattsse left a comment

mattsse Jun 22, 2022

Add a cast rpc method for raw JSON-RPC reqs #2030

Add a cast rpc method for raw JSON-RPC reqs #2030

Conversation

jpopesculian commented Jun 20, 2022

Motivation

Solution

mattsse left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jpopesculian commented Jun 20, 2022

tynes commented Jun 20, 2022 • edited Loading

mattsse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattsse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add a `cast rpc` method for raw JSON-RPC reqs #2030

Add a `cast rpc` method for raw JSON-RPC reqs #2030

mattsse left a comment •

edited

Loading

tynes commented Jun 20, 2022 •

edited

Loading