Struct ServeCommandConfiguration

pub struct ServeCommandConfiguration {

    pub environment: ExecutionEnvironment,
    pub cardano_cli_path: PathBuf,
    pub cardano_node_socket_path: PathBuf,
    pub cardano_node_version: String,
    pub network_magic: Option<u64>,
    pub network: String,
    pub chain_observer_type: ChainObserverType,
    pub protocol_parameters: ProtocolParameters,
    pub snapshot_uploader_type: SnapshotUploaderType,
    pub snapshot_bucket_name: Option<String>,
    pub snapshot_use_cdn_domain: bool,
    pub server_ip: String,
    pub server_port: u16,
    pub public_server_url: Option<String>,
    pub run_interval: u64,
    pub db_directory: PathBuf,
    pub snapshot_directory: PathBuf,
    pub data_stores_directory: PathBuf,
    pub genesis_verification_key: HexEncodedGenesisVerificationKey,
    pub reset_digests_cache: bool,
    pub disable_digests_cache: bool,
    pub store_retention_limit: Option<usize>,
    pub era_reader_adapter_type: EraReaderAdapterType,
    pub era_reader_adapter_params: Option<String>,
    pub ancillary_files_signer_config: AncillaryFilesSignerConfig,
    pub signed_entity_types: Option<String>,
    pub snapshot_compression_algorithm: CompressionAlgorithm,
    pub zstandard_parameters: Option<ZstandardCompressionParameters>,
    pub cexplorer_pools_url: Option<String>,
    pub signer_importer_run_interval: u64,
    pub allow_unparsable_block: bool,
    pub cardano_transactions_prover_cache_pool_size: usize,
    pub cardano_transactions_database_connection_pool_size: usize,
    pub cardano_transactions_signing_config: CardanoTransactionsSigningConfig,
    pub cardano_transactions_prover_max_hashes_allowed_by_request: usize,
    pub cardano_transactions_block_streamer_max_roll_forwards_per_poll: usize,
    pub enable_metrics_server: bool,
    pub metrics_server_ip: String,
    pub metrics_server_port: u16,
    pub persist_usage_report_interval_in_seconds: u64,
    pub leader_aggregator_endpoint: Option<String>,
    pub custom_origin_tag_white_list: Option<String>,
}

Serve command configuration

Fields

environment: ExecutionEnvironment

What kind of runtime environment the configuration is meant to.

cardano_cli_path: PathBuf

Cardano CLI tool path

cardano_node_socket_path: PathBuf

Path of the socket used by the Cardano CLI tool to communicate with the Cardano node

cardano_node_version: String

Cardano node version.

NOTE: This cannot be verified for now (see this issue). This is why it has to be manually given to the Aggregator

network_magic: Option<u64>

Cardano Network Magic number

useful for TestNet & DevNet

network: String

Cardano network

chain_observer_type: ChainObserverType

Cardano chain observer type

protocol_parameters: ProtocolParameters

Protocol parameters

snapshot_uploader_type: SnapshotUploaderType

Type of snapshot uploader to use

snapshot_bucket_name: Option<String>

Bucket name where the snapshots are stored if snapshot_uploader_type is Gcp

snapshot_use_cdn_domain: bool

Use CDN domain to construct snapshot urls if snapshot_uploader_type is Gcp

server_ip: String

Server listening IP

server_port: u16

Server listening port

public_server_url: Option<String>

Server URL that can be accessed from the outside

run_interval: u64

Run Interval is the interval between two runtime cycles in ms

db_directory: PathBuf

Directory of the Cardano node store.

snapshot_directory: PathBuf

Directory to store snapshot

data_stores_directory: PathBuf

Directory to store aggregator databases

genesis_verification_key: HexEncodedGenesisVerificationKey

Genesis verification key

reset_digests_cache: bool

Should the immutable cache be reset or not

disable_digests_cache: bool

Use the digest caching strategy

store_retention_limit: Option<usize>

Max number of records in stores. When new records are added, oldest records are automatically deleted so there can always be at max the number of records specified by this setting.

era_reader_adapter_type: EraReaderAdapterType

Era reader adapter type

era_reader_adapter_params: Option<String>

Era reader adapter parameters

ancillary_files_signer_config: AncillaryFilesSignerConfig

