Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: cleanup IPaymentCollector and TAPCollector docs #1083

Merged
merged 1 commit into from
Jan 13, 2025
Merged

fix: cleanup IPaymentCollector and TAPCollector docs #1083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions packages/horizon/contracts/interfaces/IPaymentsCollector.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
6 changes: 4 additions & 2 deletions packages/horizon/contracts/payments/collectors/TAPCollector.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Loading