Ksui/xyz.mcxross.ksui.model

Package-level declarations

This package contains all the data classes used by Ksui. These are mostly Sui type wrappers.

Types

AdditionalProperties

@Serializable

data class AdditionalProperties(val type: String, val format: String, val minimum: Int)

Address

object Address : TypeTag

AppId

@Serializable

enum AppId : Enum<AppId>

Argument

@Serializable

sealed class Argument

AtVersion

@Serializable

data class AtVersion(val objectId: String, val sequenceNumber: Long)

AuthorityPublicKeyBytes

@Serializable

data class AuthorityPublicKeyBytes(val description: String, val allOf: List<Schema>)

AuthSignInfo

@Serializable

data class AuthSignInfo(val epoch: Int, val signature: String, val signersMap: List<Int>)

Balance

@Serializable

data class Balance(val coinType: String, val coinObjectCount: Int, val totalBalance: Long, val lockedBalance: LockedBalance)

BalanceChange

@Serializable

data class BalanceChange(val owner: Owner, val coinType: String, val amount: String)

Bool

object Bool : TypeTag

Builder

interface Builder

BuilderArg

@Serializable

sealed class BuilderArg

CallArg

@Serializable

sealed class CallArg

Certificate

@Serializable

data class Certificate(val transactionDigest: String, val data: Data, val txSignatures: List<String>, val authSignInfo: AuthSignInfo)

Checkpoint

@Serializable

data class Checkpoint(val epoch: Long, val sequenceNumber: String, val digest: String, val networkTotalTransactions: Long, val previousDigest: String = "", val epochRollingGasCostSummary: GasCostSummary, val timestampMs: Long, val transactions: List<String>, val checkpointCommitments: List<String> = emptyList())

CheckpointContents

data class CheckpointContents(val transactions: List<Transaction>, val userSignatures: List<String>)

CheckpointContentsDigest

@Serializable

data class CheckpointContentsDigest(val digest: CheckpointDigest)

CheckpointDigest

@Serializable

data class CheckpointDigest(val digest: Digest)

CheckpointId

@Serializable

data class CheckpointId(val digest: String)

CheckpointPage

@Serializable

data class CheckpointPage(val data: List<Checkpoint>, val nextCursor: String? = "", val hasNextPage: Boolean = false)

CheckpointSequenceNumber

@Serializable

data class CheckpointSequenceNumber(val sequenceNumber: Long)

CheckpointSequenceNumberResult

@Serializable

data class CheckpointSequenceNumberResult(val value: CheckpointSequenceNumber)

CheckpointSummary

@Serializable

data class CheckpointSummary(val contentsDigest: CheckpointContentsDigest, val endOfEpochData: EndOfEpochData, val epoch: Long, val epochRollingGasCostSummary: GasCostSummary, val networkTotalTransactions: Long, val previousDigest: CheckpointDigest, val sequenceNumber: Long, val timestampMs: Long, val versionSpecificData: VersionSpecificData)

CoinData

@Serializable

data class CoinData(val coinType: String, val coinObjectId: String, val version: Long, val digest: String, val balance: Long, val lockedUntilEpoch: Long? = null, val previousTransaction: String?)

CoinObjectCount

@Serializable

data class CoinObjectCount(val type: String, val format: String, val minimum: Int)

CoinPage

@Serializable

data class CoinPage(val data: List<CoinData> = emptyList(), val nextCursor: String? = null, val hasNextPage: Boolean)

CoinType

@Serializable

data class CoinType(val type: String)

Command

@Serializable

open class Command

CommitteeInfo

@Serializable

abstract class CommitteeInfo

Components

@Serializable

data class Components(val schemas: SchemaItem)

Contact

@Serializable

data class Contact(val name: String, val url: String, val email: String)

Content

@Serializable

data class Content(val dataType: String, val type: String, val hasPublicTransfer: Boolean, val fields: Fields)

Data

@Serializable

data class Data(val messageVersion: String, val transaction: DataTransaction, val sender: String, val gasData: GasData)

