@fuel-ts/address v0.94.8 • Docs
Class: Address
Address
provides a type safe wrapper for converting between different address formats ands comparing them for equality.
Extends
Constructors
new Address()
new Address(
address
):Address
Parameters
• address: `fuel${string}`
A Bech32 address
Returns
Overrides
Defined in
address.ts:37
Properties
bech32Address
readonly
bech32Address: `fuel${string}`
Deprecated
Type Bech32Address
is now deprecated, as is this property. Use B256
addresses instead. (help)
Defined in
address.ts:31
Methods
equals()
equals(
other
):boolean
Compares this the bech32Address
property to another for direct equality
Parameters
• other: Address
Another address to compare against
Returns
boolean
The equality of the comparison
Overrides
Defined in
address.ts:137
toAddress()
toAddress(): `fuel${string}`
Returns the bech32Address
property
Returns
`fuel${string}`
The bech32Address
property
Deprecated
Type Bech32Address
is now deprecated, as is this method. Use B256
addresses instead. (help)
Overrides
Defined in
address.ts:55
toAssetId()
toAssetId():
AssetId
Wraps the B256 property and returns as an AssetId
.
Returns
The B256 property as an AssetId
Defined in
address.ts:116
toB256()
toB256():
string
Converts and returns the bech32Address
property to a 256 bit hash string
Returns
string
The bech32Address
property as a 256 bit hash string
Overrides
Defined in
address.ts:63
toBytes()
toBytes():
Uint8Array
Converts and returns the bech32Address
property to a byte array
Returns
Uint8Array
The bech32Address
property as a byte array
Overrides
Defined in
address.ts:71
toEvmAddress()
toEvmAddress():
EvmAddress
Clears the first 12 bytes of the bech32Address
property and returns it as a EvmAddress
Returns
The bech32Address
property as an EvmAddress
Defined in
address.ts:104
toHexString()
toHexString():
string
Converts the bech32Address
property to a 256 bit hash string
Returns
string
The bech32Address
property as a 256 bit hash string
Overrides
Defined in
address.ts:79
toJSON()
toJSON():
string
Converts and returns the bech32Address
property as a string
Returns
string
The bech32Address
property as a JSON string
Overrides
Defined in
address.ts:96
toString()
toString():
string
Converts and returns the bech32Address
property as a string
Returns
string
The bech32Address
property as a string
Overrides
Defined in
address.ts:88
valueOf()
valueOf():
string
Returns the value of the bech32Address
property
Returns
string
The value of bech32Address
property
Deprecated
Type Bech32Address
is now deprecated, as is this method. Use B256
addresses instead. (help)
Defined in
address.ts:128
fromAddressOrString()
static
fromAddressOrString(address
):AbstractAddress
Takes an ambiguous string or address and creates an Address
Parameters
• address: string
| AbstractAddress
Returns
a new Address
instance
Defined in
address.ts:197
fromB256()
static
fromB256(b256Address
):Address
Takes a B256 Address and creates an Address
Parameters
• b256Address: string
A b256 hash
Returns
A new Address
instance
Defined in
address.ts:162
fromDynamicInput()
static
fromDynamicInput(address
):Address
Takes a dynamic string or AbstractAddress
and creates an Address
Parameters
• address: string
| AbstractAddress
Returns
A new Address
instance
Throws
Error - Unknown address if the format is not recognised
Defined in
address.ts:208
fromEvmAddress()
static
fromEvmAddress(evmAddress
):Address
Takes an Evm Address and returns back an Address
Parameters
• evmAddress: string
Returns
A new Address
instance
Defined in
address.ts:242
fromPublicKey()
static
fromPublicKey(publicKey
):Address
Takes a Public Key, hashes it, and creates an Address
Parameters
• publicKey: string
A wallets public key
Returns
A new Address
instance
Defined in
address.ts:147
fromRandom()
static
fromRandom():Address
Creates an Address
with a randomized bech32Address
property
Returns
A new Address
instance
Defined in
address.ts:178
fromString()
static
fromString(address
):Address
Takes an ambiguous string and attempts to create an Address
Parameters
• address: string
An ambiguous string
Returns
A new Address
instance
Defined in
address.ts:188