@fuel-ts/address v0.94.6 • 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
The bech32Address
is now deprecated. Please migrate to B256 format (see https://docs.fuel.network/docs/specs/abi/argument-encoding/#b256 for more details) as this will be the standard going forward.
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
Deprecated
The bech32Address
is now deprecated. Please migrate to B256 format (see https://docs.fuel.network/docs/specs/abi/argument-encoding/#b256 for more details) as this will be the standard going forward.
Overrides
Defined in
address.ts:149
toAddress()
toAddress(): `fuel${string}`
Returns the bech32Address
property
Returns
`fuel${string}`
The bech32Address
property
Deprecated
The bech32Address
is now deprecated. Please migrate to B256 format (see https://docs.fuel.network/docs/specs/abi/argument-encoding/#b256 for more details) as this will be the standard going forward.
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:126
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
Deprecated
The bech32Address
is now deprecated. Please migrate to B256 format (see https://docs.fuel.network/docs/specs/abi/argument-encoding/#b256 for more details) as this will be the standard going forward.
Overrides
Defined in
address.ts:65
toBytes()
toBytes():
Uint8Array
Converts and returns the bech32Address
property to a byte array
Returns
Uint8Array
The bech32Address
property as a byte array
Deprecated
The bech32Address
is now deprecated. Please migrate to B256 format (see https://docs.fuel.network/docs/specs/abi/argument-encoding/#b256 for more details) as this will be the standard going forward.
Overrides
Defined in
address.ts:75
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
Deprecated
The bech32Address
is now deprecated. Please migrate to B256 format (see https://docs.fuel.network/docs/specs/abi/argument-encoding/#b256 for more details) as this will be the standard going forward.
Defined in
address.ts:114
toHexString()
toHexString():
string
Converts
Returns
string
The bech32Address
property as a 256 bit hash string
Deprecated
The bech32Address
is now deprecated. Please migrate to B256 format (see https://docs.fuel.network/docs/specs/abi/argument-encoding/#b256 for more details) as this will be the standard going forward.
Overrides
Defined in
address.ts:85
toJSON()
toJSON():
string
Converts and returns the bech32Address
property as a string
Returns
string
The bech32Address
property as a string
Deprecated
The bech32Address
is now deprecated. Please migrate to B256 format (see https://docs.fuel.network/docs/specs/abi/argument-encoding/#b256 for more details) as this will be the standard going forward.
Overrides
Defined in
address.ts:104
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:94
valueOf()
valueOf():
string
Returns the value of the bech32Address
property
Returns
string
The value of bech32Address
property
Deprecated
The bech32Address
is now deprecated. Please migrate to B256 format (see https://docs.fuel.network/docs/specs/abi/argument-encoding/#b256 for more details) as this will be the standard going forward.
Defined in
address.ts:138
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:209
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:174
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:220
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:254
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:159
fromRandom()
static
fromRandom():Address
Creates an Address
with a randomized bech32Address
property
Returns
A new Address
instance
Defined in
address.ts:190
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:200