Skip to content

feat(iroh-relay): expose Bucket rate-limit primitive#4231

Open
veeso wants to merge 1 commit inton0-computer:mainfrom
holochain:feat/expose-bucket
Open

feat(iroh-relay): expose Bucket rate-limit primitive#4231
veeso wants to merge 1 commit inton0-computer:mainfrom
holochain:feat/expose-bucket

Conversation

@veeso
Copy link
Copy Markdown

@veeso veeso commented May 5, 2026

Description

Embedders that mount the relay protocol via custom HTTP servers (e.g. axum integration in holochain/kitsune2) cannot use the existing RateLimited<S: AsyncRead> wrapper because their stream layer is already WS-framed by the time the relay handler runs. Exposing Bucket lets these embedders apply Iroh's bucket semantics at the frame layer.

Visibility-only change: Bucket struct, Bucket::new, and Bucket::consume become pub. Fields stay private. InvalidBucketConfig was already pub. Adds rustdocs to satisfy deny(missing_docs).

No behavior change.

Breaking Changes

No, just promoting visibility.

Notes & open questions

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.

Embedders that mount the relay protocol via custom HTTP servers
(e.g. axum integration in holochain/kitsune2) cannot use the existing
RateLimited<S: AsyncRead> wrapper because their stream layer is already
WS-framed by the time the relay handler runs. Exposing Bucket lets these
embedders apply iroh's bucket semantics at the frame layer.

Visibility-only change: Bucket struct, Bucket::new and Bucket::consume
become pub. Fields stay private. InvalidBucketConfig was already pub.
Adds rustdocs to satisfy deny(missing_docs).

No behavior change.
@veeso veeso force-pushed the feat/expose-bucket branch from e094320 to 3d760a9 Compare May 5, 2026 14:08
@veeso veeso marked this pull request as ready for review May 5, 2026 14:08
@dignifiedquire dignifiedquire requested a review from Frando May 5, 2026 15:26
@n0bot n0bot Bot added this to iroh May 5, 2026
@github-project-automation github-project-automation Bot moved this to 🚑 Needs Triage in iroh May 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🚑 Needs Triage

Development

Successfully merging this pull request may close these issues.

1 participant