Merge pull request #118 from onflow/enable-symbol-updates

Add the ability to update symbols in bridged ERC20/721 contracts
onflow · Sep 3, 2024 · ca95d45 · ca95d45
2 parents ce09dd2 + 8902cab
commit ca95d45
Show file tree

Hide file tree

Showing 6 changed files with 68 additions and 12 deletions.
diff --git a/cadence/args/deploy-erc20-deployer-args.json b/cadence/args/deploy-erc20-deployer-args.json
diff --git a/cadence/args/deploy-erc721-deployer-args.json b/cadence/args/deploy-erc721-deployer-args.json
diff --git a/cadence/tests/test_helpers.cdc b/cadence/tests/test_helpers.cdc
diff --git a/solidity/src/templates/FlowEVMBridgedERC20.sol b/solidity/src/templates/FlowEVMBridgedERC20.sol
@@ -15,14 +15,17 @@ contract FlowEVMBridgedERC20 is ERC165, ERC20, ERC20Burnable, ERC20Permit, Ownab
     string public cadenceTokenIdentifier;
     string public contractMetadata;
 
+    string private _customSymbol;
+
     constructor(
         address owner,
-        string memory name,
-        string memory symbol,
+        string memory name_,
+        string memory symbol_,
         string memory _cadenceTokenAddress,
         string memory _cadenceTokenIdentifier,
         string memory _contractMetadata
-    ) ERC20(name, symbol) Ownable(owner) ERC20Permit(name) {
+    ) ERC20(name_, symbol_) Ownable(owner) ERC20Permit(name_) {
+        _customSymbol = symbol_;
         cadenceTokenAddress = _cadenceTokenAddress;
         cadenceTokenIdentifier = _cadenceTokenIdentifier;
         contractMetadata = _contractMetadata;
@@ -36,17 +39,33 @@ contract FlowEVMBridgedERC20 is ERC165, ERC20, ERC20Burnable, ERC20Permit, Ownab
         return cadenceTokenIdentifier;
     }
 
-    function mint(address to, uint256 amount) public onlyOwner {
-        _mint(to, amount);
+    function symbol() public view override returns (string memory) {
+        return _customSymbol;
     }
 
     function contractURI() public view returns (string memory) {
         return contractMetadata;
     }
 
+    function mint(address to, uint256 amount) public onlyOwner {
+        _mint(to, amount);
+    }
+
+    function setSymbol(string memory newSymbol) public onlyOwner {
+        _setSymbol(newSymbol);
+    }
+
+    function setContractURI(string memory newContractURI) public onlyOwner {
+        contractMetadata = newContractURI;
+    }
+
     function supportsInterface(bytes4 interfaceId) public view override(ERC165) returns (bool) {
         return interfaceId == type(IERC20).interfaceId || interfaceId == type(ERC20Burnable).interfaceId
             || interfaceId == type(Ownable).interfaceId || interfaceId == type(ERC20Permit).interfaceId
             || interfaceId == type(ICrossVM).interfaceId || super.supportsInterface(interfaceId);
     }
+
+    function _setSymbol(string memory newSymbol) internal {
+        _customSymbol = newSymbol;
+    }
 }
diff --git a/solidity/src/templates/FlowEVMBridgedERC721.sol b/solidity/src/templates/FlowEVMBridgedERC721.sol
@@ -18,14 +18,17 @@ contract FlowEVMBridgedERC721 is ERC721, ERC721URIStorage, ERC721Burnable, ERC72
     string public cadenceNFTIdentifier;
     string public contractMetadata;
 
+    string private _customSymbol;
+
     constructor(
         address owner,
-        string memory name,
-        string memory symbol,
+        string memory name_,
+        string memory symbol_,
         string memory _cadenceNFTAddress,
         string memory _cadenceNFTIdentifier,
         string memory _contractMetadata
-    ) ERC721(name, symbol) Ownable(owner) {
+    ) ERC721(name_, symbol_) Ownable(owner) {
+        _customSymbol = symbol_;
         cadenceNFTAddress = _cadenceNFTAddress;
         cadenceNFTIdentifier = _cadenceNFTIdentifier;
         contractMetadata = _contractMetadata;
@@ -39,6 +42,10 @@ contract FlowEVMBridgedERC721 is ERC721, ERC721URIStorage, ERC721Burnable, ERC72
         return cadenceNFTIdentifier;
     }
 
+    function symbol() public view override returns (string memory) {
+        return _customSymbol;
+    }
+
     function safeMint(address to, uint256 tokenId, string memory uri) public onlyOwner {
         _safeMint(to, tokenId);
         _setTokenURI(tokenId, uri);
@@ -48,6 +55,10 @@ contract FlowEVMBridgedERC721 is ERC721, ERC721URIStorage, ERC721Burnable, ERC72
         _setTokenURI(tokenId, uri);
     }
 
+    function setSymbol(string memory newSymbol) public onlyOwner {
+        _setSymbol(newSymbol);
+    }
+
     function contractURI() public view returns (string memory) {
         return contractMetadata;
     }
@@ -72,6 +83,10 @@ contract FlowEVMBridgedERC721 is ERC721, ERC721URIStorage, ERC721Burnable, ERC72
         return _ownerOf(tokenId) != address(0);
     }
 
+    function _setSymbol(string memory newSymbol) internal {
+        _customSymbol = newSymbol;
+    }
+
     function _update(address to, uint256 tokenId, address auth)
         internal
         override(ERC721, ERC721Enumerable)

diff --git a/solidity/test/FlowBridgeFactory.t.sol b/solidity/test/FlowBridgeFactory.t.sol
@@ -158,4 +158,26 @@ contract FlowBridgeFactoryTest is Test {
         uint256 balance = deployedERC20Contract.balanceOf(recipient);
         assertEq(balance, amount);
     }
+
+    function test_UpdateERC721Symbol() public {
+        string memory _symbol = deployedERC721Contract.symbol();
+        assertEq(_symbol, symbol);
+
+        string memory newSymbol = "NEW_SYMBOL";
+        deployedERC721Contract.setSymbol(newSymbol);
+
+        _symbol = deployedERC721Contract.symbol();
+        assertEq(_symbol, newSymbol);
+    }
+
+    function test_UpdateERC20Symbol() public {
+        string memory _symbol = deployedERC20Contract.symbol();
+        assertEq(_symbol, symbol);
+
+        string memory newSymbol = "NEW_SYMBOL";
+        deployedERC20Contract.setSymbol(newSymbol);
+
+        _symbol = deployedERC20Contract.symbol();
+        assertEq(_symbol, newSymbol);
+    }
 }