ccxt
Version:
54 lines (53 loc) • 2.52 kB
TypeScript
import { BigNumberish } from '../types/index.js';
/**
* 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.
* @example
* ```typescript
* const address = "0x90591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf";
* const result = addAddressPadding(address);
* // result = "0x0000090591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf"
* ```
*/
export declare function addAddressPadding(address: BigNumberish): string;
/**
* 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.
* @example
* ```typescript
* const address = "0x90591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf";
* const result = validateAndParseAddress(address);
* // result = "0x0000090591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf"
* ```
*/
export declare function validateAndParseAddress(address: BigNumberish): string;
/**
* Convert an address to her checksum representation which uses a specific pattern of uppercase and lowercase letters within
* a given address to reduce the risk of errors introduced from typing an address or cut and paste issues.
* @param {BigNumberish} address
* @returns {string} Hex string : 0x followed by 64 characters. Mix of uppercase and lowercase
* @example
* ```typescript
* const address = "0x90591d9fa3efc87067d95a643f8455e0b8190eb8cb7bfd39e4fb7571fdf";
* const result = getChecksumAddress(address);
* // result = "0x0000090591D9fA3EfC87067d95a643f8455E0b8190eb8Cb7bFd39e4fb7571fDF"
* ```
*/
export declare function getChecksumAddress(address: BigNumberish): string;
/**
* If the casing of an address is mixed, it is a Checksum Address, which uses a specific pattern of uppercase and lowercase letters within
* a given address to reduce the risk of errors introduced from typing an address or cut and paste issues.
*
* @param address string
*
* @returns true if the ChecksumAddress is valid
* @example
* ```typescript
* const address = "0x0000090591D9fA3EfC87067d95a643f8455E0b8190eb8Cb7bFd39e4fb7571fDF";
* const result = validateChecksumAddress(address);
* // result = true
* ```
*/
export declare function validateChecksumAddress(address: string): boolean;