The AptosConfig class holds the config information for the SDK client instance. It is initialized with an instance of AptosSettings and sets up various configurations based on the provided settings.

AptosRequest

typealias AptosRequest = HttpRequest

AptosResponse

typealias AptosResponse = HttpResponse

AptosSettings

data class AptosSettings(val network: Network? = null, val fullNode: String? = null, val faucet: String? = null, val indexer: String? = null, val client: Client? = null, val clientConfig: ClientConfig = ClientConfig.default, val fullNodeConfig: FullNodeConfig? = null, val indexerConfig: IndexerConfig? = null, val faucetConfig: FaucetConfig? = null)

AuthenticationKeyScheme

sealed class AuthenticationKeyScheme

Block

@Serializable

data class Block(val blockHeight: String, val blockHash: String, val blockTimestamp: String, val firstVersion: String, val lastVersion: String)

BlockEpilogueTransactionResponse

@Serializable

@SerialName(value = "block_epilogue_transaction")

data class BlockEpilogueTransactionResponse(val type: TransactionResponseType, val version: String, val hash: String, val stateChangeHash: String, val eventRootHash: String, val stateCheckpointHash: String?, val gasUsed: String, val success: Boolean, val vmStatus: String, val accumulatorRootHash: String, val timestamp: String) : TransactionResponse

BlockMetadataTransactionResponse

@Serializable

@SerialName(value = "block_metadata_transaction")

data class BlockMetadataTransactionResponse(val type: TransactionResponseType, val version: String, val hash: String, val stateChangeHash: String, val eventRootHash: String, val stateCheckpointHash: String?, val gasUsed: String, val success: Boolean, val vmStatus: String, val accumulatorRootHash: String, val id: String, val epoch: String, val round: String, val events: List<Event>, val previousBlockVotesBitvec: List<Long>, val proposer: String, val failedProposerIndices: List<Long>, val timestamp: String) : TransactionResponse

Bool

@Serializable(with = BoolSerializer::class)

data class Bool(val value: Boolean) : TransactionArgument

ChainTopUserTransactions

typealias ChainTopUserTransactions = GetChainTopUserTransactions.Result

Client

interface Client

ClientHeadersType

open class ClientHeadersType

General type definition for client headers

CollectionData

typealias CollectionData = GetCollectionData.Result

CreateCollectionOptions

data class CreateCollectionOptions(val maxSupply: Long = Long.MAX_VALUE, val mutableDescription: Boolean = true, val mutableRoyalty: Boolean = true, val mutableURI: Boolean = true, val mutableTokenDescription: Boolean = true, val mutableTokenName: Boolean = true, val mutableTokenProperties: Boolean = true, val mutableTokenURI: Boolean = true, val tokensBurnableByCreator: Boolean = true, val tokensFreezableByCreator: Boolean = true, val royaltyNumerator: Long = 0, val royaltyDenominator: Long = 1)

Options for creating a new collection in an account.

Data

@Serializable

data class Data(val authenticationKey: String? = null, val coinRegisterEvents: Event? = null, val guidCreationNum: String? = null, val keyRotationEvents: Event? = null, val sequenceNumber: String? = null)

DeriveScheme

enum DeriveScheme : Enum<DeriveScheme>

EntryFunctionABI

class EntryFunctionABI(val typeParameters: List<MoveFunctionGenericTypeParam>, val parameters: List<TypeTag>, val signers: Int? = null) : FunctionABI

Interface of an Entry function's ABI.

EntryFunctionArgument

@Serializable(with = EntryFunctionArgumentSerializer::class)

sealed class EntryFunctionArgument : ScriptFunctionArgument

Event

@Serializable

data class Event(val guid: Guid, val sequenceNumber: String? = null, val type: String? = null, val data: JsonElement? = null)

FaucetConfig

data class FaucetConfig(val headers: Map<String, Any>? = null, val authToken: String? = null)

A Faucet only configuration object

FaucetRequest

@Serializable

data class FaucetRequest(val address: String, val amount: Long)

FaucetResponse

@Serializable

data class FaucetResponse(val txnHashes: List<String>)

FixedBytes

@Serializable

data class FixedBytes(val value: HexInput) : TransactionArgument

FullNodeConfig

data class FullNodeConfig(var headers: Map<String, Any>? = null) : ClientHeadersType

A Fullnode only configuration object.

FunctionABI

open class FunctionABI(val typeParameters: List<MoveFunctionGenericTypeParam>, val parameters: List<TypeTag>)

Data need for a generic function ABI, both view and entry

FunctionArguments

data class FunctionArguments(val functionArguments: List<EntryFunctionArgument>)

FunctionArgumentsBuilder

class FunctionArgumentsBuilder

GasEstimation

