AbstractSignature
type: Class
has property: function_info
has property: auth_data

AccountData
type: Class
comment: Account data A simplified version of the onchain Account resource
has property: sequence_number
has property: authentication_key

AccountSignature
type: Class
comment: Account signature scheme The account signature scheme allows you to have two types of accounts: 1. A single Ed25519 key account, one private key 2. A k-of-n multi-Ed25519 key account, multiple private keys, such that k-of-n must sign a transaction. 3. A single Secp256k1Ecdsa key account, one private key

AccountSignature_AbstractSignature
type: Class

AccountSignature_Ed25519Signature
type: Class

AccountSignature_MultiEd25519Signature
type: Class

AccountSignature_MultiKeySignature
type: Class

AccountSignature_NoAccountSignature
type: Class

AccountSignature_SingleKeySignature
type: Class

Address
type: Class
comment: A hex encoded 32 byte Aptos account address. This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x. For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

AptosError
type: Class
comment: This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.
has property: message
has property: error_code
has property: vm_error_code

AptosErrorCode
type: Class
comment: These codes provide more granular error information beyond just the HTTP status code of the response.

AssetType
type: Class
comment: A hex encoded 32 byte Aptos account address or a struct tag. This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x or Format: `{address}::{module name}::{struct name}`

Block
type: Class
comment: A Block with or without transactions This contains the information about a transactions along with associated transactions if requested
has property: block_height
has property: block_hash
has property: block_timestamp
has property: first_version
has property: last_version
has property: transactions

BlockEndInfo
type: Class
has property: block_gas_limit_reached
has property: block_output_limit_reached
has property: block_effective_block_gas_units
has property: block_approx_output_size

BlockEpilogueTransaction
type: Class
comment: A block epilogue transaction
has property: version
has property: hash
has property: state_change_hash
has property: event_root_hash
has property: state_checkpoint_hash
has property: gas_used
has property: success
has property: vm_status
has property: accumulator_root_hash
has property: changes
has property: timestamp
has property: block_end_info

BlockMetadataExtension
type: Class

BlockMetadataExtensionEmpty
type: Class

BlockMetadataExtensionRandomness
type: Class
has property: randomness

BlockMetadataExtensionRandomnessAndDecKey
type: Class
has property: randomness
has property: decryption_key

BlockMetadataExtension_BlockMetadataExtensionEmpty
type: Class

BlockMetadataExtension_BlockMetadataExtensionRandomness
type: Class

BlockMetadataExtension_BlockMetadataExtensionRandomnessAndDecKey
type: Class

BlockMetadataTransaction
type: Class
comment: A block metadata transaction This signifies the beginning of a block, and contains information about the specific block
has property: version
has property: hash
has property: state_change_hash
has property: event_root_hash
has property: state_checkpoint_hash
has property: gas_used
has property: success
has property: vm_status
has property: accumulator_root_hash
has property: changes
has property: id
has property: epoch
has property: round
has property: events
has property: previous_block_votes_bitvec
has property: proposer
has property: failed_proposer_indices
has property: timestamp
has property: block_metadata_extension

ChunkyDKGResultTransaction
type: Class
has property: version
has property: hash
has property: state_change_hash
has property: event_root_hash
has property: state_checkpoint_hash
has property: gas_used
has property: success
has property: vm_status
has property: accumulator_root_hash
has property: changes
has property: events
has property: timestamp
has property: certified_subtrx
has property: encryption_key

ClaimedEntryFunction
type: Class
comment: An encrypted payload's claim about the entry function. Specifies at least the module address, and optionally the specific entry funtion.
has property: module
has property: name

DKGResultTransaction
type: Class
has property: version
has property: hash
has property: state_change_hash
has property: event_root_hash
has property: state_checkpoint_hash
has property: gas_used
has property: success
has property: vm_status
has property: accumulator_root_hash
has property: changes
has property: events
has property: timestamp
has property: dkg_transcript

