Skip to content

Commit 56c86a7

Browse files
f: add natspec explaining the stake lock mechanism
1 parent 415bc5b commit 56c86a7

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

packages/subgraph-service/contracts/SubgraphService.sol

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,11 @@ contract SubgraphService is
258258
* For indexing rewards, see {AllocationManager-_collectIndexingRewards} for more details.
259259
* For indexing fees, see {SubgraphService-_collectIndexingFees} for more details.
260260
*
261+
* Note that collecting any type of payment will require locking provisioned stake as collateral for a period of time.
262+
* All types of payment share the same pool of provisioned stake however they each have separate accounting:
263+
* - Indexing rewards can make full use of the available stake
264+
* - Query and indexing fees share the pool, combined they can also make full use of the available stake
265+
*
261266
* @param indexer The address of the indexer
262267
* @param paymentType The type of payment to collect as defined in {IGraphPayments}
263268
* @param data Encoded data:

0 commit comments

Comments
 (0)