From 90552f14f15b7feeaa801eac74f92f42c83052b5 Mon Sep 17 00:00:00 2001 From: Samuel Laferriere Date: Wed, 13 Nov 2024 20:29:07 +0400 Subject: [PATCH] docs: update providers.md to use new next method instead of old open_data (#809) --- book/src/sdk/pipeline/providers.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/book/src/sdk/pipeline/providers.md b/book/src/sdk/pipeline/providers.md index 1b47ec268..f744fe2c3 100644 --- a/book/src/sdk/pipeline/providers.md +++ b/book/src/sdk/pipeline/providers.md @@ -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; @@ -83,7 +83,7 @@ pub struct ExampleAvail { impl DataAvailabilityProvider for ExampleAvail { type Item = Bytes; - async fn open_data(&self, block_ref: &BlockInfo) -> PipelineResult { + async fn next(&self, block_ref: &BlockInfo) -> PipelineResult { todo!("return an AsyncIterator implementation here") } } @@ -93,7 +93,7 @@ impl DataAvailabilityProvider for ExampleAvail { [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