DecodedTableData
type: Class
comment: Decoded table data
has property: key
has property: key_type
has property: value
has property: value_type

DecryptedPayload
type: Class
comment: Payload has been successfully decrypted.
has property: payload_hash
has property: ciphertext
has property: encryption_epoch
has property: claimed_entry_fun
has property: decrypted_payload
has property: decryption_nonce

DelegatedVoterLimitsRequest
type: Class
comment: A higher-limits request backed by a stake pool the fee payer is the delegated voter of.
has property: pool_address
has property: multipliers

DelegationPoolDelegatorLimitsRequest
type: Class
comment: A higher-limits request backed by a delegation pool the fee payer delegates to.
has property: pool_address
has property: multipliers

DeleteModule
type: Class
comment: Delete a module
has property: address
has property: state_key_hash
has property: module

DeleteResource
type: Class
comment: Delete a resource
has property: address
has property: state_key_hash
has property: resource

DeleteTableItem
type: Class
comment: Delete a table item
has property: state_key_hash
has property: handle
has property: key
has property: data

DeletedTableData
type: Class
comment: Deleted table data
has property: key
has property: key_type

DeprecatedModuleBundlePayload
type: Class

DirectWriteSet
type: Class
has property: changes
has property: events

Ed25519
type: Class
has property: value

Ed25519Signature
type: Class
comment: A single Ed25519 signature
has property: public_key
has property: signature

EncodeSubmissionRequest
type: Class
comment: Request to encode a submission
has property: sender
has property: sequence_number
has property: max_gas_amount
has property: gas_unit_price
has property: expiration_timestamp_secs
has property: payload
has property: replay_protection_nonce
has property: secondary_signers

EncryptedPayload
type: Class
comment: Payload is still encrypted and cannot be read.
has property: payload_hash
has property: ciphertext
has property: encryption_epoch
has property: claimed_entry_fun

EncryptedTransactionInnerPayload
type: Class
comment: The inner payload of an encrypted transaction, present only when decrypted.

EncryptedTransactionInnerPayload_EntryFunctionPayload
type: Class

EncryptedTransactionInnerPayload_MultisigPayload
type: Class

EncryptedTransactionInnerPayload_ScriptPayload
type: Class

EncryptedTransactionPayload
type: Class
comment: An encrypted transaction payload, discriminated by encrypted_state. NOTE: multisig_address and replay_protection_nonce are not surfaced here. They are part of extra_config and already exposed on UserTransactionRequest. For Decrypted state, multisig_address is embedded in the MultisigPayload variant of decrypted_payload.

EncryptedTransactionPayload_DecryptedPayload
type: Class

EncryptedTransactionPayload_EncryptedPayload
type: Class

EncryptedTransactionPayload_FailedDecryptionPayload
type: Class

EntryFunctionId
type: Class
comment: Entry function id is string representation of a entry function defined on-chain. Format: `{address}::{module name}::{function name}` Both `module name` and `function name` are case-sensitive.

EntryFunctionPayload
type: Class
comment: Payload which runs a single entry function
has property: function
has property: type_arguments
has property: arguments

Event
type: Class
comment: An event from a transaction
has property: guid
has property: sequence_number
has property: type
has property: data

EventGuid
type: Class
has property: creation_number
has property: account_address

ExportedAggregateSignature
type: Class
comment: A more API-friendly representation of the on-chain `aptos_types::aggregate_signature::AggregateSignature`.
has property: signer_indices
has property: sig

ExportedCertifiedAggregatedChunkySubtranscript
type: Class
comment: A more API-friendly representation of the on-chain `aptos_types::dkg::chunky_dkg::CertifiedAggregatedChunkySubtranscript`.
has property: epoch
has property: author
has property: subtrx
has property: signature

ExportedDKGTranscript
type: Class
has property: epoch
has property: author
has property: payload

ExportedProviderJWKs
type: Class
comment: A more API-friendly representation of the on-chain `aptos_types::jwks::ProviderJWKs`.
has property: issuer
has property: version
has property: jwks

