Modules§
- argument
- Nested message and enum types in
Argument. - changed_
object - Nested message and enum types in
ChangedObject. - checkpoint_
commitment - Nested message and enum types in
CheckpointCommitment. - clever_
error - Nested message and enum types in
CleverError. - coin_
metadata - Nested message and enum types in
CoinMetadata. - coin_
treasury - Nested message and enum types in
CoinTreasury. - command
- Nested message and enum types in
Command. - command_
argument_ error - Nested message and enum types in
CommandArgumentError. - datatype_
descriptor - Nested message and enum types in
DatatypeDescriptor. - dynamic_
field - Nested message and enum types in
DynamicField. - end_
of_ epoch_ transaction_ kind - Nested message and enum types in
EndOfEpochTransactionKind. - execution_
error - Nested message and enum types in
ExecutionError. - execution_
time_ observation - Nested message and enum types in
ExecutionTimeObservation. - function_
descriptor - Nested message and enum types in
FunctionDescriptor. - get_
checkpoint_ request - Nested message and enum types in
GetCheckpointRequest. - get_
object_ result - Nested message and enum types in
GetObjectResult. - get_
transaction_ result - Nested message and enum types in
GetTransactionResult. - input
- Nested message and enum types in
Input. - ledger_
service_ client - Generated client implementations.
- ledger_
service_ server - Generated server implementations.
- move_
package_ service_ client - Generated client implementations.
- move_
package_ service_ server - Generated server implementations.
- name_
service_ client - Generated client implementations.
- name_
service_ server - Generated server implementations.
- open_
signature - Nested message and enum types in
OpenSignature. - open_
signature_ body - Nested message and enum types in
OpenSignatureBody. - owner
- Nested message and enum types in
Owner. - package_
upgrade_ error - Nested message and enum types in
PackageUpgradeError. - regulated_
coin_ metadata - Nested message and enum types in
RegulatedCoinMetadata. - signature_
verification_ service_ client - Generated client implementations.
- signature_
verification_ service_ server - Generated server implementations.
- simulate_
transaction_ request - Nested message and enum types in
SimulateTransactionRequest. - state_
service_ client - Generated client implementations.
- state_
service_ server - Generated server implementations.
- subscription_
service_ client - Generated client implementations.
- subscription_
service_ server - Generated server implementations.
- transaction_
execution_ service_ client - Generated client implementations.
- transaction_
execution_ service_ server - Generated server implementations.
- transaction_
expiration - Nested message and enum types in
TransactionExpiration. - transaction_
kind - Nested message and enum types in
TransactionKind. - type_
argument_ error - Nested message and enum types in
TypeArgumentError. - unchanged_
consensus_ object - Nested message and enum types in
UnchangedConsensusObject. - user_
signature - Nested message and enum types in
UserSignature.
Structs§
- Active
Jwk - A new JWK.
- Argument
- An argument to a programmable transaction command.
- Authenticator
State Expire - Expire old JWKs.
- Authenticator
State Update - Update the set of valid JWKs.
- Balance
- Balance information for a specific coin type.
- Balance
Change - The delta, or change, in balance for an address for a particular
Cointype. - Batch
GetObjects Request - Batch
GetObjects Response - Batch
GetTransactions Request - Batch
GetTransactions Response - Bcs
Bcscontains an arbitrary type that is serialized using the BCS format as well as a name that identifies the type of the serialized value.- Canceled
Transaction - A transaction that was canceled.
- Change
Epoch - System transaction used to change the epoch.
- Changed
Object - Input/output state of an object that was changed during execution.
- Checkpoint
- Checkpoint
Commitment - A commitment made by a checkpoint.
- Checkpoint
Contents - The committed to contents of a checkpoint.
- Checkpoint
Summary - A header for a checkpoint on the Sui blockchain.
- Checkpointed
Transaction Info - Transaction information committed to in a checkpoint.
- Circom
G1 - A G1 point.
- Circom
G2 - A G2 point.
- Clever
Error - Coin
Deny List Error - Coin
Metadata - Metadata for a coin type
- Coin
Treasury - Information about a coin type’s
0x2::coin::TreasuryCapand its total available supply - Command
- A single command in a programmable transaction.
- Command
Argument Error - An error with an argument to a command.
- Command
Output - Command
Result - An intermediate result/output from the execution of a single command
- Congested
Objects - Set of objects that were congested, leading to the transaction’s cancellation.
- Consensus
Commit Prologue - Consensus commit prologue system transaction.
- Consensus
Determined Version Assignments - Version assignments performed by consensus.
- Datatype
Descriptor - Describes a Move Datatype.
- Dynamic
Field - EndOf
Epoch Data - Data, which when included in a
CheckpointSummary, signals the end of anEpoch. - EndOf
Epoch Transaction - Set of operations run at the end of the epoch to close out the current epoch and start the next one.
- EndOf
Epoch Transaction Kind - Operation run at the end of an epoch.
- Epoch
- Event
- An event.
- Execute
Transaction Request - Execute
Transaction Response - Response message for
NodeService.ExecuteTransaction. - Executed
Transaction - Execution
Error - An error that can occur during the execution of a transaction.
- Execution
Status - The status of an executed transaction.
- Execution
Time Observation - Execution
Time Observations - Field
Descriptor - Descriptor of a field that belongs to a struct or enum variant
- Function
Descriptor - Descriptor of a Move function
- GasCost
Summary - Summary of gas charges.
- GasPayment
- Payment information for executing a transaction.
- Genesis
Transaction - The genesis transaction.
- GetBalance
Request - Request message for
LiveDataService.GetBalance. - GetBalance
Response - Response message for
LiveDataService.GetBalance. Return the total coin balance for one coin type, owned by the address owner. - GetCheckpoint
Request - GetCheckpoint
Response - GetCoin
Info Request - Request message for
NodeService.GetCoinInfo. - GetCoin
Info Response - Response message for
NodeService.GetCoinInfo. - GetDatatype
Request - GetDatatype
Response - GetEpoch
Request - GetEpoch
Response - GetFunction
Request - GetFunction
Response - GetObject
Request - GetObject
Response - GetObject
Result - GetPackage
Request - GetPackage
Response - GetService
Info Request - GetService
Info Response - GetTransaction
Request - GetTransaction
Response - GetTransaction
Result - Index
Error - Input
- An input to a user transaction.
- Jwk
- A JSON web key.
- JwkId
- Key to uniquely identify a JWK.
- Linkage
- Upgraded package info for the linkage table.
- List
Balances Request - Request message for
LiveDataService.ListBalances. - List
Balances Response - Response message for
LiveDataService.ListBalances. Return the total coin balance for all coin types, owned by the address owner. - List
Dynamic Fields Request - Request message for
NodeService.ListDynamicFields - List
Dynamic Fields Response - Response message for
NodeService.ListDynamicFields - List
Owned Objects Request - List
Owned Objects Response - List
Package Versions Request - List
Package Versions Response - Lookup
Name Request - Lookup
Name Response - Make
Move Vector - Command to build a Move vector out of a set of individual elements.
- Merge
Coins - Command to merge multiple coins of the same type into a single coin.
- Module
- A Move Module.
- Move
Abort - Move
Call - Command to call a Move function.
- Move
Location - Location in Move bytecode where an error occurred.
- Move
Table - A message that represents a Move
0x2::table::Tableor0x2::bag::Bag - Multisig
Aggregated Signature - Aggregated signature from members of a multisig committee.
- Multisig
Committee - A multisig committee.
- Multisig
Member - A member in a multisig committee.
- Multisig
Member Public Key - Set of valid public keys for multisig committee members.
- Multisig
Member Signature - A signature from a member of a multisig committee.
- Name
Record - Object
- An object on the Sui blockchain.
- Object
Reference - Reference to an object.
- Object
Set - Set of Objects
- Open
Signature - Representation of a type signature that could appear as a function parameter or return value.
- Open
Signature Body - Representation of a type signature that could appear as a field type for a struct or enum
- Owner
- Enum of different types of ownership for an object.
- Package
- A Move Package
- Package
Upgrade Error - An error with upgrading a package.
- Package
Version - A simplified representation of a package version
- Passkey
Authenticator - A passkey authenticator.
- Programmable
Transaction - A user transaction.
- Protocol
Config - Publish
- Command to publish a new Move package.
- Randomness
State Update - Randomness update.
- Regulated
Coin Metadata - Information about a regulated coin, which indicates that it makes use of the transfer deny list.
- Reverse
Lookup Name Request - Reverse
Lookup Name Response - Simple
Signature - Either an ed25519, secp256k1 or secp256r1 signature
- Simulate
Transaction Request - Simulate
Transaction Response - Size
Error - A size error.
- Split
Coins - Command to split a single coin object into multiple coins.
- Stake
Subsidy - Staking
Pool - A staking pool embedded in each validator struct in the system state object.
- Storage
Fund - Struct representing the onchain storage fund.
- Subscribe
Checkpoints Request - Request message for SubscriptionService.SubscribeCheckpoints
- Subscribe
Checkpoints Response - Response message for SubscriptionService.SubscribeCheckpoints
- System
Package - System package.
- System
Parameters - System
State - Transaction
- A transaction.
- Transaction
Effects - The effects of executing a transaction.
- Transaction
Events - Events emitted during the successful execution of a transaction.
- Transaction
Expiration - A TTL for a transaction.
- Transaction
Kind - Transaction type.
- Transfer
Objects - Command to transfer ownership of a set of objects to an address.
- Type
Argument Error - Type argument error.
- Type
Origin - Identifies a struct and the module it was defined in.
- Type
Parameter - A generic type parameter used in the declaration of a struct or enum.
- Unchanged
Consensus Object - A consensus object that wasn’t changed during execution.
- Upgrade
- Command to upgrade an already published package.
- User
Signature - A signature from a user.
- Validator
- Definition of a Validator in the system contracts
- Validator
Aggregated Signature - / An aggregated signature from multiple validators.
- Validator
Committee - The validator set for a particular epoch.
- Validator
Committee Member - A member of a validator committee.
- Validator
Execution Time Observation - Validator
Report Record - Validator
Set - Variant
Descriptor - Descriptor of an enum variant
- Verify
Signature Request - Verify
Signature Response - Version
Assignment - Object version assignment from consensus.
- ZkLogin
Authenticator - A zklogin authenticator.
- ZkLogin
Claim - A claim of the iss in a zklogin proof.
- ZkLogin
Inputs - A zklogin groth16 proof and the required inputs to perform proof verification.
- ZkLogin
Proof - A zklogin groth16 proof.
- ZkLogin
Public Identifier - Public key equivalent for zklogin authenticators.
Enums§
- Ability
- An
Abilityclassifies what operations are permitted for a given type - Error
Reason - Signature
Scheme - Flag use to disambiguate the signature schemes supported by Sui.
Constants§
- FILE_
DESCRIPTOR_ SET - Byte encoded FILE_DESCRIPTOR_SET.