Kaptos/xyz.mcxross.kaptos/Aptos

Aptos

class Aptos(val settings: AptosConfig = AptosConfig()) : AutoCloseable

Kotlin-native, namespaced entry point for Aptos APIs.

Use aptos for one workflow so clients and SDK-owned accounts are cleaned up automatically. Construct this class directly when an application needs a long-lived client.

Constructors

Aptos

constructor(settings: AptosConfig = AptosConfig())

Properties

abstraction

val abstraction: AccountAbstractionService

Account-abstraction status and authentication-function transaction builders.

accounts

val accounts: AccountService

Account lookup, balance, discovery, and authentication-key rotation operations.

coins

val coins: CoinService

Legacy coin-standard transaction builders.

digitalAssets

val digitalAssets: DigitalAssetService

Digital-asset reads and transaction builders.

faucet

val faucet: FaucetService

Faucet funding operations for networks that advertise a faucet.

fungibleAssets

val fungibleAssets: FungibleAssetService

Fungible-asset transaction builders.

indexer

val indexer: IndexerService

Low-level typed GraphQL execution for queries not covered by a domain service.

ledger

val ledger: LedgerService

Ledger metadata and block lookup operations.

names

val names: NameService

Aptos Names Service reads and transaction builders.

objects

val objects: ObjectService

Object lookup operations.

settings

val settings: AptosConfig

staking

val staking: StakingService

Delegated-staking reads.

tables

val tables: TableService

REST and indexer table operations.

transactions

val transactions: TransactionService

Transaction building, signing, simulation, submission, and confirmation operations.

transport

val transport: AptosTransport

Shared transport handle used by this client and optional Kaptos modules. Its lifecycle remains owned by Aptos, unless it was supplied in AptosConfig.

views

val views: ViewService

Read-only Move view-function calls.

Functions

account

fun account(privateKey: String, address: AccountAddressInput? = null): Account

Creates an SDK-owned account from a canonical algorithm-prefixed AIP-80 string.

fun account(privateKey: Aip80PrivateKey, address: AccountAddressInput? = null): Account

Creates an SDK-owned account from a validated AIP-80 private key.

fun account(privateKey: PrivateKey, address: AccountAddressInput? = null): Account

Creates an SDK-owned local account. Its private key is cleared automatically when this client closes, including when used inside aptos.

fun account(signingScheme: SigningSchemeInput = SigningSchemeInput.Ed25519, address: AccountAddressInput? = null): Account

Generates an SDK-owned local account. Ed25519 is the conventional Aptos default.

clearAbiCache

suspend fun clearAbiCache()

Clear fetched and preloaded ABIs after a deployment or before a workflow requiring fresh ABIs.

open override fun close()

Clears SDK-owned secrets and closes SDK-created transports. Injected transports remain caller-owned. Calling this method more than once has no effect.

ed25519Account

fun ed25519Account(privateKey: String, address: AccountAddressInput? = null): Ed25519Account

Creates an SDK-owned legacy Ed25519 account from a canonical AIP-80 string.

fun ed25519Account(privateKey: Aip80PrivateKey, address: AccountAddressInput? = null): Ed25519Account

Creates an SDK-owned legacy Ed25519 account from a validated AIP-80 private key.

fun ed25519Account(privateKey: Ed25519PrivateKey, address: AccountAddressInput? = null): Ed25519Account

Creates an SDK-owned legacy Ed25519 account while retaining its concrete account type.

own

fun <T : AutoCloseable> own(resource: T): T

Transfers resource ownership to this client. Owned resources are closed in reverse order before the transport. Most applications use the higher-level account factories instead.

singleKeyAccount

fun singleKeyAccount(privateKey: PrivateKey, address: AccountAddressInput? = null): SingleKeyAccount

Creates an SDK-owned SingleKey account while retaining its concrete account type.

fun singleKeyAccount(signingScheme: SigningSchemeInput = SigningSchemeInput.Ed25519, address: AccountAddressInput? = null): SingleKeyAccount

Generates an SDK-owned SingleKey account; Ed25519 is the default key algorithm.