Configuration of the ancillary files signer

Can either be a secret key or a key stored in a Google Cloud Platform KMS account.

IMPORTANT: The cryptographic scheme used is ED25519

signed_entity_types: Option<String>

Signed entity types parameters (discriminants names in an ordered, case-sensitive, comma separated list).

The values MithrilStakeDistribution and CardanoImmutableFilesFull are prepended automatically to the list.

snapshot_compression_algorithm: CompressionAlgorithm

Compression algorithm used for the snapshot archive artifacts.

zstandard_parameters: Option<ZstandardCompressionParameters>

Specific parameters when snapshot_compression_algorithm is set to zstandard.

cexplorer_pools_url: Option<String>

Url to CExplorer list of pools to import as signer in the database.

signer_importer_run_interval: u64

Time interval at which the signers in Self::cexplorer_pools_url will be imported (in minutes).

allow_unparsable_block: bool

If set no error is returned in case of unparsable block and an error log is written instead.

Will be ignored on (pre)production networks.

cardano_transactions_prover_cache_pool_size: usize

Cardano transactions prover cache pool size

cardano_transactions_database_connection_pool_size: usize

Cardano transactions database connection pool size

cardano_transactions_signing_config: CardanoTransactionsSigningConfig

Cardano transactions signing configuration

cardano_transactions_prover_max_hashes_allowed_by_request: usize

Maximum number of transactions hashes allowed by request to the prover of the Cardano transactions

cardano_transactions_block_streamer_max_roll_forwards_per_poll: usize

The maximum number of roll forwards during a poll of the block streamer when importing transactions.

enable_metrics_server: bool

Enable metrics server (Prometheus endpoint on /metrics).

metrics_server_ip: String

Metrics HTTP Server IP.

metrics_server_port: u16

Metrics HTTP Server listening port.

persist_usage_report_interval_in_seconds: u64

Time interval at which usage metrics are persisted in event database (in seconds).

leader_aggregator_endpoint: Option<String>

This is the endpoint of the aggregator that will be used to fetch the latest epoch settings and store the signer registrations when the aggregator is running in a follower mode. If this is not set, the aggregator will run in a leader mode.

custom_origin_tag_white_list: Option<String>

Custom origin tag of client request added to the whitelist (comma separated list).

Implementations

impl ServeCommandConfiguration

pub fn new_sample(tmp_path: PathBuf) -> Self

Create a sample configuration mainly for tests

pub fn get_local_server_url(&self) -> StdResult<SanitizedUrlWithTrailingSlash>

Build the local server URL from configuration.

Trait Implementations

impl Clone for ServeCommandConfiguration

fn clone(&self) -> ServeCommandConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConfigurationSource for ServeCommandConfiguration

fn environment(&self) -> ExecutionEnvironment

What kind of runtime environment the configuration is meant to.

fn cardano_cli_path(&self) -> PathBuf

Cardano CLI tool path

fn cardano_node_socket_path(&self) -> PathBuf

Path of the socket used by the Cardano CLI tool to communicate with the Cardano node

fn cardano_node_version(&self) -> String

Cardano node version.

fn network_magic(&self) -> Option<u64>

Cardano Network Magic number

fn network(&self) -> String

Cardano network

fn chain_observer_type(&self) -> ChainObserverType

Cardano chain observer type

fn protocol_parameters(&self) -> ProtocolParameters

Protocol parameters

fn snapshot_uploader_type(&self) -> SnapshotUploaderType

Type of snapshot uploader to use

fn snapshot_bucket_name(&self) -> Option<String>

Bucket name where the snapshots are stored if snapshot_uploader_type is Gcp

fn snapshot_use_cdn_domain(&self) -> bool

Use CDN domain to construct snapshot urls if snapshot_uploader_type is Gcp

fn server_ip(&self) -> String

Server listening IP

fn server_port(&self) -> u16

Server listening port

fn public_server_url(&self) -> Option<String>

Server URL that can be accessed from the outside

fn run_interval(&self) -> u64

Run Interval is the interval between two runtime cycles in ms

fn db_directory(&self) -> PathBuf

Directory of the Cardano node store.

fn snapshot_directory(&self) -> PathBuf

Directory to store snapshot

fn data_stores_directory(&self) -> PathBuf

