feat: add support for bsc parlia consensus #4

pythonberg1997 · 2024-05-04T10:39:43Z

TODO

unclezoro · 2024-05-06T07:48:51Z

crates/interfaces/Cargo.toml

@@ -40,6 +40,7 @@ tokio = { workspace = true, features = ["full"] }
 secp256k1 = { workspace = true, features = ["alloc", "recovery", "rand"] }

 [features]
+bsc = []


No. [] is legal. This means this feature requires no additional crate.

unclezoro · 2024-05-06T07:50:01Z

crates/interfaces/src/consensus.rs

+
+    /// Error type transparently wrapping ParliaConsensusError.
+    #[error(transparent)]
+    ParliaConsensusError(#[from] ParliaConsensusError),


I think it should be more concrete error, but not Parliaxxx error, for example InvalidDifficulty error is kind of HeaderValidationError, let us try to reuse current trait and add more Enum type to current errors.

Sure. This is a transparent error. I do implement a ParliaConsensusError enum struct.

unclezoro · 2024-05-06T07:55:12Z

crates/revm/src/factory.rs

    chain_spec: Arc<ChainSpec>,
    stack: Option<InspectorStack>,
    /// Type that defines how the produced EVM should be configured.
    evm_config: EvmConfig,
+    /// Parlia consensus instance
+    parlia_consensus: Option<Arc<Parlia<P>>>,


This seems not a good pattern, I did not see anywhere use this?

unclezoro · 2024-05-06T07:57:00Z

crates/revm/src/processor.rs

@@ -60,9 +72,11 @@ pub struct EVMProcessor<'a, EvmConfig> {
    pub(crate) stats: BlockExecutorStats,
    /// The type that is able to configure the EVM environment.
    _evm_config: EvmConfig,
+
+    parlia_consensus: Option<Arc<Parlia<P>>>,


It seems not a good pattern.

If it is used as a flag, we can replace with feature?

unclezoro · 2024-05-06T07:58:12Z

crates/revm/src/processor.rs

+    }
+
+    #[cfg(feature = "bsc")]
+    pub fn finalize(


I think it is better to move to consensus.

unclezoro · 2024-05-08T05:07:33Z

crates/consensus/auto-seal/src/lib.rs

        &mut self,
        block: &BlockWithSenders,
-        executor: &mut EVMProcessor<'_, EvmConfig>,
+        executor: &mut EVMProcessor<'_, EvmConfig, P>,


I think EVMProcessor is a very high level trait, prefer not to inject the Parlia engine into it.

unclezoro · 2024-05-08T05:11:36Z

crates/consensus/parlia/src/go_rng.rs

+/// algorithm by
+/// DP Mitchell and JA Reeds
+
+const RNG_LEN: usize = 607;


move this file to a more common packages?

It will only be used inside parlia.

unclezoro · 2024-05-08T05:12:01Z

crates/consensus/parlia/src/go_rng.rs

@@ -0,0 +1,857 @@
+/// Uniform distribution
+/// algorithm by
+/// DP Mitchell and JA Reeds


can you comment the detailed go implementation lib?

How does akula handle this random library?

I copied from akula

unclezoro · 2024-05-08T05:23:01Z

crates/consensus/parlia/src/lib.rs

+}
+
+/// BSC parlia consensus implementation
+pub struct Parlia<P> {


Should't P have some trait?

unclezoro · 2024-05-08T05:28:08Z

crates/consensus/parlia/src/lib.rs

+        ))
+    }
+
+    pub fn get_snapshot_from_cache(&self, hash: &B256) -> Option<Snapshot> {


not used yet?

Used in BscEVMProcesser.finalize

unclezoro · 2024-05-08T05:30:56Z

crates/consensus/parlia/src/lib.rs

+    }
+}
+
+impl<P> Parlia<P> {


I can see many impl<P> Parlia<P>, can we structure them better in a more readable way.

There're too many method of parlia, so I try to split them into different topics. Assemble system tx, abi encode/decode, check fork and others

unclezoro · 2024-05-08T05:39:05Z

crates/consensus/parlia/src/lib.rs

+        (*STAKE_HUB_CONTRACT, Bytes::from(function.abi_encode_input(&[]).unwrap()))
+    }
+
+    pub fn unpack_data_into_max_elected_validators(&self, data: &[u8]) -> U256 {


are these unpack function still usable?

unclezoro · 2024-05-08T05:54:08Z

crates/revm/src/factory.rs

    chain_spec: Arc<ChainSpec>,
    stack: Option<InspectorStack>,
    /// Type that defines how the produced EVM should be configured.
    evm_config: EvmConfig,
+
+    _phantom: PhantomData<P>,


_phantom seems useless?

unclezoro · 2024-05-08T07:07:59Z

crates/revm/src/factory.rs

+            evm_config,
+            _phantom: PhantomData::default(),
+            #[cfg(feature = "bsc")]
+            parlia_cfg: None,


I think a factory should not have parlia_cfg, but it can generate a Processor that have parlia_cfg?

prefer to use trait instead of concreat parlia_cfg?

unclezoro · 2024-05-08T07:09:40Z

crates/revm/src/factory.rs

            self.chain_spec.clone(),
            database_state,
            self.evm_config.clone(),
        );
        if let Some(stack) = &self.stack {
            evm.set_stack(stack.clone());
        }
