Skip to content

apollo_config,workspace: remove SerializeConfig trait and preset-dump machinery #14654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
nimrod-starkware wants to merge 1 commit into
base: nimrod/jsonnet/presentation-off-dump
Choose a base branch
from
Draft

apollo_config,workspace: remove SerializeConfig trait and preset-dump machinery #14654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 0 additions & 217 deletions crates/apollo_batcher_config/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
use std::collections::BTreeMap;
use std::time::Duration;

use apollo_config::converters::{
deserialize_milliseconds_to_duration,
serialize_duration_as_milliseconds,
};
use apollo_config::dumping::{
prepend_sub_config_name,
ser_optional_sub_config,
ser_param,
SerializeConfig,
};
use apollo_config::{ParamPath, ParamPrivacyInput, SerializedParam};
use apollo_storage::db::DbConfig;
use apollo_storage::storage_reader_server::{
StorageReaderServerDynamicConfig,
Expand Down Expand Up @@ -43,19 +35,6 @@ pub struct BlockBuilderConfig {
pub versioned_constants_overrides: Option<VersionedConstantsOverrides>,
}

impl SerializeConfig for BlockBuilderConfig {
fn dump(&self) -> BTreeMap<ParamPath, SerializedParam> {
let mut dump = prepend_sub_config_name(self.chain_info.dump(), "chain_info");
dump.append(&mut prepend_sub_config_name(self.execute_config.dump(), "execute_config"));
dump.append(&mut prepend_sub_config_name(self.bouncer_config.dump(), "bouncer_config"));
dump.append(&mut ser_optional_sub_config(
&self.versioned_constants_overrides,
"versioned_constants_overrides",
));
dump
}
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct CommitmentManagerConfig {
pub tasks_channel_size: usize,
Expand All @@ -73,32 +52,6 @@ impl Default for CommitmentManagerConfig {
}
}

impl SerializeConfig for CommitmentManagerConfig {
fn dump(&self) -> BTreeMap<ParamPath, SerializedParam> {
BTreeMap::from([
ser_param(
"tasks_channel_size",
&self.tasks_channel_size,
"The size of the channel for sending tasks to the commitment manager.",
ParamPrivacyInput::Public,
),
ser_param(
"results_channel_size",
&self.results_channel_size,
"The size of the channel for receiving results from the commitment manager.",
ParamPrivacyInput::Public,
),
ser_param(
"panic_if_task_channel_full",
&self.panic_if_task_channel_full,
"If the task channel is full: if true, will panic. If false, will wait for the \
tasks channel to be available.",
ParamPrivacyInput::Public,
),
])
}
}

/// Configuration for the preconfirmed block writer component of the batcher.
#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq)]
pub struct PreconfirmedBlockWriterConfig {
Expand All @@ -112,26 +65,6 @@ impl Default for PreconfirmedBlockWriterConfig {
}
}

impl SerializeConfig for PreconfirmedBlockWriterConfig {
fn dump(&self) -> BTreeMap<ParamPath, SerializedParam> {
BTreeMap::from_iter([
ser_param(
"channel_buffer_capacity",
&self.channel_buffer_capacity,
"The capacity of the channel buffer for receiving pre-confirmed transactions.",
ParamPrivacyInput::Public,
),
ser_param(
"write_block_interval_millis",
&self.write_block_interval_millis,
"Time interval (ms) between writing pre-confirmed blocks. Writes occur only when \
block data changes.",
ParamPrivacyInput::Public,
),
])
}
}

/// Configuration for the preconfirmed Cende client component of the batcher.
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
pub struct PreconfirmedCendeConfig {
Expand All @@ -148,50 +81,13 @@ impl Default for PreconfirmedCendeConfig {
}
}

impl SerializeConfig for PreconfirmedCendeConfig {
fn dump(&self) -> BTreeMap<ParamPath, SerializedParam> {
BTreeMap::from([ser_param(
"recorder_url",
&self.recorder_url,
"The URL of the Pythonic cende_recorder",
ParamPrivacyInput::Public,
)])
}
}

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Default)]
pub struct FirstBlockWithPartialBlockHash {
pub block_number: BlockNumber,
pub block_hash: BlockHash,
pub parent_block_hash: BlockHash,
}

impl SerializeConfig for FirstBlockWithPartialBlockHash {
fn dump(&self) -> BTreeMap<ParamPath, SerializedParam> {
BTreeMap::from([
ser_param(
"block_number",
&self.block_number,
"The number of the first block with a partial block hash components.",
ParamPrivacyInput::Public,
),
ser_param(
"block_hash",
&self.block_hash,
"The hash of the first block with a partial block hash components.",
ParamPrivacyInput::Public,
),
ser_param(
"parent_block_hash",
&self.parent_block_hash,
"The hash of the parent block of the first block with a partial block hash \
components.",
ParamPrivacyInput::Public,
),
])
}
}

