Struct 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>, storage: StorageClient, ) -> Self

pub fn new_for_client( nickname: String, storage: StorageClient, chain_modes: Arc<RwLock<BTreeMap<ChainId, ListeningMode>>>, ) -> 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_block_time_grace_period( self, block_time_grace_period: Duration, ) -> Self

Returns an instance with the specified block time grace period.

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 with_chain_worker_ttl(self, chain_worker_ttl: Duration) -> Self

Returns an instance with the specified chain worker TTL.

Idle chain workers free their memory after that duration without requests.

pub fn with_sender_chain_worker_ttl( self, sender_chain_worker_ttl: Duration, ) -> Self

Returns an instance with the specified sender chain worker TTL.

Idle sender chain workers free their memory after that duration without requests.

pub fn with_chain_info_max_received_log_entries( self, chain_info_max_received_log_entries: usize, ) -> Self

Returns an instance with the specified maximum size for received_log entries.

Sizes below CHAIN_INFO_MAX_RECEIVED_LOG_ENTRIES should be avoided.

pub fn nickname(&self) -> &str

impl<StorageClient> WorkerState<StorageClient>

where StorageClient: Storage + Clone + '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>, published_blobs: Vec<Blob>, ) -> Result<(Block, ChainInfoResponse, ResourceTracker), WorkerError>

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

pub async fn stage_block_execution_with_policy( &self, block: ProposedBlock, round: Option<u32>, published_blobs: Vec<Blob>, policy: BundleExecutionPolicy, ) -> Result<(ProposedBlock, Block, ChainInfoResponse, ResourceTracker), WorkerError>

Tries to execute a block proposal with a policy for handling bundle failures.

Returns the modified block (bundles may be rejected/removed), the executed block, chain info response, and resource tracker.

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

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

If block_hash is specified, system will query the application’s state at that block. If it doesn’t exist, it uses latest state.

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

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( &self, certificate: LiteCertificate<'_>, 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.

pub async fn get_preprocessed_block_hashes( &self, chain_id: ChainId, start: BlockHeight, end: BlockHeight, ) -> Result<Vec<CryptoHash>, WorkerError>

Gets preprocessed block hashes in a given height range.

pub async fn get_inbox_next_height( &self, chain_id: ChainId, origin: ChainId, ) -> Result<BlockHeight, WorkerError>

Gets the next block height to receive from an inbox.

pub async fn get_locking_blobs( &self, chain_id: ChainId, blob_ids: Vec<BlobId>, ) -> Result<Option<Vec<Blob>>, WorkerError>

Gets locking blobs for specific blob IDs. Returns Ok(None) if any of the blobs is not found.

pub async fn get_block_hashes( &self, chain_id: ChainId, heights: Vec<BlockHeight>, ) -> Result<Vec<CryptoHash>, WorkerError>

Gets block hashes for the given heights.

pub async fn get_proposed_blobs( &self, chain_id: ChainId, blob_ids: Vec<BlobId>, ) -> Result<Vec<Blob>, WorkerError>

Gets proposed blobs from the manager for specified blob IDs.

pub async fn get_event_subscriptions( &self, chain_id: ChainId, ) -> Result<Vec<((ChainId, StreamId), EventSubscriptions)>, WorkerError>

Gets event subscriptions from the chain.

pub async fn get_stream_event_count( &self, chain_id: ChainId, stream_id: StreamId, ) -> Result<Option<u32>, WorkerError>

Gets the stream event count for a stream.

pub async fn get_received_certificate_trackers( &self, chain_id: ChainId, ) -> Result<HashMap<ValidatorPublicKey, u64>, WorkerError>

Gets received certificate trackers.

pub async fn get_tip_state_and_outbox_info( &self, chain_id: ChainId, receiver_id: ChainId, ) -> Result<(BlockHeight, Option<BlockHeight>), WorkerError>

Gets tip state and outbox info for next_outbox_heights calculation.

pub async fn get_next_height_to_preprocess( &self, chain_id: ChainId, ) -> Result<BlockHeight, WorkerError>

Gets the next height to preprocess.

pub async fn get_manager_seed( &self, chain_id: ChainId, ) -> Result<u64, WorkerError>

Gets the chain manager’s seed for leader election.

Trait Implementations

impl<StorageClient> Clone for WorkerState<StorageClient>

where StorageClient: Storage + Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.