Creates an instance of AccountAddress from a Uint8Array.
Readonly dataThis is the internal representation of an account address.
Static FOURStatic Readonly LENGTHThe number of bytes that make up an account address.
Static Readonly LONG_The length of an address string in LONG form without a leading 0x.
Static ONEStatic THREEStatic TWOStatic ZEROReturn whether AccountAddresses are equal. AccountAddresses are considered equal if their underlying byte data is identical.
The AccountAddress to compare to.
true if the AccountAddresses are equal, false if not.
Returns whether an address is special, where special 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.
true if the address is special, false if not.
Serialize the AccountAddress to a Serializer instance's data buffer.
The serializer to serialize the AccountAddress to.
void
const serializer = new Serializer();
const address = AccountAddress.fromString("0x1");
address.serialize(serializer);
const bytes = serializer.toUint8Array();
// `bytes` is now the BCS-serialized address.
Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
Serialize an argument to BCS-serialized bytes as a type aware byte sequence. The byte sequence contains an enum variant index followed by the BCS-serialized bytes for a typed argument.
Return the AccountAddress as a string as per AIP-40. https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
In short, it means that special addresses are represented in SHORT form, meaning 0x0 through to 0xf inclusive, and every other address is represented in LONG form, meaning 0x + 64 hex characters.
AccountAddress as a string conforming to AIP-40.
NOTE: Prefer to use toString where possible.
Whereas toString will format special addresses (as defined by isSpecial) using the SHORT form (no leading 0s), this format the address in the LONG format unconditionally.
This means it will be 0x + 64 hex characters.
AccountAddress as a string in LONG form.
NOTE: Prefer to use toString where possible.
Whereas toString will format special addresses (as defined by isSpecial) using the SHORT form (no leading 0s), this function will include leading zeroes. The string will not have a leading zero.
This means it will be 64 hex characters without a leading 0x.
AccountAddress as a string in LONG form without a leading 0x.
Static deserializeDeserialize an AccountAddress from the byte buffer in a Deserializer instance.
The deserializer to deserialize the AccountAddress from.
An instance of AccountAddress.
const bytes = hexToBytes("0x0102030405060708091011121314151617181920212223242526272829303132");
const deserializer = new Deserializer(bytes);
const address = AccountAddress.deserialize(deserializer);
// `address` is now an instance of AccountAddress.
Static fromConvenience method for creating an AccountAddress from all known inputs.
This handles, Uint8array, string, and AccountAddress itself
Static fromConvenience method for creating an AccountAddress from all known inputs.
This handles, Uint8array, string, and AccountAddress itself
Static fromNOTE: 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:
Where:
Learn more about the different address formats by reading AIP-40: https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
A hex string representing an account address.
An instance of AccountAddress.
Static fromNOTE: 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:
Where:
This means the following are not accepted:
Learn more about the different address formats by reading AIP-40: https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
A hex string representing an account address.
An instance of AccountAddress.
Static isCheck if the string is a valid AccountAddress.
A hex string representing an account address.
Optional strict?: booleanIf true, use strict parsing behavior. If false, use relaxed parsing behavior.
valid = true if the string is valid, valid = false if not. If the string is not valid, invalidReason will be set explaining why it is invalid.
Generated using TypeDoc
NOTE: Only use this class for account addresses. For other hex data, e.g. transaction hashes, use the Hex class.
AccountAddress is used for working with account addresses. Account addresses, when represented as a string, generally look like these examples:
Proper formatting and parsing of account addresses is defined by AIP-40. To learn more about the standard, read the AIP here: https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
The comments in this class make frequent reference to the LONG and SHORT formats, as well as "special" addresses. To learn what these refer to see AIP-40.