ExportedQuorumCertifiedUpdate
type: Class
comment: A more API-friendly representation of the on-chain `aptos_types::jwks::QuorumCertifiedUpdate`.
has property: update
has property: multi_sig

FailedDecryptionPayload
type: Class
comment: Decryption was attempted but failed.
has property: payload_hash
has property: ciphertext
has property: encryption_epoch
has property: claimed_entry_fun

FederatedKeyless
type: Class
has property: value

FeePayerSignature
type: Class
comment: Fee payer signature for fee payer transactions This allows you to have transactions across multiple accounts and with a fee payer
has property: sender
has property: secondary_signer_addresses
has property: secondary_signers
has property: fee_payer_address
has property: fee_payer_signer

GasEstimation
type: Class
comment: Struct holding the outputs of the estimate gas API
has property: deprioritized_gas_estimate
has property: gas_estimate
has property: prioritized_gas_estimate

GenesisPayload
type: Class
comment: The writeset payload of the Genesis transaction

GenesisPayload_WriteSetPayload
type: Class

GenesisTransaction
type: Class
comment: The genesis transaction This only occurs at the genesis transaction (version 0)
has property: version
has property: hash
has property: state_change_hash
has property: event_root_hash
has property: state_checkpoint_hash
has property: gas_used
has property: success
has property: vm_status
has property: accumulator_root_hash
has property: changes
has property: payload
has property: events

HashValue
type: Class

HealthCheckSuccess
type: Class
comment: Representation of a successful healthcheck
has property: message

HexEncodedBytes
type: Class
comment: All bytes (Vec<u8>) data is represented as hex-encoded string prefixed with `0x` and fulfilled with two hex digits per byte. Unlike the `Address` type, HexEncodedBytes will not trim any zeros.

I128
type: Class
comment: A string containing a 128-bit signed integer. We represent i128 values as a string to ensure compatibility with languages such as JavaScript that do not parse i128s in JSON natively.

I256
type: Class
comment: A string containing a 256-bit signed integer. We represent i256 values as a string to ensure compatibility with languages such as JavaScript that do not parse i256s in JSON natively.

I64
type: Class
comment: A string containing a 64-bit signed integer. We represent i64 values as a string to ensure compatibility with languages such as JavaScript that do not parse i64s in JSON natively.

IdentifierWrapper
type: Class

IndexResponse
type: Class
comment: The struct holding all data returned to the client by the index endpoint (i.e., GET "/"). Only for responding in JSON
has property: chain_id
has property: epoch
has property: ledger_version
has property: oldest_ledger_version
has property: ledger_timestamp
has property: node_role
has property: oldest_block_height
has property: block_height
has property: git_hash
has property: encryption_key

IndexedSignature
type: Class
has property: index
has property: signature

JWK
type: Class
comment: The JWK type that can be converted from/to `JWKMoveStruct` but easier to use in rust.

JWKUpdateTransaction
type: Class
has property: version
has property: hash
has property: state_change_hash
has property: event_root_hash
has property: state_checkpoint_hash
has property: gas_used
has property: success
has property: vm_status
has property: accumulator_root_hash
has property: changes
has property: events
has property: timestamp
has property: quorum_certified_update

Keyless
type: Class
has property: value

MoveAbility
type: Class

MoveFunction
type: Class
comment: Move function
has property: name
has property: visibility
has property: is_entry
has property: is_view
has property: generic_type_params
has property: params
has property: return

MoveFunctionGenericTypeParam
type: Class
comment: Move function generic type param
has property: constraints

MoveFunctionVisibility
type: Class
comment: Move function visibility

MoveModule
type: Class
comment: A Move module
has property: address
has property: name
has property: friends
has property: exposed_functions
has property: structs

MoveModuleBytecode
type: Class
comment: Move module bytecode along with it's ABI
has property: bytecode
has property: abi

