Skip to content

Commit

Permalink
Minor updates to docs + a few typos fixed (#2250)
Browse files Browse the repository at this point in the history
## 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
  • Loading branch information
rafal-ch authored Sep 25, 2024
1 parent 56a94ca commit 65378d0
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion crates/fuel-core/src/database.rs
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ pub type Database<Description = OnChain, Stage = RegularStage<Description>> =
GenericDatabase<DataSource<Description, Stage>>;
pub type OnChainIterableKeyValueView = IterableKeyValueView<ColumnType<OnChain>>;
pub type OffChainIterableKeyValueView = IterableKeyValueView<ColumnType<OffChain>>;
pub type ReyalerIterableKeyValueView = IterableKeyValueView<ColumnType<Relayer>>;
pub type RelayerIterableKeyValueView = IterableKeyValueView<ColumnType<Relayer>>;

pub type GenesisDatabase<Description = OnChain> = Database<Description, GenesisStage>;

Expand Down
4 changes: 2 additions & 2 deletions crates/fuel-core/src/executor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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::<Relayer>::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
Expand Down
4 changes: 2 additions & 2 deletions crates/fuel-core/src/service/adapters/executor.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use crate::{
database::ReyalerIterableKeyValueView,
database::RelayerIterableKeyValueView,
service::adapters::TransactionsSource,
};
use fuel_core_executor::ports::MaybeCheckedTransaction;
Expand Down Expand Up @@ -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")]
{
Expand Down
2 changes: 1 addition & 1 deletion crates/fuel-gas-price-algorithm/src/v1.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion crates/services/consensus_module/poa/src/signer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}
Expand Down
4 changes: 2 additions & 2 deletions docs/developers/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 65378d0

Please sign in to comment.