Update deposit() comments

sygmaprotocol · Sep 10, 2024 · a2c7812 · a2c7812
1 parent 7921f5e
commit a2c7812
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/contracts/handlers/ERC20Handler.sol b/contracts/handlers/ERC20Handler.sol
@@ -42,7 +42,7 @@ contract ERC20Handler is IHandler, ERCHandlerHelpers, DepositDataHelper, ERC20Sa
         optionalMessage                    bytes   bytes (160 + len(destinationRecipientAddress)) - END
         @dev Depending if the corresponding {tokenAddress} for the parsed {resourceID} is
         marked true in {_tokenContractAddressToTokenProperties[tokenAddress].isBurnable}, deposited tokens will be burned, if not, they will be locked.
-        @return bytes representation of the uint256 amount that was deposited, with bridge's defaultDecimals.
+        @return 32-length byte array with internal bridge amount OR empty byte array if conversion is not needed.
      */
     function deposit(
         bytes32 resourceID,

diff --git a/contracts/handlers/NativeTokenHandler.sol b/contracts/handlers/NativeTokenHandler.sol
@@ -53,7 +53,7 @@ contract NativeTokenHandler is IHandler, ERCHandlerHelpers, DepositDataHelper {
         optionalGas                        uint256 bytes (64 + len(destinationRecipientAddress)) - (96 + len(destinationRecipientAddress))
         optionalMessage             length uint256 bytes (96 + len(destinationRecipientAddress)) - (128 + len(destinationRecipientAddress))
         optionalMessage                    bytes   bytes (160 + len(destinationRecipientAddress)) - END
-        @return bytes representation of the uint256 amount that was deposited, with bridge's defaultDecimals.
+        @return 32-length byte array with internal bridge amount OR empty byte array if conversion is not needed.
      */
     function deposit(
         bytes32 resourceID,

diff --git a/contracts/handlers/XC20Handler.sol b/contracts/handlers/XC20Handler.sol
@@ -33,7 +33,7 @@ contract XC20Handler is IHandler, ERCHandlerHelpers, XC20Safe {
         destinationRecipientAddress                 bytes       bytes  64 - END
         @dev Depending if the corresponding {tokenAddress} for the parsed {resourceID} is
         marked true in {_tokenContractAddressToTokenProperties[tokenAddress].isBurnable}, deposited tokens will be burned, if not, they will be locked.
-        @return bytes representation of the uint256 amount that was deposited, with bridge's defaultDecimals.
+        @return 32-length byte array with internal bridge amount OR empty byte array if conversion is not needed.
      */
     function deposit(
         bytes32 resourceID,