crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

In @0x/contracts-utils add natspec comments RichErrors.StandardError

Browse Source
This commit is contained in:
Lawrence Forman 2019-04-11 11:40:44 -04:00 committed by Amir Bandeali
parent 5781ab5436
commit e54f5d563f
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
contracts/utils/contracts/src/RichErrors.sol
View File

@ -25,6 +25,11 @@ contract RichErrors is
MRichErrors MRichErrors
{ {
// solhint-disable func-name-mixedcase // solhint-disable func-name-mixedcase
/// @dev ABI encode a standard, string revert error payload.
/// This is the same payload that would be included by a `revert(string)`
/// solidity statement. It has the function signature `Error(string)`.
/// @param message The error string.
/// @return The ABI encoded error.
function StandardError( function StandardError(
string memory message string memory message
) )
@ -32,13 +37,14 @@ contract RichErrors is
pure pure
returns (bytes memory) returns (bytes memory)
{ {
return abi.encodePacked( return abi.encodeWithSelector(
STANDARD_ERROR_SELECTOR, STANDARD_ERROR_SELECTOR,
uint256(0x20), uint256(0x20),
bytes(message).length, bytes(message).length,
bytes(message) bytes(message)
); );
} }
// solhint-enable func-name-mixedcase
/// @dev Reverts an encoded rich revert reason `errorData`. /// @dev Reverts an encoded rich revert reason `errorData`.
/// @param errorData ABI encoded error data. /// @param errorData ABI encoded error data.