mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-30 08:09:15 +01:00
3732c5f71e
ESLint rules have been added to enforce our JSDoc conventions. These rules were introduced by updating `@metamask/eslint-config` to v9. Some of the rules have been disabled because the effort to fix all lint errors was too high. It might be easiest to enable these rules one directory at a time, or one rule at a time. Most of the changes in this PR were a result of running `yarn lint:fix`. There were a handful of manual changes that seemed obvious and simple to make. Anything beyond that and the rule was left disabled.
76 lines
2.7 KiB
JavaScript
76 lines
2.7 KiB
JavaScript
import {
|
|
isHexString,
|
|
isValidAddress,
|
|
isValidChecksumAddress,
|
|
addHexPrefix,
|
|
toChecksumAddress,
|
|
zeroAddress,
|
|
} from 'ethereumjs-util';
|
|
|
|
export const BURN_ADDRESS = zeroAddress();
|
|
|
|
export function isBurnAddress(address) {
|
|
return address === BURN_ADDRESS;
|
|
}
|
|
|
|
/**
|
|
* Validates that the input is a hex address. This utility method is a thin
|
|
* wrapper around ethereumjs-util.isValidAddress, with the exception that it
|
|
* does not throw an error when provided values that are not hex strings. In
|
|
* addition, and by default, this method will return true for hex strings that
|
|
* meet the length requirement of a hex address, but are not prefixed with `0x`
|
|
* Finally, if the mixedCaseUseChecksum flag is true and a mixed case string is
|
|
* provided this method will validate it has the proper checksum formatting.
|
|
*
|
|
* @param {string} possibleAddress - Input parameter to check against
|
|
* @param {Object} [options] - options bag
|
|
* @param {boolean} [options.allowNonPrefixed] - If true will first ensure '0x'
|
|
* is prepended to the string
|
|
* @param {boolean} [options.mixedCaseUseChecksum] - If true will treat mixed
|
|
* case addresses as checksum addresses and validate that proper checksum
|
|
* format is used
|
|
* @returns {boolean} whether or not the input is a valid hex address
|
|
*/
|
|
export function isValidHexAddress(
|
|
possibleAddress,
|
|
{ allowNonPrefixed = true, mixedCaseUseChecksum = false } = {},
|
|
) {
|
|
const addressToCheck = allowNonPrefixed
|
|
? addHexPrefix(possibleAddress)
|
|
: possibleAddress;
|
|
if (!isHexString(addressToCheck)) {
|
|
return false;
|
|
}
|
|
|
|
if (mixedCaseUseChecksum) {
|
|
const prefixRemoved = addressToCheck.slice(2);
|
|
const lower = prefixRemoved.toLowerCase();
|
|
const upper = prefixRemoved.toUpperCase();
|
|
const allOneCase = prefixRemoved === lower || prefixRemoved === upper;
|
|
if (!allOneCase) {
|
|
return isValidChecksumAddress(addressToCheck);
|
|
}
|
|
}
|
|
|
|
return isValidAddress(addressToCheck);
|
|
}
|
|
|
|
export function toChecksumHexAddress(address) {
|
|
if (!address) {
|
|
// our internal checksumAddress function that this method replaces would
|
|
// return an empty string for nullish input. If any direct usages of
|
|
// ethereumjs-util.toChecksumAddress were called with nullish input it
|
|
// would have resulted in an error on version 5.1.
|
|
return '';
|
|
}
|
|
const hexPrefixed = addHexPrefix(address);
|
|
if (!isHexString(hexPrefixed)) {
|
|
// Version 5.1 of ethereumjs-utils would have returned '0xY' for input 'y'
|
|
// but we shouldn't waste effort trying to change case on a clearly invalid
|
|
// string. Instead just return the hex prefixed original string which most
|
|
// closely mimics the original behavior.
|
|
return hexPrefixed;
|
|
}
|
|
return toChecksumAddress(addHexPrefix(address));
|
|
}
|