Skip to main content
Version: 11.x

Function: validateAndParseAddress()

validateAndParseAddress(address): string

Defined in: src/utils/address.ts:56

Check the validity of a Starknet address, and format it as a hex number: '0x' and 64 characters, adding leading zeros if necessary.

A string is read as hexadecimal, with or without its 0x prefix — so '31' is 0x31 — and one holding anything but hexadecimal digits, '0x' included, is refused as a malformed address.

Parameters​

address​

BigNumberish

Returns​

string

Hex string: 0x followed by 64 characters. No upper case characters in the response.

Throws​

address argument must be a valid address inside the address range bound

Example​

const result = [31, 0x1f, '31', '0x1f', '0x90591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf'].map(validateAndParseAddress);
// result = [
//   '0x000000000000000000000000000000000000000000000000000000000000001f',
//   '0x000000000000000000000000000000000000000000000000000000000000001f',
//   '0x0000000000000000000000000000000000000000000000000000000000000031',
//   '0x000000000000000000000000000000000000000000000000000000000000001f',
//   '0x0000090591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf'
// ]
validateAndParseAddress('test');
// throws Error("Invalid Address Format")