io.sui

Interface SuiClient

All Known Implementing Classes:

SuiClientImpl

public interface SuiClient

The interface Sui client.

Since:

2022.11

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<CommitteeInfoResponse>	getCommitteeInfo(java.lang.Long epoch) Gets committee info.
java.util.concurrent.CompletableFuture<PaginatedEvents>	getEvents(EventQuery query, EventId cursor, int limit, boolean isDescOrder) Gets events.
java.util.concurrent.CompletableFuture<java.util.List<MoveFunctionArgType>>	getMoveFunctionArgTypes(java.lang.String suiPackage, java.lang.String module, java.lang.String function) Gets move function arg types.
java.util.concurrent.CompletableFuture<MoveNormalizedFunction>	getNormalizedMoveFunction(java.lang.String suiPackage, java.lang.String module, java.lang.String function) Gets normalized move function.
java.util.concurrent.CompletableFuture<MoveNormalizedModule>	getNormalizedMoveModule(java.lang.String suiPackage, java.lang.String module) Gets normalized move module.
java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,MoveNormalizedModule>>	getNormalizedMoveModulesByPackage(java.lang.String packageId) Gets normalized move modules by package.
java.util.concurrent.CompletableFuture<MoveNormalizedStruct>	getNormalizedMoveStruct(java.lang.String suiPackage, java.lang.String module, java.lang.String struct)
java.util.concurrent.CompletableFuture<GetObjectResponse>	getObject(java.lang.String id) Gets object.
java.util.concurrent.CompletableFuture<java.util.List<SuiObjectInfo>>	getObjectsOwnedByAddress(java.lang.String address) Gets objects owned by address.
java.util.concurrent.CompletableFuture<java.util.List<SuiObjectInfo>>	getObjectsOwnedByObject(java.lang.String objectId) Gets objects owned by object.
java.util.concurrent.CompletableFuture<GetObjectResponse>	getRawObject(java.lang.String id) Gets raw object.
java.util.concurrent.CompletableFuture<java.lang.Long>	getTotalTransactionNumber() Gets total transaction number.
java.util.concurrent.CompletableFuture<TransactionResponse>	getTransaction(java.lang.String digest) Gets transaction.
java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>>	getTransactionsInRange(java.lang.Long start, java.lang.Long end) Gets transactions in range.

Method Detail

getObject

java.util.concurrent.CompletableFuture<GetObjectResponse> getObject(java.lang.String id)

Gets object.

Parameters:

id - the id

Returns:

the object

getObjectsOwnedByAddress

java.util.concurrent.CompletableFuture<java.util.List<SuiObjectInfo>> getObjectsOwnedByAddress(java.lang.String address)

Gets objects owned by address.

Parameters:

address - the address

Returns:

the objects owned by address

getObjectsOwnedByObject

java.util.concurrent.CompletableFuture<java.util.List<SuiObjectInfo>> getObjectsOwnedByObject(java.lang.String objectId)

Gets objects owned by object.

Parameters:

objectId - the object id

Returns:

the objects owned by object

getRawObject

java.util.concurrent.CompletableFuture<GetObjectResponse> getRawObject(java.lang.String id)

Gets raw object.

Parameters:

id - the id

Returns:

the raw object

getTotalTransactionNumber

java.util.concurrent.CompletableFuture<java.lang.Long> getTotalTransactionNumber()

Gets total transaction number.

Returns:

the total transaction number

getTransaction

java.util.concurrent.CompletableFuture<TransactionResponse> getTransaction(java.lang.String digest)

Gets transaction.

Parameters:

digest - the digest

Returns:

the transaction

getTransactionsInRange

java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> getTransactionsInRange(java.lang.Long start,
                                                                                                java.lang.Long end)

Gets transactions in range.

Parameters:

start - the start

end - the end

Returns:

the transactions in range

getEvents

java.util.concurrent.CompletableFuture<PaginatedEvents> getEvents(EventQuery query,
                                                                  EventId cursor,
                                                                  int limit,
                                                                  boolean isDescOrder)

Gets events.

Parameters:

query - the query

cursor - the cursor

limit - the limit

isDescOrder - the is desc order

Returns:

the events

getNormalizedMoveModulesByPackage

java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,MoveNormalizedModule>> getNormalizedMoveModulesByPackage(java.lang.String packageId)

Gets normalized move modules by package.

Parameters:

packageId - the package id

Returns:

the normalized move modules by package

getCommitteeInfo

java.util.concurrent.CompletableFuture<CommitteeInfoResponse> getCommitteeInfo(java.lang.Long epoch)

Gets committee info.

Parameters:

epoch - the epoch

Returns:

the committee info

getMoveFunctionArgTypes

java.util.concurrent.CompletableFuture<java.util.List<MoveFunctionArgType>> getMoveFunctionArgTypes(java.lang.String suiPackage,
                                                                                                    java.lang.String module,
                                                                                                    java.lang.String function)

Gets move function arg types.

Parameters:

suiPackage - the sui package

module - the module

function - the function

Returns:

the move function arg types

getNormalizedMoveFunction

java.util.concurrent.CompletableFuture<MoveNormalizedFunction> getNormalizedMoveFunction(java.lang.String suiPackage,
                                                                                         java.lang.String module,
                                                                                         java.lang.String function)

Gets normalized move function.

Parameters:

suiPackage - the sui package

module - the module

function - the function

Returns:

the normalized move function

getNormalizedMoveModule

java.util.concurrent.CompletableFuture<MoveNormalizedModule> getNormalizedMoveModule(java.lang.String suiPackage,
                                                                                     java.lang.String module)

Gets normalized move module.

Parameters:

suiPackage - the sui package

module - the module

Returns:

the normalized move module

getNormalizedMoveStruct

java.util.concurrent.CompletableFuture<MoveNormalizedStruct> getNormalizedMoveStruct(java.lang.String suiPackage,
                                                                                     java.lang.String module,
                                                                                     java.lang.String struct)