Directory to store aggregator databases

fn genesis_verification_key(&self) -> HexEncodedGenesisVerificationKey

Genesis verification key

fn reset_digests_cache(&self) -> bool

Should the immutable cache be reset or not

fn disable_digests_cache(&self) -> bool

Use the digest caching strategy

fn store_retention_limit(&self) -> Option<usize>

Max number of records in stores. When new records are added, oldest records are automatically deleted so there can always be at max the number of records specified by this setting.

fn era_reader_adapter_type(&self) -> EraReaderAdapterType

Era reader adapter type

fn era_reader_adapter_params(&self) -> Option<String>

Era reader adapter parameters

fn ancillary_files_signer_config(&self) -> AncillaryFilesSignerConfig

Configuration of the ancillary files signer

fn signed_entity_types(&self) -> Option<String>

Signed entity types parameters (discriminants names in an ordered, case-sensitive, comma separated list).

fn snapshot_compression_algorithm(&self) -> CompressionAlgorithm

Compression algorithm used for the snapshot archive artifacts.

fn zstandard_parameters(&self) -> Option<ZstandardCompressionParameters>

Specific parameters when CompressionAlgorithm is set to zstandard.

fn cexplorer_pools_url(&self) -> Option<String>

Url to CExplorer list of pools to import as signer in the database.

fn signer_importer_run_interval(&self) -> u64

Time interval at which the signers in cexplorer_pools_url will be imported (in minutes).

fn allow_unparsable_block(&self) -> bool

If set no error is returned in case of unparsable block and an error log is written instead.

fn cardano_transactions_prover_cache_pool_size(&self) -> usize

Cardano transactions prover cache pool size

fn cardano_transactions_database_connection_pool_size(&self) -> usize

Cardano transactions database connection pool size

fn cardano_transactions_signing_config( &self, ) -> CardanoTransactionsSigningConfig

Cardano transactions signing configuration

fn cardano_transactions_prover_max_hashes_allowed_by_request(&self) -> usize

Maximum number of transactions hashes allowed by request to the prover of the Cardano transactions

fn cardano_transactions_block_streamer_max_roll_forwards_per_poll( &self, ) -> usize

The maximum number of roll forwards during a poll of the block streamer when importing transactions.

fn enable_metrics_server(&self) -> bool

Enable metrics server (Prometheus endpoint on /metrics).

fn metrics_server_ip(&self) -> String

Metrics HTTP Server IP.

fn metrics_server_port(&self) -> u16

Metrics HTTP Server listening port.

fn persist_usage_report_interval_in_seconds(&self) -> u64

Time interval at which usage metrics are persisted in event database (in seconds).

fn leader_aggregator_endpoint(&self) -> Option<String>

Leader aggregator endpoint

fn custom_origin_tag_white_list(&self) -> Option<String>

Custom origin tag of client request added to the whitelist (comma separated list).

fn get_server_url(&self) -> StdResult<SanitizedUrlWithTrailingSlash>

Get the server URL.

fn get_network(&self) -> StdResult<CardanoNetwork>

Get a representation of the Cardano network.

fn get_sqlite_dir(&self) -> PathBuf

Get the directory of the SQLite stores.

fn get_snapshot_dir(&self) -> StdResult<PathBuf>

Get the snapshots directory.

fn safe_epoch_retention_limit(&self) -> Option<u64>

Get the safe epoch retention limit.

fn compute_allowed_signed_entity_types_discriminants( &self, ) -> StdResult<BTreeSet<SignedEntityTypeDiscriminants>>

Compute the list of signed entity discriminants that are allowed to be processed.

fn allow_http_serve_directory(&self) -> bool

Check if the HTTP server can serve static directories.

fn get_epoch_settings_configuration(&self) -> AggregatorEpochSettings

Infer the AggregatorEpochSettings from the configuration.

fn is_follower_aggregator(&self) -> bool

Check if the aggregator is running in follower mode.

fn compute_origin_tag_white_list(&self) -> HashSet<String>

White list for origin client request.

impl Debug for ServeCommandConfiguration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServeCommandConfiguration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Documenter for ServeCommandConfiguration

fn extract() -> StructDoc

Extract information used to generate documentation.

impl Serialize for ServeCommandConfiguration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.