Skip to content
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

Jump to bottom

added CollationConfig #24

Merged
merged 1 commit into from
Oct 29, 2024
+257 −21
Merged

added CollationConfig #24

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
71 changes: 54 additions & 17 deletions src/models/config/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,17 +365,35 @@ impl BlockchainConfigParams {
/// Returns a catchain config.
///
/// Uses [`ConfigParam28`].
#[cfg(not(feature = "tycho"))]
pub fn get_catchain_config(&self) -> Result<CatchainConfig, Error> {
ok!(self.get::<ConfigParam28>()).ok_or(Error::CellUnderflow)
}

/// Updates a catchain config.
///
/// Uses [`ConfigParam28`].
#[cfg(not(feature = "tycho"))]
pub fn set_catchain_config(&mut self, config: &CatchainConfig) -> Result<bool, Error> {
self.set_raw(ConfigParam28::ID, ok!(CellBuilder::build_from(config)))
}

/// Returns a collation config.
///
/// Uses [`ConfigParam28`].
#[cfg(feature = "tycho")]
pub fn get_collation_config(&self) -> Result<CollationConfig, Error> {
ok!(self.get::<ConfigParam28>()).ok_or(Error::CellUnderflow)
}

/// Updates a collation config.
///
/// Uses [`ConfigParam28`].
#[cfg(feature = "tycho")]
pub fn set_collation_config(&mut self, config: &CollationConfig) -> Result<bool, Error> {
self.set_raw(ConfigParam28::ID, ok!(CellBuilder::build_from(config)))
}

/// Returns a consensus config.
///
/// Uses [`ConfigParam29`].
Expand Down Expand Up @@ -700,17 +718,22 @@ impl<'de> serde::Deserialize<'de> for NonEmptyDict<Dict<u32, StoragePrices>> {
macro_rules! define_config_params {
($(
$(#[doc = $doc:expr])*
$(#[cfg($($cfg_attrs:tt)*)])?
$(#[serde($($serde_attrs:tt)*)])?
$id:literal => $ident:ident($($ty:tt)*)
),*$(,)?) => {
$($(#[doc = $doc])*
pub struct $ident;
$(
$(#[cfg($($cfg_attrs)*)])?
$(#[doc = $doc])*
pub struct $ident;

impl<'a> KnownConfigParam<'a> for $ident {
const ID: u32 = $id;
$(#[cfg($($cfg_attrs)*)])?
impl<'a> KnownConfigParam<'a> for $ident {
const ID: u32 = $id;

define_config_params!(@wrapper $($ty)*);
})*
define_config_params!(@wrapper $($ty)*);
}
)*

#[cfg(feature = "serde")]
impl serde::Serialize for BlockchainConfigParams {
Expand All @@ -735,15 +758,18 @@ macro_rules! define_config_params {

{
match key {
$($($id => {
let value = define_config_params!(
@ser
$ident,
value,
$($serde_attrs)*
);
ok!(map.serialize_entry(&key, &value));
},)?)*
$(
$(#[cfg($($cfg_attrs)*)])?
$($id => {
let value = define_config_params!(
@ser
$ident,
value,
$($serde_attrs)*
);
ok!(map.serialize_entry(&key, &value));
},)?
)*
_ => ok!(map.serialize_entry(&key, value.as_ref())),
}
}
Expand Down Expand Up @@ -781,12 +807,15 @@ macro_rules! define_config_params {

while let Some(key) = access.next_key::<u32>()? {
let value = match key {
$($($id => define_config_params!(
$(
$(#[cfg($($cfg_attrs)*)])?
$($id => define_config_params!(
@de
$ident,
access,
$($serde_attrs)*
),)?)*
),)?
)*
_ => {
let RawValue(cell) = ok!(access.next_value());
cell
Expand Down Expand Up @@ -961,9 +990,17 @@ define_config_params! {
/// Catchain configuration params.
///
/// Contains a [`CatchainConfig`].
#[cfg(not(feature = "tycho"))]
#[serde(transparent)]
28 => ConfigParam28(CatchainConfig),

/// Collation configuration params.
///
/// Contains a [`CollationConfig`].
#[cfg(feature = "tycho")]
#[serde(transparent)]
28 => ConfigParam28(CollationConfig),

/// Consensus configuration params.
///
/// Contains a [`ConsensusConfig`].
Expand Down
196 changes: 193 additions & 3 deletions src/models/config/params.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
use std::borrow::Cow;
use std::num::{NonZeroU16, NonZeroU32};

use everscale_crypto::ed25519;
Expand Down Expand Up @@ -444,6 +443,7 @@ pub struct MsgForwardPrices {
}

/// Catchain configuration params.
#[cfg(not(feature = "tycho"))]
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct CatchainConfig {
Expand All @@ -461,11 +461,13 @@ pub struct CatchainConfig {
pub shard_validators_num: u32,
}

#[cfg(not(feature = "tycho"))]
impl CatchainConfig {
const TAG_V1: u8 = 0xc1;
const TAG_V2: u8 = 0xc2;
}

#[cfg(not(feature = "tycho"))]
impl Store for CatchainConfig {
fn store_into(&self, builder: &mut CellBuilder, _: &mut dyn CellContext) -> Result<(), Error> {
let flags = ((self.isolate_mc_validators as u8) << 1) | (self.shuffle_mc_validators as u8);
Expand All @@ -478,6 +480,7 @@ impl Store for CatchainConfig {
}
}

#[cfg(not(feature = "tycho"))]
impl<'a> Load<'a> for CatchainConfig {
fn load_from(slice: &mut CellSlice<'a>) -> Result<Self, Error> {
let flags = match slice.load_u8() {
Expand All @@ -500,6 +503,191 @@ impl<'a> Load<'a> for CatchainConfig {
}
}

/// Collation configuration params.
///
/// ```text
/// collation_config_tycho#a6
/// shuffle_mc_validators:Bool
/// mc_block_min_interval_ms:uint32
/// max_uncommitted_chain_length:uint8
/// wu_used_to_import_next_anchor:uint64
/// msgs_exec_params:MsgsExecutionParams
/// work_units_params:WorkUnitsParams
/// = CollationConfig;
/// ```
#[cfg(feature = "tycho")]
#[derive(Debug, Clone, Eq, PartialEq, Store, Load, Default)]
#[tlb(tag = "#a6")]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct CollationConfig {
/// Change the order of validators in the masterchain validators list.
pub shuffle_mc_validators: bool,

/// Minimum interval between master blocks.
pub mc_block_min_interval_ms: u32,
/// Maximum length on shard blocks chain after previous master block.
pub max_uncommitted_chain_length: u8,
/// Force import next anchor when wu used exceed limit.
pub wu_used_to_import_next_anchor: u64,

/// Messages execution params.
pub msgs_exec_params: MsgsExecutionParams,

/// Params to calculate the collation work in wu.
pub work_units_params: WorkUnitsParams,
}

/// Messages execution params.
///
/// ```text
/// msgs_execution_params_tycho#00
/// buffer_limit:uint32
/// group_limit:uint16
/// group_vert_size:uint16
/// = MsgsExecutionParams;
/// ```
#[cfg(feature = "tycho")]
#[derive(Debug, Clone, Eq, PartialEq, Store, Load, Default)]
#[tlb(tag = "#00")]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct MsgsExecutionParams {
/// Maximum limit of messages buffer.
pub buffer_limit: u32,
/// The horizontal limit of one message group.
/// Shows how many unique destination accounts can be.
pub group_limit: u16,
/// The vertical limit of one message group.
/// Shows how many messages can be per one account in the group.
pub group_vert_size: u16,
}

/// Params to calculate the collation work in wu.
///
/// ```text
/// work_units_params_tycho#00
/// prepare:WorkUnitParamsPrepare
/// execute:WorkUnitParamsExecute
/// finalize:WorkUnitParamsFinalize
/// = WorkUnitsParams;
/// ```
#[cfg(feature = "tycho")]
#[derive(Debug, Clone, Eq, PartialEq, Store, Load, Default)]
#[tlb(tag = "#00")]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct WorkUnitsParams {
/// Params to calculate messages groups prepare work in wu.
pub prepare: WorkUnitsParamsPrepare,
/// Params to calculate messages execution work in wu.
pub execute: WorkUnitsParamsExecute,
/// Params to calculate block finalization work in wu.
pub finalize: WorkUnitsParamsFinalize,
}

/// Params to calculate messages groups prepare work in wu.
///
/// ```text
/// work_units_params_prepare_tycho#00
/// fixed:uint32
/// read_ext_msgs:uint16
/// read_int_msgs:uint16
/// read_new_msgs:uint32
/// = WorkUnitsParamsPrepare;
/// ```
#[cfg(feature = "tycho")]
#[derive(Debug, Clone, Eq, PartialEq, Store, Load, Default)]
#[tlb(tag = "#00")]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct WorkUnitsParamsPrepare {
/// TODO: Add docs.
pub fixed_part: u32,
/// TODO: Add docs.
pub read_ext_msgs: u16,
/// TODO: Add docs.
pub read_int_msgs: u16,
/// TODO: Add docs.
pub read_new_msgs: u32,
}

/// Params to calculate messages execution work in wu.
///
/// ```text
/// work_units_params_execute_tycho#00
/// prepare:uint32
/// execute:uint16
/// execute_err:uint16
/// execute_delimiter:uint32
/// serialize_enqueue:uint16
/// serialize_dequeue:uint16
/// insert_new_msgs_to_iterator:uint16
/// subgroup_size:uint16
/// = WorkUnitsParamsExecute;
/// ```
#[cfg(feature = "tycho")]
#[derive(Debug, Clone, Eq, PartialEq, Store, Load, Default)]
#[tlb(tag = "#00")]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct WorkUnitsParamsExecute {
/// TODO: Add docs.
pub prepare: u32,
/// TODO: Add docs.
pub execute: u16,
/// TODO: Add docs.
pub execute_err: u16,
/// TODO: Add docs.
pub execute_delimiter: u32,
/// TODO: Add docs.
pub serialize_enqueue: u16,
/// TODO: Add docs.
pub serialize_dequeue: u16,
/// TODO: Add docs.
pub insert_new_msgs_to_iterator: u16,
/// TODO: Add docs.
pub subgroup_size: u16,
}

/// Params to calculate block finalization work in wu.
///
/// ```text
/// work_units_params_finalize_tycho#00
/// build_transactions:uint16
/// build_accounts:uint16
/// build_in_msg:uint16
/// build_out_msg:uint16
/// serialize_min:uint32
/// serialize_accounts:uint16
/// serialize_msg:uint16
/// state_update_min:uint32
/// state_update_accounts:uint32
/// state_update_msg:uint16
/// = WorkUnitsParamsFinalize;
/// ```
#[cfg(feature = "tycho")]
#[derive(Debug, Clone, Eq, PartialEq, Store, Load, Default)]
#[tlb(tag = "#00")]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct WorkUnitsParamsFinalize {
/// TODO: Add docs.
pub build_transactions: u16,
/// TODO: Add docs.
pub build_accounts: u16,
/// TODO: Add docs.
pub build_in_msg: u16,
/// TODO: Add docs.
pub build_out_msg: u16,
/// TODO: Add docs.
pub serialize_min: u32,
/// TODO: Add docs.
pub serialize_accounts: u16,
/// TODO: Add docs.
pub serialize_msg: u16,
/// TODO: Add docs.
pub state_update_min: u32,
/// TODO: Add docs.
pub state_update_accounts: u32,
/// TODO: Add docs.
pub state_update_msg: u16,
}

/// DAG Consensus configuration params
///
/// ```text
Expand Down Expand Up @@ -667,6 +855,7 @@ impl ValidatorSet {
const TAG_V2: u8 = 0x12;

/// Computes a validator subset using a zero seed.
#[cfg(not(feature = "tycho"))]
pub fn compute_subset(
&self,
shard_ident: ShardIdent,
Expand Down Expand Up @@ -695,15 +884,15 @@ impl ValidatorSet {
total_weight += descr.weight;
}

Cow::Owned(Self {
std::borrow::Cow::Owned(Self {
utime_since: self.utime_since,
utime_until: self.utime_until,
main: self.main,
total_weight,
list,
})
} else {
Cow::Borrowed(self)
std::borrow::Cow::Borrowed(self)
};

let count = std::cmp::min(vset.list.len(), cc_config.shard_validators_num as usize);
Expand Down Expand Up @@ -808,6 +997,7 @@ impl ValidatorSet {
hash
}

#[cfg(not(feature = "tycho"))]
fn at_weight(&self, weight_pos: u64) -> &ValidatorDescription {
debug_assert!(weight_pos < self.total_weight);
debug_assert!(!self.list.is_empty());
Expand Down
Loading
Loading