From 871c4c0e5ec5e31a58a717c9ed8e63cf43081902 Mon Sep 17 00:00:00 2001 From: xiaolou86 <20718693+xiaolou86@users.noreply.github.com> Date: Wed, 1 Nov 2023 18:43:13 +0800 Subject: [PATCH] Fix typos in docs (#1303) Fix typos in docs Documentation: - Corrected typographical errors in various files to improve readability and understanding. Changes include spelling corrections in the Makefile, block/header-sync.md, specs/lazy-adr/adr-009-state-fraud-proofs.md, and state/block-executor.md. These changes do not impact the functionality of the system but enhance the clarity of the documentation and code comments. --- Makefile | 2 +- block/header-sync.md | 2 +- specs/lazy-adr/adr-009-state-fraud-proofs.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 0dc8c83ab..17664ebf5 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ DOCKER := $(shell which docker) DOCKER_BUF := $(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace bufbuild/buf -# Define pkgs, run, and cover vairables for test so that we can override them in +# Define pkgs, run, and cover variables for test so that we can override them in # the terminal more easily. pkgs := $(shell go list ./...) run := . diff --git a/block/header-sync.md b/block/header-sync.md index ae4f397e6..6e23540e2 100644 --- a/block/header-sync.md +++ b/block/header-sync.md @@ -14,7 +14,7 @@ The nodes in the P2P network sync headers using the header sync service that imp ## Details -All three types of nodes (sequencer, full, and light) run the header sync service to maintain the cannonical view of the rollup chain (with respect to the P2P network). +All three types of nodes (sequencer, full, and light) run the header sync service to maintain the canonical view of the rollup chain (with respect to the P2P network). The header sync service inherits the `ConnectionGater` from the node's P2P client which enables blocking and allowing peers as needed by specifying the `P2PConfig.BlockedPeers` and `P2PConfig.AllowedPeers`. diff --git a/specs/lazy-adr/adr-009-state-fraud-proofs.md b/specs/lazy-adr/adr-009-state-fraud-proofs.md index 087123d8d..062baf6a8 100644 --- a/specs/lazy-adr/adr-009-state-fraud-proofs.md +++ b/specs/lazy-adr/adr-009-state-fraud-proofs.md @@ -136,7 +136,7 @@ The `GenerateFraudProof` method in the Cosmos SDK app receives this list of stat // Represents a single-round state fraudProof message FraudProof { - // The block height during which the fraudulent state transition occured + // The block height during which the fraudulent state transition occurred uint64 block_height = 1; // Intermediate State Root right before the fraudulent state transition bytes pre_state_app_hash = 2;