sui/sui
library
Classes
ConsensusDeterminedVersionAssignments
SuiAccount <PUBLICKEY extends SuiAccountPublicKey , SINATURE extends SuiBaseSignature >
Abstract class representing a Sui account with signing capabilities.
SuiAccountConst
SuiAccountPublicKey
Abstract class representing a Sui account public key with serialization support.
SuiAddress
Represents a Sui blockchain address with utilities for serialization and comparison.
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
SuiArgument
SuiArgumentGasCoin
SuiArgumentInput
SuiArgumentNestedResult
SuiArgumentResult
SuiAuthenticationKeyScheme
Abstract class defining a contract for authentication key schemes
SuiBasePrivateKey <PUBLICKEY extends SuiCryptoPublicKey <IPublicKey > >
SuiBaseSignature
SuiCallArg <T >
SuiCallArgObject
SuiCallArgPure
SuiCommand
SuiCommandMakeMoveVec
Given n-values of the same type, it constructs a vector. For non objects or an empty vector,
the type tag must be specified.
SuiCommandMergeCoins
It merges n-coins into the first coin
SuiCommandMoveCall
SuiCommandPublish
Publishes a Move package. It takes the package bytes and a list of the package's transitive
dependencies to link against on-chain.
SuiCommandSplitCoins
It splits off some amounts into a new coins with those amounts
SuiCommandTransferObjects
It sends n-objects to the specified address. These objects must have store
(public transfer) and either the previous owner must be an address or the object must
be newly created.
SuiCommandUpgrade
Upgrades a Move package
SuiCryptoPublicKey <PUBLICKEY extends IPublicKey >
SuiCryptoUtils
SuiEd25519Account
SuiEd25519AccountPublicKey
Represents a Sui account public key using the Ed25519 signing scheme.
SuiED25519PrivateKey
Represents a Sui ED25519 private key with signing capabilities.
SuiED25519PublicKey
Represents a Sui ED25519 public key with verification capabilities.
SuiEd25519Signature
SuiGasData
SuiGenericSignature
SuiHelper
Helper class for converting SUI to Mist and vice versa with 9 decimal precision.
SuiIntent
SuiIntentApplicationId
SuiIntentMessage
SuiIntentScope
SuiIntentVersion
SuiMultisigAccount
SuiMultisigAccountPublicKey
Represents a multisig public key with multiple public keys and a threshold.
SuiMultisigPublicKeyInfo
Holds information about a multisig public key and its associated weight.
SuiMultisigSignature
SuiObjectArg
SuiObjectArgImmOrOwnedObject
A Move object from fastpath.
SuiObjectArgReceiving
A Move object that can be received in this transaction.
SuiObjectArgSharedObject
A Move object from consensus (historically consensus objects were always shared).
SharedObject::mutable controls whether caller asks for a mutable reference to shared object.
SuiObjectDigest
SuiObjectRef
SuiPersonalMessage
SuiProgrammableMoveCall
The command for calling a Move function, either an entry function or a public
function (which cannot return references).
SuiProgrammableTransaction
A series of commands where the results of one command can be used in future
commands
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
SuiSecp256k1Account
SuiSecp256k1AccountPublicKey
Represents a Sui account public key using the Secp256k1 signing scheme.
SuiSecp256k1PrivateKey
Represents a Sui secp256k1 private key with signing capabilities.
SuiSecp256k1PublicKey
Represents a Sui secp256k1 public key with verification capabilities.
SuiSecp256k1Signature
SuiSecp256r1Account
SuiSecp256r1AccountPublicKey
Represents a Sui account public key using the Secp256r1 signing scheme.
SuiSecp256r1PrivateKey
Represents a Sui secp256r1 private key with signing capabilities.
SuiSecp256r1PublicKey
Represents a Sui secp256r1 public key with verification capabilities.
SuiSecp256r1Signature
SuiSenderSignedTransaction
SuiSignleKeySignature <PUBLICKEY extends SuiCryptoPublicKey <IPublicKey > >
SuiStructInput
SuiTransactionConst
SuiTransactionData
SuiTransactionDataV1
SuiTransactionExpiration
SuiTransactionExpirationEpoch
SuiTransactionExpirationNone
SuiTransactionKind
SuiTransactionKindProgrammableTransaction
SuiTypeInput
SuiTypeInputAddress
SuiTypeInputPrimitive
SuiTypeInputSigner
SuiTypeInputStruct
SuiTypeInputVector
SuiTypeTagUtils
Utility class for parsing and handling sui type tag arguments
Exceptions / Errors
DartSuiPluginException
Custom exception for handling errors specific to the Dart Sui plugin.
