chore: Fix grammatical errors in documentation (#178)

* typo MachOptimismZkServiceManagerStorage.sol * typo MachServiceManager.sol * typo grpc.go * typos IMachServiceManager.sol * typos aggregator_grpc.pb.go * typo MachOptimismZkServiceManager.sol * typos README.md * chore: casing fix --------- Co-authored-by: Jun Hao Tan <[email protected]>
alt-research · Jan 17, 2025 · 857b435 · 857b435
1 parent 129ea75
commit 857b435
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ sequenceDiagram
     MV ->> L2: Fetch next blocks
     else the block is invalid
     MV ->> MO: Commit alert to operator
-    MV ->> MC: Commit a Earlier Alert
+    MV ->> MC: Commit an earlier Alert
     MO ->> MO: Sig the alert
     MO ->> MA: Commit alert bls sig
     MA ->> MC: If collected, commit Avs confirmed Alert
@@ -176,7 +176,7 @@ docker compose build
 docker compose up
 ```
 
-it will boot anvil as layer1, a aggregator and a operator for test.
+it will boot anvil as layer1, an aggregator and a operator for test.
 
 ## Build and Run
 

diff --git a/contracts/src/core/MachOptimismZkServiceManager.sol b/contracts/src/core/MachOptimismZkServiceManager.sol
@@ -449,7 +449,7 @@ contract MachOptimismZkServiceManager is
             })
         );
 
-        // For the proved output, if there are exist a early block alert
+        // For the proved output, if there are exist an early block alert
         // we will make it not proved! so we just set to `length`
         provedIndex = l2OutputAlerts.length;
     }

diff --git a/contracts/src/core/MachOptimismZkServiceManagerStorage.sol b/contracts/src/core/MachOptimismZkServiceManagerStorage.sol
@@ -22,7 +22,7 @@ contract MachOptimismZkServiceManagerStorage {
     bytes32 public imageId;
 
     // Alerts for blocks, the tail is for earliest block.
-    // For the proved output, if there are exist a early block alert
+    // For the proved output, if there are exist an early block alert
     // we will make it not proved!
     IMachOptimism.L2OutputAlert[] internal l2OutputAlerts;
     // The next index for no proved alert,

diff --git a/contracts/src/core/MachServiceManager.sol b/contracts/src/core/MachServiceManager.sol
@@ -406,7 +406,7 @@ contract MachServiceManager is
     }
 
     /**
-     * @dev Converts a alert header to a reduced alert header
+     * @dev Converts an alert header to a reduced alert header
      * @param alertHeader the alert header to convert
      */
     function _convertAlertHeaderToReducedAlertHeader(AlertHeader calldata alertHeader)

diff --git a/contracts/src/interfaces/IMachServiceManager.sol b/contracts/src/interfaces/IMachServiceManager.sol
@@ -87,14 +87,14 @@ interface IMachServiceManager is IServiceManager {
     event RollupChainIDUpdated(uint256 rollupChainId, bool status);
 
     /**
-     * @notice Emitted when a Alert is confirmed.
+     * @notice Emitted when an Alert is confirmed.
      * @param alertHeaderHash The hash of the alert header
      * @param messageHash The message hash
      */
     event AlertConfirmed(bytes32 indexed alertHeaderHash, bytes32 messageHash);
 
     /**
-     * @notice Emitted when a Alert is removed.
+     * @notice Emitted when an Alert is removed.
      * @param messageHash The message hash
      * @param messageHash The sender address
      */

diff --git a/legacy/aggregator/rpc/grpc.go b/legacy/aggregator/rpc/grpc.go
@@ -79,7 +79,7 @@ func (s *GRpcHandler) InitOperator(ctx context.Context, req *aggregator.InitOper
 	return resp.ToPbType(), nil
 }
 
-// Create a alert task
+// Create an alert task
 func (s *GRpcHandler) CreateTask(ctx context.Context, req *aggregator.CreateTaskRequest) (*aggregator.CreateTaskResponse, error) {
 	msg, err := message.NewCreateTaskRequest(req)
 	if err != nil {

diff --git a/legacy/api/grpc/aggregator/aggregator_grpc.pb.go b/legacy/api/grpc/aggregator/aggregator_grpc.pb.go