Last updated
Last updated
Inherits: IPaymentProcessor_v1
claim everything that the paymentClient owes to the _msgSender till the current timestamp.
This function should be callable if the _msgSender is an activePaymentReceiver.
Parameters
claim the total amount up til block.timestamp from the client for a payment order with id = streamId by _msgSender.
If for a specific streamId, the tokens could not be transferred for some reason, it will added to the unclaimableAmounts of the paymentReceiver, and the amount would no longer hold any co-relation with he specific streamId of the paymentReceiver.
Parameters
Deletes all payments related to a paymentReceiver & leaves currently streaming tokens in the {IERC20PaymentClientBase_v1}.
this function calls _removePayment which goes through all the payment orders for a paymentReceiver. For the payment orders that are completely streamed, their details are deleted in the _claimForSpecificStrea function and for others it is deleted in the _removePayment function only, leaving the currently streaming tokens as balance of the paymentClient itself.
Parameters
Deletes a specific payment with id = streamId for a paymentReceiver & leaves currently streaming tokens in the {IERC20PaymentClientBase_v1}.
the detail of the wallet that is being removed is either deleted in the _claimForSpecificStream or later down in this function itself depending on the timestamp of when this function was called.
Parameters
Getter for the start timestamp of a particular payment order with id = streamId associated with a particular paymentReceiver.
Parameters
Returns
Getter for the cliff duration of a particular payment order with id = streamId associated with a particular paymentReceiver.
Parameters
Returns
Getter for the stream end timestamp of a particular payment order with id = streamId associated with a particular paymentReceiver.
Parameters
Returns
Getter for the amount of tokens already released for a particular payment order with id = streamId associated with a particular paymentReceiver.
Parameters
Returns
Calculates the amount of tokens that has already streamed for a particular payment order with id = streamId associated with a particular paymentReceiver.
Parameters
Returns
Getter for the amount of releasable tokens for a particular payment order with id = streamId associated with a particular paymentReceiver.
Parameters
Returns
See all active payment orders for a paymentClient associated with a particular paymentReceiver.
the paymentReceiver must be an active paymentReceiver for the particular payment client.
Parameters
Returns
Tells whether a paymentReceiver has any pending payments for a particular client.
This function is for convenience and can be easily figured out by other means in the codebase.
Parameters
Returns
Emitted when a payment gets processed for execution.
Parameters
Emitted when the stream to an address is removed.
Parameters
Emitted when a running stream schedule gets updated.
Parameters
Emitted when a payment was unclaimable due to a token error.
Parameters
Emitted when an address is removed from the list of active payment receiver, eg because all payments have been fulfilled by a client.
Parameters
insufficient tokens in the client to do payments.
paymentReceiver's streamId for the paymentClient is not valid.
Parameters
paymentReceiver's streamId for the paymentClient is no longer active.
Parameters
the paymentReceiver for the given paymentClient does not exist (anymore).
Parameters
The default start, cliff and end times are invalid.
Parameters
This struct is used to store the payment order for a particular paymentReceiver by a particular payment client.
for _streamId, valid values will start from 1. 0 is not a valid id.
Properties