sui/src/rpc/rpc
library
Classes
ConsensusDeterminedVersionAssignments
SuiApiActiveJWK
SuiApiArgument
SuiApiAuthenticator
SuiApiAuthenticatorStateExpire
SuiApiBalanceChange
SuiApiBalanceResponse
SuiApiCallArg
SuiApiCallArgImmOrOwnedObject
SuiApiCallArgPure
SuiApiCallArgReceiving
SuiApiCallArgSharedObject
SuiApiChangeEpoch
SuiApiCheckPoint
SuiApiCheckpointCommitment
SuiApiCoinMetadataResponse
SuiApiCoinResponse
SuiApiCommitteeInfo
SuiApiConsensusV2
SuiApiDelegatedStake
SuiApiDevInspectArgs
SuiApiDevInspectResult
SuiApiDisplayFields
SuiApiDryRunTransactionBlockResponse
SuiApiDynamicFieldInfo
SuiApiDynamicFieldName
SuiApiECMHLiveObjectSetDigest
SuiApiEndOfEpochData
SuiApiEndOfEpochTransactionKind
SuiApiEndOfEpochTransactionKindAuthenticatorStateCreate
SuiApiEndOfEpochTransactionKindAuthenticatorStateExpire
SuiApiEndOfEpochTransactionKindBridgeCommitteeUpdate
SuiApiEndOfEpochTransactionKindBridgeStateCreate
SuiApiEndOfEpochTransactionKindChangeEpoch
SuiApiEndOfEpochTransactionKindCoinDenyListStateCreate
SuiApiEndOfEpochTransactionKindRandomNessStateCreate
SuiApiEvent
SuiApiEventFilter
SuiApiEventFilterAll
SuiApiEventFilterAny
SuiApiEventFilterMoveEventModule
SuiApiEventFilterMoveEventType
SuiApiEventFilterMoveModule
SuiApiEventFilterSender
SuiApiEventFilterTimeRange
SuiApiEventFilterTransaction
SuiApiEventId
SuiApiExecutionResult
SuiApiExecutionStatus
SuiApiGasCostSummary
SuiApiGasData
SuiApiGetCoinResponse
SuiApiGetDynamicFieldObjectResponse
SuiApiGetDynamicFieldsResponse
SuiApiGetPastObjectRequest
SuiApiJWK
SuiApiJwkId
SuiApiMoveAbilitySet
SuiApiMoveCallTransaction
SuiApiMoveFunctionArgType
SuiApiMoveFunctionArgTypeObject
SuiApiMoveFunctionArgTypePure
SuiApiMoveModuleId
SuiApiMoveNormalizedEnum
SuiApiMoveNormalizedField
SuiApiMoveNormalizedFunction
SuiApiMoveNormalizedModule
SuiApiMoveNormalizedStruct
SuiApiMoveNormalizedType
SuiApiMoveNormalizedTypeMutableReference
SuiApiMoveNormalizedTypePrimitive
SuiApiMoveNormalizedTypeReference
SuiApiMoveNormalizedTypeStruct
SuiApiMoveNormalizedTypeStructObject
SuiApiMoveNormalizedTypeTypeParameter
SuiApiMoveNormalizedTypeVector
SuiApiMoveObject
SuiApiMoveStructTypeParameter
SuiApiObjectChange
SuiApiObjectChangeCreated
SuiApiObjectChangeDeleted
SuiApiObjectChangeMutated
SuiApiObjectChangePublished
SuiApiObjectChangeTransferred
SuiApiObjectChangeWrapped
SuiApiObjectData
SuiApiObjectDataFilter
SuiApiObjectDataFilterAddressOwner
SuiApiObjectDataFilterMatchAll
SuiApiObjectDataFilterMatchAny
SuiApiObjectDataFilterMatchNone
SuiApiObjectDataFilterMoveModule
SuiApiObjectDataFilterObjectId
SuiApiObjectDataFilterObjectIds
SuiApiObjectDataFilterObjectOwner
SuiApiObjectDataFilterObjectVersion
SuiApiObjectDataFilterPackage
SuiApiObjectDataFilterStructType
SuiApiObjectDataOptions
SuiApiObjectError
SuiApiObjectErrorDeleted
SuiApiObjectErrorDisplayError
SuiApiObjectErrorDynamicFieldNotFound
SuiApiObjectErrorNotExists
SuiApiObjectErrorUnknown
SuiApiObjectOwner
SuiApiObjectOwnerAddressOwner
SuiApiObjectOwnerConsensusV2
SuiApiObjectOwnerImmutable
SuiApiObjectOwnerObjectOwner
SuiApiObjectOwnerShared
SuiApiObjectRead
SuiApiObjectReadObjectDeleted
SuiApiObjectReadObjectNotExists
SuiApiObjectReadObjectVersionNoFound
SuiApiObjectReadObjectVersionToHigh
SuiApiObjectReadVersionFound
SuiApiObjectRef
SuiApiObjectResponse
SuiApiObjectResponseQuery
SuiApiObjectVersionHighResponse
SuiApiOwnedObjectRef
SuiApiPaginatedCheckPointResponse
SuiApiPaginatedObjectResponse
SuiApiPaginatedTransactionResponse
SuiApiParsedData
SuiApiParsedDataMoveObject
SuiApiParsedDataPackage
SuiApiProtocolConfig
SuiApiQueryEventsRepose
SuiApiRawDataPackage
SuiApiRawDataResponse
SuiApiResolveNameServiceNamesResponse
SuiApiShared
SuiApiStakeObject
SuiApiSystemStateSummary
SuiApiTransaction
SuiApiTransactionBlock
SuiApiTransactionBlockData
SuiApiTransactionBlockEffectsModifiedAtVersion
SuiApiTransactionBlockKind
SuiApiTransactionBlockKindAuthenticatorStateUpdate
SuiApiTransactionBlockKindChangeEpoch
SuiApiTransactionBlockKindConsensusCommitPrologue
SuiApiTransactionBlockKindConsensusCommitPrologueV2
SuiApiTransactionBlockKindConsensusCommitPrologueV3
SuiApiTransactionBlockKindEndOfEpochTransaction
SuiApiTransactionBlockKindGenesis
SuiApiTransactionBlockKindProgrammableTransaction
SuiApiTransactionBlockKindRandomNessStateUpdate
SuiApiTransactionBlockResponse
SuiApiTransactionBlockResponseOptions
SuiApiTransactionBlockResponseQuery
SuiApiTransactionEffects
SuiApiTransactionFilter
SuiApiTransactionFilterAffectedObject
SuiApiTransactionFilterChangeObject
SuiApiTransactionFilterCheckPoint
SuiApiTransactionFilterFromAddress
SuiApiTransactionFilterFromAndToAddress
SuiApiTransactionFilterFromOrToAddress
SuiApiTransactionFilterInputObject
SuiApiTransactionFilterMoveFunction
SuiApiTransactionFilterToAddress
SuiApiTransactionFilterTransactionKind
SuiApiTransactionFilterTransactionKindIn
SuiApiTransactionMakeMoveVec
SuiApiTransactionMergeCoins
SuiApiTransactionMoveCall
SuiApiTransactionPublish
SuiApiTransactionSplitCoins
SuiApiTransactionTransferObjects
SuiApiTransactionUpgrade
SuiApiTypeOrigin
SuiApiUpgradeInfo
Upgraded package info for the linkage table
SuiApiValidatorApy
SuiApiValidatorsApy
SuiApiValidatorSummary
SuiProvider
Represents an interface to interact with Sui nodes
using JSON-RPC requests.
SuiRequest <RESULT , SERVICERESPONSE >
An abstract class representing Sui JSON-RPC requests with generic response types.
SuiRequestDetails
Represents the details of an Sui JSON-RPC request.
SuiRequestDevInspectTransactionBlock
Runs the transaction in dev-inspect mode. Which allows for nearly any transaction
(or Move call) with any arguments. Detailed results are provided, including
both the transaction effects and any return values.
sui documation
SuiRequestDryRunTransactionBlock
Return transaction execution effects including the gas cost summary, while the effects are not committed to the chain.
sui documation
SuiRequestExecuteTransactionBlock
Execute the transaction and wait for results if desired.
Request types: 1. WaitForEffectsCert: waits for TransactionEffectsCert
and then return to client. This mode is a proxy for transaction finality.
2. WaitForLocalExecution: waits for TransactionEffectsCert and make sure
the node executed the transaction locally before returning the client.
The local execution makes sure this node is aware of this transaction
when client fires subsequent queries. However if the node fails to execute
the transaction locally in a timely manner, a bool type in the response is
set to false to indicated the case. request_type is default to be WaitForEffectsCert
unless options.show_events or options.show_effects is true
sui documation
SuiRequestGetAllBalances
Return the total coin balance for all coin type, owned by the address owner.
sui documation
SuiRequestGetAllCoins
Return all Coin objects owned by an address.
sui documation
SuiRequestGetBalance
Return the total coin balance for one coin type, owned by the address owner.
sui documation
SuiRequestGetChainIdentifier
Return the first four bytes of the chain's genesis checkpoint digest.
sui documation
SuiRequestGetCheckpoint
Return a checkpoint
sui documation
SuiRequestGetCheckpoints
Return paginated list of checkpoints
sui documation
SuiRequestGetCoinMetadata
Return metadata (e.g., symbol, decimals) for a coin.
Note that if the coin's metadata was wrapped in the transaction that published its marker type,
or the latest version of the metadata object is wrapped or deleted, it will not be found.
sui documation
SuiRequestGetCoins
Return all Coin<coin_type> objects owned by an address.
sui documation
SuiRequestGetCommitteeInfo
Return the committee information for the asked epoch.
sui documation
SuiRequestGetDynamicFieldObject
Return the dynamic field object information for a specified object
sui documation
SuiRequestGetDynamicFields
Return the list of dynamic field objects owned by an object.
sui documation
SuiRequestGetEvents
Return transaction events.
sui documation
SuiRequestGetLatestCheckpointSequenceNumber
Return the sequence number of the latest checkpoint that has been executed
sui documation
SuiRequestGetLatestSuiSystemState
Return the latest SUI system state object on-chain.
sui documation
SuiRequestGetMoveFunctionArgTypes
Return the argument types of a Move function, based on normalized Type.
sui documation
SuiRequestGetNormalizedMoveFunction
Return a structured representation of Move function
sui documation
SuiRequestGetNormalizedMoveModule
Return a structured representation of Move module
sui documation
SuiRequestGetNormalizedMoveModulesByPackage
Return structured representations of all modules in the given package
sui documation
SuiRequestGetNormalizedMoveStruct
Return a structured representation of Move struct
sui documation
SuiRequestGetObject
Return the object information for a specified object
sui documation
SuiRequestGetOwnedObjects
Return the list of objects owned by an address. Note that if the address owns more
than QUERY_MAX_RESULT_LIMIT objects, the pagination is not accurate,
because previous page may have been updated when the next page is fetched.
Please use suix_queryObjects if this is a concern.
sui documation
SuiRequestGetReferenceGasPrice
Return the reference gas price for the network.
sui documation
SuiRequestGetStakes
Return all DelegatedStake.
sui documation
SuiRequestGetStakesByIds
Return one or more DelegatedStake. If a Stake was withdrawn its status will be Unstaked.
sui documation
SuiRequestGetTotalSupply
Return total supply for a coin.
sui documation
SuiRequestGetTotalTransactionBlocks
Return the total number of transaction blocks known to the server.
sui documation
SuiRequestGetTransactionBlock
Return the transaction response object.
sui documation
SuiRequestGetValidatorsApy
Return the validator APY
sui documation
SuiRequestMultiGetObjects
Return the object data for a list of objects
sui documation
SuiRequestMultiGetTransactionBlocks
Returns an ordered list of transaction responses The method will throw an error if
the input contains any duplicate or the input size exceeds QUERY_MAX_RESULT_LIMIT
sui documation
SuiRequestProtocolConfig
Return the protocol config table for the given version number.
If the version number is not specified, If none is specified,
the node uses the version of the latest epoch it has processed.
sui documation
SuiRequestQueryEvents
Return list of events for a specified query criteria.
sui documation
SuiRequestQueryTransactionBlocks
Return list of transactions for a specified query criteria.
sui documation
SuiRequestResolveNameServiceAddress
Return the resolved address given resolver and name
sui documation
SuiRequestResolveNameServiceNames
Return the resolved names given address, if multiple names are resolved, the first one is the primary name.
sui documation
SuiRequestTryGetPastObject
Note there is no software-level guarantee/SLA that objects with past
versions can be retrieved by this API, even if the object and version exists/existed.
The result may vary across nodes depending on their pruning policies.
Return the object information for a specified version
sui documation
SuiRequestTryMultiGetPastObjects
Note there is no software-level guarantee/SLA that objects with past
versions can be retrieved by this API, even if the object and version exists/existed.
The result may vary across nodes depending on their pruning policies.
Return the object information for a specified version
sui documation
