Kaptos/xyz.mcxross.kaptos.client

Package-level declarations

Types

actual class ClientConfig

actual class ClientConfig

expect class ClientConfig

actual class ClientConfig

Functions

suspend fun get(options: RequestOptions.AptosRequestOptions, apiType: AptosApiType = AptosApiType.FULLNODE): Result<AptosResponse, AptosSdkError>

Executes a GET request to an Aptos API endpoint using a configurable Ktor client.

getAptosFullNode

inline suspend fun <T> getAptosFullNode(options: RequestOptions.GetAptosRequestOptions): Result<T, AptosSdkError>

A high-level generic function to execute a GET request against an Aptos FullNode.

fun getClient(clientConfig: ClientConfig): HttpClient

getGraphqlClient

fun getGraphqlClient(config: AptosConfig): ApolloClient

getPageWithObfuscatedCursor

suspend fun getPageWithObfuscatedCursor(options: RequestOptions.GetAptosRequestOptions): Result<Pair<AptosResponse, String?>, AptosSdkError>

actual fun httpClient(clientConfig: ClientConfig): HttpClient

actual fun httpClient(clientConfig: ClientConfig): HttpClient

expect fun httpClient(clientConfig: ClientConfig): HttpClient

Create a new Ktor client with the given configuration.

actual fun httpClient(clientConfig: ClientConfig): HttpClient

Create a new Ktor client with the given configuration.

paginateWithCursor

inline suspend fun <T> paginateWithCursor(options: RequestOptions.AptosRequestOptions): Result<List<T>, AptosSdkError>

Fetches and aggregates all pages of a paginated API resource using a cursor.

inline suspend fun <V> post(options: RequestOptions.PostRequestOptions<V>): Result<AptosResponse, AptosSdkError>

postAptosFaucet

inline suspend fun <T> postAptosFaucet(options: RequestOptions.PostAptosRequestOptions<T>): Result<FaucetResponse, AptosSdkError>

Submits a request to the Aptos Faucet.

postAptosFullNode

inline suspend fun <T, V> postAptosFullNode(options: RequestOptions.PostAptosRequestOptions<V>): Result<Pair<AptosResponse, T>, AptosSdkError>

postAptosFullNodeAndGetData

inline suspend fun <T, V> postAptosFullNodeAndGetData(options: RequestOptions.PostAptosRequestOptions<V>): Result<T, AptosSdkError>

A convenience wrapper for postAptosFullNode that only returns the deserialized data on success.

responseFitCheck

suspend fun responseFitCheck(aptosResponse: AptosResponse): Result<AptosResponse, AptosSdkError>

Checks an HTTP response, returning a Result that is either the successful response or a structured error.