SafeERC20.sol 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. // SPDX-License-Identifier: MIT
  2. // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol)
  3. pragma solidity ^0.8.20;
  4. import {IERC20} from "../IERC20.sol";
  5. import {IERC1363} from "../../../interfaces/IERC1363.sol";
  6. import {Address} from "../../../utils/Address.sol";
  7. /**
  8. * @title SafeERC20
  9. * @dev Wrappers around ERC-20 operations that throw on failure (when the token
  10. * contract returns false). Tokens that return no value (and instead revert or
  11. * throw on failure) are also supported, non-reverting calls are assumed to be
  12. * successful.
  13. * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
  14. * which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
  15. */
  16. library SafeERC20 {
  17. using Address for address;
  18. /**
  19. * @dev An operation with an ERC-20 token failed.
  20. */
  21. error SafeERC20FailedOperation(address token);
  22. /**
  23. * @dev Indicates a failed `decreaseAllowance` request.
  24. */
  25. error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
  26. /**
  27. * @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
  28. * non-reverting calls are assumed to be successful.
  29. */
  30. function safeTransfer(IERC20 token, address to, uint256 value) internal {
  31. _callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
  32. }
  33. /**
  34. * @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
  35. * calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
  36. */
  37. function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
  38. _callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
  39. }
  40. /**
  41. * @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
  42. * non-reverting calls are assumed to be successful.
  43. */
  44. function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
  45. uint256 oldAllowance = token.allowance(address(this), spender);
  46. forceApprove(token, spender, oldAllowance + value);
  47. }
  48. /**
  49. * @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
  50. * value, non-reverting calls are assumed to be successful.
  51. */
  52. function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
  53. unchecked {
  54. uint256 currentAllowance = token.allowance(address(this), spender);
  55. if (currentAllowance < requestedDecrease) {
  56. revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
  57. }
  58. forceApprove(token, spender, currentAllowance - requestedDecrease);
  59. }
  60. }
  61. /**
  62. * @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
  63. * non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
  64. * to be set to zero before setting it to a non-zero value, such as USDT.
  65. */
  66. function forceApprove(IERC20 token, address spender, uint256 value) internal {
  67. bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
  68. if (!_callOptionalReturnBool(token, approvalCall)) {
  69. _callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
  70. _callOptionalReturn(token, approvalCall);
  71. }
  72. }
  73. /**
  74. * @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
  75. * code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
  76. * targeting contracts.
  77. *
  78. * Reverts if the returned value is other than `true`.
  79. */
  80. function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
  81. if (to.code.length == 0) {
  82. safeTransfer(token, to, value);
  83. } else if (!token.transferAndCall(to, value, data)) {
  84. revert SafeERC20FailedOperation(address(token));
  85. }
  86. }
  87. /**
  88. * @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
  89. * has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
  90. * targeting contracts.
  91. *
  92. * Reverts if the returned value is other than `true`.
  93. */
  94. function transferFromAndCallRelaxed(
  95. IERC1363 token,
  96. address from,
  97. address to,
  98. uint256 value,
  99. bytes memory data
  100. ) internal {
  101. if (to.code.length == 0) {
  102. safeTransferFrom(token, from, to, value);
  103. } else if (!token.transferFromAndCall(from, to, value, data)) {
  104. revert SafeERC20FailedOperation(address(token));
  105. }
  106. }
  107. /**
  108. * @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
  109. * code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
  110. * targeting contracts.
  111. *
  112. * NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
  113. * Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
  114. * once without retrying, and relies on the returned value to be true.
  115. *
  116. * Reverts if the returned value is other than `true`.
  117. */
  118. function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
  119. if (to.code.length == 0) {
  120. forceApprove(token, to, value);
  121. } else if (!token.approveAndCall(to, value, data)) {
  122. revert SafeERC20FailedOperation(address(token));
  123. }
  124. }
  125. /**
  126. * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
  127. * on the return value: the return value is optional (but if data is returned, it must not be false).
  128. * @param token The token targeted by the call.
  129. * @param data The call data (encoded using abi.encode or one of its variants).
  130. */
  131. function _callOptionalReturn(IERC20 token, bytes memory data) private {
  132. // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
  133. // we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
  134. // the target address contains contract code and also asserts for success in the low-level call.
  135. bytes memory returndata = address(token).functionCall(data);
  136. if (returndata.length != 0 && !abi.decode(returndata, (bool))) {
  137. revert SafeERC20FailedOperation(address(token));
  138. }
  139. }
  140. /**
  141. * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
  142. * on the return value: the return value is optional (but if data is returned, it must not be false).
  143. * @param token The token targeted by the call.
  144. * @param data The call data (encoded using abi.encode or one of its variants).
  145. *
  146. * This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
  147. */
  148. function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
  149. // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
  150. // we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
  151. // and not revert is the subcall reverts.
  152. (bool success, bytes memory returndata) = address(token).call(data);
  153. return success && (returndata.length == 0 || abi.decode(returndata, (bool))) && address(token).code.length > 0;
  154. }
  155. }