Ksui

2.2.2-SNAPSHOT

Ksui/xyz.mcxross.ksui.api/Object

Object

class Object(val config: SuiConfig) : Object

The concrete implementation of the Object interface.

This class provides all the functions related to fetching and interacting with on-chain objects.

Parameters

config

The SuiConfig to use for all API calls.

Constructors

constructor(config: SuiConfig)

Properties

val config: SuiConfig

Functions

getDynamicFieldObject

open suspend override fun getDynamicFieldObject(parentId: String, name: DynamicFieldName): Result<GetDynamicFieldObjectQuery.Data?, SuiError>

Fetches an object that is stored as a dynamic field on a parent object.

getDynamicFields

open suspend override fun getDynamicFields(parentId: String, limit: Int?, cursor: String?): Result<GetDynamicFieldsQuery.Data?, SuiError>

Fetches a paginated list of all dynamic fields owned by a parent object.

open suspend override fun getObject(id: String, options: ObjectDataOptions): Result<GetObjectQuery.Data?, SuiError>

Fetches the details of a specific object by its ID.

getOwnedObjects

open suspend override fun getOwnedObjects(owner: AccountAddress, limit: Int?, cursor: String?, options: ObjectDataOptions): Result<GetOwnedObjectsQuery.Data?, SuiError>

Fetches a paginated list of objects owned by a specific address.

multiGetObjects

open suspend override fun multiGetObjects(ids: List<String>, limit: Int?, cursor: String?, options: ObjectDataOptions): Result<MultiGetObjectsQuery.Data?, SuiError>

Fetches the details of multiple objects in a single batch request.

tryGetPastObject

open suspend override fun tryGetPastObject(id: String, version: Int?, options: ObjectDataOptions): Result<TryGetPastObjectQuery.Data?, SuiError>

Fetches a historical version of a specific object.