Table of Contents

Namespace Aptos

Classes

ANSClient
Account

Abstract class representing a signer account.

AccountAddress
AccountAddressConverter
AccountAuthenticator
AccountAuthenticatorEd25519
AccountAuthenticatorMultiKey
AccountAuthenticatorSingleKey
AccountClient
AccountData
AccountEd25519Signature
AccountMultiKeySignature
AccountMultiKeySignature.IndexedAccountSignature
AccountSignature
AccountSignatureConverter
AccountSingleKeySignature
Ans
AnyRawTransaction
AnyValue
AptosClient

Creates an instance of the AptosClient with a given AptosConfig. This client is used to interface with the Aptos blockchain and perform various operations such as querying the blockchain, submitting transactions, and interacting with the Aptos network.

AptosConfig

Instantiate a new instance of the AptosConfig class. This class is used to configure the AptosClient, its dependencies, and endpoints. See the Networks class for a predefined list of networks.

AptosRequest
AptosRequestClient
AptosResponse<Res>
AuthenticationKey
BaseAptosRequest
BlockClient
BlockEndInfo
BlockEpilogueTransactionResponse
BlockMetadataTransactionResponse
Bool
CdnAssetUris
CertificateSignature
ChainId
ClientRequest
ClientResponse<Res>
CoinBalance
CollectionData
CommittedTransactionResponse
ContractClient
DecodedTableData
DeletedTableData
Deserializer
DigitalAssetClient
DigitalAssetData
DigitalAssetOwnership
DirectWriteSet
Ed25519
Ed25519Account

Represents an Ed25519 signer used to sign transaction with a Ed25519 private key.

Ed25519PrivateKey
Ed25519PublicKey
Ed25519Signature
EntryFunction
EntryFunctionAbi
EntryFunctionBytes
EntryFunctionPayloadResponse
EphemeralCertificate
EphemeralKeyPair
EphemeralPublicKey
EphemeralSignature
Event
EventClient
EventData
EventGuid
FaucetClient
FederatedKeylessPublicKey
FeePayerRawTransaction
FixedBytes
FunctionAbi
FungibleAssetBalance
FungibleAssetClient
FungibleAssetMetadata
G1Bytes
G1BytesConverter
G2Bytes
G2BytesConverter
GasClient
GasEstimation
GenerateEntryFunctionPayloadData

Represents a payload data for an entry function.

GenerateMultisigPayloadData
GeneratePayloadData
GenerateScriptPayloadData
GenerateTransactionPayloadDataWithAbi
GenerateViewFunctionPayloadData

Represents a payload data for a view function.

GenesisPayloadResponse
GenesisTransactionResponse
GetAptosRequest
Groth16VerificationKey
Groth16Zkp
HdKey
HdKey.DerivedKeys
Hex
HexConverter
IndexerClient
Keyless
KeylessAccount
KeylessClient
KeylessConfiguration
KeylessPublicKey
KeylessSignature
LedgerInfo
MimeType
ModuleId
MoveFunction
MoveFunctionGenericTypeParam
MoveModule
MoveModuleBytecode
MoveOption<T>
MoveResource
MoveScriptBytecode
MoveString
MoveStruct
MoveStructField
MoveVector<T>
MultiAgentRawTransaction
MultiAgentTransaction
MultiKey
MultiKeyAccount

Represents a MultiKey signer used to sign transactions with the MultiKey authentication scheme.

This accounts to use a M of N signing scheme. M and N are specified in the MultiKey. It signs messages via the array of M number of Accounts that individually correspond to a public key in the MultiKey.

MultiKeySignature
MultisigPayloadResponse
NetworkConfig

The network configuration for an AptosConfig for all endpoints used by the AptosClient.

Networks
OriginatingAddress
PendingTransactionResponse
PepperResponse
PostAptosRequest
PrivateKey
Proof
ProverResponse
PublicKey
PublicKeyConverter
PublicKeySignature

Cryptographic signatures typically using a private key to sign a message or transaction.

PublicKeySignatureConverter
RawTransaction
RawTransactionWithData
RequestClient
ResourceHandle
ResourceOption
ResourceStruct
ResourceStruct.InnerStruct

Resource structs will have an inner struct inside a vec. The inner struct will contain the account address, module name, and struct name. Typically the module name and struct name will be in hex format.
Example of 0x1::aptos_coin::AptosCoin struct: { account_address: "0x1", module_name: "0x6170746f735f636f696e", struct_name: "0x4170746f73436f696e", }

Script
ScriptPayloadResponse
ScriptWriteSet
Secp256k1
Secp256k1PrivateKey
Secp256k1PublicKey
Secp256k1Signature
Serializable
Serializer
Signature

Base signatures for anything signed (not specific to signing transactions/messages). This may include all signatures needed for ZK proofs, Certificates, etc.

SignedTransaction
SigningMessage
SimpleTransaction
SimulateTransactionData
SimulateTransactionOptions
SingleKey
SingleKeyAccount
StateCheckpointTransactionResponse
StructTag
SubmitTransactionData
TableClient
TokenOwnership
TransactionArgument
TransactionAuthenticator
TransactionAuthenticatorEd25519
TransactionAuthenticatorFeePayer
TransactionAuthenticatorMultiAgent
TransactionAuthenticatorSingleSender
TransactionBuilder
TransactionBuilder.GenerateTransactionOptions
TransactionClient
TransactionClient.WaitForTransactionOptions
TransactionEd25519Signature
TransactionEntryFunctionPayload
TransactionFeePayerSignature
TransactionMultiAgentSignature
TransactionPayload
TransactionPayloadResponse
TransactionPayloadResponseConverter
TransactionResponse
TransactionResponseConverter
TransactionScriptPayload
TransactionSignature
TransactionSignatureConverter
TransactionSingleSenderSignature
TypeTag
TypeTag.TypeTagState
TypeTagAddress
TypeTagBool
TypeTagGeneric
TypeTagReference
TypeTagSigner
TypeTagStruct
TypeTagU128
TypeTagU16
TypeTagU256
TypeTagU32
TypeTagU64
TypeTagU8
TypeTagVector
U128
U16
U256
U32
U64
U8
UserTransactionResponse
ValidatorTransactionResponse
ViewFunctionAbi
WriteSet
WriteSetChange
WriteSetChangeDeleteModule
WriteSetChangeDeleteResource
WriteSetChangeDeleteTableItem
WriteSetChangeWriteModule
WriteSetChangeWriteResource
WriteSetChangeWriteTableItem
WriteSetConverter
WritesSetChangeConverter
ZeroKnowledgeSignature
ZkProof

Interfaces

Deserializable<T>
IEntryFunctionArgument
IScriptFunctionArgument
IVerifyingKey

A verifying key represents a collection of public keys that can be used to verify signatures or derive authentication keys. This interface is typically implemented to collect public keys for Account Authenticators.

Enums

AccountAuthenticatorVariant
ApiType
EphemeralSignatureVariant
MoveAbility
MoveFunctionVisibility
PrivateKeyVariant
PublicKeySignatureVariant
PublicKeyVariant
RawTransactionVariant
ScriptTransactionArgumentVariants
TransactionAuthenticatorVariant
TransactionResponseType
TransactionSignatureVariant
TypeTagVariant
ZkpVariant