Ksui/xyz.mcxross.ksui.generated.type

Package-level declarations

Types

AccumulatorRootCreateTransaction

class AccumulatorRootCreateTransaction

System transaction for creating the accumulator root.

Address

class Address

AddressOwner

class AddressOwner

Object is exclusively owned by a single address, and is mutable.

AuthenticatorStateCreateTransaction

class AuthenticatorStateCreateTransaction

System transaction for creating the on-chain state used by zkLogin.

AuthenticatorStateExpireTransaction

class AuthenticatorStateExpireTransaction

System transaction that is executed at the end of an epoch to expire JSON Web Keys (JWKs) that are no longer valid, based on their associated epoch. This is part of the on-chain state management for zkLogin and authentication.

AuthenticatorStateUpdateTransaction

class AuthenticatorStateUpdateTransaction

Balance

class Balance

The total balance for a particular coin type.

BalanceChange

class BalanceChange

Effects to the balance (sum of coin values per coin type) of addresses and objects.

BalanceChangeConnection

class BalanceChangeConnection

BalanceConnection

class BalanceConnection

Base64

class Base64

String containing Base64-encoded binary data.

BigInt

class BigInt

String representation of an arbitrary width, possibly signed integer

BridgeCommitteeInitTransaction

class BridgeCommitteeInitTransaction

System transaction for initializing bridge committee.

BridgeStateCreateTransaction

class BridgeStateCreateTransaction

System transaction for creating bridge state for cross-chain operations.

ChangeEpochTransaction

class ChangeEpochTransaction

A system transaction that updates epoch information on-chain (increments the current epoch). Executed by the system once per epoch, without using gas. Epoch change transactions cannot be submitted by users, because validators will refuse to sign them.

Checkpoint

class Checkpoint

Checkpoints contain finalized transactions and are used for node synchronization and global transaction ordering.

CheckpointConnection

class CheckpointConnection

CoinDenyListStateCreateTransaction

class CoinDenyListStateCreateTransaction

System transaction for creating the coin deny list state.

CoinMetadata

class CoinMetadata

An object representing metadata about a coin type.

CoinRegistryCreateTransaction

class CoinRegistryCreateTransaction

System transaction for creating the coin registry.

CommandOutput

class CommandOutput

A value produced or modified during command execution.

CommandResult

class CommandResult

The intermediate results for each command of a transaction simulation.

ConsensusAddressOwner

class ConsensusAddressOwner

Object is exclusively owned by a single adderss and sequenced via consensus.

ConsensusCommitPrologueTransaction

class ConsensusCommitPrologueTransaction

System transaction that runs at the beginning of a checkpoint, and is responsible for setting the current value of the clock, based on the timestamp from consensus.

DateTime

class DateTime

ISO-8601 Date and Time: RFC3339 in UTC with format: YYYY-MM-DDTHH:MM:SS.mmmZ. Note that the milliseconds part is optional, and it may be omitted if its value is 0.

Display

class Display

A rendered JSON blob based on an on-chain template.

DynamicField

class DynamicField

Dynamic fields are heterogenous fields that can be added or removed from an object at runtime. Their names are arbitrary Move values that have copy, drop, and store.

DynamicFieldConnection

class DynamicFieldConnection

DynamicFieldName

data class DynamicFieldName(val type: String, val bcs: Any)

A description of a dynamic field's name.

DynamicFieldValue

class DynamicFieldValue

The value of a dynamic field (MoveValue) or dynamic object field (MoveObject).

EndOfEpochTransaction

class EndOfEpochTransaction

System transaction that supersedes ChangeEpochTransaction as the new way to run transactions at the end of an epoch. Behaves similarly to ChangeEpochTransaction but can accommodate other optional transactions to run at the end of the epoch.

EndOfEpochTransactionKind

class EndOfEpochTransactionKind

EndOfEpochTransactionKindConnection

class EndOfEpochTransactionKindConnection

Epoch

class Epoch

Activity on Sui is partitioned in time, into epochs.

Event

class Event

EventConnection

class EventConnection

EventFilter

data class EventFilter(val afterCheckpoint: Optional<Any?> = Optional.Absent, val atCheckpoint: Optional<Any?> = Optional.Absent, val beforeCheckpoint: Optional<Any?> = Optional.Absent, val sender: Optional<Any?> = Optional.Absent, val module: Optional<String?> = Optional.Absent, val type: Optional<String?> = Optional.Absent)

