Skip to content

Commit

Permalink
docs: update providers.md to use new next method instead of old open_…
Browse files Browse the repository at this point in the history
…data (#809)
  • Loading branch information
samlaf authored Nov 13, 2024
1 parent 86a421e commit 90552f1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions book/src/sdk/pipeline/providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ let pipeline = PipelineBuilder::new()
> Notice
>
> The only required method for the [`DataAvailabilityProvider`][dap]
> trait is the [`open_data`][open-data] method.
> trait is the [`next`][next] method.
```rust
use async_trait::async_trait;
Expand All @@ -83,7 +83,7 @@ pub struct ExampleAvail {
impl DataAvailabilityProvider for ExampleAvail {
type Item = Bytes;

async fn open_data(&self, block_ref: &BlockInfo) -> PipelineResult<Self::Item> {
async fn next(&self, block_ref: &BlockInfo) -> PipelineResult<Self::Item> {
todo!("return an AsyncIterator implementation here")
}
}
Expand All @@ -93,7 +93,7 @@ impl DataAvailabilityProvider for ExampleAvail {
<!-- Links -->

[dap]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.DataAvailabilityProvider.html
[open-data]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.DataAvailabilityProvider.html#tymethod.open_data
[next]: https://docs.rs/kona-derive/latest/kona_derive/traits/trait.DataAvailabilityProvider.html#tymethod.next
[builder]: https://docs.rs/kona-derive/latest/kona_derive/pipeline/struct.PipelineBuilder.html
[alloy]: https://github.com/alloy-rs/alloy
[kda]: https://crates.io/crates/kona-derive-alloy
Expand Down

0 comments on commit 90552f1

Please sign in to comment.