Struct linera_core::worker::WorkerState

pub struct WorkerState<StorageClient>
where
    StorageClient: Storage,
{ /* private fields */ }

State of a worker in a validator or a local node.

Implementations

impl<StorageClient> WorkerState<StorageClient>

where StorageClient: Storage,

pub fn new( nickname: String, key_pair: Option<(ValidatorSecretKey, AccountSecretKey)>, storage: StorageClient, chain_worker_limit: NonZeroUsize, ) -> Self

pub fn new_for_client( nickname: String, storage: StorageClient, tracked_chains: Arc<RwLock<HashSet<ChainId>>>, chain_worker_limit: NonZeroUsize, ) -> Self

pub fn with_allow_inactive_chains(self, value: bool) -> Self

pub fn with_allow_messages_from_deprecated_epochs(self, value: bool) -> Self

pub fn with_long_lived_services(self, value: bool) -> Self

pub fn with_tracked_chains( self, tracked_chains: impl IntoIterator<Item = ChainId>, ) -> Self

Configures the subset of chains that this worker is tracking.

pub fn with_grace_period(self, grace_period: Duration) -> Self

Returns an instance with the specified grace period, in microseconds.

Blocks with a timestamp this far in the future will still be accepted, but the validator will wait until that timestamp before voting.

pub fn nickname(&self) -> &str

pub fn storage_client(&self) -> &StorageClient

Returns the storage client so that it can be manipulated or queried by tests in other crates.

impl<StorageClient> WorkerState<StorageClient>

where StorageClient: Storage + Clone + Send + Sync + 'static,

pub async fn fully_handle_certificate_with_notifications<T>( &self, certificate: GenericCertificate<T>, notifier: &impl Notifier, ) -> Result<ChainInfoResponse, WorkerError>

where T: ProcessableCertificate,

pub async fn stage_block_execution( &self, block: ProposedBlock, round: Option<u32>, ) -> Result<(ExecutedBlock, ChainInfoResponse), WorkerError>

Tries to execute a block proposal without any verification other than block execution.

pub async fn query_application( &self, chain_id: ChainId, query: Query, ) -> Result<QueryOutcome, WorkerError>

Executes a Query for an application’s state on a specific chain.

pub async fn describe_application( &self, chain_id: ChainId, application_id: UserApplicationId, ) -> Result<UserApplicationDescription, WorkerError>

pub async fn read_certificate( &self, chain_id: ChainId, height: BlockHeight, ) -> Result<Option<ConfirmedBlockCertificate>, WorkerError>

Returns a stored ConfirmedBlockCertificate for a chain’s block.

pub async fn chain_state_view( &self, chain_id: ChainId, ) -> Result<OwnedRwLockReadGuard<ChainStateView<StorageClient::Context>>, WorkerError>

Returns a read-only view of the ChainStateView of a chain referenced by its ChainId.

The returned view holds a lock on the chain state, which prevents the worker from changing the state of that chain.

pub async fn handle_block_proposal( &self, proposal: BlockProposal, ) -> Result<(ChainInfoResponse, NetworkActions), WorkerError>

pub async fn handle_lite_certificate<'a>( &self, certificate: LiteCertificate<'a>, notify_when_messages_are_delivered: Option<Sender<()>>, ) -> Result<(ChainInfoResponse, NetworkActions), WorkerError>

Processes a certificate, e.g. to extend a chain with a confirmed block.

pub async fn handle_confirmed_certificate( &self, certificate: ConfirmedBlockCertificate, notify_when_messages_are_delivered: Option<Sender<()>>, ) -> Result<(ChainInfoResponse, NetworkActions), WorkerError>

Processes a confirmed block certificate.

pub async fn handle_validated_certificate( &self, certificate: ValidatedBlockCertificate, ) -> Result<(ChainInfoResponse, NetworkActions), WorkerError>

Processes a validated block certificate.

pub async fn handle_timeout_certificate( &self, certificate: TimeoutCertificate, ) -> Result<(ChainInfoResponse, NetworkActions), WorkerError>

Processes a timeout certificate

pub async fn handle_chain_info_query( &self, query: ChainInfoQuery, ) -> Result<(ChainInfoResponse, NetworkActions), WorkerError>

pub async fn download_pending_blob( &self, chain_id: ChainId, blob_id: BlobId, ) -> Result<Blob, WorkerError>

pub async fn handle_pending_blob( &self, chain_id: ChainId, blob: Blob, ) -> Result<ChainInfoResponse, WorkerError>

pub async fn handle_cross_chain_request( &self, request: CrossChainRequest, ) -> Result<NetworkActions, WorkerError>

pub async fn update_received_certificate_trackers( &self, chain_id: ChainId, new_trackers: BTreeMap<ValidatorPublicKey, u64>, ) -> Result<(), WorkerError>

Updates the received certificate trackers to at least the given values.

impl<StorageClient> WorkerState<StorageClient>

where StorageClient: Storage,

pub fn public_key(&self) -> ValidatorPublicKey

Gets a reference to the validator’s ValidatorPublicKey.

Panics

If the validator doesn’t have a key pair assigned to it.

pub fn account_key(&self) -> AccountPublicKey

Gets a reference to the validator’s AccountPublicKey.

Panics

If the validator doesn’t have an account secret key assigned to it.

Trait Implementations

impl<StorageClient> Clone for WorkerState<StorageClient>

where StorageClient: Storage + Clone,

fn clone(&self) -> WorkerState<StorageClient>

Returns a copy of the value.

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

Performs copy-assignment from source.