add missing docstrings

Signed-off-by: Ihor Farion <ihor@umaproject.org>

Author: grasphoper

contracts/AdapterStore.sol

@@ -5,9 +5,12 @@ import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 import { IOFT } from "./interfaces/IOFT.sol";
 
 /**
+ * @title MessengerTypes
+ * @notice Library containing messenger type constants
  * @custom:security-contact bugs@across.to
  */
 library MessengerTypes {
+    /** @notice Identifier for OFT (Omni-chain Fungible Token by LayerZero) messenger type */
     bytes32 public constant OFT_MESSENGER = bytes32("OFT_MESSENGER");
 }
 
@@ -18,20 +21,39 @@ library MessengerTypes {
  * @custom:security-contact bugs@across.to
  */
 contract AdapterStore is Ownable {
-    // (messengerType, dstDomainId, srcChainToken) => messenger address
+    /** @notice Maps messenger type and destination domain to token-messenger pairs */
     mapping(bytes32 => mapping(uint256 => mapping(address => address))) public crossChainMessengers;
 
+    /**
+     * @notice Emitted when a messenger is set for a specific token and destination
+     * @param messengerType Type of messenger being set
+     * @param dstDomainId Destination domain ID
+     * @param srcChainToken Source chain token address
+     * @param srcChainMessenger Source chain messenger address
+     */
     event MessengerSet(
         bytes32 indexed messengerType,
         uint256 indexed dstDomainId,
         address indexed srcChainToken,
         address srcChainMessenger
     );
 
+    /** @notice Thrown when array lengths don't match in batch operations */
     error ArrayLengthMismatch();
+
+    /** @notice Thrown when IOFT messenger's token doesn't match expected token */
     error IOFTTokenMismatch();
+
+    /** @notice Thrown when messenger type is not supported */
     error NonExistentMessengerType();
 
+    /**
+     * @notice Sets a messenger for a specific token and destination domain
+     * @param messengerType Type of messenger to set
+     * @param dstDomainId Destination domain ID
+     * @param srcChainToken Source chain token address
+     * @param srcChainMessenger Source chain messenger address
+     */
     function setMessenger(
         bytes32 messengerType,
         uint256 dstDomainId,
@@ -41,6 +63,13 @@ contract AdapterStore is Ownable {
         _setMessenger(messengerType, dstDomainId, srcChainToken, srcChainMessenger);
     }
 
+    /**
+     * @notice Sets multiple messengers in a single transaction
+     * @param messengerTypes Array of messenger types
+     * @param dstDomainIds Array of destination domain IDs
+     * @param srcChainTokens Array of source chain token addresses
+     * @param srcChainMessengers Array of source chain messenger addresses
+     */
     function batchSetMessengers(
         bytes32[] calldata messengerTypes,
         uint256[] calldata dstDomainIds,
@@ -60,6 +89,13 @@ contract AdapterStore is Ownable {
         }
     }
 
+    /**
+     * @notice Internal function to set a messenger with validation
+     * @param _messengerType Type of messenger to set
+     * @param _dstDomainId Destination domain ID
+     * @param _srcChainToken Source chain token address
+     * @param _srcChainMessenger Source chain messenger address
+     */
     function _setMessenger(
         bytes32 _messengerType,
         uint256 _dstDomainId,

contracts/libraries/OFTTransportAdapter.sol

@@ -15,11 +15,12 @@ contract OFTTransportAdapter {
     using SafeERC20 for IERC20;
     using AddressToBytes32 for address;
 
+    /** @notice Empty bytes array used for OFT messaging parameters */
     bytes public constant EMPTY_MSG_BYTES = new bytes(0);
 
     /**
-     * @dev a fee cap we check against before sending a message with value to OFTMessenger as fees.
-     * @dev this cap should be pretty conservative (high) to not interfere with operations under normal conditions.
+     * @notice Fee cap checked before sending messages to OFTMessenger
+     * @dev Conservative (high) cap to not interfere with operations under normal conditions
      */
     /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
     uint256 public immutable OFT_FEE_CAP;
@@ -31,10 +32,19 @@ contract OFTTransportAdapter {
     /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
     uint32 public immutable OFT_DST_EID;
 
+    /** @notice Thrown when OFT fee exceeds the configured cap */
     error OftFeeCapExceeded();
+
+    /** @notice Thrown when contract has insufficient balance to pay OFT fees */
     error OftInsufficientBalanceForFee();
+
+    /** @notice Thrown when LayerZero token fee is not zero (only native fees supported) */
     error OftLzFeeNotZero();
+
+    /** @notice Thrown when amount received differs from expected amount */
     error OftIncorrectAmountReceivedLD();
+
+    /** @notice Thrown when amount sent differs from expected amount */
     error OftIncorrectAmountSentLD();
 
     /**
@@ -56,12 +66,7 @@ contract OFTTransportAdapter {
      * @param _to address to receive a transfer on the destination chain.
      * @param _amount amount to send.
      */
-    function _transferViaOFT(
-        IERC20 _token,
-        IOFT _messenger,
-        address _to,
-        uint256 _amount
-    ) internal {
+    function _transferViaOFT(IERC20 _token, IOFT _messenger, address _to, uint256 _amount) internal {
         bytes32 to = _to.toBytes32();
 
         SendParam memory sendParam = SendParam(

contracts/libraries/OFTTransportAdapterWithStore.sol

@@ -9,17 +9,24 @@ import { AdapterStore, MessengerTypes } from "../AdapterStore.sol";
  * @custom:security-contact bugs@across.to
  */
 contract OFTTransportAdapterWithStore is OFTTransportAdapter {
-    // Helper storage contract to keep track of token => IOFT relationships
+    /** @notice Helper storage contract to keep track of token => IOFT relationships */
     AdapterStore public immutable OFT_ADAPTER_STORE;
 
-    constructor(
-        uint32 _oftDstEid,
-        uint256 _feeCap,
-        address _adapterStore
-    ) OFTTransportAdapter(_oftDstEid, _feeCap) {
+    /**
+     * @notice Initializes the OFTTransportAdapterWithStore contract
+     * @param _oftDstEid The endpoint ID that OFT protocol will transfer funds to
+     * @param _feeCap Fee cap checked before sending messages to OFTMessenger
+     * @param _adapterStore Address of the AdapterStore contract
+     */
+    constructor(uint32 _oftDstEid, uint256 _feeCap, address _adapterStore) OFTTransportAdapter(_oftDstEid, _feeCap) {
         OFT_ADAPTER_STORE = AdapterStore(_adapterStore);
     }
 
+    /**
+     * @notice Retrieves the OFT messenger address for a given token
+     * @param _token Token address to look up messenger for
+     * @return Address of the OFT messenger for the token
+     */
     function _getOftMessenger(address _token) internal view returns (address) {
         return OFT_ADAPTER_STORE.crossChainMessengers(MessengerTypes.OFT_MESSENGER, OFT_DST_EID, _token);
     }