Class Address

constructor

• new Address(address): Address

• Parameters

  • address: AddressInput

    A B256 address, public key, EVM address, or Address instance

  Returns Address

Readonlyb256Address

equals

• equals(other): boolean

• Compares this the b256Address property to another for direct equality

  Parameters

  • other: Address

    Another address to compare against

  Returns boolean

  The equality of the comparison

toAddress

• toAddress(): string

• Returns the b256Address property

  Returns string

toAssetId

• toAssetId(): AssetId

• Wraps the B256 property and returns as an AssetId.

  Returns AssetId

  The B256 property as an AssetId

toB256

• toB256(): string

• Returns the B256 hash address as a string

  Returns string

  The B256 address

toBytes

• toBytes(): Uint8Array<ArrayBufferLike>

• Returns the B256 hash address as a Uint8Array

  Returns Uint8Array<ArrayBufferLike>

  The B256 address as a Uint8Array

toChecksum

• toChecksum(): string

• Takes an B256 Address and returns back an checksum address. The implementation follows the ERC-55 https://github.com/ethereum/ercs/blob/master/ERCS/erc-55.md.

  Returns string

  A new ChecksumAddress instance

toEvmAddress

• toEvmAddress(): EvmAddress

• Converts to an EVM address

  Returns EvmAddress

  an EvmAddress representation of the address

toHexString

• toHexString(): string

• Returns the B256 hash address as a string

  Returns string

  The B256 address

toJSON

• toJSON(): string

• Converts and returns the b256Address property as a string

  Returns string

  The b256Address property as a JSON string

toString

• toString(): string

• returns the address checksum as a string

  Returns string

  The b256Address property as a string

valueOf

• valueOf(): string

• Wraps the B256 address checksum and returns it as a string

  Returns string

  The B256 address checksum as a string

StaticfromAddressOrString

• fromAddressOrString(address): Address

• Takes an ambiguous string or address and creates an Address

  Parameters

  • address: string | Address

  Returns Address

  a new Address instance

  Deprecated

  Use new Address instead

StaticfromB256

• fromB256(b256Address): Address

• Takes a B256 Address and creates an Address

  Parameters

  • b256Address: string

    A b256 hash

  Returns Address

  A new Address instance

  Deprecated

  Use new Address instead

StaticfromDynamicInput

• fromDynamicInput(address): Address

• Takes a dynamic string or Address and creates an Address

  Parameters

  • address: string | Address

  Returns Address

  A new Address instance

  Throws

  Error - Unknown address if the format is not recognized

  Deprecated

  Use new Address instead

StaticfromEvmAddress

• fromEvmAddress(evmAddress): Address

• Takes an Evm Address and returns back an Address

  Parameters

  • evmAddress: string

  Returns Address

  A new Address instance

  Deprecated

  Use new Address instead

StaticfromPublicKey

• fromPublicKey(publicKey): Address

• Takes a Public Key, hashes it, and creates an Address

  Parameters

  • publicKey: string

    A wallets public key

  Returns Address

  A new Address instance

  Deprecated

  Use new Address instead

StaticfromRandom

• fromRandom(): Address

• Creates an Address with a randomized b256Address property

  Returns Address

  A new Address instance

StaticfromString

• fromString(address): Address

• Takes an ambiguous string and attempts to create an Address

  Parameters

  • address: string

    An ambiguous string

  Returns Address

  A new Address instance

  Deprecated

  Use new Address instead

StaticisChecksumValid

• isChecksumValid(address): boolean

• Takes an ChecksumAddress and validates if it is a valid checksum address.

  Parameters

  • address: string

  Returns boolean

  A boolean instance indicating if the address is valid.