From 65378d0f1e05ec02dcfa69c47c218c4b6958bfc3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Chabowski?= <88321181+rafal-ch@users.noreply.github.com> Date: Wed, 25 Sep 2024 15:29:38 +0200 Subject: [PATCH] Minor updates to docs + a few typos fixed (#2250) ## Description This PR changes the following: 1. Update the `debugging.md` file to refer to `fuel-core-keygen` instead of `fuel-core-keygen-bin`. This change stems from [this modification](https://github.com/FuelLabs/fuel-core/pull/1515/files#diff-35b578593f4bea8ee7799191093588be084eb849138698a4b1ce355d27742a48R12-R15). 2. Minor typos that I stumbled upon when reading through the codebase ### Before requesting review - [X] I have reviewed the code myself --- crates/fuel-core/src/database.rs | 2 +- crates/fuel-core/src/executor.rs | 4 ++-- crates/fuel-core/src/service/adapters/executor.rs | 4 ++-- crates/fuel-gas-price-algorithm/src/v1.rs | 2 +- .../src/v1/tests/update_da_record_data_tests.rs | 2 +- crates/services/consensus_module/poa/src/signer.rs | 2 +- docs/developers/debugging.md | 4 ++-- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/crates/fuel-core/src/database.rs b/crates/fuel-core/src/database.rs index 1ce471381ce..ac479fae6f8 100644 --- a/crates/fuel-core/src/database.rs +++ b/crates/fuel-core/src/database.rs @@ -121,7 +121,7 @@ pub type Database> = GenericDatabase>; pub type OnChainIterableKeyValueView = IterableKeyValueView>; pub type OffChainIterableKeyValueView = IterableKeyValueView>; -pub type ReyalerIterableKeyValueView = IterableKeyValueView>; +pub type RelayerIterableKeyValueView = IterableKeyValueView>; pub type GenesisDatabase = Database; diff --git a/crates/fuel-core/src/executor.rs b/crates/fuel-core/src/executor.rs index 7300127a33a..8d1a1fd37f2 100644 --- a/crates/fuel-core/src/executor.rs +++ b/crates/fuel-core/src/executor.rs @@ -3641,11 +3641,11 @@ mod tests { ); // when - let verifyer_db = database_with_genesis_block(genesis_da_height); + let verifier_db = database_with_genesis_block(genesis_da_height); let mut verifier_relayer_db = Database::::default(); let events = vec![event]; add_events_to_relayer(&mut verifier_relayer_db, da_height.into(), &events); - let verifier = create_relayer_executor(verifyer_db, verifier_relayer_db); + let verifier = create_relayer_executor(verifier_db, verifier_relayer_db); let (result, _) = verifier.validate(&produced_block).unwrap().into(); // then diff --git a/crates/fuel-core/src/service/adapters/executor.rs b/crates/fuel-core/src/service/adapters/executor.rs index 4728de7ca71..9218965aee3 100644 --- a/crates/fuel-core/src/service/adapters/executor.rs +++ b/crates/fuel-core/src/service/adapters/executor.rs @@ -1,5 +1,5 @@ use crate::{ - database::ReyalerIterableKeyValueView, + database::RelayerIterableKeyValueView, service::adapters::TransactionsSource, }; use fuel_core_executor::ports::MaybeCheckedTransaction; @@ -29,7 +29,7 @@ impl fuel_core_executor::ports::TransactionsSource for TransactionsSource { } } -impl fuel_core_executor::ports::RelayerPort for ReyalerIterableKeyValueView { +impl fuel_core_executor::ports::RelayerPort for RelayerIterableKeyValueView { fn enabled(&self) -> bool { #[cfg(feature = "relayer")] { diff --git a/crates/fuel-gas-price-algorithm/src/v1.rs b/crates/fuel-gas-price-algorithm/src/v1.rs index ca3b58f22f9..dad6d64beea 100644 --- a/crates/fuel-gas-price-algorithm/src/v1.rs +++ b/crates/fuel-gas-price-algorithm/src/v1.rs @@ -127,7 +127,7 @@ pub struct AlgorithmUpdaterV1 { pub max_da_gas_price_change_percent: u16, /// The cumulative reward from the DA portion of the gas price pub total_da_rewards_excess: u128, - /// The height of the las L2 block recorded on the DA chain + /// The height of the last L2 block recorded on the DA chain pub da_recorded_block_height: u32, /// The cumulative cost of recording L2 blocks on the DA chain as of the last recorded block pub latest_known_total_da_cost_excess: u128, diff --git a/crates/fuel-gas-price-algorithm/src/v1/tests/update_da_record_data_tests.rs b/crates/fuel-gas-price-algorithm/src/v1/tests/update_da_record_data_tests.rs index 8df873854f3..e9d64a63bcc 100644 --- a/crates/fuel-gas-price-algorithm/src/v1/tests/update_da_record_data_tests.rs +++ b/crates/fuel-gas-price-algorithm/src/v1/tests/update_da_record_data_tests.rs @@ -143,7 +143,7 @@ fn update_da_record_data__updates_known_total_cost() { } #[test] -fn update_da_record_data__if_da_height_matches_l2_height_prjected_and_known_match() { +fn update_da_record_data__if_da_height_matches_l2_height_projected_and_known_match() { // given let da_cost_per_byte = 20; let da_recorded_block_height = 10; diff --git a/crates/services/consensus_module/poa/src/signer.rs b/crates/services/consensus_module/poa/src/signer.rs index 2712b980c7d..876a9d6b5a7 100644 --- a/crates/services/consensus_module/poa/src/signer.rs +++ b/crates/services/consensus_module/poa/src/signer.rs @@ -48,7 +48,7 @@ pub enum SignMode { } impl SignMode { - /// Is block sigining (production) available + /// Is block signing (production) available pub fn is_available(&self) -> bool { !matches!(self, SignMode::Unavailable) } diff --git a/docs/developers/debugging.md b/docs/developers/debugging.md index 06b41322d5d..08b2ab2b81c 100644 --- a/docs/developers/debugging.md +++ b/docs/developers/debugging.md @@ -50,10 +50,10 @@ Using environment variables for CLI arguments allows these values to be reused a When running the client with the P2P service enabled, i.e., building the binary with the `p2p` feature and supplying the runtime argument `--enable-p2p`, the client will connect to a Fuel network. This requires additional CLI arguments, including the `--keypair` and `--network` arguments. -A key pair can be generated by running the utility binary `fuel-core-keygen-bin`: +A key pair can be generated by running the utility binary `fuel-core-keygen`: ```bash -cargo run --bin fuel-core-keygen-bin new +cargo run --bin fuel-core-keygen new ``` The resulting key pair printed to the console contains an address and secret. The `secret` can be provided to the `--keypair` argument when running the node.