@0x/contracts-utils: Update comments in LibERC20Token.

This commit is contained in:
Lawrence Forman
2019-10-31 10:42:38 -04:00
parent 0c064bf85b
commit 575cb99839

View File

@@ -21,8 +21,9 @@ pragma solidity ^0.5.9;
library LibERC20Token { library LibERC20Token {
/// @dev Calls `IERC20Token(token).approve()`. Does not revert if /// @dev Calls `IERC20Token(token).approve()`.
/// no data is returned. /// Reverts if `false` is returned or if the return
/// data length is nonzero and not 32 bytes.
/// @param token The address of the token contract. /// @param token The address of the token contract.
/// @param spender The address that receives an allowance. /// @param spender The address that receives an allowance.
/// @param allowance The allowance to set. /// @param allowance The allowance to set.
@@ -41,8 +42,9 @@ library LibERC20Token {
_callWithOptionalBooleanResult(token, callData); _callWithOptionalBooleanResult(token, callData);
} }
/// @dev Calls `IERC20Token(token).transfer()`. Does not revert if /// @dev Calls `IERC20Token(token).transfer()`.
/// no data is returned. /// Reverts if `false` is returned or if the return
/// data length is nonzero and not 32 bytes.
/// @param token The address of the token contract. /// @param token The address of the token contract.
/// @param to The address that receives the tokens /// @param to The address that receives the tokens
/// @param amount Number of tokens to transfer. /// @param amount Number of tokens to transfer.
@@ -61,8 +63,9 @@ library LibERC20Token {
_callWithOptionalBooleanResult(token, callData); _callWithOptionalBooleanResult(token, callData);
} }
/// @dev Calls `IERC20Token(token).transferFrom()`. Does not revert if /// @dev Calls `IERC20Token(token).transferFrom()`.
/// no data is returned. /// Reverts if `false` is returned or if the return
/// data length is nonzero and not 32 bytes.
/// @param token The address of the token contract. /// @param token The address of the token contract.
/// @param from The owner of the tokens. /// @param from The owner of the tokens.
/// @param to The address that receives the tokens /// @param to The address that receives the tokens