Struct ChannelBank

pub struct ChannelBank<P>
where
    P: NextFrameProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug,
{ /* private fields */ }

ChannelBank is a stateful stage that does the following:

1. Unmarshalls frames from L1 transaction data
2. Applies those frames to a channel
3. Attempts to read from the channel when it is ready
4. Prunes channels (not frames) when the channel bank is too large.

Note: we prune before we ingest data. As we switch between ingesting data & reading, the prune step occurs at an odd point Specifically, the channel bank is not allowed to become too large between successive calls to IngestData. This means that we can do an ingest and then do a read while becoming too large. ChannelBank buffers channel frames, and emits full channel data

Implementations

impl<P> ChannelBank<P>

where P: NextFrameProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug,

pub fn new(cfg: Arc<RollupConfig>, prev: P) -> ChannelBank<P>

Create a new ChannelBank stage.

pub fn size(&self) -> usize

Returns the size of the channel bank by accumulating over all channels.

pub fn prune(&mut self) -> Result<(), PipelineErrorKind>

Prunes the Channel bank, until it is below the max channel bank size. Prunes from the high-priority channel since it failed to be read.

pub fn ingest_frame(&mut self, frame: Frame) -> Result<(), PipelineErrorKind>

Adds new L1 data to the channel bank. Should only be called after all data has been read.

pub fn read(&mut self) -> Result<Option<Bytes>, PipelineErrorKind>

Read the raw data of the first channel, if it’s timed-out or closed.

Returns an error if there is nothing new to read.

Trait Implementations

impl<P> ChannelReaderProvider for ChannelBank<P>

where P: NextFrameProvider + OriginAdvancer + OriginProvider + SignalReceiver + Send + Debug,

fn next_data<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Option<Bytes>, PipelineErrorKind>> + Send + 'async_trait>>

where 'life0: 'async_trait, ChannelBank<P>: 'async_trait,

Pulls the next piece of data from the channel bank. Note that it attempts to pull data out of the channel bank prior to loading data in (unlike most other stages). This is to ensure maintain consistency around channel bank pruning which depends upon the order of operations.

impl<P> Debug for ChannelBank<P>

where P: Debug + NextFrameProvider + OriginAdvancer + OriginProvider + SignalReceiver,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<P> OriginAdvancer for ChannelBank<P>

where P: NextFrameProvider + OriginAdvancer + OriginProvider + SignalReceiver + Send + Debug,

fn advance_origin<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), PipelineErrorKind>> + Send + 'async_trait>>

where 'life0: 'async_trait, ChannelBank<P>: 'async_trait,

Advances the internal state of the lowest stage to the next l1 origin. This method is the equivalent of the reference implementation advance_l1_block.

impl<P> OriginProvider for ChannelBank<P>

where P: NextFrameProvider + OriginAdvancer + OriginProvider + SignalReceiver + Debug,

fn origin(&self) -> Option<BlockInfo>

Returns the optional L1 BlockInfo origin.

impl<P> SignalReceiver for ChannelBank<P>

where P: NextFrameProvider + OriginAdvancer + OriginProvider + SignalReceiver + Send + Debug,

fn signal<'life0, 'async_trait>( &'life0 mut self, signal: Signal, ) -> Pin<Box<dyn Future<Output = Result<(), PipelineErrorKind>> + Send + 'async_trait>>

where 'life0: 'async_trait, ChannelBank<P>: 'async_trait,

Receives a signal from the driver.