From 8cd29787857303c6f455c08e948a694cc2e8f46d Mon Sep 17 00:00:00 2001 From: crStiv Date: Tue, 17 Dec 2024 18:21:51 +0100 Subject: [PATCH] fix: multiple typos of different importance (#470) * simplification * typo * typo * typo * typos --- benches/README.md | 2 +- benches/harness.rs | 2 +- ethereum/consensus-core/src/consensus_core.rs | 2 +- examples/checkpoints.rs | 2 +- rpc.md | 6 +++--- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/benches/README.md b/benches/README.md index 0842859e..257421bd 100644 --- a/benches/README.md +++ b/benches/README.md @@ -7,7 +7,7 @@ Benchmarks are defined in the [benches](./) subdirectory and can be run using th #### Flamegraphs -[Flamegraph](https://github.com/brendangregg/FlameGraph) is a powerful rust crate for generating profile visualizations, that is graphing the time a program spends in each function. Functions called during execution are displayed as horizontal rectangles with the width proportional to the time spent in that function. As the call stack grows (think nested function invocations), the rectangles are stacked vertically. This provides a powerful visualization for quickly understanding which parts of a codebase take up disproportionate amounts of time. +[Flamegraph](https://github.com/brendangregg/FlameGraph) is a powerful rust crate for generating profile visualizations, graphing the time a program spends in each function. Functions called during execution are displayed as horizontal rectangles with the width proportional to the time spent in that function. As the call stack grows (think nested function invocations), the rectangles are stacked vertically. This provides a powerful visualization for quickly understanding which parts of a codebase take up disproportionate amounts of time. Check out Brendan Gregg's [Flame Graphs](http://www.brendangregg.com/flamegraphs.html) blog post if you're interested in learning more about flamegraphs and performance visualizations in general. diff --git a/benches/harness.rs b/benches/harness.rs index b160b9e1..766ffc16 100644 --- a/benches/harness.rs +++ b/benches/harness.rs @@ -11,7 +11,7 @@ use std::{path::PathBuf, str::FromStr}; /// Fetches the latest mainnet checkpoint from the fallback service. /// /// Uses the [CheckpointFallback](config::CheckpointFallback). -/// The `build` method will fetch a list of [CheckpointFallbackService](config::CheckpointFallbackService)s from a community-mainained list by ethPandaOps. +/// The `build` method will fetch a list of [CheckpointFallbackService](config::CheckpointFallbackService)s from a community-maintained list by ethPandaOps. /// This list is NOT guaranteed to be secure, but is provided in good faith. /// The raw list can be found here: https://github.com/ethpandaops/checkpoint-sync-health-checks/blob/master/_data/endpoints.yaml pub async fn fetch_mainnet_checkpoint() -> eyre::Result { diff --git a/ethereum/consensus-core/src/consensus_core.rs b/ethereum/consensus-core/src/consensus_core.rs index 3eb0f9e7..84e3483d 100644 --- a/ethereum/consensus-core/src/consensus_core.rs +++ b/ethereum/consensus-core/src/consensus_core.rs @@ -349,7 +349,7 @@ pub fn verify_generic_update( Ok(()) } -/// WARNING: `force_update` allows Helios to accept a header with less than a quorum of signaures. +/// WARNING: `force_update` allows Helios to accept a header with less than a quorum of signatures. /// Use with caution only in cases where it is not possible that valid updates are being censored. pub fn force_update(store: &mut LightClientStore, current_slot: u64) { if current_slot > store.finalized_header.beacon().slot + S::slots_per_sync_commitee_period() { diff --git a/examples/checkpoints.rs b/examples/checkpoints.rs index 0b4a593f..c6814be5 100644 --- a/examples/checkpoints.rs +++ b/examples/checkpoints.rs @@ -6,7 +6,7 @@ use helios::ethereum::config::{checkpoints, networks}; #[tokio::main] async fn main() -> Result<()> { // Construct the checkpoint fallback services. - // The `build` method will fetch a list of [CheckpointFallbackService]s from a community-mainained list by ethPandaOps. + // The `build` method will fetch a list of [CheckpointFallbackService]s from a community-maintained list by ethPandaOps. // This list is NOT guaranteed to be secure, but is provided in good faith. // The raw list can be found here: https://github.com/ethpandaops/checkpoint-sync-health-checks/blob/master/_data/endpoints.yaml let cf = checkpoints::CheckpointFallback::new() diff --git a/rpc.md b/rpc.md index 79c76ebf..6161e145 100644 --- a/rpc.md +++ b/rpc.md @@ -10,7 +10,7 @@ Helios provides a variety of RPC methods for interacting with the Ethereum netwo | `eth_getTransactionCount` | `get_nonce` | Returns the number of transactions sent from the given address. | `client.get_nonce(&self, address: &str, block: BlockTag)` | | `eth_getCode` | `get_code` | Returns the code at a given address. | `client.get_code(&self, address: &str, block: BlockTag)` | | `eth_call` | `call` | Executes a new message call immediately without creating a transaction on the blockchain. | `client.call(&self, opts: CallOpts, block: BlockTag)` | -| `eth_estimateGas` | `estimate_gas` | Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. | `client.estimate_gas(&self, opts: CallOpts)` | +| `eth_estimateGas` | `estimate_gas` | Generates and returns an estimate of how much gas is necessary to allow the transaction to be completed. | `client.estimate_gas(&self, opts: CallOpts)` | | `eth_getChainId` | `chain_id` | Returns the chain ID of the current network. | `client.chain_id(&self)` | | `eth_gasPrice` | `gas_price` | Returns the current price per gas in wei. | `client.gas_price(&self)` | | `eth_maxPriorityFeePerGas` | `max_priority_fee_per_gas` | Returns the current max priority fee per gas in wei. | `client.max_priority_fee_per_gas(&self)` | @@ -27,8 +27,8 @@ Helios provides a variety of RPC methods for interacting with the Ethereum netwo | `eth_getBlockTransactionCountByHash` | `get_block_transaction_count_by_hash` | Returns the number of transactions in a block from a block matching the transaction hash. | `client.get_block_transaction_count_by_hash(&self, hash: &str)` | | `eth_getBlockTransactionCountByNumber` | `get_block_transaction_count_by_number` | Returns the number of transactions in a block from a block matching the block number. | `client.get_block_transaction_count_by_number(&self, block: BlockTag)` | | `eth_getLogs` | `get_logs` | Returns an array of logs matching the filter. | `client.get_logs(&self, filter: Filter)` | -| `eth_getFilterChanges` | `get_filter_changes` | Polling method for a filter, which returns an array of logs or transaction hashes or block hashes (depending on type of filter) which occurred since last poll. | `client.get_filter_changes(&self, filter_id: H256)` | -| `eth_getFilterLogs` | `get_filter_logs` | Returns an array of all logs matching filter with given id. | `client.get_filter_logs(&self, filter_id: H256)` | +| `eth_getFilterChanges` | `get_filter_changes` | Polling method for a filter, which returns an array of logs or transaction hashes or block hashes (depending on the type of filter) which occurred since the last poll. | `client.get_filter_changes(&self, filter_id: H256)` | +| `eth_getFilterLogs` | `get_filter_logs` | Returns an array of all logs matching the filter with a given id. | `client.get_filter_logs(&self, filter_id: H256)` | | `eth_newFilter` | `new_filter` | Creates a filter object, based on filter options, to notify when the state changes (logs). | `client.new_filter(&self, filter: Filter)` | | `eth_newBlockFilter` | `new_block_filter` | Creates a filter in the node, to notify when a new block arrives. | `client.new_block_filter(&self)` | | `eth_newPendingTransactionFilter` | `new_pending_transaction_filter` | Creates a filter in the node, to notify when new pending transactions arrive. | `client.new_pending_transaction_filter(&self)` |