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

ByteString

open class ByteString(value: ByteArray)

Immutable byte sequence with content equality.

ClaimedEntryFunction

data class ClaimedEntryFunction(val module: ModuleId, val function: Identifier? = null)

Client

interface Client

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>

EncryptedCiphertext

data class EncryptedCiphertext(val verificationKey: FixedBytes32, val bibeCiphertext: BibeCiphertext, val associatedData: ByteString, val signature: FixedBytes64)

EncryptedTransactionPayload

data class EncryptedTransactionPayload(val ciphertext: EncryptedCiphertext, val extraConfig: TransactionExtraConfig, val payloadHash: FixedBytes32, val encryptionEpoch: ULong, val claimedEntryFunction: ClaimedEntryFunction? = null)

Batch-encryption wire record. Cryptographic construction lives in kaptos-encrypted-transactions.

EntryFunctionABI

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

Interface of an Entry function's ABI.

EntryFunctionArgument

@Serializable(with = EntryFunctionArgumentSerializer::class)

sealed class EntryFunctionArgument : ScriptFunctionArgument

EntryFunctionArgumentBuilder

class EntryFunctionArgumentBuilder

Builder for constructing entry-function arguments with inferred MoveArgument conversions.

EntryFunctionCall

data class EntryFunctionCall(val module: ModuleId, val function: Identifier, val typeArguments: List<TypeTag> = emptyList(), val arguments: List<MoveArgument> = emptyList())

Event

@Serializable

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

ExternalFeePayerRequest

data class ExternalFeePayerRequest(val transactionBytes: ByteArray, val senderAuthenticatorBytes: ByteArray, val additionalSignersAuthenticatorBytes: List<ByteArray> = emptyList(), val fingerprint: String)

Opaque BCS values accepted by an external Aptos Gas Station.

FaucetRequest

@Serializable

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

FaucetResponse

@Serializable

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

FeePayerSignature

data class FeePayerSignature(val transaction: UnsignedTransaction.FeePayer, val authenticator: AccountAuthenticator)

The immutable transaction and authenticator produced when a sponsor signs.

FixedBytes

@Serializable

data class FixedBytes(val value: HexInput) : TransactionArgument

FixedBytes12

class FixedBytes12(value: ByteArray) : ByteString

FixedBytes16

class FixedBytes16(value: ByteArray) : ByteString

FixedBytes32

class FixedBytes32(value: ByteArray) : ByteString

FixedBytes64

class FixedBytes64(value: ByteArray) : ByteString

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)

GenesisTransactionResponse

@Serializable

@SerialName(value = "genesis_transaction")

data class GenesisTransactionResponse(val type: TransactionResponseType = TransactionResponseType.GENESIS, 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 payload: JsonElement, val events: List<Event>) : TransactionResponse

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"

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

InputGenerateTransactionPayloadData

interface InputGenerateTransactionPayloadData

InputGenerateTransactionPayloadDataWithRemoteABI

interface InputGenerateTransactionPayloadDataWithRemoteABI

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 = "", val encryptionKey: String? = null)

LedgerVersionArg

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

LedgerVersionQueryParam

class LedgerVersionQueryParam : QueryParams

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(with = MoveOptionSerializer::class)

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 isEvent: Boolean = false, val isEnum: Boolean = false, val abilities: List<MoveAbility>, val genericTypeParams: List<MoveFunctionGenericTypeParam>, val fields: List<MoveStructField>, val variants: List<MoveStructVariant> = emptyList())

MoveStructField

@Serializable

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

MoveStructId

typealias MoveStructId = String

MoveStructType

abstract class MoveStructType(typeString: String) : MoveType

Base class for defining typed Move struct markers or wrappers.

MoveStructVariant

@Serializable

data class MoveStructVariant(val name: String, val fields: List<MoveStructField>)

MoveType

interface MoveType

Represents a Move type in Kotlin that can provide its corresponding TypeTag.

MoveTypeRegistry

object MoveTypeRegistry

Registry mapping Kotlin types to Move TypeTags for reified type inference.

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>

MultisigPayload

sealed interface MultisigPayload

Network

enum Network : Enum<Network>

Enum class representing the network to connect to.

OriginatingAddress

@Serializable

data class OriginatingAddress(val addressMap: AddressMap)

OriginatingAddressResponse

@Serializable

data class OriginatingAddressResponse(val type: String, val data: OriginatingAddress)

PageRequest

data class PageRequest(val offset: Int = 0, val limit: Int = 20)

Kotlin-native offset pagination shared by indexer-backed services.

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

ProcessorType

enum ProcessorType : Enum<ProcessorType>

The list of supported Processor types for our indexer api.

PropertyType

sealed class PropertyType

PropertyValue

sealed class PropertyValue

ReplayProtection

sealed interface ReplayProtection

Selects conventional sequence-number or AIP-122 nonce replay protection.

ScriptFunctionArgument

@Serializable

sealed class ScriptFunctionArgument

ScriptPayload

class ScriptPayload(bytecode: ByteArray, val typeArguments: List<TypeTag> = emptyList(), val arguments: List<MoveArgument> = emptyList())

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>

SimulationOptions

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

Controls the estimates returned by transaction simulation.

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: JsonElement)

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

TransactionExecutable

sealed interface TransactionExecutable

TransactionExtraConfig

sealed interface TransactionExtraConfig

TransactionOptions

data class TransactionOptions(val maxGasAmount: ULong? = null, val gasUnitPrice: ULong? = null, val expirationTimestampSecs: ULong? = null, val expirationSecondsFromNow: ULong? = null, val replayProtection: ReplayProtection? = null)

Immutable options used when building a transaction.

TransactionPayload

sealed interface TransactionPayload

Exact wire model for Aptos transaction payload variants.

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

TypeTagI128

data object TypeTagI128 : TypeTag

TypeTagI16

data object TypeTagI16 : TypeTag

TypeTagI256

data object TypeTagI256 : TypeTag

TypeTagI32

data object TypeTagI32 : TypeTag

TypeTagI64

data object TypeTagI64 : TypeTag

TypeTagI8

data object TypeTagI8 : 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

UnsignedTransaction

sealed interface UnsignedTransaction

A transaction before account authenticators are attached.

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

ValidatorTransactionResponse

@Serializable

@SerialName(value = "validator_transaction")

data class ValidatorTransactionResponse(val type: TransactionResponseType = TransactionResponseType.VALIDATOR, 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 events: List<Event>, val timestamp: String, val validatorTransactionType: String, val dkgTranscript: JsonElement? = null) : TransactionResponse

ViewFunctionABI

class ViewFunctionABI(typeParameters: List<MoveFunctionGenericTypeParam>, 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")