@Serializable

data class GasEstimation(val gasEstimate: Long, val deprioritizedGasEstimate: Long? = null, val prioritizedGasEstimate: Long? = null)

GraphqlQuery

@Serializable

data class GraphqlQuery(val query: String, val variables: Map<String, Int>? = null)

Guid

@Serializable

data class Guid(val creationNumber: String? = null, val accountAddress: String? = null)

HexInput

@Serializable(with = HexInputSerializer::class)

data class HexInput(val value: String) : TransactionArgument, AccountAddressInput

Identifier

@Serializable

data class Identifier(value: String)

Representation of an Identifier that can serialized and deserialized. We use Identifier to represent the module "name" in "ModuleId" and the "function name" in "EntryFunction"

IndexerConfig

data class IndexerConfig(var headers: Map<String, Any>? = null) : ClientHeadersType

An Indexer only configuration object.

InputEntryFunctionData

data class InputEntryFunctionData(val function: MoveFunctionId, val typeArguments: List<TypeTag>, val functionArguments: List<EntryFunctionArgument>, val abi: EntryFunctionABI? = null) : InputGenerateTransactionPayloadData

The data needed to generate an Entry Function payload

InputEntryFunctionDataBuilder

class InputEntryFunctionDataBuilder

InputEntryFunctionGenerateTransactionPayloadDataWithRemoteABIWithRemoteABI

data class InputEntryFunctionGenerateTransactionPayloadDataWithRemoteABIWithRemoteABI(val inputEntryFunctionData: InputEntryFunctionData) : InputGenerateTransactionPayloadDataWithRemoteABI

InputGenerateMultiSignerRawTransactionData

data class InputGenerateMultiSignerRawTransactionData(val sender: AccountAddressInput, val data: InputGenerateTransactionPayloadData, val options: InputGenerateTransactionOptions?, val withFeePayer: Boolean, val secondarySignerAddresses: List<AccountAddressInput>) : InputGenerateTransactionData

InputGenerateSingleSignerRawTransactionData

data class InputGenerateSingleSignerRawTransactionData(val sender: AccountAddressInput, val data: InputGenerateTransactionPayloadData, val options: InputGenerateTransactionOptions?, val withFeePayer: Boolean, val secondarySignerAddresses: Nothing?) : InputGenerateTransactionData

InputGenerateTransactionData

interface InputGenerateTransactionData

InputGenerateTransactionOptions

data class InputGenerateTransactionOptions(val maxGasAmount: Long = DEFAULT_MAX_GAS_AMOUNT, val gasUnitPrice: Long? = null, val expireTimestamp: Long? = null, val accountSequenceNumber: Number? = null)

Optional options to set when generating a transaction

InputGenerateTransactionPayloadData

interface InputGenerateTransactionPayloadData

InputGenerateTransactionPayloadDataWithRemoteABI

interface InputGenerateTransactionPayloadDataWithRemoteABI

InputSimulateTransactionData

data class InputSimulateTransactionData(val signerPublicKey: PublicKey, val transaction: AnyRawTransaction, val feePayerPublicKey: PublicKey?, val options: InputSimulateTransactionOptions)

InputSimulateTransactionOptions

data class InputSimulateTransactionOptions(val estimateGasUnitPrice: Boolean = false, val estimateMaxGasAmount: Boolean = false, val estimatePrioritizedGasUnitPrice: Boolean = false)

InputSubmitTransactionData

data class InputSubmitTransactionData(val transaction: AnyRawTransaction, val senderAuthenticator: AccountAuthenticator, val feePayerAuthenticator: AccountAuthenticator? = null, val additionalSignersAuthenticators: List<AccountAuthenticator>? = null)

InputViewFunctionData

@Serializable

data class InputViewFunctionData(val function: MoveFunctionId, val typeArguments: List<TypeTag>, val functionArguments: List<EntryFunctionArgument>, val abi: ViewFunctionABI? = null)

The data needed to generate a View Function payload

LedgerInfo

@Serializable

data class LedgerInfo(val chainId: Long, val epoch: String, val ledgerVersion: String, val oldestLedgerVersion: String, val ledgerTimestamp: String, val nodeRole: String, val oldestBlockHeight: String, val blockHeight: String, val gitHash: String)

LedgerVersionArg

data class LedgerVersionArg(val ledgerVersion: Int? = null)

LedgerVersionQueryParam

class LedgerVersionQueryParam : QueryParams

MimeType

enum MimeType : Enum<MimeType>

ModuleId

@Serializable

data class ModuleId(val address: AccountAddress, val name: Identifier)

Representation of a ModuleId that can serialized and deserialized ModuleId means the module address (e.g "0x1") and the module name (e.g "coin")

MoveAbility