MoveModuleId
type: Class
comment: Move module id is a string representation of Move module. Format: `{address}::{module name}` `address` should be hex-encoded 32 byte account address that is prefixed with `0x`. Module name is case-sensitive.

MoveResource
type: Class
comment: A parsed Move resource
has property: type
has property: data

MoveScriptBytecode
type: Class
comment: Move script bytecode
has property: bytecode
has property: abi

MoveStruct
type: Class
comment: A move struct
has property: name
has property: is_native
has property: is_event
has property: is_enum
has property: abilities
has property: generic_type_params
has property: fields
has property: variants

MoveStructField
type: Class
comment: Move struct field
has property: name
has property: type

MoveStructGenericTypeParam
type: Class
comment: Move generic type param
has property: constraints

MoveStructTag
type: Class
comment: String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle. It is a combination of: 1. `move_module_address`, `module_name` and `struct_name`, all joined by `::` 2. `struct generic type parameters` joined by `, ` Examples: * `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>` * `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding). See [doc](https://aptos.dev/concepts/accounts) for more details.

MoveStructValue
type: Class
comment: This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top level fields within the given resource. To clarify, you might query for 0x1::account::Account and see the example data. Move `bool` type value is serialized into `boolean`. Move `u8`, `u16`, `u32`, `i8`, `i16`, and `i32` type value is serialized into `integer`. Move `u64`, `u128`, `u256`, `i64`, `i128`, and `i256` type value is serialized into `string`. Move `address` type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example: - `0x1` - `0x1668f6be25668c1a17cd8caf6b8d2f25` Move `vector` type value is serialized into `array`, except `vector<u8>` which is serialized into a HexEncodedBytes string with `0x` prefix. For example: - `vector<u64>{255, 255}` => `["255", "255"]` - `vector<u8>{255, 255}` => `0xffff` Move `struct` type value is serialized into `object` that looks like this (except some Move stdlib types, see the following section): ```json { field1_name: field1_value, field2_name: field2_value, ...... } ``` For example: `{ "created": "0xa550c18", "role_id": "0" }` **Special serialization for Move stdlib types**: - [0x1::string::String](https://github.com/aptos-labs/aptos-core/blob/main/third_party/move/move-stdlib/docs/ascii.md) is serialized into `string`. For example, struct value `0x1::string::String{bytes: b"Hello World!"}` is serialized as `"Hello World!"` in JSON.

MoveStructVariant
type: Class
comment: A single variant of a Move enum.
has property: name
has property: fields

MoveType
type: Class
comment: String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - i8 - i16 - i32 - i64 - i128 - i256 - address - signer - vector: `vector<{non-reference MoveTypeId}>` - struct: `{address}::{module_name}::{struct_name}::<{generic types}>` Vector type value examples: - `vector<u8>` - `vector<vector<u64>>` - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>` Struct type value examples: - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> - `0x1::account::Account` Note: 1. Empty chars should be ignored when comparing 2 struct tag ids. 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

MoveValue
type: Class
comment: An enum of the possible Move value types

MultiAgentSignature
type: Class
comment: Multi agent signature for multi agent transactions This allows you to have transactions across multiple accounts
has property: sender
has property: secondary_signer_addresses
has property: secondary_signers

MultiEd25519Signature
type: Class
comment: A Ed25519 multi-sig signature This allows k-of-n signing for a transaction
has property: public_keys
has property: signatures
has property: threshold
has property: bitmap

MultiKeySignature
type: Class
comment: A multi key signature
has property: public_keys
has property: signatures
has property: signatures_required

MultisigPayload
type: Class
comment: A multisig transaction that allows an owner of a multisig account to execute a pre-approved transaction as the multisig account.
has property: multisig_address
has property: transaction_payload

MultisigTransactionPayload
type: Class
comment: Enum for multisig transaction payloads, supporting both entry functions and scripts.

MultisigTransactionPayload_EntryFunctionPayload
type: Class

MultisigTransactionPayload_ScriptPayload
type: Class

