docs: add example for EsploraClient with timeout configuration #359
+113
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #359 +/- ##
=======================================
Coverage 85.24% 85.24%
=======================================
Files 23 23
Lines 8230 8230
=======================================
Hits 7016 7016
Misses 1214 1214
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
AdamuAbba
reviewed
Jan 2, 2026
README.md
Outdated
|
|
||
| * [`examples/esplora_async`](https://github.com/bitcoindevkit/bdk_wallet/tree/master/examples/esplora_async) | ||
| * [`examples/esplora_blocking`](https://github.com/bitcoindevkit/bdk_wallet/tree/master/examples/esplora_blocking) | ||
| * [`examples/esplora_with_timeout`](https://github.com/bitcoindevkit/bdk_wallet/tree/master/examples/esplora_with_timeout) - Demonstrates custom timeout and retry configuration |
There was a problem hiding this comment.
I think the comment is unnecessary, and just listing the example should suffice.
Add a new example demonstrating how to configure EsploraClient with custom timeout and retry settings. This is useful for developers working with slow or unreliable network connections. The example shows: - Setting socket timeout using Builder::timeout() - Configuring max retries using Builder::max_retries() - Handling timeout-related errors gracefully Closes bitcoindevkit#260 Signed-off-by: Eeshu-Yadav <[email protected]>
Eeshu-Yadav
force-pushed
the
docs/esplora-timeout-example
branch
from
a63ddd5 to
f60708b
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds a new example demonstrating how to configure EsploraClient with custom timeout and retry settings for developers working with potentially slow or unreliable network connections.
- Adds
esplora_with_timeout.rsexample showing Builder::timeout() and Builder::max_retries() configuration - Includes comprehensive error handling with helpful tips for timeout failures
- Updates documentation to reference the new example
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| examples/esplora_with_timeout.rs | New example demonstrating EsploraClient configuration with custom timeout (30s) and retry settings (3 retries), including graceful error handling |
| README.md | Adds reference to the new esplora_with_timeout example in the blockchain data sources section |
| Cargo.toml | Registers the new example in the build configuration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AdamuAbba
approved these changes
Jan 4, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add a new example demonstrating how to configure EsploraClient with custom timeout and retry settings. This is useful for developers working with slow or unreliable network connections.
The example shows:
Closes #260
Checklists
All Submissions:
just pbefore pushingFeatures: