stellar-sdk/com.soneso.stellar.sdk.scval/Scv

Scv

object Scv

Provides a range of methods to help you build and parse SCValXdr more conveniently.

This utility class offers factory methods for creating Soroban Contract Values (SCVal) from Kotlin native types and converting them back. All methods are optimized for production use with proper validation and error handling.

Usage Example

// Create SCVal from primitive types
val int32Val = Scv.toInt32(42)
val stringVal = Scv.toString("hello")
val boolVal = Scv.toBoolean(true)

// Create SCVal from collections
val vecVal = Scv.toVec(listOf(int32Val, stringVal))
val mapVal = Scv.toMap(linkedMapOf(
    Scv.toSymbol("key") to Scv.toInt64(100L)
))

// Convert back to Kotlin types
val intValue = Scv.fromInt32(int32Val)  // 42
val strValue = Scv.fromString(stringVal)  // "hello"

Functions

fun fromAddress(scVal: SCValXdr): SCAddressXdr

Convert from SCValXdr with the type of SCValTypeXdr.SCV_ADDRESS to SCAddressXdr.

fun fromBoolean(scVal: SCValXdr): Boolean

Convert from SCValXdr with the type of SCValTypeXdr.SCV_BOOL to Boolean.

fun fromBytes(scVal: SCValXdr): ByteArray

Convert from SCValXdr with the type of SCValTypeXdr.SCV_BYTES to ByteArray.

fromContractInstance

fun fromContractInstance(scVal: SCValXdr): SCContractInstanceXdr

Convert from SCValXdr with the type of SCValTypeXdr.SCV_CONTRACT_INSTANCE to SCContractInstanceXdr.

fun fromDuration(scVal: SCValXdr): ULong

Convert from SCValXdr with the type of SCValTypeXdr.SCV_DURATION to ULong.

fun fromError(scVal: SCValXdr): SCErrorXdr

Convert from SCValXdr with the type of SCValTypeXdr.SCV_ERROR to SCErrorXdr.

fun fromInt128(scVal: SCValXdr): BigInteger

Convert from SCValXdr with the type of SCValTypeXdr.SCV_I128 to BigInteger.

fun fromInt256(scVal: SCValXdr): BigInteger

Convert from SCValXdr with the type of SCValTypeXdr.SCV_I256 to BigInteger.

fun fromInt32(scVal: SCValXdr): Int

Convert from SCValXdr with the type of SCValTypeXdr.SCV_I32 to Int.

fun fromInt64(scVal: SCValXdr): Long

Convert from SCValXdr with the type of SCValTypeXdr.SCV_I64 to Long.

fromLedgerKeyContractInstance

fun fromLedgerKeyContractInstance(scVal: SCValXdr)

Parse from SCValXdr with the type of SCValTypeXdr.SCV_LEDGER_KEY_CONTRACT_INSTANCE. This function validates the type and returns Unit if successful.

fromLedgerKeyNonce

fun fromLedgerKeyNonce(scVal: SCValXdr): SCNonceKeyXdr

Convert from SCValXdr with the type of SCValTypeXdr.SCV_LEDGER_KEY_NONCE to SCNonceKeyXdr.

fun fromMap(scVal: SCValXdr): LinkedHashMap<SCValXdr, SCValXdr>

Convert from SCValXdr with the type of SCValTypeXdr.SCV_MAP to LinkedHashMap.

fun fromString(scVal: SCValXdr): String

Convert from SCValXdr with the type of SCValTypeXdr.SCV_STRING to String.

fun fromSymbol(scVal: SCValXdr): String

Convert from SCValXdr with the type of SCValTypeXdr.SCV_SYMBOL to String.

fun fromTimePoint(scVal: SCValXdr): ULong

Convert from SCValXdr with the type of SCValTypeXdr.SCV_TIMEPOINT to ULong.

fun fromUint128(scVal: SCValXdr): BigInteger

Convert from SCValXdr with the type of SCValTypeXdr.SCV_U128 to BigInteger.

fun fromUint256(scVal: SCValXdr): BigInteger

Convert from SCValXdr with the type of SCValTypeXdr.SCV_U256 to BigInteger.

fun fromUint32(scVal: SCValXdr): UInt

Convert from SCValXdr with the type of SCValTypeXdr.SCV_U32 to UInt.

fun fromUint64(scVal: SCValXdr): ULong

Convert from SCValXdr with the type of SCValTypeXdr.SCV_U64 to ULong.

fun fromVec(scVal: SCValXdr): List<SCValXdr>

Convert from SCValXdr with the type of SCValTypeXdr.SCV_VEC to List.

fun fromVoid(scVal: SCValXdr)

Parse from SCValXdr with the type of SCValTypeXdr.SCV_VOID. This function validates the type and returns Unit if successful.

fun toAddress(address: SCAddressXdr): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_ADDRESS.

fun toBoolean(value: Boolean): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_BOOL.

fun toBytes(bytes: ByteArray): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_BYTES.

toContractInstance

fun toContractInstance(instance: SCContractInstanceXdr): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_CONTRACT_INSTANCE.

fun toDuration(duration: ULong): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_DURATION.

fun toError(error: SCErrorXdr): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_ERROR.

fun toInt128(value: BigInteger): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_I128.

fun toInt256(value: BigInteger): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_I256.

fun toInt32(value: Int): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_I32.

fun toInt64(value: Long): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_I64.

toLedgerKeyContractInstance

fun toLedgerKeyContractInstance(): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_LEDGER_KEY_CONTRACT_INSTANCE.

toLedgerKeyNonce

fun toLedgerKeyNonce(nonce: SCNonceKeyXdr): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_LEDGER_KEY_NONCE.

fun toMap(map: LinkedHashMap<SCValXdr, SCValXdr>): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_MAP.

fun toString(string: String): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_STRING.

fun toSymbol(symbol: String): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_SYMBOL.

fun toTimePoint(timePoint: ULong): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_TIMEPOINT.

fun toUint128(value: BigInteger): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_U128.

fun toUint256(value: BigInteger): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_U256.

fun toUint32(value: UInt): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_U32.

fun toUint64(value: ULong): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_U64.

fun toVec(vec: List<SCValXdr>): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_VEC.

fun toVoid(): SCValXdr

Build a SCValXdr with the type of SCValTypeXdr.SCV_VOID.