DataTransaction

@Serializable

data class DataTransaction(val kind: String, val inputs: List<DataTransactionInput> = emptyList(), val transactions: List<TransactionKind> = emptyList())

DataTransactionInput

@Serializable

abstract class DataTransactionInput

DelegatedStake

@Serializable

data class DelegatedStake(val validatorAddress: String, val stakingPool: String, val stakes: List<Stake>)

Details

@Serializable

data class Details(val objectId: String, val version: Int, val digest: Digest, val type: String, val owner: Owner_, val previousTransaction: Transaction, val storageRebate: Int, val content: Content)

DevInspectResults

@Serializable

data class DevInspectResults(val effects: List<TransactionEffect>, val event: List<Event>, val results: List<Array<Pair<UInt, SuiExecutionResultOrString>>>)

Digest

@Serializable

data class Digest(val value: String)

DiscoverBalance

@Serializable

data class DiscoverBalance(val type: String, val required: List<String>, val properties: Properties)

DiscoverBalanceChange

@Serializable

data class DiscoverBalanceChange(val type: String, val required: List<String>)

Discovery

@Serializable

data class Discovery(val openrpc: String, val info: Info, val methods: List<Method>)

DryRunTransactionBlockResponse

@Serializable

data class DryRunTransactionBlockResponse(val effects: TransactionBlockEffects, val events: List<Event>, val objectChanges: List<ObjectChange>, val balanceChanges: List<BalanceChange>, val input: TransactionBlockData)

DynamicFieldName

@Serializable

data class DynamicFieldName(val type: String, val value: String)

Effects

@Serializable

data class Effects(val messageVersion: String, val status: Status, val executedEpoch: String, val gasUsed: GasUsed, val modifiedAtVersions: List<AtVersion> = emptyList(), val sharedObjects: List<SharedObject> = emptyList(), val transactionDigest: String, val created: List<Object> = emptyList(), val mutated: List<Object> = emptyList(), val gasObject: GasObject, val eventsDigest: String = "", val dependencies: List<String> = emptyList())

EndOfEpochData

@Serializable

data class EndOfEpochData(val value: String)

EpochId

@Serializable

data class EpochId(val id: String)

Event

@Serializable

data class Event(val id: EventID, val packageId: String, val transactionModule: String, val sender: String, val type: String, val parsedJson: String, val bcs: String)

EventEnvelope

@Serializable

data class EventEnvelope(val id: EventID, val packageId: String, val transactionModule: String, val sender: String, val type: String, val parsedJson: EventParsedJson, val bcs: String, val timestampMs: String)

EventFilter

@Serializable(with = EventFilterSerializer::class)

open class EventFilter

EventFilterMutable

abstract class EventFilterMutable

EventID

@Serializable

data class EventID(val txDigest: String, val eventSeq: Long)

EventPage

@Serializable

data class EventPage(val data: List<EventEnvelope>, val nextCursor: NextCursor?, val hasNextPage: Boolean)

EventParsedJson

@Serializable(with = EventParsedJsonSerializer::class)

data class EventParsedJson(val data: String)

EventResponse

@Serializable(with = EventResponseSerializer::class)

sealed class EventResponse

EventTmp

@Serializable

abstract class EventTmp

ExecuteTransactionRequestType

enum ExecuteTransactionRequestType : Enum<ExecuteTransactionRequestType>

FaucetResponse

@Serializable(with = FaucetResponseSerializer::class)

sealed class FaucetResponse

Fields

@Serializable

data class Fields(val balance: Balance, val id: ID)

Filter

@Serializable

data class Filter(val condition: FilterCondition)

FilterCondition

@Serializable

sealed class FilterCondition

Friend

@Serializable

data class Friend(val address: String, val name: String)

Gas

@Serializable

data class Gas(val objectId: String, val version: Int, val digest: String)

GasCostSummary

@Serializable

data class GasCostSummary(val computationCost: Long, val storageCost: Long, val storageRebate: Long)

GasData

@Serializable

data class GasData(val payment: List<ObjectReference>, val owner: String, val price: ULong, val budget: ULong)

GasObject

@Serializable

data class GasObject(val owner: Owner.AddressOwner, val reference: ObjectReference)

GasPrice

@Serializable

data class GasPrice(val cost: Long)

GasUsed

@Serializable

data class GasUsed(val computationCost: String, val storageCost: String, val storageRebate: String, val nonRefundableStorageFee: String)

@Serializable

data class ID(val value: String)

ImmOrOwnedMoveObject

@Serializable

data class ImmOrOwnedMoveObject(val objectId: String, val version: Int, val digest: String)

Info

@Serializable

data class Info(val title: String, val description: String, val contact: Contact, val license: License, val version: String)

Input

@Serializable

data class Input(val type: String, val valueType: String, val value: String)

Intent

@Serializable

data class Intent(val scope: IntentScope, val version: IntentVersion, val appId: AppId)

IntentMessage

@Serializable

data class IntentMessage<T>(val intent: Intent, val value: T)

IntentScope

@Serializable

enum IntentScope : Enum<IntentScope>

IntentType

@Serializable

enum IntentType : Enum<IntentType>

IntentVersion

@Serializable

enum IntentVersion : Enum<IntentVersion>

License

@Serializable

data class License(val name: String, val url: String)

LoadedChildObject

@Serializable

data class LoadedChildObject(val objectId: String, val sequenceNumber: String)

LoadedChildObjectsResponse

@Serializable

data class LoadedChildObjectsResponse(val loadedChildObjects: List<LoadedChildObject>)

LockedBalance

@Serializable

class LockedBalance

LockedBalanceProperties

@Serializable

data class LockedBalanceProperties(val type: String, val additionalProperties: AdditionalProperties)

MakeMoveVecBuilder

class MakeMoveVecBuilder : Builder

MergeCoinsBuilder

class MergeCoinsBuilder : Builder

Method

@Serializable

data class Method(val name: String, val tags: List<Tag>, val description: String = "", val params: List<Param>, val result: Result)

ModuleExposedFunction

@Serializable

data class ModuleExposedFunction(val name: String, val normalized: MoveNormalizedFunction)

MoveCallBuilder

class MoveCallBuilder : Builder

MoveFunctionArgType

@Serializable(with = MoveFunctionArgTypeSerializer::class)

abstract class MoveFunctionArgType

MoveFunctionParameter

@Serializable(with = MoveNormalizedFunctionParameterSerializer::class)

abstract class MoveFunctionParameter

MoveNormalizedFunction

@Serializable

data class MoveNormalizedFunction(val visibility: String, val isEntry: Boolean, val typeParameters: List<SuiMoveAbilitySet> = emptyList(), val parameters: List<MoveFunctionParameter> = emptyList(), val returnType: List<MoveFunctionParameter>)

MoveNormalizedModule

@Serializable

data class MoveNormalizedModule(val fileFormatVersion: Long, val address: String, val name: String, val friends: List<Friend> = emptyList(), val structs: String, val exposedFunctions: List<ModuleExposedFunction> = emptyList())

NameServicePage

@Serializable

data class NameServicePage(val data: List<String>, val hasNextPage: Boolean, val nextCursor: String? = null)

NextCursor

@Serializable

data class NextCursor(val txDigest: String, val eventSeq: Long)

Object

@Serializable

data class Object(val owner: Owner, val reference: ObjectReference)

ObjectArg

@Serializable

sealed class ObjectArg

ObjectChange

@Serializable

abstract class ObjectChange

ObjectData

@Serializable

data class ObjectData(val data: ObjectInfo)

ObjectId

@Serializable

data class ObjectId(val hash: String)

ObjectInfo

@Serializable

data class ObjectInfo(val objectId: String, val version: String, val digest: String, val type: String, val previousTransaction: String, val storageRebateL: String)

ObjectReference

@Serializable

data class ObjectReference(val objectId: String, val version: Long, val digest: String)

ObjectResponse

@Serializable(with = ObjectResponseSerializer::class)

sealed class ObjectResponse

ObjectResponseQuery

@Serializable

data class ObjectResponseQuery(val filter: Filter, val options: ObjectResponse.ObjectDataOptions)

ObjectsPage

@Serializable

data class ObjectsPage(val data: List<ObjectData>, val nextCursor: String? = null, val hasNextPage: Boolean)

Operator

enum Operator : Enum<Operator>

Option

@Serializable(with = OptionSerializer::class)

sealed class Option<out T>

Owner

interface Owner

Owner_

@Serializable

data class Owner_(val address: SuiAddress)

Param

@Serializable

data class Param(val name: String, val description: String? = null, val required: Boolean? = null, val schema: Schema)

PastObjectRequest

@Serializable

data class PastObjectRequest(val objectId: ObjectId, val version: Long)

PastObjectResponse

@Serializable

data class PastObjectResponse(val status: String, val details: ObjectResponse)

Payment

@Serializable

data class Payment(val objectId: String, val version: Long, val digest: String)

ProgrammableMoveCall

@Serializable

data class ProgrammableMoveCall(val pakage: ObjectId, val module: String, val function: String, val typeArguments: List<TypeTag>, val arguments: List<Argument>)

ProgrammableTransaction

@Serializable

data class ProgrammableTransaction(val inputs: List<CallArg>, val commands: List<Command>) : TransactionKind

ProgrammableTransactionBuilder

class ProgrammableTransactionBuilder

Properties

@Serializable

data class Properties(val coinObjectCount: CoinObjectCount, val coinType: CoinType, val lockedBalance: LockedBalanceProperties, val totalBalance: TotalBalance)

PublishBuilder

class PublishBuilder : Builder

Response

@Serializable(with = ResponseSerializer::class)

sealed class Response<out T>

A sealed class representing the response of an API call.

Result

@Serializable

data class Result(val name: String, val required: Boolean? = null, val schema: Schema)

Schema

@Serializable

data class Schema(val type: String? = null, val format: String? = null, val minimum: Double? = null, val ref: String? = null)

SchemaItem

@Serializable

data class SchemaItem(val authorityPublicKeyBytes: AuthorityPublicKeyBytes, val balance: DiscoverBalance, val balanceChange: DiscoverBalanceChange)

SenderSignedData

@Serializable

data class SenderSignedData(val senderSignedTransactions: List<SenderSignedTransaction>)

SenderSignedTransaction

@Serializable

data class SenderSignedTransaction(val intentMessage: IntentMessage<TransactionData>, val txSignatures: List<String>)

SharedObject

@Serializable

data class SharedObject(val objectId: String, val version: Long, val digest: String)

SplitCoinsBuilder

class SplitCoinsBuilder : Builder

Stake

@Serializable

data class Stake(val stakedSuiId: String, val stakeRequestEpoch: String, val stakeActiveEpoch: String, val principal: String, val status: String, val estimatedReward: String = "")

Status

@Serializable

data class Status(val status: String)

SuiAddress

@Serializable

data class SuiAddress(val pubKey: String)

SuiCoinMetadata

@Serializable

data class SuiCoinMetadata(val decimals: UByte, val description: String, val iconUrl: String?, val id: String = "", val name: String, val symbol: String)

SuiExecutionResultOrString

@Serializable

sealed class SuiExecutionResultOrString

SuiMoveAbilitySet

@Serializable

data class SuiMoveAbilitySet(val abilities: List<String> = emptyList())

SuiObjectInfo

data class SuiObjectInfo(var objectId: String, val version: Long, val digest: Digest, val type: String, val owner: Owner.AddressOwner, val previousTransaction: Transaction)

SuiObjectResponse

@Serializable

data class SuiObjectResponse(val status: Status, val details: Details)

SuiSystemStateSummary

@Serializable

data class SuiSystemStateSummary(val epoch: Long, val protocolVersion: Long, val systemStateVersion: Long, val storageFundTotalObjectStorageRebates: Long, val storageFundNonRefundableBalance: Long, val referenceGasPrice: Long, val safeMode: Boolean, val safeModeStorageRewards: Long, val safeModeComputationRewards: Long, val safeModeStorageRebates: Long, val safeModeNonRefundableStorageFee: Long, val epochStartTimestampMs: Long, val epochDurationMs: Long, val stakeSubsidyStartEpoch: Long, val maxValidatorCount: Int, val minValidatorJoiningStake: Long, val validatorLowStakeThreshold: Long, val validatorVeryLowStakeThreshold: Long, val validatorLowStakeGracePeriod: Long, val stakeSubsidyBalance: String, val stakeSubsidyDistributionCounter: Long, val stakeSubsidyCurrentDistributionAmount: Long, val stakeSubsidyPeriodLength: Long, val stakeSubsidyDecreaseRate: Long, val totalStake: Long, val activeValidators: List<SuiValidatorSummary>, val pendingActiveValidatorsId: String, val pendingActiveValidatorsSize: Long, val pendingRemovals: List<String>, val stakingPoolMappingsId: String, val stakingPoolMappingsSize: Long, val inactivePoolsId: String, val inactivePoolsSize: Int, val validatorCandidatesId: String, val validatorCandidatesSize: Long, val atRiskValidators: List<String>, val validatorReportRecords: List<ValidatorReportRecord>)

Latest SUI system state object on-chain

SuiTransactionBuilderMode

enum SuiTransactionBuilderMode : Enum<SuiTransactionBuilderMode>

SuiValidatorSummary

@Serializable

data class SuiValidatorSummary(val suiAddress: String, val protocolPubkeyBytes: String, val networkPubkeyBytes: String, val workerPubkeyBytes: String, val proofOfPossessionBytes: String, val name: String, val description: String, val imageUrl: String, val projectUrl: String, val netAddress: String, val p2pAddress: String, val primaryAddress: String, val workerAddress: String, val nextEpochProtocolPubkeyBytes: String? = null, val nextEpochProofOfPossession: String? = null, val nextEpochNetworkPubkeyBytes: String? = null, val nextEpochWorkerPubkeyBytes: String? = null, val nextEpochNetAddress: String? = null, val nextEpochP2pAddress: String? = null, val nextEpochPrimaryAddress: String? = null, val nextEpochWorkerAddress: String? = null, val votingPower: Long, val operationCapId: String, val gasPrice: Long, val commissionRate: Long, val nextEpochStake: Long, val nextEpochGasPrice: Long, val nextEpochCommissionRate: Long, val stakingPoolId: String, val stakingPoolActivationEpoch: Long, val stakingPoolDeactivationEpoch: Long? = null, val stakingPoolSuiBalance: Long, val rewardsPool: Long, val poolTokenBalance: Long, val pendingStake: Long, val pendingTotalSuiWithdraw: Long, val pendingPoolTokenWithdraw: Long, val exchangeRatesId: String, val exchangeRatesSize: Long)

A summary of a validator's information.

Supply

@Serializable

data class Supply(val value: Long)

Tag

@Serializable

data class Tag(val name: String)

TotalBalance

@Serializable

data class TotalBalance(val type: String, val format: String, val minimum: Int)

Transaction

@Serializable

data class Transaction(val data: Data, val txSignatures: List<String>)

Transaction1

@Serializable

data class Transaction1(val kind: String, val inputs: List<Input>)

TransactionBlock

@Serializable

data class TransactionBlock(val digest: String)

TransactionBlockBuilderMode

enum TransactionBlockBuilderMode : Enum<TransactionBlockBuilderMode>

TransactionBlockBytes

@Serializable

data class TransactionBlockBytes(val txBytes: String, val gas: List<Gas>)

TransactionBlockData

@Serializable

data class TransactionBlockData(val messageVersion: String, val transaction: Transaction1, val sender: String, val gasData: GasData)

TransactionBlockEffects

@Serializable

