Object

interface Object

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

Functions

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

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

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

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

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

Fetches the details of a specific object by its ID.

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

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

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

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

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

Fetches a historical version of a specific object.