Skip to content

Commit f33e23d

Browse files
f: more NatSpec
1 parent bfe97fe commit f33e23d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ library IndexingAgreement {
3131
IndexingAgreementVersion version;
3232
}
3333

34+
/**
35+
* @notice Wrapper for Indexing Agreement and Collector Agreement Data
36+
* @dev This struct is used to encapsulate the state of an indexing agreement
37+
* @param agreement The indexing agreement state
38+
* @param collectorAgreement The collector agreement data
39+
*/
3440
struct AgreementWrapper {
3541
State agreement;
3642
IRecurringCollector.AgreementData collectorAgreement;
@@ -84,6 +90,9 @@ library IndexingAgreement {
8490
* @notice Storage manager for indexing agreements
8591
* @dev This struct holds the state of indexing agreements and their terms.
8692
* It is used to manage the lifecycle of indexing agreements in the subgraph service.
93+
* @param agreements Mapping of agreement IDs to their states
94+
* @param termsV1 Mapping of agreement IDs to their terms for version 1 agreements
95+
* @param allocationToActiveAgreementId Mapping of allocation IDs to their active agreement IDs
8796
* @custom:storage-location erc7201:graphprotocol.subgraph-service.storage.StorageManager.IndexingAgreement
8897
*/
8998
struct StorageManager {

0 commit comments

Comments
 (0)