diff --git a/src/utils/address.ts b/src/utils/address.ts index e0647df86..60ce39d18 100644 --- a/src/utils/address.ts +++ b/src/utils/address.ts @@ -7,10 +7,20 @@ import { addHexPrefix, removeHexPrefix } from './encode'; import { keccakBn } from './hash'; import { assertInRange, toHex } from './num'; +/** + * Format a hex number to '0x' and 64 characters, adding leading zeros if necessary. + * @param {BigNumberish} address + * @returns {string} Hex string : 0x followed by 64 characters. No upper case characters in the response. + */ export function addAddressPadding(address: BigNumberish): string { return addHexPrefix(removeHexPrefix(toHex(address)).padStart(64, '0')); } +/** + * Check the validity of a Starknet address, and format it as a hex number : '0x' and 64 characters, adding leading zeros if necessary. + * @param {BigNumberish} address + * @returns {string} Hex string : 0x followed by 64 characters. No upper case characters in the response. + */ export function validateAndParseAddress(address: BigNumberish): string { assertInRange(address, ZERO, ADDR_BOUND - 1n, 'Starknet Address');