Struct Config 

pub struct Config {
    pub shard: NonZero<Shard>,
    pub keypair: PrivKey,
    pub rpc_url: Option<String>,
    pub storage: Option<StorageConfig>,
}

Domain configuration

By default a domain.yaml file is loaded to configure a domain. The file has the following structure:

# Shard ID number of the shard this domain operates
shard: 123

# Path to a JSON-encoded, base58 string of an ed25519 private-key that is used
# as the domain operator's key.
#
# Path is relative to the domain configuration file.
keypair: ./path/to/key.json

# (optional) URL of the base layer RPC endpoint.
# If omitted/commented, a mock RPC is used.
# rpc_url: https://your-rpc.delta.network:8765

Dev Note

This is the in-memory, resolved equivalent of ConfigFile. In comparison with ConfigFile, all files/keys/paths are resolved and read into memory.

Fields

shard: NonZero<Shard>

the shard this domain operates

keypair: PrivKey

Keypair that identifies the domain operator and with which it signs transactions

rpc_url: Option<String>

URL of the base layer RPC to connect to. If none, a mock RPC is used.

storage: Option<StorageConfig>

Storage configuration

Implementations

impl Config

pub fn load() -> Result<Self, Error>

Load Config from a file called domain in the current directory.

Environment variables prefixed with DOMAIN_ can override configuration in the file. The file can be in any allowed format and has to have the contents of ConfigFile.

pub fn load_from(path: impl AsRef<Path>) -> Result<Self, Error>

Load Config from a configuration file at the given path.

Environment variables prefixed with DOMAIN_ can override configuration in the file. The file can be in any allowed format and has to have the contents of ConfigFile.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Config

impl StructuralPartialEq for Config