aptos/src/provider/provider library

Classes

AptosApiAccountData
AptosApiAccountSignature
AptosApiAccountSignatureAbstractionSignature
AptosApiAccountSignatureEd25519Signature
AptosApiAccountSignatureMultiEd25519Signature
AptosApiAccountSignatureMultiKeySignature
AptosApiAccountSignatureNoAccountSignature
AptosApiAccountSingleKeySignature
AptosApiBlock
AptosApiBlockEndInfo
AptosApiBlockEpilogueTransaction
AptosApiBlockMetadataTransaction
AptosApiDecodeTableData
AptosApiDeleteTableData
AptosApiEvent
AptosApiEventGuid
AptosApiGasEstimation
AptosApiGenesisTransaction
AptosApiIndexedSignature
AptosApiLedgerInfo
AptosApiMethod
AptosApiMoveFunction
AptosApiMoveFunctionGenericTypeParams
AptosApiMoveModule
AptosApiMoveModuleByteCode
AptosApiMoveResource
AptosApiMoveScruptByteCode
AptosApiMoveStrictField
AptosApiMoveStrunct
AptosApiPendingTransaction
AptosApiPublicKey
AptosApiSignature
AptosApiStateCheckpointTransaction
AptosApiTransaction
AptosApiTransactionEd25519Signature
AptosApiTransactionFeePayerSignature
AptosApiTransactionMultiAgentSignature
AptosApiTransactionMultiEd25519Signature
AptosApiTransactionNoAccountSignature
AptosApiTransactionPayload
AptosApiTransactionPayloadEntryFunction
AptosApiTransactionPayloadMultisig
AptosApiTransactionPayloadScript
AptosApiTransactionSecp256k1EcdsaSignature
AptosApiTransactionSignature
AptosApiTransactionSingleSenderSignature
AptosApiUserTransaction
AptosApiValidatorTransaction
AptosApiWriteSetChange
AptosApiWriteSetChangeDeleteModule
AptosApiWriteSetChangeDeleteResource
AptosApiWriteSetChangeDeleteTableItem
AptosApiWriteSetChangeWriteModule
AptosApiWriteSetChangeWriteResource
AptosApiWriteSetChangeWriteTableItem
AptosGraphQLApiAggregate
AptosGraphQLAptosName
AptosGraphQLCollectionOwnershipV2View
AptosGraphQLCollectionOwnershipV2ViewCollection
AptosGraphQLCollectionV2
AptosGraphQLCollectionV2CdnAssetUris
AptosGraphQLDelegatedStakingActivity
AptosGraphQLEvent
AptosGraphQLFungibleAssetActivity
AptosGraphQLFungibleAssetBalance
AptosGraphQLFungibleAssetMetadata
AptosGraphQLNumActiveDelegatorPerPool
AptosGraphQLObject
AptosGraphQLPaginatedVariablesParams
AptosGraphQLPaginatedWithOrderVariablesParams
AptosGraphQLProcessorStatus
AptosGraphqlQueriesConst
AptosGraphQLRequest<RESULT, RESPONSE>
AptosGraphQLRequestChainId
AptosGraphQLRequestGetAccountCoinsCount
AptosGraphQLRequestGetAccountCoinsData
AptosGraphQLRequestGetAccountCollectionsWithOwnedTokens
AptosGraphQLRequestGetAccountOwnedTokens
AptosGraphQLRequestGetAccountOwnedTokensByTokenData
AptosGraphQLRequestGetAccountOwnedTokensFromCollection
AptosGraphQLRequestGetAccountTokensCount
AptosGraphQLRequestGetAccountTransactionsCount
AptosGraphQLRequestGetChainTopUserTransactions
AptosGraphQLRequestGetCollectionData
AptosGraphQLRequestGetCurrentFungibleAssetBalances
AptosGraphQLRequestGetCurrentTokenData
AptosGraphQLRequestGetCurrentTokenOwnership
AptosGraphQLRequestGetDelegatedStakingActivities
AptosGraphQLRequestGetEvents
AptosGraphQLRequestGetFungibleAssetActivities
AptosGraphQLRequestGetFungibleAssetMetadata
AptosGraphQLRequestGetNames
AptosGraphQLRequestGetNumberOfDelegators
AptosGraphQLRequestGetObjectData
AptosGraphQLRequestGetProcessorStatus
AptosGraphQLRequestGetTableItemsData
AptosGraphQLRequestGetTableItemsMetadata
AptosGraphQLRequestGetTokenActivity
AptosGraphQLTableItem
AptosGraphQLTableMetadata
AptosGraphQLTokenActivity
AptosGraphQLTokenCollection
AptosGraphQLTokenData
AptosGraphQLTokenOwnershipV2
AptosGraphQLTokenOwnershipV2TokenData
AptosGraphQLTokenOwnershipV2TokenDataCollection
AptosGraphQlWhereCondition
AptosGraphQLWhereConditionVariablesParams
AptosGraphQLWhereConditionWithOrderVariablesParams
AptosPostRequest<RESULT, RESPONSE>
AptosProvider
AptosRequest<RESULT, RESPONSE>
AptosRequestCheckBasicNodeHealth
By default this endpoint just checks that it can get the latest ledger info and then returns 200. If the duration_secs param is provided, this endpoint will return a 200 if the following condition is true: server_latest_ledger_info_timestamp >= server_current_time_timestamp - duration_secs aptos documation
AptosRequestDetails
AptosRequestEncodeSubmission
This endpoint accepts an EncodeSubmissionRequest, which internally is a UserTransactionRequestInner (and optionally secondary signers) encoded as JSON, validates the request format, and then returns that request encoded in BCS. The client can then use this to create a transaction signature to be used in a SubmitTransactionRequest, which it then passes to the /transactions POST endpoint. aptos documation
AptosRequestEstimateGasPrice
Gives an estimate of the gas unit price required to get a transaction on chain in areasonable amount of time. The gas unit price is the amount that each transaction commits topay for each unit of gas consumed in executing the transaction. The estimate is based onrecent history: it gives the minimum gas that would have been required to get into recentblocks, for blocks that were full. (When blocks are not full, the estimate will match theminimum gas unit price.) The estimation is given in three values: de-prioritized (low), regular, and prioritized(aggressive). Using a more aggressive value increases the likelihood that the transactionwill make it into the next block; more aggressive values are computed with a larger historyand higher percentile statistics. More details are in AIP-34. aptos documation
AptosRequestExecuteViewFunctionOfaModule<T>
Execute the Move function with the given parameters and return its execution result. The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410. aptos documation
AptosRequestGetAccount
Return the authentication key and the sequence number for an account\naddress. Optionally, a ledger version can be specified. If the ledger\nversion is not specified in the request, the latest ledger version is used aptos documation
AptosRequestGetAccountAssetResources
Retrieves all account resources for a given account and a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410. aptos documation
AptosRequestGetAccountModule
Retrieves an individual module from a given account and at a specific ledger version. If theledger version is not specified in the request, the latest ledger version is used. The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410. aptos documation
AptosRequestGetAccountModules
Retrieves all account modules' bytecode for a given account at a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used. The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410. aptos documation
AptosRequestGetAccountResource
Retrieves an individual resource from a given account and at a specific ledger version. If theledger version is not specified in the request, the latest ledger version is used. The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410. aptos documation
AptosRequestGetAccountResources
Retrieves all account resources for a given account and a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410. aptos documation
AptosRequestGetAccountTransactions
Retrieves on-chain committed transactions from an account. If the start version is too far in the past, a 410 will be returned. If no start version is given, it will start at version 0.To retrieve a pending transaction, use /transactions/by_hash. aptos documation
AptosRequestGetBlocksByHeight
This endpoint allows you to get the transactions in a blockand the corresponding block information.Transactions are limited by max default transactions size. If not all transactionsare present, the user will need to query for the rest of the transactions via theget transactions API.If the block is pruned, it will return a 410 aptos documation
AptosRequestGetBlocksByVersion
This endpoint allows you to get the transactions in a blockand the corresponding block information given a version in the block. Transactions are limited by max default transactions size. If not all transactionsare present, the user will need to query for the rest of the transactions via theget transactions API.If the block has been pruned, it will return a 410 aptos documation
AptosRequestGetEventsByCreationNumber
AptosGraphQLEvent types are globally identifiable by an account address andmonotonically increasing creationNumber, one per event type emittedto the given account. This API returns events corresponding to thatthat event type. aptos documation
AptosRequestGetEventsByEventHandle
This API uses the given account address, eventHandle, and fieldNameto build a key that can globally identify an event types. It then uses thiskey to return events emitted to the given account matching that event type. aptos documation
AptosRequestGetLedgerInfo
Get the latest ledger information, including data such as chain ID,role type, ledger versions, epoch, etc. aptos documation
AptosRequestGetRawTableItem
Get a table item at a specific ledger version from the table identified by {table_handle}in the path and the "key" (RawTableItemRequest) provided in the request body.The get_raw_table_item requires only a serialized key comparing to the full move type informationcomparing to the get_table_item api, and can only return the query in the bcs format. The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410. aptos documation
AptosRequestGetTableItem
Get a table item at a specific ledger version from the table identified by {table_handle} in the path and the "key" (TableItemRequest) provided in the request body.This is a POST endpoint because the "key" for requesting a specifictable item (TableItemRequest) could be quite complex, as each of its fields could themselves be composed of other structs. This makes itimpractical to express using query params, meaning GET isn't an option.The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410. aptos documation
AptosRequestGetTransactionByHash
Look up a transaction by its hash. This is the same hash that is returnedby the API when submitting a transaction (see PendingTransaction). When given a transaction hash, the server first looks for the transactionin storage (on-chain, committed). If no on-chain transaction is found, itlooks the transaction up by hash in the mempool (pending, not yet committed).To create a transaction hash by yourself, do the following:
AptosRequestGetTransactionByVersion
Retrieves a transaction by a given version. If the version has beenpruned, a 410 will be returned. aptos documation
AptosRequestGetTransactions
Retrieve on-chain committed transactions. The page size and start ledger version can be provided to get a specific sequence of transactions. If the version has been pruned, then a 410 will be returned. To retrieve a pending transaction, use /transactions/by_hash. aptos documation
AptosRequestShowSomeBasicInfoOfTheNode
Show some basic info of the node. aptos documation
AptosRequestSimulateTransaction
The output of the transaction will have the exact transaction outputs and events that runningan actual signed transaction would have. However, it will not have the associated statehashes, as they are not updated in storage. This can be used to estimate the maximum gasunits for a submitted transaction.To use this, you must:
AptosRequestSubmitTransaction
This endpoint accepts transaction submissions in two formats.To submit a transaction as JSON, you must submit a SubmitTransactionRequest. To build this request, do the following:
AptosRequestWaitForTransactionByHash
Same as /transactions/by_hash, but will wait for a pending transaction to be committed. To be used as a longpoll optimization by clients, to reduce latency caused by polling. The "long" poll is generally a second orless but dictated by the server; the client must deal with the result as if the request was a normal/transactions/by_hash request, e.g., by retrying if the transaction is pending. aptos documation
ExecuteViewFunctionOfAModuleRequestParams
TableItemRequestParams

Typedefs

AptosServiceResponse<T> = BaseServiceResponse<T>