rust-esplora-client icon indicating copy to clipboard operation
rust-esplora-client copied to clipboard

feat: add new `AsyncAnonymizedClient` using `arti-hyper`

Open oleonardolima opened this issue 1 year ago • 5 comments

  • add new async client, AsyncAnonymizedClient, that uses arti-hyper, and arti-client to connect and do requests over the Tor network.

fixes #61

Summary by CodeRabbit

  • New Features
    • Added support for asynchronous operations in AsyncClient with multiple HTTP clients.
    • Introduced AsyncAnonymizedClient for anonymized requests using Tor.
    • Expanded esplora_client library for anonymized asynchronous communication over Tor.
  • Chores
    • Updated dependencies including Tor-related and async utilities.
    • Adjusted test configurations for Rust projects and modified cache key generation in CI workflow.

oleonardolima avatar Dec 08 '23 16:12 oleonardolima

Please rebase to pick up changes in #69 that fix CI.

notmandatory avatar Dec 29 '23 15:12 notmandatory

Most of the implementation is done, and it currently works on rust 1.70, also good to review and get inputs from it's being done.

But it does not work with our current MSRV, how do you usually go forward? just pin some of the dependencies?

cc @notmandatory @vladimirfomene

oleonardolima avatar Jan 15 '24 15:01 oleonardolima

Pull Request Test Coverage Report for Build 10686027379

Details

  • 106 of 408 (25.98%) changed or added relevant lines in 4 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage decreased (-16.3%) to 71.198%

Changes Missing Coverage Covered Lines Changed/Added Lines %
examples/tor.rs 0 16 0.0%
src/async.rs 104 123 84.55%
src/async_tor.rs 0 267 0.0%
<!-- Total: 106 408
Files with Coverage Reduction New Missed Lines %
src/lib.rs 1 97.08%
<!-- Total: 1
Totals Coverage Status
Change from base Build 10514244019: -16.3%
Covered Lines: 1016
Relevant Lines: 1427

💛 - Coveralls

coveralls avatar Jan 26 '24 23:01 coveralls

@oleonardolima can your rebase and rework this now that #75 is merged? hopefully not too big a change.

notmandatory avatar Mar 06 '24 05:03 notmandatory

Walkthrough

This update introduces Tor support to the rust-esplora-client and rust-electrum-client by integrating arti-hyper, enhancing privacy and anonymity features. It includes adjustments to continuous integration workflows and expands the library's capabilities with asynchronous operations and Tor communication via new feature flags and client structures.

Changes

Files Change Summary
.github/workflows/... Adjusted workflow configuration for Rust projects, including cache, toolchain setup, and testing.
src/async.rs Extended AsyncClient to support asynchronous operations with Tor integration.
src/lib.rs Expanded library to support anonymized async client with arti-hyper for Tor communication.

Assessment against linked issues

Objective Addressed Explanation
Add Tor support using arti-hyper with feature async-arti-hyper (#61)
Utilize Arti features for HTTP-based requests integration, aligning with async streams (#61)
Introduce async-arti-hyper feature flag for Tor support, maintaining compatibility with existing APIs (#61)
Align implementation with existing APIs and usage patterns of rust-esplora-client (#61)
Consider a long-term strategy for support of different transport layers using a consistent API approach (#61) It's unclear if a long-term strategy for transport layer support has been explicitly outlined.

This assessment concludes that the primary objectives have been largely met, with potential ambiguity regarding the strategic planning for future transport layer integrations.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

:bangbang: IMPORTANT Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Mar 06 '24 14:03 coderabbitai[bot]