Change comment about token address

0xPolygonHermez · Nov 7, 2024 · 1bfda81 · 1bfda81
1 parent 8a7ad06
commit 1bfda81
Show file tree

Hide file tree

Showing 13 changed files with 419 additions and 335 deletions.
diff --git a/contracts/PolygonZkEVMBridge.sol b/contracts/PolygonZkEVMBridge.sol
@@ -139,7 +139,7 @@ contract PolygonZkEVMBridge is
      * @param destinationNetwork Network destination
      * @param destinationAddress Address destination
      * @param amount Amount of tokens
-     * @param token Token address, 0 address is reserved for ether
+     * @param token Token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param forceUpdateGlobalExitRoot Indicates if the new global exit root is updated or not
      * @param permitData Raw data of the call `permit` of the token
      */
@@ -306,7 +306,7 @@ contract PolygonZkEVMBridge is
      * @param mainnetExitRoot Mainnet exit root
      * @param rollupExitRoot Rollup exit root
      * @param originNetwork Origin network
-     * @param originTokenAddress  Origin token address, 0 address is reserved for ether
+     * @param originTokenAddress  Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param destinationNetwork Network destination
      * @param destinationAddress Address destination
      * @param amount Amount of tokens
@@ -483,7 +483,7 @@ contract PolygonZkEVMBridge is
      * Since the metadata has relevance in the address deployed, this function will not return a valid
      * wrapped address if the metadata provided is not the original one.
      * @param originNetwork Origin network
-     * @param originTokenAddress Origin token address, 0 address is reserved for ether
+     * @param originTokenAddress Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param name Name of the token
      * @param symbol Symbol of the token
      * @param decimals Decimals of the token
