Skip to content

docs: clarify isHexChecksumAddress checks shape, not the checksum#301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gomesalexandre wants to merge 1 commit into
base:main
Choose a base branch
from
Open

docs: clarify isHexChecksumAddress checks shape, not the checksum #301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions src/hex.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,10 +61,17 @@ export function isHexAddress(value: unknown): value is Hex {
}

/**
* Check if a string is a valid hex checksum address.
* Check if a string has the shape of a hex address, allowing the mixed case
* used by ERC-55 checksummed addresses.
*
* This only validates the shape - "0x" followed by 40 hexadecimal characters,
* upper- or lower-case. It does NOT verify the ERC-55 checksum, so a
* non-checksummed (for example all-lowercase) address still passes. Use
* {@link getChecksumAddress} to compute the checksummed form.
*
* @param value - The value to check.
* @returns Whether the value is a valid hex checksum address.
* @returns Whether the value has the shape of a (possibly checksummed) hex
* address. The ERC-55 checksum itself is not verified.
*/
export function isHexChecksumAddress(value: unknown): value is Hex {
return isString(value) && HEX_CHECKSUM_ADDRESS_REGEX.test(value);
Expand Down