Merge pull request #1083 from graphprotocol/ma/horizon-ipayment-colle…

…ctor-docs-fix fix: cleanup IPaymentCollector and TAPCollector docs
graphprotocol · Jan 13, 2025 · 1d097de · 1d097de
2 parents 1038cf4 + a800d09
commit 1d097de
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/packages/horizon/contracts/interfaces/IPaymentsCollector.sol b/packages/horizon/contracts/interfaces/IPaymentsCollector.sol
@@ -34,9 +34,6 @@ interface IPaymentsCollector {
      * @notice Initiate a payment collection through the payments protocol
      * @dev This function should require the caller to present some form of evidence of the payer's debt to
      * the receiver. The collector should validate this evidence and, if valid, collect the payment.
-     * Requirements:
-     * - The caller must be the data service the RAV was issued to
-     * - The signer of the RAV must be authorized to sign for the payer
      *
      * Emits a {PaymentCollected} event
      *

diff --git a/packages/horizon/contracts/payments/collectors/TAPCollector.sol b/packages/horizon/contracts/payments/collectors/TAPCollector.sol
@@ -124,8 +124,10 @@ contract TAPCollector is EIP712, GraphDirectory, ITAPCollector {
     /**
      * @notice Initiate a payment collection through the payments protocol
      * See {IGraphPayments.collect}.
-     * @dev Caller must be the data service the RAV was issued to.
-     * @dev Service provider must have an active provision with the data service to collect payments
+     * @dev Requirements:
+     * - Caller must be the data service the RAV was issued to.
+     * - Signer of the RAV must be authorized to sign for the payer.
+     * - Service provider must have an active provision with the data service to collect payments.
      * @notice REVERT: This function may revert if ECDSA.recover fails, check ECDSA library for details.
      */
     function collect(IGraphPayments.PaymentTypes paymentType, bytes memory data) external override returns (uint256) {