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.

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

feat: Use timestamp of last block when dry running transactions #2206

Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- [2155](https://github.com/FuelLabs/fuel-core/pull/2155): Added trait declaration for block committer data
- [2142](https://github.com/FuelLabs/fuel-core/pull/2142): Added benchmarks for varied forms of db lookups to assist in optimizations.
- [2158](https://github.com/FuelLabs/fuel-core/pull/2158): Log the public address of the signing key, if it is specified
- [2206](https://github.com/FuelLabs/fuel-core/pull/2206): Use timestamp of last block when dry running transactions.

## [Version 0.35.0]

Expand Down
1 change: 1 addition & 0 deletions crates/fuel-core/src/graphql_api/ports.rs
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ pub trait BlockProducerPort: Send + Sync {
&self,
transactions: Vec<Transaction>,
height: Option<BlockHeight>,
time: Option<Tai64>,
utxo_validation: Option<bool>,
gas_price: Option<u64>,
) -> anyhow::Result<Vec<TransactionExecutionStatus>>;
Expand Down
3 changes: 2 additions & 1 deletion crates/fuel-core/src/schema/tx.rs
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,8 @@ impl TxMutation {
let tx_statuses = block_producer
.dry_run_txs(
transactions,
None,
None, // TODO(#1749): Pass parameter from API
None, // TODO(#1749): Pass parameter from API
utxo_validation,
gas_price.map(|x| x.into()),
)
Expand Down
3 changes: 2 additions & 1 deletion crates/fuel-core/src/service/adapters/graphql_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,12 @@ impl BlockProducerPort for BlockProducerAdapter {
&self,
transactions: Vec<Transaction>,
height: Option<BlockHeight>,
time: Option<Tai64>,
utxo_validation: Option<bool>,
gas_price: Option<u64>,
) -> anyhow::Result<Vec<TransactionExecutionStatus>> {
self.block_producer
.dry_run(transactions, height, utxo_validation, gas_price)
.dry_run(transactions, height, time, utxo_validation, gas_price)
.await
}
}
Expand Down
17 changes: 12 additions & 5 deletions crates/services/producer/src/block_producer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -268,26 +268,33 @@ where
GasPriceProvider: GasPriceProviderConstraint,
ConsensusProvider: ConsensusParametersProvider,
{
// TODO: Support custom `block_time` for `dry_run`.
/// Simulates multiple transactions without altering any state. Does not acquire the production lock.
/// since it is basically a "read only" operation and shouldn't get in the way of normal
/// production.
pub async fn dry_run(
&self,
transactions: Vec<Transaction>,
height: Option<BlockHeight>,
time: Option<Tai64>,
utxo_validation: Option<bool>,
gas_price: Option<u64>,
) -> anyhow::Result<Vec<TransactionExecutionStatus>> {
let view = self.view_provider.latest_view()?;
let height = height.unwrap_or_else(|| {
view.latest_height()
.unwrap_or_default()
let latest_height = view.latest_height().unwrap_or_default();

let simulated_height = height.unwrap_or_else(|| {
latest_height
.succ()
.expect("It is impossible to overflow the current block height")
});

let header = self._new_header(height, Tai64::now())?;
let simulated_time = time.unwrap_or_else(|| {
view.get_block(&latest_height)
netrome marked this conversation as resolved.
Show resolved Hide resolved
.map(|block| block.header().time())
.unwrap_or(Tai64::UNIX_EPOCH)
});

let header = self._new_header(simulated_height, simulated_time)?;
netrome marked this conversation as resolved.
Show resolved Hide resolved

let gas_price = if let Some(inner) = gas_price {
inner
Expand Down
181 changes: 139 additions & 42 deletions crates/services/producer/src/block_producer/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,110 @@ mod produce_and_execute_block_txpool {
}
}

// Tests for the `dry_run` method.
mod dry_run {
use super::*;

#[tokio::test]
async fn dry_run__executes_with_given_timestamp() {
netrome marked this conversation as resolved.
Show resolved Hide resolved
// Given
let simulated_block_time = Tai64::from_unix(1337);
let executor = MockExecutorWithCapture::default();
let ctx = TestContext::default_from_executor(executor.clone());

// When
let _err = ctx
.producer()
.dry_run(vec![], None, Some(simulated_block_time), None, None)
.await
.expect("dry run failed");
netrome marked this conversation as resolved.
Show resolved Hide resolved

// Then
assert_eq!(executor.captured_block_timestamp(), simulated_block_time);
}

#[tokio::test]
async fn dry_run__executes_with_past_timestamp() {
// Given
let simulated_block_time = Tai64::UNIX_EPOCH;
let last_block_time = Tai64::from_unix(1337);

let executor = MockExecutorWithCapture::default();
let ctx = TestContextBuilder::new()
.with_prev_time(last_block_time)
.build_with_executor(executor.clone());

// When
let _err = ctx
.producer()
.dry_run(vec![], None, Some(simulated_block_time), None, None)
.await
.expect("dry run failed");
netrome marked this conversation as resolved.
Show resolved Hide resolved

// Then
assert_eq!(executor.captured_block_timestamp(), simulated_block_time);
}

#[tokio::test]
async fn dry_run__uses_last_block_timestamp_when_no_time_provided() {
// Given
let last_block_time = Tai64::from_unix(1337);

let executor = MockExecutorWithCapture::default();
let ctx = TestContextBuilder::new()
.with_prev_time(last_block_time)
.build_with_executor(executor.clone());

// When
let _err = ctx
.producer()
.dry_run(vec![], None, None, None, None)
.await
.expect("dry run failed");
netrome marked this conversation as resolved.
Show resolved Hide resolved

// Then
assert_eq!(executor.captured_block_timestamp(), last_block_time);
}

#[tokio::test]
async fn dry_run__errors_early_if_height_is_lower_than_chain_tip() {
// Given
let last_block_height = BlockHeight::new(42);

let executor = MockExecutorWithCapture::default();
let ctx = TestContextBuilder::new()
.with_prev_height(last_block_height)
.build_with_executor(executor.clone());

// When
let _err = ctx
.producer()
.dry_run(vec![], last_block_height.pred(), None, None, None)
.await
.expect_err("expected failure");

// Then
assert!(executor.has_no_captured_block_timestamp());
}

impl MockExecutorWithCapture<Transaction> {
fn captured_block_timestamp(&self) -> Tai64 {
*self
.captured
.lock()
.unwrap()
.as_ref()
.expect("should have captured a block")
.header_to_produce
.time()
}

fn has_no_captured_block_timestamp(&self) -> bool {
self.captured.lock().unwrap().is_none()
}
}
}

use fuel_core_types::fuel_tx::field::MintGasPrice;
use proptest::{
prop_compose,
Expand Down Expand Up @@ -804,6 +908,7 @@ struct TestContextBuilder {
prev_da_height: DaBlockHeight,
block_gas_limit: Option<u64>,
prev_height: BlockHeight,
prev_time: Tai64,
}

impl TestContextBuilder {
Expand All @@ -814,6 +919,7 @@ impl TestContextBuilder {
prev_da_height: 1u64.into(),
block_gas_limit: None,
prev_height: 0u32.into(),
prev_time: Tai64::UNIX_EPOCH,
}
}

Expand Down Expand Up @@ -846,16 +952,25 @@ impl TestContextBuilder {
self
}

fn build(&self) -> TestContext<MockExecutor> {
fn with_prev_time(mut self, prev_time: Tai64) -> Self {
self.prev_time = prev_time;
self
}

fn pre_existing_blocks(&self) -> Arc<Mutex<HashMap<BlockHeight, CompressedBlock>>> {
let da_height = self.prev_da_height;
let previous_block = PartialFuelBlock {
let height = self.prev_height;
let time = self.prev_time;

let block = PartialFuelBlock {
header: PartialBlockHeader {
application: ApplicationHeader {
da_height,
..Default::default()
},
consensus: ConsensusHeader {
height: self.prev_height,
height,
time,
..Default::default()
},
},
Expand All @@ -865,67 +980,49 @@ impl TestContextBuilder {
.unwrap()
.compress(&Default::default());

let db = MockDb {
blocks: Arc::new(Mutex::new(
vec![(self.prev_height, previous_block)]
.into_iter()
.collect(),
)),
consensus_parameters_version: 0,
state_transition_bytecode_version: 0,
};
Arc::new(Mutex::new(HashMap::from_iter(Some((height, block)))))
}

fn build(self) -> TestContext<MockExecutor> {
let block_gas_limit = self.block_gas_limit.unwrap_or_default();

let mock_relayer = MockRelayer {
latest_block_height: self.latest_block_height,
latest_da_blocks_with_costs: self.blocks_with_gas_costs.clone(),
..Default::default()
};

let db = MockDb {
blocks: self.pre_existing_blocks(),
consensus_parameters_version: 0,
state_transition_bytecode_version: 0,
};

TestContext {
relayer: mock_relayer,
block_gas_limit: self.block_gas_limit.unwrap_or_default(),
block_gas_limit,
..TestContext::default_from_db(db)
}
}

fn build_with_executor<Ex>(&self, executor: Ex) -> TestContext<Ex> {
let da_height = self.prev_da_height;
let previous_block = PartialFuelBlock {
header: PartialBlockHeader {
application: ApplicationHeader {
da_height,
..Default::default()
},
consensus: ConsensusHeader {
height: self.prev_height,
..Default::default()
},
},
transactions: vec![],
}
.generate(&[], Default::default())
.unwrap()
.compress(&Default::default());

let db = MockDb {
blocks: Arc::new(Mutex::new(
vec![(self.prev_height, previous_block)]
.into_iter()
.collect(),
)),
consensus_parameters_version: 0,
state_transition_bytecode_version: 0,
};
fn build_with_executor<Ex>(self, executor: Ex) -> TestContext<Ex> {
let block_gas_limit = self.block_gas_limit.unwrap_or_default();

let mock_relayer = MockRelayer {
latest_block_height: self.latest_block_height,
latest_da_blocks_with_costs: self.blocks_with_gas_costs.clone(),
..Default::default()
};

let db = MockDb {
blocks: self.pre_existing_blocks(),
consensus_parameters_version: 0,
state_transition_bytecode_version: 0,
};

TestContext {
relayer: mock_relayer,
block_gas_limit: self.block_gas_limit.unwrap_or_default(),
block_gas_limit,
..TestContext::default_from_db_and_executor(db, executor)
}
}
Expand Down
14 changes: 14 additions & 0 deletions crates/services/producer/src/mocks.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use crate::ports::{
BlockProducer,
BlockProducerDatabase,
DryRunner,
Relayer,
TxPool,
};
Expand Down Expand Up @@ -37,6 +38,7 @@ use fuel_core_types::{
Error as ExecutorError,
ExecutionResult,
Result as ExecutorResult,
TransactionExecutionStatus,
UncommittedResult,
},
txpool::ArcPoolTx,
Expand Down Expand Up @@ -227,6 +229,18 @@ impl BlockProducer<Vec<Transaction>> for MockExecutorWithCapture<Transaction> {
}
}

impl DryRunner for MockExecutorWithCapture<Transaction> {
fn dry_run(
&self,
block: Components<Vec<Transaction>>,
_utxo_validation: Option<bool>,
) -> ExecutorResult<Vec<TransactionExecutionStatus>> {
*self.captured.lock().unwrap() = Some(block);

Ok(Vec::new())
}
}

impl<Tx> Default for MockExecutorWithCapture<Tx> {
fn default() -> Self {
Self {
Expand Down
Loading
Loading