Skip to content

chore: update quickstart to be more accurate #78

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

Open
okdistribute wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: update quickstart to be more accurate #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f8a33b
update quickstart to be more accurate
okdistribute Apr 14, 2026
d64f292
update cargo lock
okdistribute Apr 15, 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
4 changes: 2 additions & 2 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions examples/quickstart.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,29 @@ use iroh_services::Client;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
tracing_subscriber::fmt::init();

let endpoint = Endpoint::bind(presets::N0).await?;

// Wait for the endpoint to be online
endpoint.online().await;

Comment on lines +10 to +12
Copy link

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

endpoint.online().await can block indefinitely if the endpoint never establishes a relay connection (e.g., offline network). Elsewhere (e.g. src/net_diagnostics.rs) this wait is wrapped in tokio::time::timeout with a warning; consider doing the same here (or otherwise bounding the wait) so the quickstart doesn’t hang without feedback.

Copilot uses AI. Check for mistakes.
// needs IROH_SERVICES_API_SECRET set to an environment variable
// client will now push endpoint metrics to iroh-services
let client = Client::builder(&endpoint)
.api_secret_from_env()?
.name("quickstart-example")?
.build()
.await?;

// we can also ping the service just to confirm everything is working
client.ping().await?;

// keep the endpoint running so it continues pushing metrics.
// ctrl+c to exit.
println!("endpoint running. ctrl+c to exit.");
tokio::signal::ctrl_c().await?;
endpoint.close().await;

Ok(())
}
Loading