Kaptos/xyz.mcxross.kaptos.api/Account

Account

class Account(val config: AptosConfig) : Account

Account API namespace. This class provides functionality to reading and writing account related information.

Constructors

Account

constructor(config: AptosConfig)

Properties

config

open override val config: AptosConfig

AptosConfig object for configuration

Functions

getAccountAPTAmount

open suspend override fun getAccountAPTAmount(accountAddress: AccountAddressInput, minimumLedgerVersion: Long?): Result<Long, AptosIndexerError>

Queries the account's APT amount

getAccountCoinAmount

open suspend override fun getAccountCoinAmount(accountAddress: AccountAddressInput, coinType: MoveValue.MoveStructId, page: PaginationArgs?): Result<GetAccountCoinsDataQuery.Data?, AptosIndexerError>

Queries the account's coin amount by the coin type

getAccountCoinAmountFromSmartContract

open suspend override fun getAccountCoinAmountFromSmartContract(accountAddress: AccountAddressInput, coinType: MoveValue.MoveStructId?, faMetadataAddress: AccountAddressInput?): Result<Long, AptosSdkError>

Queries the account's coin amount directly from smart contracts (view function), matching the TS SDK behavior.

getAccountCoinsCount

open suspend override fun getAccountCoinsCount(accountAddress: AccountAddressInput, minimumLedgerVersion: Long?): Result<Long, AptosIndexerError>

Queries the current count of an account's coins aggregated

getAccountCoinsData

open suspend override fun getAccountCoinsData(accountAddress: AccountAddressInput, minimumLedgerVersion: Long?, sortOrder: List<FungibleAssetSortOrder>?, page: PaginationArgs?): Result<GetAccountCoinsDataQuery.Data?, AptosIndexerError>

Queries an account's fungible asset (coin) data from the indexer.

getAccountCollectionsWithOwnedTokens

open suspend override fun getAccountCollectionsWithOwnedTokens(accountAddress: AccountAddressInput, tokenStandard: TokenStandard?, sortOrder: List<CollectionOwnershipV2ViewSortOrder>?, page: PaginationArgs?, minimumLedgerVersion: Long?): Result<GetAccountCollectionsWithOwnedTokensQuery.Data?, AptosIndexerError>

Queries for all collections that an account currently has tokens for.

getAccountInfo

open suspend override fun getAccountInfo(accountAddress: AccountAddressInput, params: LedgerVersionQueryParam.() -> Unit): Result<AccountData, AptosSdkError>

Retrieves the Aptos blockchain for an account's on-chain state.

getAccountModule

open suspend override fun getAccountModule(accountAddress: AccountAddressInput, moduleName: String, param: LedgerVersionQueryParam.() -> Unit): Result<MoveModuleBytecode, AptosSdkError>

Retrieves a specific Move module from an account by its name.

getAccountModules

open suspend override fun getAccountModules(accountAddress: AccountAddressInput, params: SpecificPaginationQueryParams.() -> Unit): Result<List<MoveModuleBytecode>, AptosSdkError>

Retrieves all Move modules deployed to a specific Aptos account.

getAccountOwnedObjects

open suspend override fun getAccountOwnedObjects(accountAddress: AccountAddressInput, sortOrder: List<ObjectSortOrder>?, page: PaginationArgs?, minimumLedgerVersion: Long?): Result<GetObjectDataQuery.Data?, AptosIndexerError>

Queries for objects owned by a specific account.

getAccountOwnedTokensFromCollectionAddress

open suspend override fun getAccountOwnedTokensFromCollectionAddress(accountAddress: AccountAddressInput, collectionAddress: AccountAddressInput, tokenStandard: TokenStandard?, sortOrder: List<TokenOwnershipV2SortOrder>?, page: PaginationArgs?): Result<GetAccountOwnedTokensFromCollectionQuery.Data?, AptosIndexerError>

Queries for all tokens an account owns within a specific collection.

getAccountResources

open suspend override fun getAccountResources(accountAddress: AccountAddressInput, params: SpecificPaginationQueryParams.() -> Unit): Result<List<MoveResource>, AptosSdkError>

Retrieves all Move resources for a specific account.

getAccountTokensCount

open suspend override fun getAccountTokensCount(accountAddress: AccountAddressInput, page: PaginationArgs?, minimumLedgerVersion: Long?): Result<Long, AptosIndexerError>

Queries the total count of tokens owned by a specific account.

getAccountTransactions

open suspend override fun getAccountTransactions(accountAddress: AccountAddressInput, params: PaginationQueryParams.() -> Unit): Result<List<TransactionResponse>, AptosSdkError>

Queries for transactions submitted by a specific account.

getAccountTransactionsCount

open suspend override fun getAccountTransactionsCount(accountAddress: AccountAddressInput, minimumLedgerVersion: Long?): Result<Long, AptosIndexerError>

Queries the current count of transactions submitted by an account

lookupOriginalAccountAddress

open suspend override fun lookupOriginalAccountAddress(authenticationKey: AccountAddressInput, ledgerVersion: Int?): Result<AccountAddressInput, AptosSdkError>

Retrieves the original account address for a given authentication key.