Class Address

An Address, as an immutable object.

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/address.ts:31

Methods

bech32

bech32(): string
Use toBech32 instead.

Returns string
- Defined in src/address.ts:196

equals

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

getHrp

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

Returns string
- Defined in src/address.ts:230

getPublicKey

getPublicKey(): Buffer
Returns the pubkey as raw bytes (buffer)

Returns Buffer
- Defined in src/address.ts:223

hex

hex(): string
Use toHex instead.

Returns string
- Defined in src/address.ts:178

isContractAddress

isContractAddress(): boolean
Use isSmartContract instead.

Returns boolean
- Defined in src/address.ts:280

isEmpty

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

Returns boolean
- Defined in src/address.ts:237

isSmartContract

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

Returns boolean
- Defined in src/address.ts:287

pubkey

pubkey(): Buffer
Use getPublicKey instead.

Returns Buffer
- Defined in src/address.ts:216

toBech32

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

Returns string
- Defined in src/address.ts:203

toHex

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

Returns string
- Defined in src/address.ts:185

toJSON

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

Returns object
- Defined in src/address.ts:262

toString

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

Returns string
- Defined in src/address.ts:255

`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/address.ts:156

`Static`fromAddress

fromAddress(address: Address): Address
Parameters
- address: Address
Returns Address
Deprecated
Constructing an address object from another object is deprecated.
- Defined in src/address.ts:130

`Static`fromBech32

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

`Static`fromBuffer

fromBuffer(buffer: Buffer, hrp?: string): Address
Parameters
- buffer: Buffer
- Optionalhrp: string
Returns Address
Deprecated
Use the constructor, instead.
- Defined in src/address.ts:137

`Static`fromHex

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

`Static`fromString

fromString(value: string, hrp?: string): Address
Parameters
- value: string
- Optionalhrp: string
Returns Address
Deprecated
Use newFromBech32 or newFromHex.
- Defined in src/address.ts:144

`Static`isValid

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

`Static`newFromBech32

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

`Static`newFromHex

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

`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/address.ts:273