ExecutionError

class ExecutionError

Represents execution error information for failed transactions.

ExecutionResult

class ExecutionResult

The execution result of a transaction, including the transaction effects and any potential errors due to signing or quorum-driving.

ExecutionStatus

enum ExecutionStatus : Enum<ExecutionStatus>

The execution status of this transaction: success or failure.

FeatureFlag

class FeatureFlag

A boolean protocol configuration.

GasCoin

class GasCoin

Access to the gas inputs, after they have been smashed into one coin. The gas coin can only be used by reference, except for with TransferObjectsTransaction that can accept it by value.

GasCostSummary

class GasCostSummary

Summary of charges from transactions.

GasEffects

class GasEffects

Effects related to gas (costs incurred and the identity of the smashed gas object returned).

GenesisTransaction

class GenesisTransaction

System transaction that initializes the network and writes the initial set of objects on-chain.

GraphQLBoolean

class GraphQLBoolean

The Boolean scalar type represents true or false.

GraphQLFloat

class GraphQLFloat

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

GraphQLID

class GraphQLID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

GraphQLInt

class GraphQLInt

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

GraphQLString

class GraphQLString

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

IAddressable

class IAddressable

Interface implemented by GraphQL types representing entities that are identified by an address.

Immutable

class Immutable

Object is accessible to all addresses, and is immutable.

IMoveDatatype

class IMoveDatatype

Interface implemented by all GraphQL types that represent a Move datatype definition (either a struct or an enum definition).

IMoveObject

class IMoveObject

Interface implemented by types that represent a Move object on-chain (A Move value whose type has key).

Input

class Input

IObject

class IObject

Interface implemented by versioned on-chain values that are addressable by an ID (also referred to as its address). This includes Move objects and packages.

JSON

class JSON

Arbitrary JSON data.

MoveAbility

enum MoveAbility : Enum<MoveAbility>

Abilities are keywords in Sui Move that define how types behave at the compiler level.

MoveDatatypeTypeParameter

class MoveDatatypeTypeParameter

Declaration of a type parameter on a Move struct.

MoveEnum

class MoveEnum

Description of an enum type, defined in a Move module.

MoveEnumConnection

class MoveEnumConnection

MoveEnumVariant

class MoveEnumVariant

MoveField

class MoveField

MoveFunction

class MoveFunction

A function defined in a Move module.

MoveFunctionConnection

class MoveFunctionConnection

MoveFunctionTypeParameter

class MoveFunctionTypeParameter

Declaration of a type parameter on a Move function.

MoveModule

class MoveModule

Modules are a unit of code organization in Move.

MoveModuleConnection

class MoveModuleConnection

MoveObject

class MoveObject

A MoveObject is a kind of Object that reprsents data stored on-chain.

MoveObjectConnection

class MoveObjectConnection

MovePackage

class MovePackage

A MovePackage is a kind of Object that represents code that has been published on-chain. It exposes information about its modules, type definitions, functions, and dependencies.

MoveStruct

class MoveStruct

Description of a struct type, defined in a Move module.

MoveStructConnection

class MoveStructConnection

MoveType

class MoveType

Represents instances of concrete types (no type parameters, no references).

MoveTypeLayout

class MoveTypeLayout

The shape of a concrete Move Type (a type with all its type parameters instantiated with concrete types), corresponding to the following recursive type:

MoveTypeSignature

class MoveTypeSignature

The signature of a concrete Move Type (a type with all its type parameters instantiated with concrete types, that contains no references), corresponding to the following recursive type:

MoveValue

class MoveValue

MoveVisibility

enum MoveVisibility : Enum<MoveVisibility>

The visibility modifier describes which modules can access this module member.

Mutation

class Mutation

Mutations are used to write to the Sui network.

Object

class Object

An Object on Sui is either a typed value (a Move Object) or a Package (modules containing functions and types).

ObjectChange

class ObjectChange

ObjectChangeConnection

class ObjectChangeConnection

ObjectFilter

data class ObjectFilter(val ownerKind: Optional<OwnerKind?> = Optional.Absent, val owner: Optional<Any?> = Optional.Absent, val type: Optional<String?> = Optional.Absent)

