Class Address

A Value Object to facilitate Address conversions.

Index

Methods

equals getNumericId getPublicKey getReedSolomonAddress getReedSolomonAddressExtended create fromNumericId fromPublicKey fromReedSolomonAddress

Methods

equals

equals(address): boolean
Checks for equality
Parameters
- address: Address
  The other address to be compared
Returns boolean
true if equal, otherwise false
- Defined in packages/core/src/address/address.ts:148

getNumericId

getNumericId(): string
Returns string
Gets numeric Account Id
- Defined in packages/core/src/address/address.ts:112

getPublicKey

getPublicKey(): string
Returns string
Gets public key
- Defined in packages/core/src/address/address.ts:105

getReedSolomonAddress

getReedSolomonAddress(withPrefix?): string
Gets as Reed Solomon representation
Parameters
- withPrefix: boolean = true
  If false, the address without prefix will be returned. Default: true
Returns string
Reed Solomon Address Format

See
Address.getReedSolomonAddressExtended
- Defined in packages/core/src/address/address.ts:122

getReedSolomonAddressExtended

getReedSolomonAddressExtended(withPrefix?): string
Gets as extended Reed Solomon representation carrying the public key as suffix in base36 encoding

This method requires that the address was created from a public key or extended address.
Parameters
- withPrefix: boolean = true
  If false, the address without prefix will be returned. Default: true
Returns string
Extended Reed Solomon Address Format

Throws
if no public key is available

See
Address.getReedSolomonAddress
- Defined in packages/core/src/address/address.ts:136

`Static`create

create(anyValidAddress, prefix?): Address
Tries to create the address from whatever input is given
Parameters
- anyValidAddress: string
  Any valid address, may it be Reed Solomon address, numeric ID, or public key
- prefix: string = AddressPrefix.MainNet
  An optional prefix, which can be used to substitute the default AddressPrefix.MainNet
Returns Address
The new address, if the input was valid

Throws
when no valid format
- Defined in packages/core/src/address/address.ts:50

`Static`fromNumericId

fromNumericId(numericId, prefix?): Address
Parameters
- numericId: string
- prefix: string = AddressPrefix.MainNet
Returns Address
- Defined in packages/core/src/address/address.ts:65

`Static`fromPublicKey

fromPublicKey(publicKey, prefix?): Address
Creates an Account Address object from public key
Parameters
- publicKey: string
  The public key of that address (in hex format)
- prefix: string = AddressPrefix.MainNet
  The Reed-Solomon Address prefix
Returns Address
- Defined in packages/core/src/address/address.ts:75

`Static`fromReedSolomonAddress

fromReedSolomonAddress(address): Address
Creates an Account Address object from extended Reed-Solomon address
Parameters
- address: string
  The Reed-Solomon address in simple or extended format (with base36 suffix)
Returns Address
Throws
Error if the passed address is invalid
- Defined in packages/core/src/address/address.ts:84