Merge pull request #637 from petercover/main

chore: fix some comments

peers/external_handler.go

@@ -139,7 +139,7 @@ func (h *RelayerExternalHandler) RegisterRequestID(
 	return responseChan
 }
 
-// RegisterRequest registers an AppRequest with the timeout manager.
+// RegisterAppRequest registers an AppRequest with the timeout manager.
 // If RegisterResponse is not called before the timeout, HandleInbound is called with
 // an internally created AppRequestFailed message.
 func (h *RelayerExternalHandler) RegisterAppRequest(reqID ids.RequestID) {

relayer/listener.go

@@ -40,7 +40,7 @@ type Listener struct {
 	messageCoordinator *MessageCoordinator
 }
 
-// runListener creates a Listener instance and the ApplicationRelayers for a subnet.
+// RunListener creates a Listener instance and the ApplicationRelayers for a subnet.
 // The Listener listens for warp messages on that subnet, and the ApplicationRelayers handle delivery to the destination
 func RunListener(
 	ctx context.Context,

relayer/main/main.go

@@ -428,7 +428,7 @@ func createApplicationRelayers(
 	return applicationRelayers, minHeights, nil
 }
 
-// createApplicationRelayers creates Application Relayers for a given source blockchain.
+// createApplicationRelayersForSourceChain creates Application Relayers for a given source blockchain.
 func createApplicationRelayersForSourceChain(
 	ctx context.Context,
 	logger logging.Logger,

relayer/message_coordinator.go

@@ -24,7 +24,7 @@ import (
 
 // MessageCoordinator contains all the logic required to process messages in the relayer.
 // Other components such as the listeners or the API should pass messages to the MessageCoordinator
-// so that it can parse the message(s) and pass them the the proper ApplicationRelayer.
+// so that it can parse the message(s) and pass them the proper ApplicationRelayer.
 type MessageCoordinator struct {
 	logger logging.Logger
 	// Maps Source blockchain ID and protocol address to a Message Handler Factory

scripts/build_relayer.sh

@@ -11,7 +11,7 @@ go_version() {
 }
 
 version_lt() {
-    # Return true if $1 is a lower version than than $2,
+    # Return true if $1 is a lower version than $2,
     local ver1=$1
     local ver2=$2
     # Reverse sort the versions, if the 1st item != ver1 then ver1 < ver2

scripts/build_signature_aggregator.sh

@@ -11,7 +11,7 @@ go_version() {
 }
 
 version_lt() {
-    # Return true if $1 is a lower version than than $2,
+    # Return true if $1 is a lower version than $2,
     local ver1=$1
     local ver2=$2
     # Reverse sort the versions, if the 1st item != ver1 then ver1 < ver2

scripts/install_avalanchego_release.sh

@@ -72,7 +72,7 @@ else
       git clone --no-checkout ${GIT_CLONE_URL} ${GIT_CLONE_PATH}
     fi
 
-    # check to see if the commitish exists in the repo
+    # check to see if the commit hash exists in the repo
     WORKDIR=$(pwd)
 
     cd ${GIT_CLONE_PATH}

scripts/versions.sh

@@ -23,7 +23,7 @@ AVALANCHEGO_VERSION=v1.12.0
 GINKGO_VERSION=${GINKGO_VERSION:-$(getDepVersion github.com/onsi/ginkgo/v2)}
 
 SUBNET_EVM_VERSION=${SUBNET_EVM_VERSION:-$(getDepVersion github.com/ava-labs/subnet-evm)}
-# Temporarily harcode the Subnet EVM version until there is a tagged release
+# Temporarily hardcode the Subnet EVM version until there is a tagged release
 SUBNET_EVM_VERSION=6c98da796f359335f2dcfd1151af191584be8d74
 
 # Set golangci-lint version

tests/contracts/src/BatchCrossChainMessenger.sol

@@ -31,7 +31,7 @@ contract BatchCrossChainMessenger is ReentrancyGuard, TeleporterOwnerUpgradeable
     mapping(bytes32 sourceBlockchainID => string[] messages) private _messages;
 
     /**
-     * @dev Emitted when a message is submited to be sent.
+     * @dev Emitted when a message is submitted to be sent.
      */
     event SendMessages(
         bytes32 indexed destinationBlockchainID,

utils/utils.go

@@ -86,7 +86,7 @@ func CallWithRetry[T any](ctx context.Context, f func() (T, error)) (T, error) {
 //
 
 // BigToHashSafe ensures that a bignum value is able to fit into a 32 byte buffer before converting it to a common.Hash
-// Returns an error if overflow/truncation would occur by trying to perfom this operation.
+// Returns an error if overflow/truncation would occur by trying to perform this operation.
 func BigToHashSafe(in *big.Int) (common.Hash, error) {
 	if in == nil {
 		return common.Hash{}, ErrNilInput