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

feat(katana): compute block commitments #2609

Merged
merged 4 commits into from
Nov 1, 2024
Merged

feat(katana): compute block commitments #2609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c8b650
compute block commitments
kariy Nov 1, 2024
19f9099
update test db
kariy Nov 1, 2024
8acd21c
udpate test db again
kariy Nov 1, 2024
8e6a1fa
Merge branch 'main' into katana/commitments
kariy Nov 1, 2024
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
2 changes: 2 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions crates/katana/core/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ katana-pool.workspace = true
katana-primitives.workspace = true
katana-provider.workspace = true
katana-tasks.workspace = true
katana-trie.workspace = true

anyhow.workspace = true
async-trait.workspace = true
Expand All @@ -27,6 +28,7 @@ reqwest.workspace = true
serde.workspace = true
serde_json.workspace = true
starknet.workspace = true
starknet-types-core.workspace = true
thiserror.workspace = true
tokio.workspace = true
tracing.workspace = true
Expand Down
187 changes: 157 additions & 30 deletions crates/katana/core/src/backend/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,21 @@ use std::sync::Arc;

use katana_executor::{ExecutionOutput, ExecutionResult, ExecutorFactory};
use katana_primitives::block::{
Block, FinalityStatus, GasPrices, Header, SealedBlock, SealedBlockWithStatus,
FinalityStatus, Header, PartialHeader, SealedBlock, SealedBlockWithStatus,
};
use katana_primitives::chain_spec::ChainSpec;
use katana_primitives::da::L1DataAvailabilityMode;
use katana_primitives::env::BlockEnv;
use katana_primitives::receipt::Receipt;
use katana_primitives::receipt::{Event, ReceiptWithTxHash};
use katana_primitives::state::{compute_state_diff_hash, StateUpdates};
use katana_primitives::transaction::{TxHash, TxWithHash};
use katana_primitives::Felt;
use katana_provider::traits::block::{BlockHashProvider, BlockWriter};
use katana_provider::traits::trie::{ClassTrieWriter, ContractTrieWriter};
use katana_trie::compute_merkle_root;
use parking_lot::RwLock;
use starknet::macros::short_string;
use starknet_types_core::hash::{self, StarkHash};
use tracing::info;