#[derive(Clone, Debug, Serialize, Deserialize, Validate, PartialEq)]
pub struct BatcherStaticConfig {
#[validate(nested)]
Expand All @@ -214,76 +110,6 @@ pub struct BatcherStaticConfig {
pub validation_only: bool,
}

impl SerializeConfig for BatcherStaticConfig {
fn dump(&self) -> BTreeMap<ParamPath, SerializedParam> {
// TODO(yair): create nicer function to append sub configs.
let mut dump = BTreeMap::from([
ser_param(
"outstream_content_buffer_size",
&self.outstream_content_buffer_size,
"The maximum number of items to include in a single get_proposal_content response.",
ParamPrivacyInput::Public,
),
ser_param(
"input_stream_content_buffer_size",
&self.input_stream_content_buffer_size,
"Sets the buffer size for the input transaction channel. Adding more transactions \
beyond this limit will block until space is available.",
ParamPrivacyInput::Public,
),
ser_param(
"max_l1_handler_txs_per_block_proposal",
&self.max_l1_handler_txs_per_block_proposal,
"The maximum number of L1 handler transactions to include in a block proposal.",
ParamPrivacyInput::Public,
),
ser_param(
"propose_l1_txs_every",
&self.propose_l1_txs_every,
"Only propose L1 transactions every N proposals.",
ParamPrivacyInput::Public,
),
]);
dump.append(&mut prepend_sub_config_name(self.storage.dump(), "storage"));
dump.append(&mut prepend_sub_config_name(
self.block_builder_config.dump(),
"block_builder_config",
));
dump.append(&mut prepend_sub_config_name(
self.pre_confirmed_block_writer_config.dump(),
"pre_confirmed_block_writer_config",
));
dump.append(&mut prepend_sub_config_name(
self.contract_class_manager_config.dump(),
"contract_class_manager_config",
));
dump.append(&mut prepend_sub_config_name(
self.commitment_manager_config.dump(),
"commitment_manager_config",
));
dump.append(&mut prepend_sub_config_name(
self.pre_confirmed_cende_config.dump(),
"pre_confirmed_cende_config",
));
dump.extend(ser_optional_sub_config(
&self.first_block_with_partial_block_hash,
"first_block_with_partial_block_hash",
));
dump.append(&mut prepend_sub_config_name(
self.storage_reader_server_static_config.dump(),
"storage_reader_server_static_config",
));
dump.append(&mut BTreeMap::from([ser_param(
"validation_only",
&self.validation_only,
"If true, the batcher only validates proposed blocks and cannot build proposals. Set \
via the node-level validation_only config pointer.",
ParamPrivacyInput::Public,
)]));
dump
}
}

impl Default for BatcherStaticConfig {
fn default() -> Self {
Self {
Expand Down Expand Up @@ -345,40 +171,6 @@ impl Default for BatcherDynamicConfig {
}
}

impl SerializeConfig for BatcherDynamicConfig {
fn dump(&self) -> BTreeMap<ParamPath, SerializedParam> {
let mut dump = BTreeMap::from([
self.native_classes_whitelist.ser_param(),
ser_param(
"n_concurrent_txs",
&self.n_concurrent_txs,
"Number of transactions in each request from the tx_provider.",
ParamPrivacyInput::Public,
),
ser_param(
"tx_polling_interval_millis",
&self.tx_polling_interval_millis,
"Time to wait (in milliseconds) between transaction requests when the previous \
request returned no transactions.",
ParamPrivacyInput::Public,
),
ser_param(
"proposer_idle_detection_delay_millis",
&self.proposer_idle_detection_delay_millis.as_millis(),
"Minimum time (in milliseconds) that must pass since block creation started \
before checking for idle state. If this delay has passed AND no transactions are \
currently being executed, the proposer will finish building the current block.",
ParamPrivacyInput::Public,
),
]);
dump.append(&mut prepend_sub_config_name(
self.storage_reader_server_dynamic_config.dump(),
"storage_reader_server_dynamic_config",
));
dump
}
}

/// The batcher related configuration.
#[derive(Clone, Debug, Default, Serialize, Deserialize, Validate, PartialEq)]
#[validate(schema(function = "validate_batcher_config"))]
Expand All @@ -389,15 +181,6 @@ pub struct BatcherConfig {
pub dynamic_config: BatcherDynamicConfig,
}

impl SerializeConfig for BatcherConfig {
fn dump(&self) -> BTreeMap<ParamPath, SerializedParam> {
let mut config = BTreeMap::new();
config.extend(prepend_sub_config_name(self.static_config.dump(), "static_config"));
config.extend(prepend_sub_config_name(self.dynamic_config.dump(), "dynamic_config"));
config
}
}

fn validate_batcher_dynamic_config(
dynamic_config: &BatcherDynamicConfig,
) -> Result<(), ValidationError> {
Expand Down
Loading
Loading