Ksui/xyz.mcxross.ksui.util

Package-level declarations

This package contains all the utility functions used by Ksui.

Types

Logger

enum Logger : Enum<Logger>

LogLevel

enum LogLevel : Enum<LogLevel>

Properties

FUNCTION

const val FUNCTION: String

LENGTH

const val LENGTH: Int = 32

MODULE

const val MODULE: String

NetworkToChainId

val NetworkToChainId: Map<String, Int>

NetworkToFaucetAPI

val NetworkToFaucetAPI: Map<String, String>

NetworkToIndexerAPI

val NetworkToIndexerAPI: Map<String, String>

NetworkToNetworkName

val NetworkToNetworkName: Map<String, Network>

NetworkToNodeAPI

val NetworkToNodeAPI: Map<String, String>

PACKAGE_ID

const val PACKAGE_ID: String

SUI_PRIVATE_KEY_PREFIX

const val SUI_PRIVATE_KEY_PREFIX: String

Functions

bcsDecode

inline fun <T> bcsDecode(data: ByteArray): T

bcsEncode

inline fun <T> bcsEncode(data: T): ByteArray

compose

infix suspend fun ProgrammableTransaction.compose(details: Pair<Account, ULong>): String

Composes a ProgrammableTransaction into the final transaction bytes string. This is the infix version for a more expressive syntax.

suspend fun ProgrammableTransaction.compose(details: Pair<Account, ULong>, sui: Sui = SuiKit.client): String

Composes a ProgrammableTransaction into the final transaction bytes string. This is the standard extension function.

convertBits

fun convertBits(data: ByteArray, fromBits: Int, toBits: Int, pad: Boolean): ByteArray

decodeBase58

fun String.decodeBase58(): ByteArray

Decodes the base58 string into a ByteArray

encodeToBase58String

fun ByteArray.encodeToBase58String(): String

Encodes the bytes as a base58 string (no checksum is appended).

formatSuiDomain

fun formatSuiDomain(domain: String): String

getKtorLogger

fun Logger.getKtorLogger(): Logger

getKtorLogLevel

fun LogLevel.getKtorLogLevel(): LogLevel

idToMapped

fun idToMapped(id: String): Map<String, String>

idToParts

fun idToParts(id: String): Triple<String, String, String>

inputs

inline fun <T : Any> ProgrammableTransactionBuilder.inputs(vararg inputs: T): List<Argument>

Extension functions to create Argument.Inputs from various types.

runBlocking

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

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

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

toTxnDigest

fun String.toTxnDigest(): TransactionDigest

Extension function to create a TransactionDigest from a String.

types

inline fun <T : TypeTag> ProgrammableTransactionBuilder.types(vararg types: T): List<TypeTag>