Ksui/xyz.mcxross.ksui.client

Package-level declarations

This package contains the SuiHttpClient and SuiWebsocketClient classes and related classes for interacting with Sui Full node.

Types

ClientConfig

class ClientConfig

ClientType

enum ClientType : Enum<ClientType>

An enumeration of the different types of clients that can be created by ClientConfig.build.

ConfigContainer

data class ConfigContainer(val engine: HttpClientEngine? = null, val endPoint: EndPoint, val customUrl: String, val port: Int = 443, val maxRetries: Int, val agentName: String, val requestTimeout: Long, val connectionTimeout: Long, val followRedirectsWrapper: Boolean, val enableLogging: Boolean, val loggerWrapper: Logger, val logLevelWrapper: LogLevel)

EndPoint

enum EndPoint : Enum<EndPoint>

SuiClient

interface SuiClient

An interface representing a Sui client.

SuiHttpClient

class SuiHttpClient(val configContainer: ConfigContainer) : SuiClient

A Kotlin wrapper around the Sui JSON-RPC API for interacting with a Sui full node.

SuiWebSocketClient

class SuiWebSocketClient(val configContainer: ConfigContainer) : SuiClient

Properties

defaultEngine

actual val defaultEngine: HttpClientEngine

expect val defaultEngine: HttpClientEngine

actual val defaultEngine: HttpClientEngine

KSUI_VERSION

const val KSUI_VERSION: String

Functions

runBlocking

actual suspend fun <T> runBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> T): T

expect suspend fun <T> runBlocking(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): T

actual suspend fun <T> runBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> T): T

suspend fun DefaultWebSocketSession.subscribe(method: String, params: JsonElement)

subscribeEvent

suspend fun DefaultWebSocketSession.subscribeEvent(json: Json, filter: EventFilter)

subscribeTransaction

suspend fun DefaultWebSocketSession.subscribeTransaction(json: Json, filter: TransactionFilter)

suiHttpClient

fun suiHttpClient(builderAction: ClientConfig.() -> Unit): SuiHttpClient

Creates a new instance of SuiHttpClient using the provided configuration.

suiWebSocketClient

fun suiWebSocketClient(builderAction: ClientConfig.() -> Unit): SuiWebSocketClient

Creates a new instance of SuiWebSocketClient using the provided configuration.