ethers.js/src.ts/hash/message.ts

48 lines
1.5 KiB
TypeScript
Raw Normal View History

2022-09-16 05:31:00 +03:00
import { keccak256 } from "../crypto/index.js";
2022-09-05 23:14:43 +03:00
import { MessagePrefix } from "../constants/index.js";
2023-01-15 15:54:49 +03:00
import { recoverAddress } from "../transaction/index.js";
2022-09-05 23:14:43 +03:00
import { concat, toUtf8Bytes } from "../utils/index.js";
2023-01-15 15:54:49 +03:00
import type { SignatureLike } from "../crypto/index.js";
2022-12-10 02:21:45 +03:00
/**
* Computes the [[link-eip-191]] personal-sign message digest to sign.
*
* This prefixes the message with [[MessagePrefix]] and the decimal length
* of %%message%% and computes the [[keccak256]] digest.
*
* If %%message%% is a string, it is converted to its UTF-8 bytes
* first. To compute the digest of a [[DataHexString]], it must be converted
* to [bytes](getBytes).
*
* @example:
* hashMessage("Hello World")
* //_result:
*
* // Hashes the SIX (6) string characters, i.e.
* // [ "0", "x", "4", "2", "4", "3" ]
* hashMessage("0x4243")
* //_result:
*
* // Hashes the TWO (2) bytes [ 0x42, 0x43 ]...
* hashMessage(getBytes("0x4243"))
* //_result:
*
* // ...which is equal to using data
* hashMessage(new Uint8Array([ 0x42, 0x43 ]))
* //_result:
*
*/
2022-09-05 23:14:43 +03:00
export function hashMessage(message: Uint8Array | string): string {
if (typeof(message) === "string") { message = toUtf8Bytes(message); }
return keccak256(concat([
toUtf8Bytes(MessagePrefix),
toUtf8Bytes(String(message.length)),
message
]));
}
2023-01-15 15:54:49 +03:00
export function verifyMessage(message: Uint8Array | string, sig: SignatureLike): string {
const digest = hashMessage(message);
return recoverAddress(digest, sig);
}