A filter over the live object set, the filter can be one of:

ObjectKey

data class ObjectKey(val address: Any, val version: Optional<Any?> = Optional.Absent, val rootVersion: Optional<Any?> = Optional.Absent, val atCheckpoint: Optional<Any?> = Optional.Absent)

Identifies a specific version of an object.

ObjectOwner

class ObjectOwner

Object is exclusively owned by a single object, and is mutable. Note that the owning object may be inaccessible because it is wrapped.

OpenMoveType

class OpenMoveType

Represents types that could contain references or free type parameters. Such types can appear as function parameters, in fields of structs, or as actual type parameter.

OpenMoveTypeSignature

class OpenMoveTypeSignature

The shape of an abstract Move Type (a type that can contain free type parameters, and can optionally be taken by reference), corresponding to the following recursive type:

Owner

class Owner

The object's owner kind.

OwnerKind

enum OwnerKind : Enum<OwnerKind>

Filter on who owns an object.

PageInfo

class PageInfo

Information about pagination in a connection

ProgrammableSystemTransaction

class ProgrammableSystemTransaction

ProgrammableSystemTransaction is identical to ProgrammableTransaction, but GraphQL does not allow multiple variants with the same type.

ProgrammableTransaction

class ProgrammableTransaction

ProtocolConfig

class ProtocolConfig

A protocol configuration that can hold an arbitrary value (or no value at all).

ProtocolConfigs

class ProtocolConfigs

Constants that control how the chain operates.

Query

class Query

RandomnessStateCreateTransaction

class RandomnessStateCreateTransaction

System transaction for creating the on-chain randomness state.

RandomnessStateUpdateTransaction

class RandomnessStateUpdateTransaction

System transaction to update the source of on-chain randomness.

SafeMode

class SafeMode

Shared

class Shared

Object is shared, can be used by any address, and is mutable.

SimulationResult

class SimulationResult

The result of simulating a transaction, including the predicted effects, events, and any errors.

StakeSubsidy

class StakeSubsidy

Parameters that control the distribution of the stake subsidy.

StorageFund

class StorageFund

SUI set aside to account for objects stored on-chain.

StoreExecutionTimeObservationsTransaction

class StoreExecutionTimeObservationsTransaction

System transaction for storing execution time observations.

SuiAddress

class SuiAddress

String containing 32 byte hex-encoded address, with a leading '0x'. Leading zeroes can be omitted on input but will always appear in outputs (SuiAddress in output is guaranteed to be 66 characters long).

SystemParameters

class SystemParameters

Details of the system that are decided during genesis.

Transaction

class Transaction

Description of a transaction, the unit of activity on Sui.

TransactionArgument

class TransactionArgument

An argument to a programmable transaction command.

TransactionConnection

class TransactionConnection

TransactionEffects

class TransactionEffects

The results of executing a transaction.

TransactionFilter

data class TransactionFilter(val afterCheckpoint: Optional<Any?> = Optional.Absent, val atCheckpoint: Optional<Any?> = Optional.Absent, val beforeCheckpoint: Optional<Any?> = Optional.Absent, val function: Optional<String?> = Optional.Absent, val kind: Optional<TransactionKindInput?> = Optional.Absent, val affectedAddress: Optional<Any?> = Optional.Absent, val affectedObject: Optional<Any?> = Optional.Absent, val sentAddress: Optional<Any?> = Optional.Absent)

TransactionKind

class TransactionKind

Different types of transactions that can be executed on the Sui network.

TransactionKindInput

enum TransactionKindInput : Enum<TransactionKindInput>

An input filter selecting for either system or programmable transactions.

TxResult

class TxResult

The result of another command.

UInt53

class UInt53

An unsigned integer that can hold values up to 2^53 - 1. This can be treated similarly to Int, but it is guaranteed to be non-negative, and it may be larger than 2^32 - 1.

UserSignature

class UserSignature

Validator

class Validator

ValidatorAggregatedSignature

class ValidatorAggregatedSignature

ValidatorConnection

class ValidatorConnection

ValidatorCredentials

class ValidatorCredentials

The credentials related fields associated with a validator.

ValidatorSet

class ValidatorSet

Representation of 0x3::validator_set::ValidatorSet.