pub mod contract;
Expand Down Expand Up @@ -50,20 +55,29 @@ impl<EF: ExecutorFactory> Backend<EF> {
// only include successful transactions in the block
for (tx, res) in execution_output.transactions {
if let ExecutionResult::Success { receipt, trace, .. } = res {
txs.push(tx);
receipts.push(ReceiptWithTxHash::new(tx.hash, receipt));
traces.push(trace);
receipts.push(receipt);
txs.push(tx);
}
}

let tx_count = txs.len() as u32;
let tx_hashes = txs.iter().map(|tx| tx.hash).collect::<Vec<TxHash>>();

// create a new block and compute its commitment
let block = self.commit_block(block_env, txs, &receipts)?;
let block = self.commit_block(
block_env.clone(),
execution_output.states.state_updates.clone(),
txs,
&receipts,
)?;
kariy marked this conversation as resolved.
Show resolved Hide resolved

let block = SealedBlockWithStatus { block, status: FinalityStatus::AcceptedOnL2 };
let block_number = block.block.header.number;

// TODO: maybe should change the arguments for insert_block_with_states_and_receipts to
// accept ReceiptWithTxHash instead to avoid this conversion.
let receipts = receipts.into_iter().map(|r| r.receipt).collect::<Vec<_>>();
kariy marked this conversation as resolved.
Show resolved Hide resolved
self.blockchain.provider().insert_block_with_states_and_receipts(
block,
execution_output.states,
Expand Down Expand Up @@ -101,41 +115,154 @@ impl<EF: ExecutorFactory> Backend<EF> {

fn commit_block(
&self,
block_env: &BlockEnv,
block_env: BlockEnv,
state_updates: StateUpdates,
transactions: Vec<TxWithHash>,
receipts: &[Receipt],
receipts: &[ReceiptWithTxHash],
) -> Result<SealedBlock, BlockProductionError> {
// get the hash of the latest committed block
let parent_hash = self.blockchain.provider().latest_hash()?;
let events_count = receipts.iter().map(|r| r.events().len() as u32).sum::<u32>();
let transaction_count = transactions.len() as u32;

let l1_gas_prices =
GasPrices { eth: block_env.l1_gas_prices.eth, strk: block_env.l1_gas_prices.strk };
let l1_data_gas_prices = GasPrices {
eth: block_env.l1_data_gas_prices.eth,
strk: block_env.l1_data_gas_prices.strk,
let partial_header = PartialHeader {
parent_hash,
number: block_env.number,
timestamp: block_env.timestamp,
protocol_version: self.chain_spec.version.clone(),
sequencer_address: block_env.sequencer_address,
l1_gas_prices: block_env.l1_gas_prices,
l1_data_gas_prices: block_env.l1_data_gas_prices,
l1_da_mode: L1DataAvailabilityMode::Calldata,
};

let block = UncommittedBlock::new(
partial_header,
transactions,
receipts,
&state_updates,
&self.blockchain.provider(),
)
.commit();
Ok(block)
}
kariy marked this conversation as resolved.
Show resolved Hide resolved
}

#[derive(Debug, Clone)]
pub struct UncommittedBlock<'a, P>
where
P: ClassTrieWriter + ContractTrieWriter,
{
header: PartialHeader,
transactions: Vec<TxWithHash>,
receipts: &'a [ReceiptWithTxHash],
state_updates: &'a StateUpdates,
trie_provider: P,
}

impl<'a, P> UncommittedBlock<'a, P>
where
P: ClassTrieWriter + ContractTrieWriter,
{
pub fn new(
header: PartialHeader,
transactions: Vec<TxWithHash>,
receipts: &'a [ReceiptWithTxHash],
state_updates: &'a StateUpdates,
trie_provider: P,
) -> Self {
Self { header, transactions, receipts, state_updates, trie_provider }
}

pub fn commit(self) -> SealedBlock {
// get the hash of the latest committed block
let parent_hash = self.header.parent_hash;
let events_count = self.receipts.iter().map(|r| r.events().len() as u32).sum::<u32>();
let transaction_count = self.transactions.len() as u32;
let state_diff_length = self.state_updates.len() as u32;

let state_root = self.compute_new_state_root();
let transactions_commitment = self.compute_transaction_commitment();
let events_commitment = self.compute_event_commitment();
let receipts_commitment = self.compute_receipt_commitment();
let state_diff_commitment = self.compute_state_diff_commitment();

let header = Header {
state_root,
parent_hash,
events_count,
l1_gas_prices,
state_diff_length,
transaction_count,
l1_data_gas_prices,
state_root: Felt::ZERO,
number: block_env.number,
events_commitment: Felt::ZERO,
timestamp: block_env.timestamp,
receipts_commitment: Felt::ZERO,
state_diff_commitment: Felt::ZERO,
transactions_commitment: Felt::ZERO,
l1_da_mode: L1DataAvailabilityMode::Calldata,
sequencer_address: block_env.sequencer_address,
protocol_version: self.chain_spec.version.clone(),
events_commitment,
receipts_commitment,
state_diff_commitment,
transactions_commitment,
number: self.header.number,
timestamp: self.header.timestamp,
l1_da_mode: self.header.l1_da_mode,
l1_gas_prices: self.header.l1_gas_prices,
l1_data_gas_prices: self.header.l1_data_gas_prices,
sequencer_address: self.header.sequencer_address,
protocol_version: self.header.protocol_version,
};

let sealed = Block { header, body: transactions }.seal();
Ok(sealed)
let hash = header.compute_hash();

SealedBlock { hash, header, body: self.transactions }
}

fn compute_transaction_commitment(&self) -> Felt {
let tx_hashes = self.transactions.iter().map(|t| t.hash).collect::<Vec<TxHash>>();
compute_merkle_root::<hash::Poseidon>(&tx_hashes).unwrap()
}

fn compute_receipt_commitment(&self) -> Felt {
let receipt_hashes = self.receipts.iter().map(|r| r.compute_hash()).collect::<Vec<Felt>>();
compute_merkle_root::<hash::Poseidon>(&receipt_hashes).unwrap()
}
Comment on lines +210 to +218
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Propagate Errors Instead of Unwrapping

Ohayo, sensei! In the commitment computation methods, using .unwrap() can lead to panics. Consider returning Result<Felt, ErrorType> and propagating errors.

Example for compute_transaction_commitment:

-fn compute_transaction_commitment(&self) -> Felt {
+fn compute_transaction_commitment(&self) -> Result<Felt, SomeErrorType> {
    let tx_hashes = self.transactions.iter().map(|t| t.hash).collect::<Vec<TxHash>>();
-   compute_merkle_root::<hash::Poseidon>(&tx_hashes).unwrap()
+   compute_merkle_root::<hash::Poseidon>(&tx_hashes)
}

Apply similar changes to compute_receipt_commitment and compute_event_commitment.

Committable suggestion skipped: line range outside the PR's diff.


fn compute_state_diff_commitment(&self) -> Felt {
compute_state_diff_hash(self.state_updates.clone())
}

fn compute_event_commitment(&self) -> Felt {
// h(emitter_address, tx_hash, h(keys), h(data))
fn event_hash(tx: TxHash, event: &Event) -> Felt {
let keys_hash = hash::Poseidon::hash_array(&event.keys);
let data_hash = hash::Poseidon::hash_array(&event.data);
hash::Poseidon::hash_array(&[tx, event.from_address.into(), keys_hash, data_hash])
}
kariy marked this conversation as resolved.
Show resolved Hide resolved

// the iterator will yield all events from all the receipts, each one paired with the
// transaction hash that emitted it: (tx hash, event).
let events = self.receipts.iter().flat_map(|r| r.events().iter().map(|e| (r.tx_hash, e)));

let mut hashes = Vec::new();
for (tx, event) in events {
let event_hash = event_hash(tx, event);
hashes.push(event_hash);
}

// compute events commitment
compute_merkle_root::<hash::Poseidon>(&hashes).unwrap()
}

Comment on lines +225 to +245
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Optimize Event Commitment Calculation

Ohayo, sensei! The current implementation collects event hashes into a Vec, which might not be necessary. You can compute the Merkle root directly using an iterator to reduce memory usage.

Modify the compute_event_commitment method:

-fn compute_event_commitment(&self) -> Felt {
-    // ...
-    let mut hashes = Vec::new();
-    for (tx, event) in events {
-        let event_hash = event_hash(tx, event);
-        hashes.push(event_hash);
-    }
-    compute_merkle_root::<hash::Poseidon>(&hashes).unwrap()
+fn compute_event_commitment(&self) -> Result<Felt, SomeErrorType> {
+    let hashes = events.map(|(tx, event)| event_hash(tx, event));
+    compute_merkle_root_iter::<hash::Poseidon, _, _>(hashes)
}

Committable suggestion skipped: line range outside the PR's diff.

// state_commitment = hPos("STARKNET_STATE_V0", contract_trie_root, class_trie_root)
fn compute_new_state_root(&self) -> Felt {
let class_trie_root = ClassTrieWriter::insert_updates(
&self.trie_provider,
self.header.number,
&self.state_updates.declared_classes,
)
.unwrap();

let contract_trie_root = ContractTrieWriter::insert_updates(
&self.trie_provider,
self.header.number,
self.state_updates,
)
.unwrap();

hash::Poseidon::hash_array(&[
short_string!("STARKNET_STATE_V0"),
contract_trie_root,
class_trie_root,
])
kariy marked this conversation as resolved.
Show resolved Hide resolved
}
}
5 changes: 5 additions & 0 deletions crates/katana/core/src/backend/storage.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ use katana_provider::traits::transaction::{
ReceiptProvider, TransactionProvider, TransactionStatusProvider, TransactionTraceProvider,
TransactionsProviderExt,
};
use katana_provider::traits::trie::{ClassTrieWriter, ContractTrieWriter};
use katana_provider::BlockchainProvider;
use num_traits::ToPrimitive;
use starknet::core::types::{BlockStatus, MaybePendingBlockWithTxHashes};
Expand All @@ -43,6 +44,8 @@ pub trait Database:
+ ContractClassWriter
+ StateFactoryProvider
+ BlockEnvProvider
+ ClassTrieWriter
+ ContractTrieWriter
+ 'static
+ Send
+ Sync
Expand All @@ -64,6 +67,8 @@ impl<T> Database for T where
+ ContractClassWriter
+ StateFactoryProvider
+ BlockEnvProvider
+ ClassTrieWriter
+ ContractTrieWriter
+ 'static
+ Send
+ Sync
Expand Down
Loading
Loading