Class AccountAddress

constructor

• new AccountAddress(input): AccountAddress

• Creates an instance of AccountAddress from a Uint8Array.

  This function ensures that the input data is exactly 32 bytes long, which is required for a valid account address.

  Parameters

  • input: Uint8Array

    A Uint8Array representing an account address.

  Returns AccountAddress

  Throws

  ParsingError if the input length is not equal to 32 bytes.

equals

• equals(other): boolean

• Determine if two AccountAddresses are equal based on their underlying byte data.

  Parameters

  • other: AccountAddress

    The AccountAddress to compare to.

  Returns boolean

  true if the AccountAddresses are equal, false if not.

isSpecial

• isSpecial(): boolean

• Determines if the address is classified as special, which is defined as 0x0 to 0xf inclusive. In other words, the last byte of the address must be < 0b10000 (16) and every other byte must be zero.

  For more information on how special addresses are defined, see AIP-40: https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.

  Returns boolean

  true if the address is special, false otherwise.

serialize

• serialize(serializer): void

• Serialize the AccountAddress to a Serializer instance's data buffer.

  Parameters

  • serializer: Serializer

    The serializer to serialize the AccountAddress to.

  Returns void

  void

  Example

  const serializer = new Serializer();
  const address = AccountAddress.fromString("0x1");
  address.serialize(serializer);
  const bytes = serializer.toUint8Array();
  // `bytes` is now the BCS-serialized address.
  Copy

serializeForEntryFunction

• serializeForEntryFunction(serializer): void

• Serializes the current instance into a byte sequence suitable for entry functions. This allows for the proper encoding of data when interacting with entry functions in the blockchain.

  Parameters

  • serializer: Serializer

    The serializer instance used to convert the data into bytes.

  Returns void

serializeForScriptFunction

• serializeForScriptFunction(serializer): void

• Serializes the current instance for use in a script function by encoding it into a byte sequence. This process involves serializing the variant index and the instance data, making it suitable for transmission.

  Parameters

  • serializer: Serializer

    The serializer instance used to perform the serialization.

  Returns void

toString

• toString(): `0x${string}`

• Return the AccountAddress as a string as per AIP-40. https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md. This representation returns special addresses in SHORT form (0xf) and other addresses in LONG form (0x + 64 characters).

  Returns `0x${string}`

  AccountAddress as a string conforming to AIP-40.

toStringLong

• toStringLong(): `0x${string}`

• Convert the account address to a string in LONG format, which is always 0x followed by 64 hex characters.

  NOTE: Prefer to use toString where possible, as it formats special addresses using the SHORT form (no leading 0s).

  Returns `0x${string}`

  AccountAddress as a string in LONG form.

toStringLongWithoutPrefix

• toStringLongWithoutPrefix(): string

• Returns the account address as a string in LONG form without a leading 0x. This function will include leading zeroes and will produce a string of 64 hex characters.

  NOTE: Prefer to use toString where possible, as it formats special addresses using the SHORT form (no leading 0s).

  Returns string

  The account address in LONG form.

toStringWithoutPrefix

• toStringWithoutPrefix(): string

• Return the AccountAddress as a string conforming to AIP-40 but without the leading 0x.

  NOTE: Prefer to use toString where possible.

  Returns string

  AccountAddress as a string without the leading 0x.

toUint8Array

• toUint8Array(): Uint8Array

• Get the inner data as a Uint8Array. The inner data is already a Uint8Array, so no conversion takes place.

  Returns Uint8Array

  Hex data as Uint8Array

Staticdeserialize

• deserialize(deserializer): AccountAddress

• Deserialize an AccountAddress from the byte buffer in a Deserializer instance. This function allows you to convert a byte representation of an AccountAddress into an instance of AccountAddress.

  Parameters

  • deserializer: Deserializer

    The deserializer to deserialize the AccountAddress from.

  Returns AccountAddress

  An instance of AccountAddress.

  Example

  const bytes = hexToBytes("0x0102030405060708091011121314151617181920212223242526272829303132");
  const deserializer = new Deserializer(bytes);
  const address = AccountAddress.deserialize(deserializer);
  // `address` is now an instance of AccountAddress.
  Copy

Staticfrom

• from(input): AccountAddress

• Convenience method for creating an AccountAddress from various input types. This function accepts a string, Uint8Array, or an existing AccountAddress instance and returns the corresponding AccountAddress.

  Parameters

  • input: AccountAddressInput

    The input to convert into an AccountAddress. This can be a string representation of an address, a Uint8Array, or an existing AccountAddress.

  Returns AccountAddress

StaticfromStrict

• fromStrict(input): AccountAddress

• Create an AccountAddress from various input types, including strings, Uint8Array, and AccountAddress instances.

  Parameters

  • input: AccountAddressInput

    The input to convert into an AccountAddress, which can be a string, a Uint8Array, or an AccountAddress.

  Returns AccountAddress

StaticfromString

• fromString(input): AccountAddress

• NOTE: This function has relaxed parsing behavior. For strict behavior, please use the fromStringStrict function. Where possible use fromStringStrict rather than this function, fromString is only provided for backwards compatibility.

  Creates an instance of AccountAddress from a hex string.

  This function allows all formats defined by AIP-40. In short this means the following formats are accepted:

  • LONG, with or without leading 0x
  • SHORT, with or without leading 0x

  Where:

  • LONG is 64 hex characters.
  • SHORT is 1 to 63 hex characters inclusive.
  • Padding zeroes are allowed, e.g. 0x0123 is valid.

  Learn more about the different address formats by reading AIP-40: https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.

  Parameters

  • input: string

    A hex string representing an account address.

  Returns AccountAddress

  An instance of AccountAddress.

  Throws

  ParsingError if the hex string is too short, too long, or contains invalid characters.

StaticfromStringStrict

• fromStringStrict(input): AccountAddress

• NOTE: This function has strict parsing behavior. For relaxed behavior, please use the fromString function.

  Creates an instance of AccountAddress from a hex string.

  This function allows only the strictest formats defined by AIP-40. In short this means only the following formats are accepted:

  • LONG
  • SHORT for special addresses

  Where:

  • LONG is defined as 0x + 64 hex characters.
  • SHORT for special addresses is 0x0 to 0xf inclusive without padding zeroes.

  This means the following are not accepted:

  • SHORT for non-special addresses.
  • Any address without a leading 0x.

  Parameters

  • input: string

    A hex string representing an account address.

  Returns AccountAddress

  An instance of AccountAddress.

  Throws

  If the hex string does not start with 0x or is not in a valid format.

  Note

  This function has strict parsing behavior. For relaxed behavior, please use the fromString function.

  See

  AIP-40 documentation for more details on address formats: https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.

StaticisValid

• isValid(args): ParsingResult<AddressInvalidReason>

• Check if the provided input is a valid AccountAddress.

  Parameters

  • args: {
        input: AccountAddressInput;
        strict?: boolean;
    }

    The arguments for validation.

    • input: AccountAddressInput

      A hex string representing an account address.

    • Optionalstrict?: boolean

      If true, use strict parsing behavior; if false, use relaxed parsing behavior.

  Returns ParsingResult<AddressInvalidReason>

  An object indicating whether the address is valid. If valid, valid = true; if not, valid = false with additional details. If the address is invalid, invalidReason will explain why it is invalid, and invalidReasonMessage will provide the error message.

Readonlydata

StaticA

StaticFOUR

Static ReadonlyLENGTH

Static ReadonlyLONG_STRING_LENGTH

StaticONE

StaticTHREE

StaticTWO

StaticZERO