@@ -520,7 +520,7 @@ contract PolygonZkEVMBridge is
     /**
      * @notice Returns the address of a wrapper using the token information if already exist
      * @param originNetwork Origin network
-     * @param originTokenAddress Origin token address, 0 address is reserved for ether
+     * @param originTokenAddress Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      */
     function getTokenWrappedAddress(
         uint32 originNetwork,

diff --git a/contracts/mocks/DepositContractMock.sol b/contracts/mocks/DepositContractMock.sol
@@ -18,7 +18,7 @@ contract DepositContractMock is DepositContract {
      * @notice Given the leaf data returns the leaf value
      * @param leafType Leaf type
      * @param originNetwork Origin Network
-     * @param originTokenAddress Origin token address, 0 address is reserved for ether
+     * @param originTokenAddress Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param destinationNetwork Destination network
      * @param destinationAddress Destination address
      * @param amount Amount of tokens

diff --git a/contracts/mocks/PolygonZkEVMBridgeMock.sol b/contracts/mocks/PolygonZkEVMBridgeMock.sol
@@ -42,7 +42,7 @@ contract PolygonZkEVMBridgeMock is PolygonZkEVMBridge, OwnableUpgradeable {
      * @param destinationNetwork Network destination
      * @param destinationAddress Address destination
      * @param amount Amount of tokens
-     * @param token Token address, 0 address is reserved for ether
+     * @param token Token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param permitData Raw data of the call `permit` of the token
      */
     function bridgeAsset(

diff --git a/contracts/v2/PolygonZkEVMBridgeV2.sol b/contracts/v2/PolygonZkEVMBridgeV2.sol
@@ -205,7 +205,7 @@ contract PolygonZkEVMBridgeV2 is
      * @param destinationNetwork Network destination
      * @param destinationAddress Address destination
      * @param amount Amount of tokens
-     * @param token Token address, 0 address is reserved for ether
+     * @param token Token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param forceUpdateGlobalExitRoot Indicates if the new global exit root is updated or not
      * @param permitData Raw data of the call `permit` of the token
      */
@@ -689,7 +689,7 @@ contract PolygonZkEVMBridgeV2 is
      * Since the metadata has relevance in the address deployed, this function will not return a valid
      * wrapped address if the metadata provided is not the original one.
      * @param originNetwork Origin network
-     * @param originTokenAddress Origin token address, 0 address is reserved for ether
+     * @param originTokenAddress Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param name Name of the token
      * @param symbol Symbol of the token
      * @param decimals Decimals of the token
@@ -726,7 +726,7 @@ contract PolygonZkEVMBridgeV2 is
     /**
      * @notice Returns the address of a wrapper using the token information if already exist
      * @param originNetwork Origin network
-     * @param originTokenAddress Origin token address, 0 address is reserved for ether
+     * @param originTokenAddress Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      */
     function getTokenWrappedAddress(
         uint32 originNetwork,
@@ -1182,7 +1182,7 @@ contract PolygonZkEVMBridgeV2 is
      * Since the metadata has relevance in the address deployed, this function will not return a valid
      * wrapped address if the metadata provided is not the original one.
      * @param originNetwork Origin network
-     * @param originTokenAddress Origin token address, 0 address is reserved for ether
+     * @param originTokenAddress Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param token Address of the token to calculate the wrapper address
      */
     function calculateTokenWrapperAddress(

diff --git a/contracts/v2/lib/DepositContractV2.sol b/contracts/v2/lib/DepositContractV2.sol
@@ -13,7 +13,7 @@ contract DepositContractV2 is ReentrancyGuardUpgradeable, DepositContractBase {
      * @notice Given the leaf data returns the leaf value
      * @param leafType Leaf type -->  [0] transfer Ether / ERC20 tokens, [1] message
      * @param originNetwork Origin Network
-     * @param originAddress [0] Origin token address, 0 address is reserved for ether, [1] msg.sender of the message
+     * @param originAddress [0] Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token, [1] msg.sender of the message
      * @param destinationNetwork Destination network
      * @param destinationAddress Destination address
      * @param amount [0] Amount of tokens/ether, [1] Amount of ether

diff --git a/contracts/v2/mocks/BridgeReceiverMock.sol b/contracts/v2/mocks/BridgeReceiverMock.sol
@@ -59,7 +59,7 @@ contract BridgeReceiverMock {
      * @param mainnetExitRoot Mainnet exit root
      * @param rollupExitRoot Rollup exit root
      * @param originNetwork Origin network
-     * @param originTokenAddress  Origin token address, 0 address is reserved for ether
+     * @param originTokenAddress  Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param destinationNetwork Network destination
      * @param destinationAddress Address destination
      * @param amount Amount of tokens

diff --git a/contracts/v2/sovereignChains/BridgeL2SovereignChain.sol b/contracts/v2/sovereignChains/BridgeL2SovereignChain.sol
@@ -205,7 +205,7 @@ contract BridgeL2SovereignChain is
      * this will override the previous calls and only keep the last sovereignTokenAddress.
      * @notice The tokenInfoToWrappedToken mapping  value is replaced by the new sovereign address but it's not the case for the wrappedTokenToTokenInfo map where the value is added, this way user will always be able to withdraw their tokens
      * @param originNetwork Origin network
-     * @param originTokenAddress Origin token address, 0 address is reserved for ether
+     * @param originTokenAddress Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param sovereignTokenAddress Address of the sovereign wrapped token
      * @param isNotMintable Flag to indicate if the wrapped token is not mintable
      */
@@ -231,7 +231,7 @@ contract BridgeL2SovereignChain is
      * this will override the previous calls and only keep the last sovereignTokenAddress.
      * @notice The tokenInfoToWrappedToken mapping  value is replaced by the new sovereign address but it's not the case for the wrappedTokenToTokenInfo map where the value is added, this way user will always be able to withdraw their tokens
      * @param originNetwork Origin network
-     * @param originTokenAddress Origin token address, 0 address is reserved for ether
+     * @param originTokenAddress Origin token address, 0 address is reserved for gas token address. If WETH address is zero, means this gas token is ether, else means is a custom erc20 gas token
      * @param sovereignTokenAddress Address of the sovereign wrapped token
      * @param isNotMintable Flag to indicate if the wrapped token is not mintable
      */