Class Address

Represents a VeChain Address as unsigned integer.

Hierarchy (view full)

HexUInt
- Address

Index

Constructors

`Protected`constructor

new Address(sign, digits, normalize?): Address
Creates a new instance of this class to represent the value built multiplying sign for the absolute value expressed by the hexadecimal digits.
Parameters
- sign: number
  The sign of the value.
- digits: string
  The digits of the absolute value in hexadecimal base.
- Optionalnormalize: ((digits: string) => string) = ...
  The function used to normalize the digits. Defaults to converting digits to lowercase.
  - - (digits): string
    - Parameters
      digits: string
      Returns string
Returns Address
Inherited from HexUInt.constructor
- Defined in packages/core/src/vcdm/Hex.ts:84

Properties

`Readonly`digits

digits: string

Returns the hexadecimal digits expressing this absolute value, sign and 0x prefix omitted.

Remarks

An empty content results in an empty string returned.

`Readonly`sign

sign: number

Represents the sign multiplier of a given number:

NEGATIVE -1 if negative,
POSITIVE 1 if positive.

`Static` `Readonly`DIGITS

DIGITS: number = 40

The address is 20 bytes hence 40 digits long.

`Protected` `Static` `Readonly`NEGATIVE

NEGATIVE: number = -1

Negative multiplier of the digits absolute value.

`Protected` `Static` `Readonly`POSITIVE

POSITIVE: number = 1

Positive multiplier of the digits absolute value.

`Static` `Readonly`PREFIX

PREFIX: "0x" = '0x'

A constant string prefix used in hexadecimal notation.

`Static` `Readonly`RADIX

RADIX: number = 16

The radix used for representing numbers base 16 in a positional numeral notation system.

`Protected` `Static` `Readonly`REGEX_HEX_PREFIX

REGEX_HEX_PREFIX: RegExp = ...

Regular expression pattern to match a prefix indicating hexadecimal number.

`Protected` `Static` `Readonly`REGEX_HEXUINT_PREFIX

REGEX_HEXUINT_PREFIX: RegExp = ...

Regular expression pattern to match a prefix indicating hexadecimal number.

Accessors

abs

get abs(): Hex
Returns the absolute value of this Hex object.

Returns Hex
A new Hex object representing the absolute value of this Hex.
Inherited from HexUInt.abs
- Defined in packages/core/src/vcdm/Hex.ts:98

bi

get bi(): bigint
Returns the value of bi as a BigInt type.

Returns bigint
The value of bi as a BigInt.
Inherited from HexUInt.bi
- Defined in packages/core/src/vcdm/Hex.ts:107

bytes

get bytes(): Uint8Array
Returns the Uint8Array representation of the aligned bytes.

Returns Uint8Array
The Uint8Array representation of the aligned bytes.
Inherited from HexUInt.bytes
- Defined in packages/core/src/vcdm/Hex.ts:116

n

get n(): number
Retrieves the value of n cast from this instance interpreted as the hexadecimal expression of a bigint value.

Returns number
The value of n.

Throws
If n is not within the safe number range, if the number representation of this instance results approximated.

Remarks
This class makes equal instances created from the same value as number or as bigint.
Inherited from HexUInt.n
- Defined in packages/core/src/vcdm/HexInt.ts:22

Methods

alignToBytes

alignToBytes(): Hex
Aligns the hexadecimal string to bytes by adding a leading '0' if the string length is odd.

Returns Hex
- The aligned hexadecimal string.
Inherited from HexUInt.alignToBytes
- Defined in packages/core/src/vcdm/Hex.ts:143

compareTo

compareTo(that): number
Compares the current Hex object with another Hex object.
Parameters
- that: Hex
  The Hex object to compare with.
Returns number
- Returns a negative number if the current Hex object is less than the given Hex object, zero if they are equal, or a positive number if the current Hex object is greater than the given Hex object.
Inherited from HexUInt.compareTo
- Defined in packages/core/src/vcdm/Hex.ts:157

fit

fit(digits): Hex
Returns a new instance of the Hex class, its value fits to the specified number of digits.
Parameters
- digits: number
  The number of digits to fit the Hex value into.
Returns Hex
- A new Hex instance that represents the fitted Hex value.
Throws
- If the Hex value cannot be fit into the specified number of digits.
Inherited from HexUInt.fit
- Defined in packages/core/src/vcdm/Hex.ts:182

isEqual

isEqual(that): boolean
Determines whether this Hex instance is equal to the given Hex instance.
Parameters
- that: Hex
  The Hex instance to compare with.
Returns boolean
- True if the Hex instances are equal, otherwise false.
Inherited from HexUInt.isEqual
- Defined in packages/core/src/vcdm/Hex.ts:217

isNumber

isNumber(): boolean
Checks if this instance expresses a valid Number value according the IEEE 754 double precision 64 bits floating point format.

Returns boolean
Returns true if this instance expresses 32 hex digits (16 bytes, 128 bits) needed to represent a Number value, else it returns false.
Inherited from HexUInt.isNumber
- Defined in packages/core/src/vcdm/Hex.ts:229

toString

toString(compact?): string
Returns a string representation of the object.
Parameters
- compact: boolean = false
  Whether to compact the string representation.
Returns string
The string representation of the object.
Inherited from HexUInt.toString
- Defined in packages/core/src/vcdm/Hex.ts:345

