Document --network

foundry-rs · Jan 16, 2025 · 1f8960f · 1f8960f
1 parent faf9a1b
commit 1f8960f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/crates/sncast/src/helpers/rpc.rs b/crates/sncast/src/helpers/rpc.rs
@@ -14,7 +14,7 @@ pub struct RpcArgs {
     #[clap(short, long)]
     pub url: Option<String>,
 
-    /// Use predefined network using public provider
+    /// Use predefined network using public provider. When using this option you may experience rate limits and other unexpected behavior
     #[clap(long)]
     pub network: Option<Network>,
 }

diff --git a/docs/src/starknet/sncast-overview.md b/docs/src/starknet/sncast-overview.md
@@ -53,6 +53,13 @@ response: [0x0, 0x0, 0x43686172697a617264, 0x9, 0x0, 0x0, 0x41a78e741e5af2fec34b
 > 📝 **Note**
 > In the above example we supply `sncast` with `--account` and `--network` flags. If `snfoundry.toml` is present, and have these properties set, values provided using these flags will override values from `snfoundry.toml`. Learn more about `snfoundry.toml` configuration [here](../projects/configuration.md#sncast).
 
+### Network and RPC Providers
+
+When providing `--network` flag, `sncast` will randomly select on of the free RPC providers.
+When using free provider you may experience rate limits and other unexpected behavior.
+
+If using `sncast` extensively, we recommend getting access to a dedicated RPC node and providing its URL to sncast with
+`--url` flag.
 
 ### Arguments