Struct sov_sequencer_registry::SequencerRegistry

pub struct SequencerRegistry<C: Context> { /* private fields */ }

The sov-sequencer-registry module struct.

Implementations

impl<C: Context> SequencerRegistry<C>

pub fn get_coins_to_lock( &self, working_set: &mut WorkingSet<C::Storage> ) -> Option<Coins<C>>

Returns the configured amount of Coins to lock.

pub fn get_preferred_sequencer( &self, working_set: &mut WorkingSet<C::Storage> ) -> Option<Vec<u8>>

Returns the preferred sequencer, or None it wasn’t set.

Read about SequencerConfig::is_preferred_sequencer to learn about preferred sequencers.

pub fn is_sender_allowed<T: BasicAddress>( &self, sender: &T, working_set: &mut WorkingSet<C::Storage> ) -> bool

Checks whether sender is a registered sequencer.

Trait Implementations

impl<C: Context, B: BlobReaderTrait> ApplyBlobHooks<B> for SequencerRegistry<C>

type Context = C

type BlobResult = SequencerOutcome

fn begin_blob_hook( &self, blob: &mut B, working_set: &mut WorkingSet<<Self::Context as Spec>::Storage> ) -> Result<()>

Runs at the beginning of apply_blob, locks the sequencer bond. If this hook returns Err, batch is not applied

fn end_blob_hook( &self, result: Self::BlobResult, working_set: &mut WorkingSet<<Self::Context as Spec>::Storage> ) -> Result<()>

Executes at the end of apply_blob and rewards or slashed the sequencer If this hook returns Err rollup panics

impl<C: Clone + Context> Clone for SequencerRegistry<C>where C::Address: Clone,

fn clone(&self) -> SequencerRegistry<C>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Context> Default for SequencerRegistry<C>

fn default() -> Self

Returns the “default value” for a type.

impl<C: Context> Module for SequencerRegistry<C>

type Context = C

Execution context.

type Config = SequencerConfig<C>

Configuration for the genesis method.

type CallMessage = CallMessage

Module defined argument to the call method.

fn genesis( &self, config: &Self::Config, working_set: &mut WorkingSet<C::Storage> ) -> Result<(), Error>

Genesis is called when a rollup is deployed and can be used to set initial state values in the module.

fn call( &self, message: Self::CallMessage, context: &Self::Context, working_set: &mut WorkingSet<<Self::Context as Spec>::Storage> ) -> Result<CallResponse, Error>

Call allows interaction with the module and invokes state changes. It takes a module defined type and a context as parameters.

impl<C: Context> ModuleInfo for SequencerRegistry<C>

type Context = C

fn prefix(&self) -> Prefix

Returns the prefix of the module.

fn address(&self) -> &<Self::Context as Spec>::Address

Returns address of the module.

fn dependencies(&self) -> Vec<&<Self::Context as Spec>::Address>

Returns addresses of all the other modules this module is dependent on