@Serializable

enum MoveAbility : Enum<MoveAbility>

MoveFunction

@Serializable

data class MoveFunction(val name: String, val visibility: MoveVisibility, val isEntry: Boolean, val isView: Boolean, val genericTypeParams: List<MoveFunctionGenericTypeParam>, val params: List<String>, val return: List<String>)

MoveFunctionGenericTypeParam

@Serializable

data class MoveFunctionGenericTypeParam(val constraints: List<MoveAbility>)

MoveFunctionId

typealias MoveFunctionId = MoveModuleId

MoveModule

@Serializable

data class MoveModule(val address: String, val name: String, val friends: List<MoveModuleId>, val exposedFunctions: List<MoveFunction>, val structs: List<MoveStruct>)

MoveModuleBytecode

@Serializable

data class MoveModuleBytecode(val bytecode: String, val abi: MoveModule? = null)

MoveModuleId

typealias MoveModuleId = String

MoveOption

@Serializable

data class MoveOption<T : EntryFunctionArgument>(val value: T?) : TransactionArgument

MoveResource

@Serializable

data class MoveResource(val type: String)

MoveString

@Serializable(with = MoveStringSerializer::class)

data class MoveString(val value: String) : TransactionArgument

MoveStruct

@Serializable

data class MoveStruct(val name: String, val isNative: Boolean, val abilities: List<MoveAbility>, val genericTypeParams: List<MoveFunctionGenericTypeParam>, val fields: List<MoveStructField>)

MoveStructField

@Serializable

data class MoveStructField(val name: String, val type: String)

MoveStructId

typealias MoveStructId = String

MoveValue

@Serializable

sealed class MoveValue

MoveVector

@Serializable(with = MoveVectorSerializer::class)

data class MoveVector<T : EntryFunctionArgument>(var values: List<T>) : TransactionArgument

This class is the Kotlin representation of a Move vector<T>, where T is a type that represents either a primitive type (bool, u8, u64, ...) or a BCS-serializable struct itself.

MoveVisibility

@Serializable

enum MoveVisibility : Enum<MoveVisibility>

MultiAgentTransaction

@Serializable

data class MultiAgentTransaction(val rawTransaction: RawTransaction) : AnyRawTransaction

Network

enum Network : Enum<Network>

Enum class representing the network to connect to.

NumberOfDelegators

typealias NumberOfDelegators = GetNumberOfDelegators.Result

Option

sealed class Option<out T>

PaginationArgs

data class PaginationArgs(val offset: Int? = null, val limit: Int? = null)

Controls the number of results that are returned and the starting position of those results.

PaginationQueryParams

class PaginationQueryParams : QueryParams

PendingTransactionResponse

@Serializable

@SerialName(value = "pending_transaction")

data class PendingTransactionResponse(val type: TransactionResponseType = TransactionResponseType.PENDING, val hash: String, val sender: String, val sequenceNumber: String, val maxGasAmount: String, val gasUnitPrice: String, val expirationTimestampSecs: String) : TransactionResponse

PrivateKeyInput

data class PrivateKeyInput(val privateKey: PrivateKey, val address: AccountAddressInput? = null, val legacy: Boolean = true)

Input for creating an account from a private key.

ProcessorStatus

typealias ProcessorStatus = GetProcessorStatus.Result

ProcessorType

enum ProcessorType : Enum<ProcessorType>

The list of supported Processor types for our indexer api.

PropertyType

sealed class PropertyType

PropertyValue

sealed class PropertyValue

QueryParams

interface QueryParams

RequestOptions

abstract class RequestOptions

ScriptFunctionArgument

@Serializable

sealed class ScriptFunctionArgument

ScriptPayloadResponse

@Serializable

data class ScriptPayloadResponse(val type: String, val code: String, val type_arguments: List<String>, val arguments: List<String>) : TransactionPayloadResponse

SigningScheme

enum SigningScheme : Enum<SigningScheme>

SigningSchemeInput

enum SigningSchemeInput : Enum<SigningSchemeInput>

SimpleTransaction

@Serializable

data class SimpleTransaction(val rawTransaction: RawTransaction, var feePayerAddress: AccountAddress?, val secondarySignerAddresses: Nothing? = null) : AnyRawTransaction

SpecificPaginationQueryParams

class SpecificPaginationQueryParams : QueryParams

StateCheckpointTransactionResponse

@Serializable

@SerialName(value = "state_checkpoint_transaction")

data class StateCheckpointTransactionResponse(val type: TransactionResponseType, val version: String, val hash: String, val stateChangeHash: String, val eventRootHash: String, val stateCheckpointHash: String?, val gasUsed: String, val success: Boolean, val vmStatus: String, val accumulatorRootHash: String, val timestamp: String) : TransactionResponse

