Skip to content

Commit

Permalink
typo: replace [BlockId] by [BlockId] (paradigmxyz#10121)
Browse files Browse the repository at this point in the history
Co-authored-by: nk_ysg <[email protected]>
  • Loading branch information
tcoratger and nkysg authored Aug 6, 2024
1 parent 58a5d26 commit ef728b5
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions crates/storage/storage-api/src/block.rs
Original file line number Diff line number Diff line change
Expand Up @@ -200,12 +200,12 @@ pub trait BlockReaderIdExt: BlockReader + BlockIdReader + ReceiptProviderIdExt {
self.sealed_header_by_id(BlockNumberOrTag::Finalized.into())
}

/// Returns the block with the matching [BlockId] from the database.
/// Returns the block with the matching [`BlockId`] from the database.
///
/// Returns `None` if block is not found.
fn block_by_id(&self, id: BlockId) -> ProviderResult<Option<Block>>;

/// Returns the block with senders with matching [BlockId].
/// Returns the block with senders with matching [`BlockId`].
///
/// Returns the block's transactions in the requested variant.
///
Expand Down
6 changes: 3 additions & 3 deletions crates/storage/storage-api/src/block_id.rs
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ pub trait BlockNumReader: BlockHashReader + Send + Sync {
}
}

/// Client trait for transforming [BlockId] into block numbers or hashes.
/// Client trait for transforming [`BlockId`] into block numbers or hashes.
///
/// Types that implement this trait must be able to resolve all variants of [BlockNumberOrTag] to
/// block numbers or hashes. Automatic implementations for resolving [BlockNumberOrTag] variants
/// Types that implement this trait must be able to resolve all variants of [`BlockNumberOrTag`] to
/// block numbers or hashes. Automatic implementations for resolving [`BlockNumberOrTag`] variants
/// are provided if the type implements the `pending_block_num_hash`, `finalized_block_num`, and
/// `safe_block_num` methods.
///
Expand Down
2 changes: 1 addition & 1 deletion crates/storage/storage-api/src/state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ pub trait StateProviderFactory: BlockIdReader + Send + Sync {
/// Storage provider for latest block.
fn latest(&self) -> ProviderResult<StateProviderBox>;

/// Returns a [StateProvider] indexed by the given [BlockId].
/// Returns a [`StateProvider`] indexed by the given [`BlockId`].
///
/// Note: if a number or hash is provided this will __only__ look at historical(canonical)
/// state.
Expand Down

0 comments on commit ef728b5

Please sign in to comment.