data class TransactionBlockEffects(val messageVersion: String, val status: Status, val executedEpoch: String, val gasUsed: GasUsed, val modifiedAtVersions: List<AtVersion>, val transactionDigest: String, val mutated: List<Object> = emptyList(), val gasObject: GasObject, val dependencies: List<String>)

TransactionBlockResponse

@Serializable

data class TransactionBlockResponse(val digest: String, val transaction: Transaction? = null, val rawTransaction: String = "", val effects: Effects? = null, val events: List<Event> = emptyList(), val objectChanges: List<ObjectChange> = emptyList(), val balanceChanges: List<BalanceChange> = emptyList(), val timestampMs: Long, val checkpoint: Long, val errors: List<String> = emptyList())

TransactionBlockResponseOptions

@Serializable

data class TransactionBlockResponseOptions(val showInput: Boolean, val showRawInput: Boolean, val showEffects: Boolean, val showEvents: Boolean, val showObjectChanges: Boolean, val showBalanceChanges: Boolean)

The options for the transaction response.

TransactionBlockResponseQuery

@Serializable

data class TransactionBlockResponseQuery(val filter: TransactionBlockResponseQueryFilter? = null, val options: TransactionBlockResponseOptions? = null)

The transaction query criteria.

TransactionBlockResponseQueryFilter

@Serializable

data class TransactionBlockResponseQueryFilter(val inputObject: String? = null)

TransactionBlocksPage

@Serializable

data class TransactionBlocksPage(val data: List<TransactionBlock>, val nextCursor: String? = null, val hasNextPage: Boolean)

TransactionData

@Serializable

sealed class TransactionData

TransactionDataComposer

object TransactionDataComposer

TransactionDataV1

@Serializable

data class TransactionDataV1(val kind: TransactionKind, val sender: SuiAddress, val gasData: GasData, val expiration: TransactionExpiration) : TransactionDataVersion

TransactionDataVersion

interface TransactionDataVersion

TransactionDigest

@Serializable

data class TransactionDigest(val value: String)

TransactionDigests

@Serializable

data class TransactionDigests(val vec: List<String>)

TransactionEffect

@Serializable

data class TransactionEffect(val value: String)

TransactionExpiration

@Serializable

sealed class TransactionExpiration

TransactionFilter

@Serializable(with = TransactionFilterSerializer::class)

open class TransactionFilter

TransactionFilterMutable

abstract class TransactionFilterMutable

TransactionKind

@Serializable

sealed class TransactionKind

TransactionSubscriptionResponse

@Serializable(with = TxnSubResSerializer::class)

sealed class TransactionSubscriptionResponse

TransferObjectsBuilder

class TransferObjectsBuilder : Builder

TransferredGasObject

@Serializable

data class TransferredGasObject(val amount: String, val id: String, val transferTxDigest: String)

TypeTag

@Serializable

sealed class TypeTag

U128

object U128 : TypeTag

U16

object U16 : TypeTag

U256

object U256 : TypeTag

U32

object U32 : TypeTag

U64

object U64 : TypeTag

object U8 : TypeTag

UpgradeBuilder

class UpgradeBuilder : Builder

Validator

@Serializable

data class Validator(val publicKey: String, val weight: Int)

ValidatorApy

@Serializable

data class ValidatorApy(val address: String, val apy: Double)

ValidatorApys

@Serializable

data class ValidatorApys(val apys: List<ValidatorApy>, val epoch: String)

ValidatorMetadata

@Serializable

data class ValidatorMetadata(val suiAddress: String, val pubkeyBytes: List<Int>, val networkPubkeyBytes: List<Int>, val workerPubkeyBytes: List<Int>, val proofOfPossessionBytes: List<Int>, val name: String, val description: String, val imageUrl: String, val projectUrl: String, val netAddress: List<Int>, val consensusAddress: List<Int>, val workerAddress: List<Int>, val nextEpochStake: Int, val nextEpochDelegation: Long, val nextEpochGasPrice: Int, val nextEpochCommissionRate: Int)

ValidatorReportRecord

@Serializable