f: more NatSpec

Author: matiasedgeandnode

packages/subgraph-service/contracts/libraries/IndexingAgreement.sol

@@ -235,6 +235,7 @@ library IndexingAgreement {
      * Emits {IndexingAgreementAccepted} event
      *
      * @param self The indexing agreement storage manager
+     * @param allocations The mapping of allocation IDs to their states
      * @param allocationId The id of the allocation
      * @param signedRCA The signed Recurring Collection Agreement
      */

packages/subgraph-service/contracts/libraries/SubgraphServiceLib.sol

@@ -9,6 +9,18 @@ library SubgraphServiceLib {
     using Allocation for mapping(address => Allocation.State);
     using Allocation for Allocation.State;
 
+    /**
+     * @notice Requires that the allocation is valid and owned by the indexer.
+     *
+     * Requirements:
+     * - Allocation must belong to the indexer
+     * - Allocation must be open
+     *
+     * @param self The allocation storage manager
+     * @param allocationId The id of the allocation
+     * @param indexer The address of the indexer
+     * @return The allocation state
+     */
     function requireValidAllocation(
         mapping(address => Allocation.State) storage self,
         address allocationId,

packages/subgraph-service/contracts/libraries/UnsafeDecoder.sol

@@ -6,13 +6,20 @@ import { IndexingAgreement } from "./IndexingAgreement.sol";
 library UnsafeDecoder {
     /**
      * @notice See {Decoder.decodeCollectIndexingFeeData}
+     * @param data The data to decode
+     * @return agreementId The agreement ID
+     * @return nestedData The nested encoded data
      */
     function decodeCollectIndexingFeeData_(bytes calldata data) public pure returns (bytes16, bytes memory) {
         return abi.decode(data, (bytes16, bytes));
     }
 
     /**
      * @notice See {Decoder.decodeRCAMetadata}
+     * @dev The data should be encoded as {IndexingAgreement.AcceptIndexingAgreementMetadata}
+     * @param data The data to decode
+     * @return The decoded data
+     *
      */
     function decodeRCAMetadata_(
         bytes calldata data
@@ -22,6 +29,9 @@ library UnsafeDecoder {
 
     /**
      * @notice See {Decoder.decodeRCAUMetadata}
+     * @dev The data should be encoded as {IndexingAgreement.UpdateIndexingAgreementMetadata}
+     * @param data The data to decode
+     * @return The decoded data
      */
     function decodeRCAUMetadata_(
         bytes calldata data
@@ -31,6 +41,11 @@ library UnsafeDecoder {
 
     /**
      * @notice See {Decoder.decodeCollectIndexingFeeDataV1}
+     * @dev The data should be encoded as (uint256 entities, bytes32 poi, uint256 epoch)
+     * @param data The data to decode
+     * @return entities The number of entities indexed
+     * @return poi The proof of indexing
+     * @return epoch The current epoch
      */
     function decodeCollectIndexingFeeDataV1_(
         bytes memory data
@@ -40,6 +55,9 @@ library UnsafeDecoder {
 
     /**
      * @notice See {Decoder.decodeIndexingAgreementTermsV1}
+     * @dev The data should be encoded as {IndexingAgreement.IndexingAgreementTermsV1}
+     * @param data The data to decode
+     * @return The decoded indexing agreement terms
      */
     function decodeIndexingAgreementTermsV1_(
         bytes memory data