Branch v3.0.0 (#5)

Co-authored-by: Jan-Paul Azucena <[email protected]>
Co-authored-by: Nathan Sala <[email protected]>

CHANGELOG.md

@@ -1,9 +1,10 @@
 # Changelog
 
-## 2.0.1 (28/05/2020)
+## 3.0.0 (17/06/2020)
 
-### Bugfixes
- * Removed merge artifacts.
+### Breaking changes
+ * Contracts compiler version fixed at solidity 0.6.8.
+ * Updated `@animoca/ethereum-contracts-core_library` to version 3 and downgraded it to be a dev dependency.
 
 ## 2.0.0 (27/05/2020)
 

README.md

@@ -14,13 +14,12 @@ This project serves as a base dependency for Solidity-based ERC20 contract proje
 
 ## Overview
 
-
 ### Installation
 
 Install as a module dependency in your host NodeJS project:
 
 ```bash
-$ npm install --save @animoca/ethereum-contracts-erc20_base
+npm install --save-dev @animoca/ethereum-contracts-erc20_base
 ```
 
 

contracts/metatx/ERC20Fees.sol

@@ -110,10 +110,22 @@ abstract contract ERC20Fees is GSNRecipient, PayoutWallet
         );
     }
 
+    /**
+     * @dev Replacement for msg.sender. Returns the actual sender of a transaction: msg.sender for regular transactions,
+     * and the end-user for GSN relayed calls (where msg.sender is actually `RelayHub`).
+     *
+     * IMPORTANT: Contracts derived from {GSNRecipient} should never use `msg.sender`, and use {_msgSender} instead.
+     */
     function _msgSender() internal virtual override(Context, GSNRecipient) view returns (address payable) {
         return GSNRecipient._msgSender();
     }
 
+    /**
+     * @dev Replacement for msg.data. Returns the actual calldata of a transaction: msg.data for regular transactions,
+     * and a reduced version for GSN relayed calls (where msg.data contains additional information).
+     *
+     * IMPORTANT: Contracts derived from {GSNRecipient} should never use `msg.data`, and use {_msgData} instead.
+     */
     function _msgData() internal virtual override(Context, GSNRecipient) view returns (bytes memory) {
         return GSNRecipient._msgData();
     }