Fix typo in relayer usage doc (#115)

* Fix typo in relayer usage doc
mshantanu · Mar 23, 2022 · d8d22ce · d8d22ce
1 parent 8ea1c32
commit d8d22ce
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/docs/message-store-service.md b/docs/message-store-service.md
@@ -11,7 +11,7 @@ This service is an essential component for protocols such as GPACT that rely on
 ### Design and Specification
 The *Message Store Service* consumes events that have been processed by Relayers. 
 The service can be configured to store all messages that pass through a Relayer or only a subset that require persistence (e.g. GPACT events).
-A [specialised message dispatcher]("TODO") is responsible for forwarding messages to the store by interacting with its API.
+A specialised message dispatcher is responsible for forwarding messages to the store by interacting with its API.
 Relayers can either create a message if it is not already in the Message Store, or update it with their own attestation (or other proof), if the message already exists.
 
 The service is responsible for ensuring that all create and update operations on messages can only be performed by authorised Relayers.
@@ -29,4 +29,6 @@ It is defined using the [Open API Specification format](https://swagger.io/speci
 
 #### TODOs
 - [ ] Security
+- [ ] Message expiration and removal
+- [ ] API versioning
 - [ ] Deployment considerations
diff --git a/docs/relayer-usage.md b/docs/relayer-usage.md
@@ -71,7 +71,7 @@ Walking through the diagram:
  a crosschain function call.</li>
 <li>The Crosschain Control contract emits an event indicating the destination
  blockchain, contract address, function call and parameters to be called.
- All relayers associated with the blockchain observer the event being emitted.
+ All relayers associated with the blockchain observe the event being emitted.
  Once the block containing the transaction that emitted the event is final
  relayers process the event.</li>
 <li>The relayer signs the event and submits a transaction to the Signed Event Store contract
@@ -146,7 +146,7 @@ Walking through the diagram:
  results from funcion calls, or whether provisional updates should be committed
  or discarded.
 
- All relayers associated with the blockchain observer the event being emitted.
+ All relayers associated with the blockchain observe the event being emitted.
  Once the block containing the transaction that emitted the event is final
  relayers process the event. Similarly, the application observes the event.</li>
 <li>The relayer signs the block header of the block containing the transaction
@@ -209,7 +209,7 @@ Walking through the diagram:
  results from funcion calls, or whether provisional updates should be committed
  or discarded.
 
- All relayers associated with the blockchain observer the event being emitted.
+ All relayers associated with the blockchain observe the event being emitted.
  Once the block containing the transaction that emitted the event is final
  relayers process the event. Similarly, the application observes the event.</li>
 <li>The application requests the signed event from attestors.