StructTag

@Serializable

class StructTag(val address: AccountAddress, val moduleName: String, val name: String, val typeArgs: List<TypeTag>)

TableItemRequest

@Serializable

data class TableItemRequest(val key_type: String, val value_type: String, val key: String)

TokenData

typealias TokenData = GetTokenData.Result

TokenStandard

enum TokenStandard : Enum<TokenStandard>

TokenStandardArg

data class TokenStandardArg(val tokenStandard: TokenStandard? = null)

TransactionArgument

@Serializable

sealed class TransactionArgument : EntryFunctionArgument

TransactionEd25519Signature

@Serializable

data class TransactionEd25519Signature(val type: String, val public_key: String, val signature: String) : TransactionSignature

TransactionPayload

@Serializable(with = TransactionPayloadSerializer::class)

open class TransactionPayload

TransactionPayloadEntryFunction

@Serializable

data class TransactionPayloadEntryFunction(val entryFunction: EntryFunction) : TransactionPayload

TransactionPayloadResponse

@Serializable

sealed class TransactionPayloadResponse

TransactionPayloadVariants

@Serializable(with = TransactionPayloadVariantsSerializer::class)

enum TransactionPayloadVariants : Enum<TransactionPayloadVariants>

TransactionQueryParams

class TransactionQueryParams : QueryParams

TransactionResponse

@Serializable

sealed class TransactionResponse

TransactionResponseType

@Serializable

enum TransactionResponseType : Enum<TransactionResponseType>

TransactionSignature

@Serializable

sealed class TransactionSignature

TypeArguments

data class TypeArguments(val typeArguments: List<TypeTag>)

TypeArgumentsBuilder

class TypeArgumentsBuilder

TypeTag

@Serializable(with = TypeTagSerializer::class)

sealed class TypeTag

TypeTagAddress

data object TypeTagAddress : TypeTag

TypeTagBool

data object TypeTagBool : TypeTag

TypeTagGeneric

class TypeTagGeneric(val id: UShort) : TypeTag

TypeTagReference

class TypeTagReference(val ref: TypeTag) : TypeTag

TypeTagSigner

data object TypeTagSigner : TypeTag

TypeTagStruct

@Serializable

class TypeTagStruct(val type: StructTag) : TypeTag

TypeTagU128

data object TypeTagU128 : TypeTag

TypeTagU16

data object TypeTagU16 : TypeTag

TypeTagU256

data object TypeTagU256 : TypeTag

TypeTagU32

data object TypeTagU32 : TypeTag

TypeTagU64

data object TypeTagU64 : TypeTag

TypeTagU8

data object TypeTagU8 : TypeTag

TypeTagVariants

@Serializable

enum TypeTagVariants : Enum<TypeTagVariants>

TypeTagVector

class TypeTagVector(val type: TypeTag) : TypeTag

U128

@Serializable

data class U128(val value: String) : TransactionArgument

U16

@Serializable

data class U16(val value: UShort) : TransactionArgument

U256

@Serializable

data class U256(val value: String) : TransactionArgument

U32

@Serializable

data class U32(val value: UInt) : TransactionArgument

U64

@Serializable(with = U64Serializer::class)

data class U64(val value: ULong) : TransactionArgument

@Serializable(with = U8Serializer::class)

data class U8(val value: Byte) : TransactionArgument

UserAgent

enum UserAgent : Enum<UserAgent>

UserTransactionResponse

@Serializable

@SerialName(value = "user_transaction")

data class UserTransactionResponse(val type: TransactionResponseType = TransactionResponseType.USER, val version: String, val hash: String, val stateChangeHash: String, val eventRootHash: String, val statecCheckpointHash: String?, val gasUsed: String, val success: Boolean, val vmStatus: String, val accumulatorRootHash: String, val sender: String, val sequenceNumber: String, val maxGasAmount: String, val gasUnitPrice: String, val expirationTimestampSecs: String, val events: List<Event>, val timestamp: String) : TransactionResponse

ViewFunctionABI

class ViewFunctionABI(val typeParameters: List<MoveFunctionGenericTypeParam>, val parameters: List<TypeTag>, val returnTypes: List<TypeTag>) : FunctionABI

Interface of an View function's ABI.

WaitForTransactionOptions

data class WaitForTransactionOptions(val timeoutSecs: Int = DEFAULT_TXN_TIMEOUT_SEC, val checkSuccess: Boolean = true, val waitForIndexer: Boolean? = null)

Options for waiting for a transaction to be finalized.

WriteSetChange

@Serializable

sealed class WriteSetChange

WriteSetChangeDeleteModule

@Serializable

@SerialName(value = "WriteSetChange::Delete")