Struct scabbard::service::Scabbard

pub struct Scabbard { /* fields omitted */ }

A service for running Sawtooth Sabre smart contracts with two-phase commit consensus.

Implementations

impl Scabbard

pub fn new(
    service_id: String,
    circuit_id: &str,
    version: ScabbardVersion,
    peer_services: HashSet<String>,
    state_db_dir: &Path,
    state_db_size: usize,
    receipt_db_dir: &Path,
    receipt_db_size: usize,
    signature_verifier: Box<dyn SignatureVerifier>,
    admin_keys: Vec<String>,
    coordinator_timeout: Option<Duration>
) -> Result<Self, ScabbardError>

Generate a new Scabbard service.

pub fn get_state_at_address(
    &self,
    address: &str
) -> Result<Option<Vec<u8>>, ScabbardError>

Fetch the value at the given address in the scabbard service’s state. Returns None if the address is not set.

pub fn get_state_with_prefix(
    &self,
    prefix: Option<&str>
) -> Result<StateIter, ScabbardError>

Fetch a list of entries in the scabbard service’s state. If a prefix is provided, only return entries whose addresses are under the given address prefix. If no prefix is provided, return all state entries.

pub fn get_current_state_root(&self) -> Result<String, ScabbardError>

Get the current state root hash of the scabbard service’s state.

pub fn add_batches(
    &self,
    batches: Vec<BatchPair>
) -> Result<Option<String>, ScabbardError>

pub fn get_batch_info(
    &self,
    ids: HashSet<String>,
    wait: Option<Duration>
) -> Result<BatchInfoIter, ScabbardError>

Get the BatchInfo for each specified batch.

Arguments

• ids: List of batch IDs to get info on
• wait: If Some, wait up to the given time for all requested batches to complete (statuses will be either Committed or Invalid); if the timeout expires, an Err result will be given by the returned iterator. If None, return the BatchInfos to complete.

pub fn get_events_since(
    &self,
    event_id: Option<String>
) -> Result<Events, ScabbardError>

pub fn add_state_subscriber(
    &self,
    subscriber: Box<dyn StateSubscriber>
) -> Result<(), ScabbardError>

Trait Implementations

impl Clone for Scabbard

fn clone(&self) -> Scabbard

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Service for Scabbard

fn service_id(&self) -> &str

This service’s ID

fn service_type(&self) -> &str

This service’s type

fn start(
    &mut self,
    service_registry: &dyn ServiceNetworkRegistry
) -> Result<(), ServiceStartError>

Starts the service

fn stop(
    &mut self,
    service_registry: &dyn ServiceNetworkRegistry
) -> Result<(), ServiceStopError>

Stops Starts the service

fn destroy(self: Box<Self>) -> Result<(), ServiceDestroyError>

Clean-up any resources before the service is removed. Consumes the service (which, given the use of dyn traits, this must take a boxed Service instance).

fn purge(&mut self) -> Result<(), InternalError>

Purge any persistent state maintained by this service.

fn handle_message(
    &self,
    message_bytes: &[u8],
    _message_context: &ServiceMessageContext
) -> Result<(), ServiceError>

Handle any incoming message intended for this service instance.

fn as_any(&self) -> &dyn Any

Cast the service as &dyn Any.