Ksui/xyz.mcxross.ksui.protocol/Object

Object

interface Object

Defines the API for fetching and interacting with on-chain objects in the Sui network.

Inheritors

Functions

Link copied to clipboard
abstract suspend fun getDynamicFieldObject(parentId: String, name: DynamicFieldName): <Error class: unknown class><GetDynamicFieldObjectQuery.Data?, <Error class: unknown class>>

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

Link copied to clipboard
abstract suspend fun getDynamicFields(parentId: String, limit: Int? = null, cursor: String? = null): <Error class: unknown class><GetDynamicFieldsQuery.Data?, <Error class: unknown class>>

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

Link copied to clipboard
abstract suspend fun getObject(id: String, options: <Error class: unknown class> = ObjectDataOptions()): <Error class: unknown class><GetObjectQuery.Data?, <Error class: unknown class>>

Fetches the details of a specific object by its ID.

Link copied to clipboard
abstract suspend fun getOwnedObjects(owner: <Error class: unknown class>, limit: Int? = null, cursor: String? = null, options: <Error class: unknown class> = ObjectDataOptions()): <Error class: unknown class><GetOwnedObjectsQuery.Data?, <Error class: unknown class>>

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

Link copied to clipboard
abstract suspend fun multiGetObjects(ids: List<String>, limit: Int? = null, cursor: String? = null, options: <Error class: unknown class> = ObjectDataOptions()): <Error class: unknown class><MultiGetObjectsQuery.Data?, <Error class: unknown class>>

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

Link copied to clipboard
abstract suspend fun tryGetPastObject(id: String, version: Int? = null, options: <Error class: unknown class> = ObjectDataOptions()): <Error class: unknown class><TryGetPastObjectQuery.Data?, <Error class: unknown class>>

Fetches a historical version of a specific object.