dapphub / ds-token

A simple and sufficient ERC20 implementation
https://dapp.tools/dappsys/ds-token.html
GNU General Public License v3.0
224 stars 76 forks source link

Suggesting updates on the doc of DSToken.transferFrom #39

Open DocCon-team opened 2 years ago

DocCon-team commented 2 years ago

Hi,

The function DSToken.transferFrom emits an event Transfer, which is not documented in the README doc.

https://github.com/dapphub/ds-token/blob/16f187acc15dd839589be60173ad1ebd0716eb82/src/token.sol#L80

A potential fix could be adding "Emits a Transfer event" to the README doc.

Furthermore, function DSToken.transfer calls the function transferFrom. So it also emits the event Transfer.

https://github.com/dapphub/ds-token/blob/16f187acc15dd839589be60173ad1ebd0716eb82/src/token.sol#L63

A potential fix could be also adding "Emits a Transfer event" to this function in the README doc.

Could you please check it?

Thanks.