add natspec to transceiver

Author: Rahul Maganti

evm/src/Endpoint.sol

@@ -77,13 +77,12 @@ abstract contract Endpoint is
     }
 
     /// =============== TRANSCEIVING LOGIC ===============================================
-    /**
-     *   @dev send a message to another chain.
-     *   @param recipientChain The chain id of the recipient.
-     *   @param instruction An additional Instruction provided by the Endpoint to be
-     *          executed on the recipient chain.
-     *   @param managerMessage A message to be sent to the manager on the recipient chain.
-     */
+
+    /// @dev send a message to another chain.
+    /// @param recipientChain The chain id of the recipient.
+    /// @param instruction An additional Instruction provided by the Endpoint to be
+    ///        executed on the recipient chain.
+    /// @param managerMessage A message to be sent to the manager on the recipient chain.
     function sendMessage(
         uint16 recipientChain,
         EndpointStructs.EndpointInstruction memory instruction,
@@ -109,11 +108,11 @@ abstract contract Endpoint is
         bytes memory managerMessage
     ) internal virtual;
 
-    // @dev      This method is called by the BridgeManager contract to send a cross-chain message.
-    //           Forwards the VAA payload to the endpoint manager contract.
-    // @param    sourceChainId The chain id of the sender.
-    // @param    sourceManagerAddress The address of the sender's manager contract.
-    // @param    payload The VAA payload.
+    /// @dev      This method is called by the BridgeManager contract to send a cross-chain message.
+    ///           Forwards the VAA payload to the endpoint manager contract.
+    /// @param    sourceChainId The chain id of the sender.
+    /// @param    sourceManagerAddress The address of the sender's manager contract.
+    /// @param    payload The VAA payload.
     function _deliverToManager(
         uint16 sourceChainId,
         bytes32 sourceManagerAddress,

evm/src/interfaces/IEndpoint.sol

@@ -4,26 +4,59 @@ pragma solidity >=0.8.8 <0.9.0;
 import "../libraries/EndpointStructs.sol";
 
 interface IEndpoint {
+    /// @notice Error code for when the caller is not the manager.
+    /// @dev Selector 0x3b2495f1.
+    /// @param caller The caller's address.
     error CallerNotManager(address caller);
-    error CannotRenounceEndpointOwnership(address currentOwner);
+
+    /// @notice Error code when ownership of the endpoint cannot be transferred.
+    /// @dev Selector 0x7ab04e14.
+    /// @param currentOwner The current owner of the endpoint and the maaager.
+    /// @param newOwner The updated owner of the endpoint and the manager.
     error CannotTransferEndpointOwnership(address currentOwner, address newOwner);
+
+    /// @notice Error code emitted when the recipient manager address for the transfer
+    ///         does not match the manager address encoded in the paylood sent over the wire.
+    /// @dev Selector 0x3a680c9a.
+    /// @param recipientManagerAddress The provided recipientManagerAddress
+    ///        at the time of delivery.
+    /// @param expectedRecipientManagerAddress The recipient manager address encoded
+    ///        in the payload sent over the wire.
     error UnexpectedRecipientManagerAddress(
         bytes32 recipientManagerAddress, bytes32 expectedRecipientManagerAddress
     );
 
+    /// @notice Method to provide a quote for the delivery price.
+    /// @dev This method is called by the manager to get a quote for the delivery price.
+    /// @param recipientChain The chain id of the recipient.
+    /// @param instruction An additional Instruction provided by the Endpoint.
+    /// @return The price of the delivery.
     function quoteDeliveryPrice(
         uint16 recipientChain,
         EndpointStructs.EndpointInstruction memory instruction
     ) external view returns (uint256);
 
+    /// @notice Send a message to the recipient chain.
+    /// @dev This method is called by the manager to send a message to the recipient chain.
+    /// @param recipientChain The chain id of the recipient.
+    /// @param instruction An additional Instruction provided by the Endpoint.
+    /// @param managerMessage A message to be sent to the manager on the recipient chain.
+    /// @param recipientManagerAddress The address of the recipient manager.
     function sendMessage(
         uint16 recipientChain,
         EndpointStructs.EndpointInstruction memory instruction,
         bytes memory managerMessage,
         bytes32 recipientManagerAddress
     ) external payable;
 
+    /// @notice upgrade the endpoint to a new implementation.
+    /// @dev This is upgraded via a proxy.
+    /// @param newImplementation The address of the new implementation.
     function upgrade(address newImplementation) external;
 
+    /// @notice transfer the ownership of the endpoint to a new address
+    /// @dev The manager should be able to update endpoint ownership.
+    ///      The owner of the manager should be the same as the owner of the endpoint.
+    /// @param newOwner The address of the new owner.
     function transferEndpointOwnership(address newOwner) external;
 }