Suggesting updates on the doc of Escrow.deposit and Escrow.withdraw

[DocCon-team]

Hi,

The Escrow.deposit function emits a Deposited event, which is not stated in its doc.
Similarly, the Escrow.withdraw function emits a Withdrawn event, which is not stated in its doc either.

A potential fix could be adding "Emits a {Deposited} event" to the doc of Escrow.deposit, and adding "Emits a {Withdrawn} event" to Escrow.withdraw.

openzeppelin-contracts/contracts/utils/escrow/Escrow.sol

Line 41 in fcf35e5

emit Deposited(payee, amount);

openzeppelin-contracts/contracts/utils/escrow/Escrow.sol

Line 61 in fcf35e5

emit Withdrawn(payee, payment);

These events can also transitively emit in the functions PullPayment._asyncTransfer and PullPayment.withdrawPayments, because they call Escrow.deposit and Escrow.withdraw respectively.

openzeppelin-contracts/contracts/security/PullPayment.sol

Line 68 in fcf35e5

_escrow.deposit{value: amount}(dest);

openzeppelin-contracts/contracts/security/PullPayment.sol

Line 48 in fcf35e5

_escrow.withdraw(payee);

Could you please check it?

Thanks.

[Amxx]

Hello @DocCon-team

I'll add the details in Escrow.sol.
About the PullPayment, calling withdrawPayments or _asyncTransfer will indeed trigger an event, but at another address (the escrow and the PullPayment are two different contract) so the wording should reflect that.

[DocCon-team]

Thanks for the clarification.

[frangio]

Fixed in #3365