`Static`checksum

checksum(huint): string
It checksums a given hexadecimal address.
Parameters
- huint: HexUInt
  The HexUInt object representing the hexadecimal value.
Returns string
The checksummed address.
- Defined in packages/core/src/vcdm/Address.ts:27

`Static`isValid

isValid(exp): boolean
Validate the given expression to be a valid address.
Parameters
- exp: string
  Expression to validate
Returns boolean
true if the expression is a valid address, false otherwise
Overrides HexUInt.isValid
- Defined in packages/core/src/vcdm/Address.ts:49

`Static`isValid0x

isValid0x(exp): boolean
Determines whether the given string is a valid unsigned hexadecimal number prefixed with '0x'.
Parameters
- exp: string
  The string to be evaluated.
Returns boolean
- True if the string is a valid unsigned hexadecimal number prefixed with '0x', otherwise false.
Inherited from HexUInt.isValid0x
- Defined in packages/core/src/vcdm/HexUInt.ts:44

`Static`of

of(exp): Address
Create an Address instance from the given expression interpreted as an unsigned integer.
Parameters
- exp:
      | string
      | number
      | bigint
      | Uint8Array
      | HexUInt
  The expression to convert. It can be of type bigint, number, string, Uint8Array, or HexUInt. Not meaningful 0 digits on the left of the expression can be omitted, the returned address is always 20 bytes, 40 digits expression.
Returns Address
The converted hexadecimal unsigned integer.

Throws
If the expression is not a valid hexadecimal positive integer expression.
Overrides HexUInt.of
- Defined in packages/core/src/vcdm/Address.ts:65

`Static`ofMnemonic

ofMnemonic(mnemonic, path?): Address
Derives the address from a given list of words of BIP39 Mnemonic Words and a BIP44 Derivation Path as in the examples.

Secure audit function.
- bip32.HDKey(https://github.com/paulmillr/scure-bip32)
- HDKey
Parameters
- mnemonic: string[]
  Mnemonic used to generate the HD node.
- Optionalpath: string = 'm/0'
  The derivation path from the current node.
Returns Address
- The derived address.
Example
```
`m/0` (default)
```
Example
```
`m/0/2`
```
Example
```
`m/0/2/4/6`
```
Throws
- Defined in packages/core/src/vcdm/Address.ts:156

`Static`ofPrivateKey

ofPrivateKey(privateKey): Address
Generates an Address object from the given private key.
Parameters
- privateKey: Uint8Array
  The private key used to derive the corresponding address.
Returns Address
The derived Address object.

Throws
If the provided private key is invalid or cannot derive an address.
- Defined in packages/core/src/vcdm/Address.ts:94

`Static`ofPublicKey

ofPublicKey(publicKey): Address
Create an Address instance from the given public key.
Parameters
- publicKey: Uint8Array
  The public key to convert.
Returns Address
The converted address.
Remarks
Security auditable method, depends on
- Secp256k1.inflatePublicKey.
- Defined in packages/core/src/vcdm/Address.ts:119

`Static`random

random(bytes): Hex
Generates a random Hex value of the given number of bytes length.
Parameters
- bytes: number
  The number of bytes to generate.
Returns Hex
- A randomly generated Hex value.
Throws
- If the bytes argument is not greater than 0.
Remarks
Security auditable method, depends on
- nh_utils.randomBytes.
Inherited from HexUInt.random
- Defined in packages/core/src/vcdm/Hex.ts:330

Class Address

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Parameters

Returns string

Returns Address

Properties

Readonlydigits

Remarks

Readonlysign

Static ReadonlyDIGITS

Protected Static ReadonlyNEGATIVE

Protected Static ReadonlyPOSITIVE

Static ReadonlyPREFIX

Static ReadonlyRADIX

Protected Static ReadonlyREGEX_HEX_PREFIX

Protected Static ReadonlyREGEX_HEXUINT_PREFIX

Accessors

abs

Returns Hex

bi

Returns bigint

bytes

Returns Uint8Array

n

Returns number

Throws

Remarks

Methods

alignToBytes

Returns Hex

compareTo

Parameters

Returns number

fit

Parameters

Returns Hex

Throws

isEqual

Parameters

Returns boolean

isNumber

Returns boolean

toString

Parameters

Returns string

Staticchecksum

Parameters

Returns string

StaticisValid

Parameters

Returns boolean

StaticisValid0x

Parameters

Returns boolean

Staticof

Parameters

Returns Address

Throws

StaticofMnemonic

Parameters

Returns Address

Example

Example

Example

Throws

StaticofPrivateKey

Parameters

Returns Address

Throws

StaticofPublicKey

Parameters

Returns Address

`Protected`constructor

`Readonly`digits

`Readonly`sign

`Static` `Readonly`DIGITS

`Protected` `Static` `Readonly`NEGATIVE

`Protected` `Static` `Readonly`POSITIVE

`Static` `Readonly`PREFIX

`Static` `Readonly`RADIX

`Protected` `Static` `Readonly`REGEX_HEX_PREFIX

`Protected` `Static` `Readonly`REGEX_HEXUINT_PREFIX

`Static`checksum

`Static`isValid

`Static`isValid0x

`Static`of

`Static`ofMnemonic

`Static`ofPrivateKey

`Static`ofPublicKey

`Static`random