Skip to content

Update code block attributes in README documentation #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JonoPrest merged 2 commits into from
Mar 26, 2026
Merged

Update code block attributes in README documentation #124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a9442b
Fix broken doctests in README.md
JonoPrest Mar 26, 2026
162204d
Make network examples snippet real compiling code
JonoPrest Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export ENVIO_API_TOKEN="your-token-here"

Query ERC-20 Transfer events from USDC on Ethereum mainnet:

```rust
```rust,no_run
use hypersync_client::{Client, net_types::{Query, LogFilter, LogField}, StreamConfig};

#[tokio::main]
Expand Down Expand Up @@ -108,15 +108,22 @@ See the [examples directory](./examples) for more usage patterns including walle

Change the `chain_id` (or use `url`) to connect to any supported network:

```rust
```rust,no_run
use hypersync_client::Client;

# fn main() -> anyhow::Result<()> {
let api_token = std::env::var("ENVIO_API_TOKEN")?;

// Arbitrum
Client::builder().chain_id(42161).api_token(...).build()?;
Client::builder().chain_id(42161).api_token(&api_token).build()?;

// Base
Client::builder().chain_id(8453).api_token(...).build()?;
Client::builder().chain_id(8453).api_token(&api_token).build()?;

// Or use the URL directly
Client::builder().url("https://eth.hypersync.xyz").api_token(...).build()?;
Client::builder().url("https://eth.hypersync.xyz").api_token(&api_token).build()?;
# Ok(())
# }
```

See the full list of [supported networks and URLs](https://docs.envio.dev/docs/HyperSync/hypersync-supported-networks).
Expand Down
Loading