Kaptos/xyz.mcxross.kaptos.names/NameService

NameService

interface NameService

Aptos Name Service operations exposed as client.names.

Functions

buildClearTarget

abstract suspend fun buildClearTarget(sender: AccountAddressInput, name: String, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>

Builds a transaction that removes the address target from name.

abstract suspend fun buildRegister(sender: AccountAddressInput, name: String, expiration: NameExpirationPolicy, transferable: Boolean = false, target: AccountAddressInput? = null, owner: AccountAddressInput? = null, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>

Builds a domain or subdomain registration transaction.

abstract suspend fun buildRenew(sender: AccountAddressInput, name: String, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>

Builds a renewal transaction for an existing name.

buildSetPrimary

abstract suspend fun buildSetPrimary(sender: AccountAddressInput, name: String? = null, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>

Set a primary name, or clear it when name is null.

abstract suspend fun buildSetTarget(sender: AccountAddressInput, name: String, target: AccountAddressInput, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>

Builds a transaction that assigns target to name.

abstract suspend fun expiration(name: String): AptosResult<ULong>

Returns the on-chain expiration timestamp in Unix seconds.

getAccountDomains

abstract suspend fun getAccountDomains(accountAddress: AccountAddressInput, page: PageRequest = PageRequest()): AptosResult<AptosPage<NameRecord>>

Returns top-level domains associated with an account.

getAccountNames

abstract suspend fun getAccountNames(accountAddress: AccountAddressInput, page: PageRequest = PageRequest()): AptosResult<AptosPage<NameRecord>>

Returns all domains and subdomains associated with an account.

getAccountSubdomains

abstract suspend fun getAccountSubdomains(accountAddress: AccountAddressInput, page: PageRequest = PageRequest()): AptosResult<AptosPage<NameRecord>>

Returns subdomains associated with an account.

getDomainSubdomains

abstract suspend fun getDomainSubdomains(domain: String, page: PageRequest = PageRequest()): AptosResult<AptosPage<NameRecord>>

Returns indexed subdomains belonging to domain.

abstract suspend fun getName(name: String): AptosResult<NameRecord?>

Returns the exact indexed name record.

abstract suspend fun owner(name: String): AptosResult<AccountAddress?>

Resolves the current owner of name.

abstract suspend fun primaryName(accountAddress: AccountAddressInput): AptosResult<String?>

Returns the account's primary name, if one is configured.

abstract suspend fun target(name: String): AptosResult<AccountAddress?>

Resolves the address currently targeted by name.