@aptos-labs/ts-sdk - v7.1.0
    Preparing search index...

    Interface AnsName

    interface AnsName {
        domain?: string;
        domain_expiration_timestamp: string;
        expiration: Date;
        expiration_status: ExpirationStatus;
        expiration_timestamp: string;
        is_primary?: boolean;
        isInRenewablePeriod: boolean;
        owner_address?: string;
        registered_address?: string;
        subdomain?: string;
        subdomain_expiration_policy: SubdomainExpirationPolicy;
        token_standard?: AnsTokenStandard;
    }

    Hierarchy (View Summary)

    Index

    Properties

    domain? domain_expiration_timestamp expiration expiration_status expiration_timestamp is_primary? isInRenewablePeriod owner_address? registered_address? subdomain? subdomain_expiration_policy token_standard?

    Properties

    domain?: string

    The domain name. ie "aptos.apt" would have a domain of "aptos".

    The indexer schema marks this field as nullable, so it is surfaced as string | undefined here rather than fabricating a placeholder when the indexer returns null. Callers should treat a missing domain as a bad row.

    domain_expiration_timestamp: string

    The expiration timestamp of the domain in milliseconds since epoch.

    expiration: Date

    This is a derived date value. It takes into consideration if the name is a subdomain and its expiration policy.

    expiration_status: ExpirationStatus

    The status of the name's expiration.

    1. Expired: The name has expired and is no longer resolvable.
    2. InGracePeriod: The name is within the grace period and is still resolvable if it is renewed.
    3. Active: The name is active and is resolvable.

    ExpirationStatus

    expiration_timestamp: string

    The expiration timestamp of the name in milliseconds since epoch. Note, if the name is not a subdomain, this will be the same as the domain expiration timestamp.

    is_primary?: boolean

    If the name is registered as a primary name for any account. It is possible to have multiple primary names returned in a single query.

    Nullable upstream — surfaced as optional instead of defaulting to false.

    isInRenewablePeriod: boolean

    Whether the name is in the renewable period. This incorporates leading time before the name expires and the grace period after the name expires.

    owner_address?: string

    The address of the wallet that owns the name.

    registered_address?: string

    The address that the name points to. For example, if you send a transaction to "aptos.apt" with a target address of "0x1", the registered_address will be "0x1".

    subdomain?: string

    The subdomain name, if the name is a subdomain. ie "name.aptos.apt" would have a subdomain of "name"

    subdomain_expiration_policy: SubdomainExpirationPolicy

    The expiration policy for the subdomain. See SubdomainExpirationPolicy for more details.

    token_standard?: AnsTokenStandard

    The token standard for the name. See AnsTokenStandard for more details.

    Nullable upstream — surfaced as optional instead of fabricating "v2".

    Settings

    Member Visibility

    On This Page

    Properties