Update docs
This commit is contained in:
@ -1,5 +1,5 @@
|
||||
// SPDX-License-Identifier: MIT
|
||||
// OpenZeppelin Contracts (last updated v5.0.0) (utils/cryptography/MessageHashUtils.sol)
|
||||
// OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/MessageHashUtils.sol)
|
||||
|
||||
pragma solidity ^0.8.20;
|
||||
|
||||
@ -9,12 +9,12 @@ import {Strings} from "../Strings.sol";
|
||||
* @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing.
|
||||
*
|
||||
* The library provides methods for generating a hash of a message that conforms to the
|
||||
* https://eips.ethereum.org/EIPS/eip-191[EIP 191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712]
|
||||
* https://eips.ethereum.org/EIPS/eip-191[ERC-191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712]
|
||||
* specifications.
|
||||
*/
|
||||
library MessageHashUtils {
|
||||
/**
|
||||
* @dev Returns the keccak256 digest of an EIP-191 signed data with version
|
||||
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
|
||||
* `0x45` (`personal_sign` messages).
|
||||
*
|
||||
* The digest is calculated by prefixing a bytes32 `messageHash` with
|
||||
@ -28,8 +28,7 @@ library MessageHashUtils {
|
||||
* See {ECDSA-recover}.
|
||||
*/
|
||||
function toEthSignedMessageHash(bytes32 messageHash) internal pure returns (bytes32 digest) {
|
||||
/// @solidity memory-safe-assembly
|
||||
assembly {
|
||||
assembly ("memory-safe") {
|
||||
mstore(0x00, "\x19Ethereum Signed Message:\n32") // 32 is the bytes-length of messageHash
|
||||
mstore(0x1c, messageHash) // 0x1c (28) is the length of the prefix
|
||||
digest := keccak256(0x00, 0x3c) // 0x3c is the length of the prefix (0x1c) + messageHash (0x20)
|
||||
@ -37,7 +36,7 @@ library MessageHashUtils {
|
||||
}
|
||||
|
||||
/**
|
||||
* @dev Returns the keccak256 digest of an EIP-191 signed data with version
|
||||
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
|
||||
* `0x45` (`personal_sign` messages).
|
||||
*
|
||||
* The digest is calculated by prefixing an arbitrary `message` with
|
||||
@ -52,7 +51,7 @@ library MessageHashUtils {
|
||||
}
|
||||
|
||||
/**
|
||||
* @dev Returns the keccak256 digest of an EIP-191 signed data with version
|
||||
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
|
||||
* `0x00` (data with intended validator).
|
||||
*
|
||||
* The digest is calculated by prefixing an arbitrary `data` with `"\x19\x00"` and the intended
|
||||
@ -65,7 +64,7 @@ library MessageHashUtils {
|
||||
}
|
||||
|
||||
/**
|
||||
* @dev Returns the keccak256 digest of an EIP-712 typed data (EIP-191 version `0x01`).
|
||||
* @dev Returns the keccak256 digest of an EIP-712 typed data (ERC-191 version `0x01`).
|
||||
*
|
||||
* The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with
|
||||
* `\x19\x01` and hashing the result. It corresponds to the hash signed by the
|
||||
@ -74,8 +73,7 @@ library MessageHashUtils {
|
||||
* See {ECDSA-recover}.
|
||||
*/
|
||||
function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) {
|
||||
/// @solidity memory-safe-assembly
|
||||
assembly {
|
||||
assembly ("memory-safe") {
|
||||
let ptr := mload(0x40)
|
||||
mstore(ptr, hex"19_01")
|
||||
mstore(add(ptr, 0x02), domainSeparator)
|
||||
|
||||
Reference in New Issue
Block a user