NoAccountSignature
type: Class
comment: A placeholder to represent the absence of account signature

PendingTransaction
type: Class
comment: A transaction waiting in mempool
has property: hash
has property: sender
has property: sequence_number
has property: max_gas_amount
has property: gas_unit_price
has property: expiration_timestamp_secs
has property: payload
has property: signature
has property: replay_protection_nonce
has property: txn_limits_request

PersistedAuxiliaryInfo
type: Class
comment: API representation of persisted auxiliary transaction information
has property: transaction_index

PublicKey
type: Class

PublicKey_Ed25519
type: Class

PublicKey_FederatedKeyless
type: Class

PublicKey_Keyless
type: Class

PublicKey_Secp256k1Ecdsa
type: Class

PublicKey_Secp256r1Ecdsa
type: Class

PublicKey_SlhDsa_Sha2_128s
type: Class

RSA_JWK
type: Class
comment: Move type `0x1::jwks::RSA_JWK` in rust. See its doc in Move for more details.
has property: kid
has property: kty
has property: alg
has property: e
has property: n

RawTableItemRequest
type: Class
comment: Table Item request for the GetTableItemRaw API
has property: key

ReplayProtector
type: Class

ReplayProtector_string(U64)
type: Class

RequestedMultipliers
type: Class
comment: Multipliers for higher transaction limits, expressed as percent of the base limit (100 = 1x, 200 = 2x, 250 = 2.5x).
has property: execution_multiplier_percent
has property: io_multiplier_percent

RoleType
type: Class

ScriptPayload
type: Class
comment: Payload which runs a script that can run multiple functions
has property: code
has property: type_arguments
has property: arguments

ScriptWriteSet
type: Class
has property: execute_as
has property: script

Secp256k1Ecdsa
type: Class
has property: value

Secp256r1Ecdsa
type: Class
has property: value

Signature
type: Class

Signature_Ed25519
type: Class

Signature_Keyless
type: Class

Signature_Secp256k1Ecdsa
type: Class

Signature_SlhDsa_Sha2_128s
type: Class

Signature_WebAuthn
type: Class

SingleKeySignature
type: Class
comment: A single key signature
has property: public_key
has property: signature

SlhDsa_Sha2_128s
type: Class
has property: value

StakePoolOwnerLimitsRequest
type: Class
comment: A higher-limits request whose backing is a stake pool the fee payer owns.
has property: multipliers

StateCheckpointTransaction
type: Class
comment: A state checkpoint transaction
has property: version
has property: hash
has property: state_change_hash
has property: event_root_hash
has property: state_checkpoint_hash
has property: gas_used
has property: success
has property: vm_status
has property: accumulator_root_hash
has property: changes
has property: timestamp

StateKeyWrapper
type: Class
comment: Representation of a StateKey as a hex string. This is used for cursor based pagination.

SubmitTransactionRequest
type: Class
comment: A request to submit a transaction This requires a transaction and a signature of it
has property: sender
has property: sequence_number
has property: max_gas_amount
has property: gas_unit_price
has property: expiration_timestamp_secs
has property: payload
has property: replay_protection_nonce
has property: signature

TableItemRequest
type: Class
comment: Table Item request for the GetTableItem API
has property: key_type
has property: value_type
has property: key

Transaction
type: Class
comment: Enum of the different types of transactions in Aptos

TransactionPayload
type: Class
comment: An enum of the possible transaction payloads

TransactionPayload_DeprecatedModuleBundlePayload
type: Class

TransactionPayload_EncryptedTransactionPayload
type: Class

TransactionPayload_EntryFunctionPayload
type: Class

TransactionPayload_MultisigPayload
type: Class

TransactionPayload_ScriptPayload
type: Class

TransactionSignature
type: Class
comment: An enum representing the different transaction signatures available

TransactionSignature_AccountSignature
type: Class

TransactionSignature_Ed25519Signature
type: Class

TransactionSignature_FeePayerSignature
type: Class

