feat(vault): <- adds EthPNT handling...

.eslintrc.js

@@ -19,8 +19,14 @@ module.exports = {
     "ethers": false,
     "upgrades": false,
   },
+  plugins: [
+    'no-only-tests',
+    'no-skip-tests',
+  ],
   rules: {
-    "max-len": ["error", 120, 2, {
+    'no-skip-tests/no-skip-tests': 'warn',
+    'no-only-tests/no-only-tests': 'warn',
+    'max-len': ["error", 120, 2, {
       ignoreUrls: true,
       ignoreComments: false,
       ignoreRegExpLiterals: true,

contracts/Erc20Vault.sol

@@ -1,4 +1,9 @@
 // SPDX-License-Identifier: MIT
+
+// NOTE: This special version of the pTokens-erc20-vault is for ETH mainnet, and includes custom
+// logic to handle ETHPNT<->PNT fungibility, as well as custom logic to handle GALA tokens after
+// they upgraded from v1 to v2.
+
 pragma solidity ^0.8.0;
 
 import "./wEth/IWETH.sol";
@@ -30,6 +35,8 @@ contract Erc20Vault is
     IWETH public weth;
     bytes4 public ORIGIN_CHAIN_ID;
     address private wEthUnwrapperAddress;
+    address public constant PNT_TOKEN_ADDRESS = 0x89Ab32156e46F46D02ade3FEcbe5Fc4243B9AAeD;
+    address public constant ETHPNT_TOKEN_ADDRESS = 0xf4eA6B892853413bD9d9f1a5D3a620A0ba39c5b2;
 
     event PegIn(
         address _tokenAddress,
@@ -146,15 +153,26 @@ contract Erc20Vault is
     {
         require(_tokenAmount > 0, "Token amount must be greater than zero!");
         IERC20Upgradeable(_tokenAddress).safeTransferFrom(msg.sender, address(this), _tokenAmount);
+
+        // NOTE: This is the special handling of the EthPNT token, where a peg in of EthPNT will
+        // result in an event which will mint a PNT pToken on the other side of the bridge, thus
+        // making fungible the PNT & EthPNT tokens.
+        address normalizedTokenAddress = _tokenAddress == ETHPNT_TOKEN_ADDRESS
+            ? PNT_TOKEN_ADDRESS
+            : _tokenAddress;
+
+        require(normalizedTokenAddress != address(0), "`normalizedTokenAddress` is set to zero address!");
+
         emit PegIn(
-            _tokenAddress,
+            normalizedTokenAddress,
             msg.sender,
             _tokenAmount,
             _destinationAddress,
             _userData,
             ORIGIN_CHAIN_ID,
             _destinationChainId
         );
+
         return true;
     }
 
@@ -263,14 +281,11 @@ contract Erc20Vault is
     )
         public
         onlyPNetwork
-        returns (bool)
+        returns (bool success)
     {
-        if (_tokenAddress == address(weth)) {
-            pegOutWeth(_tokenRecipient, _tokenAmount, "");
-        } else {
-            IERC20Upgradeable(_tokenAddress).safeTransfer(_tokenRecipient, _tokenAmount);
-        }
-        return true;
+        return _tokenAddress == address(weth)
+            ? pegOutWeth(_tokenRecipient, _tokenAmount, "")
+            : pegOutTokens(_tokenAddress, _tokenRecipient, _tokenAmount, "");
     }
 
     function pegOut(
@@ -283,17 +298,91 @@ contract Erc20Vault is
         onlyPNetwork
         returns (bool success)
     {
-        if (_tokenAddress == address(weth)) {
-            pegOutWeth(_tokenRecipient, _tokenAmount, _userData);
+        return _tokenAddress == address(weth)
+            ? pegOutWeth(_tokenRecipient, _tokenAmount, _userData)
+            : pegOutTokens(_tokenAddress, _tokenRecipient, _tokenAmount, _userData);
+    }
+
+    function pegOutTokens(
+        address _tokenAddress,
+        address _tokenRecipient,
+        uint256 _tokenAmount,
+        bytes memory _userData
+    )
+        internal
+        returns (bool success)
+    {
+        if (_tokenAddress == PNT_TOKEN_ADDRESS) {
+            return handlePntPegOut(_tokenRecipient, _tokenAmount, _userData);
+        }
+
+        if (_tokenAddress == 0x15D4c048F83bd7e37d49eA4C83a07267Ec4203dA) { // NOTE: Gala v1
+            return handleGalaV1PegOut(_tokenRecipient, _tokenAmount);
+        }
+
+        if (tokenIsErc777(_tokenAddress)) {
+            // NOTE: This is an ERC777 token, so let's use its `send` function so that hooks are called...
+            IERC777Upgradeable(_tokenAddress).send(_tokenRecipient, _tokenAmount, _userData);
         } else {
-            address erc777Address = _erc1820.getInterfaceImplementer(_tokenAddress, Erc777Token_INTERFACE_HASH);
-            if (erc777Address == address(0)) {
-                return pegOut(_tokenRecipient, _tokenAddress, _tokenAmount);
-            } else {
-                IERC777Upgradeable(erc777Address).send(_tokenRecipient, _tokenAmount, _userData);
-                return true;
-            }
+            // NOTE: Otherwise, we use standard ERC20 transfer function instead.
+            IERC20Upgradeable(_tokenAddress).safeTransfer(_tokenRecipient, _tokenAmount);
         }
+
+        return true;
+    }
+
+    function tokenIsErc777(address _tokenAddress) view internal returns (bool) {
+        return _erc1820.getInterfaceImplementer(_tokenAddress, Erc777Token_INTERFACE_HASH) != address(0);
+    }
+
+    function handleGalaV1PegOut(
+        address _tokenRecipient,
+        uint256 _tokenAmount
+    )
+        internal
+        returns (bool success)
+    {
+        // NOTE: Neither Gala tokens implement hooks so we use a basic ERC20 transfer.
+
+        IERC20Upgradeable(0x15D4c048F83bd7e37d49eA4C83a07267Ec4203dA) // NOTE Gala v1
+            .safeTransfer(_tokenRecipient, _tokenAmount);
+
+        IERC20Upgradeable(0xd1d2Eb1B1e90B638588728b4130137D262C87cae) // NOTE Gala v2
+            .safeTransfer(_tokenRecipient, _tokenAmount);
+
+        return true;
+    }
+
+    function handlePntPegOut(
+        address _tokenRecipient,
+        uint256 _tokenAmount,
+        bytes memory _userData
+    )
+        internal
+        returns (bool success)
+    {
+        // NOTE: The PNT contract is ERC777...
+        IERC777Upgradeable pntContract = IERC777Upgradeable(PNT_TOKEN_ADDRESS);
+        // NOTE: Whilst the EthPNT contract is ERC20.
+        IERC20Upgradeable ethPntContract = IERC20Upgradeable(ETHPNT_TOKEN_ADDRESS);
+
+        // NOTE: First we need to know how much PNT this vault holds...
+        uint256 vaultPntTokenBalance = pntContract.balanceOf(address(this));
+
+        if (_tokenAmount <= vaultPntTokenBalance) {
+            // NOTE: If we can peg out _entirely_ with PNT tokens, we do so...
+            pntContract.send(_tokenRecipient, _tokenAmount, _userData);
+        } else if (vaultPntTokenBalance == 0) {
+            // NOTE: Here we must peg out entirely with ETHPNT tokens instead...
+            ethPntContract.safeTransfer(_tokenRecipient, _tokenAmount);
+        } else {
+            // NOTE: And so here we must peg out the total using as much PNT as possible, with
+            // the remainder being sent as EthPNT...
+            pntContract.send(_tokenRecipient, vaultPntTokenBalance, _userData);
+            ethPntContract.safeTransfer(_tokenRecipient, _tokenAmount - vaultPntTokenBalance);
+        }
+
+        return true;
     }
 
     receive() external payable { }

hardhat.config.js

@@ -9,6 +9,7 @@ const {
 const { assoc } = require('ramda')
 
 require('hardhat-erc1820')
+require('hardhat-storage-layout')
 require('@nomiclabs/hardhat-waffle')
 require('@nomiclabs/hardhat-etherscan')
 require('@openzeppelin/hardhat-upgrades')

lib/show-existing-contract-addresses.js

@@ -9,7 +9,7 @@ const EXISTING_LOGIC_CONTRACT_ADDRESSES = [
   { 'version': 'v2', 'chain': 'ropsten', 'address': '0x2Ea67a02058c3A0CE5f774949b6E8741B8D0a399' },
   { 'version': 'v2', 'chain': 'rinkeby', 'address': '0x6819bbFdf803B8b87850916d3eEB3642DdE6C24F' },
   { 'version': 'v2', 'chain': 'interim', 'address': '0xeEa7CE353a076898E35E82609e45918B5e4d0e0A' },
-  { 'version': 'v2', 'chain': 'ethereum', 'address': '0xE01a9c36170b8Fa163C6a54D7aB3015C85e0186c' },
+  { 'version': 'v2', 'chain': 'ethereum', 'address': '0xfbc347975C48578F4A25ECeEB61BC16356abE8a2' },
   { 'version': 'v2', 'chain': 'goerli', 'address': '0xEa1FFBf0715FE7ccaae5d57dC698550f23581a27' },
   { 'version': 'v2', 'chain': 'sepolia', 'address': '0x9fdbc63D5250Aa59cb6d5382eF4e92113fE1FC35' },
 ]

package.json

@@ -1,13 +1,14 @@
 {
   "name": "ptokens-erc20-vault-smart-contract",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "The pToken ERC20 vault smart-contract & CLI",
   "main": "cli.js",
   "scripts": {
+    "lint": "npx eslint .",
     "test": "npm run tests",
     "tests": "ENDPOINT=http://localhost:8545 npx hardhat test",
-    "compile": "npx hardhat compile",
-    "lint": "npx eslint ."
+    "compile": "ENDPOINT=http://localhost:8545 npx hardhat compile",
+    "showStorage": "ENDPOINT=http://localhost:8545 node ./scripts/show-storage-layout.js"
   },
   "repository": {
     "type": "git",
@@ -45,10 +46,13 @@
     "eslint-config-standard": "^12.0.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-mocha": "^5.3.0",
+    "eslint-plugin-no-only-tests": "^3.0.0",
+    "eslint-plugin-no-skip-tests": "^1.1.0",
     "eslint-plugin-node": "^8.0.1",
     "eslint-plugin-promise": "^4.3.1",
     "eslint-plugin-standard": "^4.1.0",
     "ethereum-waffle": "^3.4.4",
+    "hardhat-storage-layout": "^0.1.7",
     "mocha": "^6.2.3"
   }
 }