feat: FP deployment with ERC20Permit extension

BuildOnBeam · Feb 28, 2024 · 3c6e22b · 3c6e22b
1 parent ac3916b
commit 3c6e22b
Show file tree

Hide file tree

Showing 15 changed files with 9,466 additions and 18 deletions.
diff --git a/constants/tokenConfig.js b/constants/tokenConfig.js
@@ -44,7 +44,7 @@ module.exports = {
             symbol: "DOMI",
             withFee: true,
         },
-        FpOFT: {
+        ForgottenPlaylandOFT: {
             name: "Forgotten Playland",
             symbol: "FP",
             withFee: true,
@@ -120,7 +120,7 @@ module.exports = {
             withFee: true,
             minGas: 10000000,
         },
-        FpProxyOFT: {
+        ForgottenPlaylandProxyOFT: {
             address: "0xEeee2A2E650697d2A8e8BC990C2f3d04203bE06f",
             withFee: true,
             minGas: 10000000,

diff --git a/contracts/contracts-upgradable/examples/FP.sol b/contracts/contracts-upgradable/examples/FP.sol
@@ -2,9 +2,9 @@
 
 pragma solidity ^0.8.18;
 
-import "../token/oft/v2/fee/OFTWithFeeUpgradeable.sol";
+import "../token/oft/v2/fee/OFTWithFeePermitUpgradeable.sol";
 import "../token/oft/v2/fee/ProxyOFTWithFeeUpgradeable.sol";
 
-contract FpOFT is OFTWithFeeUpgradeable {}
+contract ForgottenPlaylandOFT is OFTWithFeePermitUpgradeable {}
 
-contract FpProxyOFT is ProxyOFTWithFeeUpgradeable {}
+contract ForgottenPlaylandProxyOFT is ProxyOFTWithFeeUpgradeable {}
diff --git a/contracts/contracts-upgradable/token/oft/v2/fee/OFTWithFeePermitUpgradeable.sol b/contracts/contracts-upgradable/token/oft/v2/fee/OFTWithFeePermitUpgradeable.sol
@@ -15,11 +15,16 @@ contract OFTWithFeePermitUpgradeable is Initializable, BaseOFTWithFeeUpgradeable
         _disableInitializers();
     }
 
-    function initialize(string memory _name, string memory _symbol, uint8 _sharedDecimals, address _lzEndpoint) public virtual initializer {
-        __OFTWithFeeUpgradeable_init(_name, _symbol, _sharedDecimals, _lzEndpoint);
+    function initialize(
+        string memory _name,
+        string memory _symbol,
+        uint8 _sharedDecimals,
+        address _lzEndpoint
+    ) public virtual initializer {
+        __OFTWithFeePermitUpgradeable_init(_name, _symbol, _sharedDecimals, _lzEndpoint);
     }
 
-    function __OFTWithFeeUpgradeable_init(
+    function __OFTWithFeePermitUpgradeable_init(
         string memory _name,
         string memory _symbol,
         uint8 _sharedDecimals,
@@ -32,13 +37,13 @@ contract OFTWithFeePermitUpgradeable is Initializable, BaseOFTWithFeeUpgradeable
         __ERC20_init_unchained(_name, _symbol);
         __ERC20Permit_init_unchained(_name);
 
-        __OFTWithFeeUpgradeable_init_unchained(_sharedDecimals);
+        __OFTWithFeePermitUpgradeable_init_unchained(_sharedDecimals);
     }
 
-    function __OFTWithFeeUpgradeable_init_unchained(uint8 _sharedDecimals) internal onlyInitializing {
+    function __OFTWithFeePermitUpgradeable_init_unchained(uint8 _sharedDecimals) internal onlyInitializing {
         uint8 decimals = decimals();
         require(_sharedDecimals <= decimals, "OFTWithFee: sharedDecimals must be <= decimals");
-        ld2sdRate = 10 ** (decimals - _sharedDecimals);
+        ld2sdRate = 10**(decimals - _sharedDecimals);
     }
 
     /************************************************************************
@@ -55,19 +60,32 @@ contract OFTWithFeePermitUpgradeable is Initializable, BaseOFTWithFeeUpgradeable
     /************************************************************************
      * internal functions
      ************************************************************************/
-    function _debitFrom(address _from, uint16, bytes32, uint _amount) internal virtual override returns (uint) {
+    function _debitFrom(
+        address _from,
+        uint16,
+        bytes32,
+        uint _amount
+    ) internal virtual override returns (uint) {
         address spender = _msgSender();
         if (_from != spender) _spendAllowance(_from, spender, _amount);
         _burn(_from, _amount);
         return _amount;
     }
 
-    function _creditTo(uint16, address _toAddress, uint _amount) internal virtual override returns (uint) {
+    function _creditTo(
+        uint16,
+        address _toAddress,
+        uint _amount
+    ) internal virtual override returns (uint) {
         _mint(_toAddress, _amount);
         return _amount;
     }
 
-    function _transferFrom(address _from, address _to, uint _amount) internal virtual override returns (uint) {
+    function _transferFrom(
+        address _from,
+        address _to,
+        uint _amount
+    ) internal virtual override returns (uint) {
         address spender = _msgSender();
         // if transfer from this contract, no need to check allowance
         if (_from != address(this) && _from != spender) _spendAllowance(_from, spender, _amount);

diff --git a/deploy/FpOFT.js → deploy/ForgottenPlaylandOFT.js b/deploy/FpOFT.js → deploy/ForgottenPlaylandOFT.js
@@ -1,7 +1,7 @@
 const LZ_ENDPOINTS = require("../constants/layerzeroEndpoints.json")
 const TOKEN_CONFIG = require("../constants/tokenConfig")
 
-const CONTRACT_NAME = "FpOFT"
+const CONTRACT_NAME = "ForgottenPlaylandOFT"
 
 module.exports = async function ({ deployments, getNamedAccounts }) {
     const { deploy } = deployments

diff --git a/deploy/FpProxyOFT.js → deploy/ForgottenPlaylandProxyOFT.js b/deploy/FpProxyOFT.js → deploy/ForgottenPlaylandProxyOFT.js
@@ -1,7 +1,7 @@
 const LZ_ENDPOINTS = require("../constants/layerzeroEndpoints.json")
 const TOKEN_CONFIG = require("../constants/tokenConfig")
 
-const CONTRACT_NAME = "FpProxyOFT"
+const CONTRACT_NAME = "ForgottenPlaylandProxyOFT"
 
 module.exports = async function ({ deployments, getNamedAccounts }) {
     const { deploy } = deployments