+        #[cfg(feature = "bsc")]


not good code pattern, if more chain support, it will be chaos,

unclezoro · 2024-05-08T07:16:28Z

crates/revm/src/processor.rs

+        }
+
+        // perf: do not execute empty blocks
+        if block.body.is_empty() {


even an empty block, may need to consensus finalize (like breath block and so on)

In fact there should never be empty block on BSC. Anyway, I remove this line.

unclezoro · 2024-05-08T07:18:09Z

crates/revm/src/processor.rs

+        total_difficulty: U256,
+    ) -> Result<Vec<Receipt>, BlockExecutionError> {
+        self.init_env(&block.header, total_difficulty);
+        let (mut system_tx, mut receipts, mut cumulative_gas_used) =


==> system_txs?

unclezoro · 2024-05-08T07:20:30Z

crates/revm/src/processor.rs

+        let validator = header.beneficiary;
+        let parent = self.parlia_consensus.get_header_by_hash(header.number, header.parent_hash)?;
+
+        // The snapshot should be ready after the header stage


can we wrap most of the following code into the conseneus parlia crate?

unclezoro · 2024-05-08T07:25:47Z

crates/revm/src/processor.rs

+        }
+
+        let nonce = self.db_mut().basic(validator).unwrap().unwrap().nonce;
+        self.parlia_consensus.distribute_to_validator(nonce, validator, block_reward)?;


need todo self.transact_system_tx?

unclezoro · 2024-05-08T07:39:42Z

crates/stages/src/stages/headers.rs

@@ -79,6 +86,24 @@ where
        consensus: Arc<dyn Consensus>,
        etl_config: EtlConfig,
    ) -> Self {
+        #[cfg(feature = "bsc")]


is it a good pattern to use the feature inside a function?

unclezoro reviewed May 6, 2024

View reviewed changes

crates/revm/src/processor.rs Outdated

}

#[cfg(feature = "bsc")]

pub fn finalize(

Copy link

Collaborator

unclezoro May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is better to move to consensus.

pythonberg1997 changed the base branch from develop to bsc_feature May 6, 2024 12:04

unclezoro reviewed May 8, 2024

View reviewed changes

pythonberg1997 force-pushed the roshan/parlia branch from 37d9fc1 to 576673d Compare May 11, 2024 07:07

feat: add support for bsc parlia consensus

72e843a

pythonberg1997 force-pushed the roshan/parlia branch from 576673d to 72e843a Compare May 11, 2024 07:18

pythonberg1997 added 3 commits May 11, 2024 16:00

fix ordering of ValidatorItem

d2caf1f

fix build errors

272439f

update errors type

3ace179

forcodedancing marked this pull request as ready for review May 15, 2024 07:24

forcodedancing merged commit fede7b9 into bsc_feature May 15, 2024
5 of 24 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for bsc parlia consensus #4

feat: add support for bsc parlia consensus #4

pythonberg1997 commented May 4, 2024

unclezoro May 6, 2024

pythonberg1997 May 6, 2024

unclezoro May 6, 2024 •

edited

Loading

pythonberg1997 May 6, 2024

unclezoro May 6, 2024 •

edited

Loading

pythonberg1997 May 9, 2024

unclezoro May 6, 2024 •

edited

Loading

pythonberg1997 May 6, 2024

unclezoro May 6, 2024

unclezoro May 8, 2024

unclezoro May 8, 2024

pythonberg1997 May 9, 2024

unclezoro May 8, 2024 •

edited

Loading

unclezoro May 8, 2024

pythonberg1997 May 9, 2024

unclezoro May 8, 2024

unclezoro May 8, 2024

pythonberg1997 May 9, 2024

unclezoro May 8, 2024

pythonberg1997 May 9, 2024

unclezoro May 8, 2024

pythonberg1997 May 9, 2024

unclezoro May 8, 2024

pythonberg1997 May 9, 2024

unclezoro May 8, 2024

unclezoro May 8, 2024

unclezoro May 8, 2024

unclezoro May 8, 2024

pythonberg1997 May 9, 2024

unclezoro May 8, 2024

pythonberg1997 May 9, 2024

unclezoro May 8, 2024 •

edited

Loading

unclezoro May 8, 2024

unclezoro May 8, 2024

feat: add support for bsc parlia consensus #4

feat: add support for bsc parlia consensus #4

Conversation

pythonberg1997 commented May 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unclezoro May 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unclezoro May 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unclezoro May 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unclezoro May 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unclezoro May 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unclezoro May 6, 2024 •

edited

Loading

unclezoro May 6, 2024 •

edited

Loading

unclezoro May 6, 2024 •

edited

Loading

unclezoro May 8, 2024 •

edited

Loading

unclezoro May 8, 2024 •

edited

Loading