TransactionSignature_MultiAgentSignature
type: Class

TransactionSignature_NoAccountSignature
type: Class

TransactionSummary
type: Class
has property: sender
has property: version
has property: transaction_hash
has property: replay_protector

Transaction_BlockEpilogueTransaction
type: Class

Transaction_BlockMetadataTransaction
type: Class

Transaction_GenesisTransaction
type: Class

Transaction_PendingTransaction
type: Class

Transaction_StateCheckpointTransaction
type: Class

Transaction_UserTransaction
type: Class

Transaction_ValidatorTransaction
type: Class

TransactionsBatchSingleSubmissionFailure
type: Class
comment: Information telling which batch submission transactions failed
has property: error
has property: transaction_index

TransactionsBatchSubmissionResult
type: Class
comment: Batch transaction submission result Tells which transactions failed
has property: transaction_failures

U128
type: Class
comment: A string containing a 128-bit unsigned integer. We represent u128 values as a string to ensure compatibility with languages such as JavaScript that do not parse u128s in JSON natively.

U256
type: Class
comment: A string containing a 256-bit unsigned integer. We represent u256 values as a string to ensure compatibility with languages such as JavaScript that do not parse u256s in JSON natively.

U64
type: Class
comment: A string containing a 64-bit unsigned integer. We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

UnsupportedJWK
type: Class
comment: Move type `0x1::jwks::UnsupportedJWK` in rust. See its doc in Move for more details.
has property: id
has property: payload

UserTransaction
type: Class
comment: A transaction submitted by a user to change the state of the blockchain
has property: version
has property: hash
has property: state_change_hash
has property: event_root_hash
has property: state_checkpoint_hash
has property: gas_used
has property: success
has property: vm_status
has property: accumulator_root_hash
has property: changes
has property: sender
has property: sequence_number
has property: max_gas_amount
has property: gas_unit_price
has property: expiration_timestamp_secs
has property: payload
has property: signature
has property: replay_protection_nonce
has property: txn_limits_request
has property: events
has property: timestamp

UserTxnLimitsRequest
type: Class
comment: A request for higher transaction execution limits, backed by a staking proof.

UserTxnLimitsRequest_DelegatedVoterLimitsRequest
type: Class

UserTxnLimitsRequest_DelegationPoolDelegatorLimitsRequest
type: Class

UserTxnLimitsRequest_StakePoolOwnerLimitsRequest
type: Class

ValidatorTransaction
type: Class

ValidatorTransaction_ChunkyDKGResultTransaction
type: Class

ValidatorTransaction_DKGResultTransaction
type: Class

ValidatorTransaction_JWKUpdateTransaction
type: Class

VersionedEvent
type: Class
comment: An event from a transaction with a version
has property: version
has property: guid
has property: sequence_number
has property: type
has property: data

ViewRequest
type: Class
comment: View request for the Move View Function API
has property: function
has property: type_arguments
has property: arguments

WebAuthn
type: Class
has property: value

WriteModule
type: Class
comment: Write a new module or update an existing one
has property: address
has property: state_key_hash
has property: data

WriteResource
type: Class
comment: Write a resource or update an existing one
has property: address
has property: state_key_hash
has property: data

WriteSet
type: Class
comment: The associated writeset with a payload

WriteSetChange
type: Class
comment: A final state change of a transaction on a resource or module

WriteSetChange_DeleteModule
type: Class

WriteSetChange_DeleteResource
type: Class

WriteSetChange_DeleteTableItem
type: Class

WriteSetChange_WriteModule
type: Class

WriteSetChange_WriteResource
type: Class

WriteSetChange_WriteTableItem
type: Class

WriteSetPayload
type: Class
comment: A writeset payload, used only for genesis
has property: write_set

WriteSet_DirectWriteSet
type: Class

WriteSet_ScriptWriteSet
type: Class

WriteTableItem
type: Class
comment: Change set to write a table item
has property: state_key_hash
has property: handle
has property: key
has property: value
has property: data