Class Address

An Address, as an immutable object.

Index

Constructors

constructor

new Address(
value: string | Uint8Array<ArrayBufferLike> | Address,
hrp?: string,
): Address
Creates an address object, given a raw string (whether a hex pubkey or a Bech32 address), a sequence of bytes, or another Address object.
Parameters
- value: string | Uint8Array<ArrayBufferLike> | Address
- Optionalhrp: string
Returns Address
- Defined in src/core/address.ts:26

Methods

bech32

bech32(): string
Returns string
Deprecated
Use toBech32 instead.
- Defined in src/core/address.ts:149

equals

equals(other: null | Address): boolean
Compares the address to another address
Parameters
- other: null | Address
Returns boolean
- Defined in src/core/address.ts:220

getHrp

getHrp(): string
Returns the human-readable-part of the bech32 addresses.

Returns string
- Defined in src/core/address.ts:183

getPublicKey

getPublicKey(): Buffer
Returns the underlying public key.

Returns Buffer
- Defined in src/core/address.ts:176

hex

hex(): string
Returns string
Deprecated
Use toHex instead.
- Defined in src/core/address.ts:131

isContractAddress

isContractAddress(): boolean
Returns boolean
Deprecated
Use isSmartContract instead.
- Defined in src/core/address.ts:256

isEmpty

isEmpty(): boolean
Returns whether the address is empty.

Returns boolean
- Defined in src/core/address.ts:213

isSmartContract

isSmartContract(): boolean
Returns whether the address is a smart contract address.

Returns boolean
- Defined in src/core/address.ts:263

pubkey

pubkey(): Buffer
Returns Buffer
Deprecated
Use getPublicKey instead.
- Defined in src/core/address.ts:169

toBech32

toBech32(): string
Returns the bech32 representation of the address

Returns string
- Defined in src/core/address.ts:156

toHex

toHex(): string
Returns the hex representation of the address (pubkey)

Returns string
- Defined in src/core/address.ts:138

toJSON

toJSON(): object
Converts the address to a pretty, plain JavaScript object.

Returns object
- Defined in src/core/address.ts:238

toString

toString(): string
Returns the bech32 representation of the address

Returns string
- Defined in src/core/address.ts:231

`Static`empty

empty(): Address
Creates an empty address object. Generally speaking, this should not be used by client code (internal use only).

Returns Address
- Defined in src/core/address.ts:191

`Static`fromBech32

fromBech32(value: string): Address
Parameters
- value: string
Returns Address
Deprecated
Use newFromBech32 instead.
- Defined in src/core/address.ts:99

`Static`fromHex

fromHex(value: string, hrp?: string): Address
Parameters
- value: string
- Optionalhrp: string
Returns Address
Deprecated
Use newFromHex instead.
- Defined in src/core/address.ts:120

`Static`isValid

isValid(value: string): boolean
Performs address validation without throwing errors
Parameters
- value: string
Returns boolean
- Defined in src/core/address.ts:198

`Static`newFromBech32

newFromBech32(value: string): Address
Named constructor Creates an address object from a bech32-encoded string
Parameters
- value: string
Returns Address
- Defined in src/core/address.ts:91

`Static`newFromHex

newFromHex(value: string, hrp?: string): Address
Named constructor Creates an address object from a hex-encoded string
Parameters
- value: string
- Optionalhrp: string
Returns Address
- Defined in src/core/address.ts:109

`Static`Zero

Zero(): Address
Creates the Zero address (the one that should be used when deploying smart contracts). Generally speaking, this should not be used by client code (internal use only).

Returns Address
- Defined in src/core/address.ts:249