Struct Domain 

pub struct Domain<S = Storage>
where
    S: KeyValueStorageWithColumnFamilies<ColumnFamilyIdentifier = ColumnFamilies, Error = StorageError> + Send + Sync + 'static,
{
    pub runner: Runner<S>,
    pub client: DomainClient,
    pub views: Views<S>,
}

A delta domain

This struct gives access to all domain operations:

• the runner to run the domain’s event processing
• the client to perform actions on the domain
• the views to read data and state from the domain

The struct is generic over:

• S: the storage back-end, defaults to the storage back-end defined by the cargo features (see below)

Storage back-ends can be enabled via cargo features:

• in-memory storage by default
• RocksDB storage if feature rocksdb is set

Create a new domain with a builder:

• by reading from configuration with Self::from_config, or
• manually by calling Self::builder.

Destructuring into the three components is recommended upon creation:

use delta_domain_sdk::{Domain, Config};

async fn example() -> Result<(), Box<dyn std::error::Error>> {
    let config = Config::load()?;
    let Domain {
        runner,
        client,
        views,
    } = Domain::from_config(config).build().await?;
    Ok(())
}

Fields

runner: Runner<S>

Runner to start the domain.

The runner must be used once to launch the domain’s event loop with Runner::run. It’s not cloneable.

client: DomainClient

Client to performing actions on a running domain.

views: Views<S>

Read-only views of the domain’s state and data.

Implementations

impl Domain<Storage>

pub fn from_config(config: Config) -> DomainBuilder<DbOptions>

Construct a new domain from configuration.

See Config for how to load configuration.

By default, a mock RPC is configured. Use DomainBuilder::with_rpc or set a rpc_url in the configuration file to use a real base layer RPC.

By default, a mock proving client is used. To configure a proving client use with_proving_client or set proving in the configuration file.

Returns

A DomainBuilder to continue configuration or build the domain.

pub fn builder( shard: NonZero<Shard>, keypair: PrivKey, ) -> DomainBuilder<DbOptions>

Construct a new domain with the builder.

The storage layer used is defined by the cargo feature rocksdb (RocksDB if set, in-memory if not).

Parameters

• shard - the shard this domain operates
• keypair - the domain signs transactions with

Returns

A DomainBuilder to continue configuration or build the domain.

pub fn in_mem_builder( shard: NonZero<Shard>, keypair: PrivKey, ) -> DomainBuilder<Database<Storage>>

Same as Self::builder but with storage forced to in-memory.

Trait Implementations

impl<S> Debug for Domain<S>

where S: KeyValueStorageWithColumnFamilies<ColumnFamilyIdentifier = ColumnFamilies, Error = StorageError> + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.