Skip to main content

Crate sui_types

Crate sui_types 

Source

Modules§

accumulator_event
accumulator_metadata
accumulator_root
address_alias
allowance
Rust bindings for sui::allowance.
authenticator_state
balance
balance_change
base_types
bridge
clock
coin
coin_registry
coin_reservation
This module defines the protocol for specifying an address balance reservation via an ObjectRef, in order to provide backward compatibility for clients that do not understand address balances.
collection_types
committee
config
crypto
deny_list_v1
deny_list_v2
derived_object
digests
display
display_registry
dynamic_field
effects
epoch_data
error
event
executable_transaction
execution
execution_params
execution_status
full_checkpoint_content
funds_accumulator
Rust bindings for sui::funds_accumulator
gas
gas_coin
gas_model
global_state_hash
governance
id
in_memory_storage
inner_temporary_store
layout_resolver
message_envelope
messages_checkpoint
messages_consensus
messages_grpc
messages_safe_client
metrics
move_package
multiaddr
multisig
multisig_legacy
nitro_attestation
node_role
object
passkey_authenticator
programmable_transaction_builder
Utility for generating programmable transactions, either by specifying a command or for migrating legacy transactions
ptb_trace
randomness_state
rpc_proto_conversions
Module for conversions from sui-core types to rpc protos
signature
signature_verification
storage
sui_sdk_types_conversions
Module for conversions between sui-core types and sui-sdk types
sui_serde
sui_system_state
supported_protocol_versions
test_checkpoint_data_builder
traffic_control
transaction
transaction_deny_rules
transaction_driver_types
transaction_executor
transfer
type_input
utils
versioned
zk_login_authenticator
zk_login_util

Macros§

assert_invariant
checked_as
A helper macro for performing a checked cast from one type to another, returning a ExecutionError invariant violation if the cast fails.
exit_main
fp_bail
fp_ensure
invariant_violation
make_invariant_violation

Structs§

Identifier
An owned identifier.

Enums§

TypeTag

Constants§

BRIDGE_ADDRESS
BRIDGE_PACKAGE_ID
DEEPBOOK_ADDRESS
DEEPBOOK_PACKAGE_ID
IMPLICITLY_READ_SYSTEM_OBJECTS
System objects that a transaction may read implicitly during execution, i.e. without declaring them as shared inputs. Their read version is recorded in effects (as a read-only consensus object) and reproduced when executing from effects (checkpoint execution during state sync, and crash recovery) so the read resolves to the same version on every node. Execution paths that are not sequenced by consensus (dev-inspect / dry-run) pin these objects at their latest committed versions instead.
MOVE_STDLIB_ADDRESS
MOVE_STDLIB_PACKAGE_ID
SUI_ACCUMULATOR_ROOT_ADDRESS
SUI_ACCUMULATOR_ROOT_OBJECT_ID
SUI_ADDRESS_ALIAS_STATE_ADDRESS
SUI_ADDRESS_ALIAS_STATE_OBJECT_ID
SUI_AUTHENTICATOR_STATE_ADDRESS
SUI_AUTHENTICATOR_STATE_OBJECT_ID
SUI_BRIDGE_ADDRESS
SUI_BRIDGE_OBJECT_ID
SUI_CLOCK_ADDRESS
SUI_CLOCK_OBJECT_ID
SUI_CLOCK_OBJECT_SHARED_VERSION
SUI_COIN_REGISTRY_ADDRESS
SUI_COIN_REGISTRY_OBJECT_ID
SUI_DENY_LIST_ADDRESS
SUI_DENY_LIST_OBJECT_ID
SUI_DISPLAY_REGISTRY_ADDRESS
SUI_DISPLAY_REGISTRY_OBJECT_ID
SUI_FORWARDING_ADDRESS_REGISTRY_ADDRESS
SUI_FORWARDING_ADDRESS_REGISTRY_OBJECT_ID
SUI_FRAMEWORK_ADDRESS
SUI_FRAMEWORK_PACKAGE_ID
SUI_RANDOMNESS_STATE_ADDRESS
SUI_RANDOMNESS_STATE_OBJECT_ID
SUI_SYSTEM_ADDRESS
SUI_SYSTEM_PACKAGE_ID
SUI_SYSTEM_STATE_ADDRESS
SUI_SYSTEM_STATE_OBJECT_ID
SUI_SYSTEM_STATE_OBJECT_SHARED_VERSION
SYSTEM_PACKAGE_ADDRESSES

Traits§

MoveTypeTagTrait
MoveTypeTagTraitGeneric

Functions§

is_object
is_object_vector
is_primitive
is_system_package
parse_sui_address
Parses s as an address. Valid formats for addresses are:
parse_sui_fq_name
Parse s as a fully-qualified name: A Module ID (see parse_sui_module_id), followed by ::, and then an identifier (for the module member). Parsing succeeds if and only if s matches this format exactly, with no remaining input. This function is intended for use within the authority codebases.
parse_sui_module_id
Parse s as a Module ID: An address (see parse_sui_address), followed by ::, and then a module name (an identifier). Parsing succeeds if and only if s matches this format exactly, with no remaining input. This function is intended for use within the authority codebases.
parse_sui_struct_tag
Parse s as a struct type: A fully-qualified name, optionally followed by a list of type parameters (types – see parse_sui_type_tag, separated by commas, surrounded by angle brackets). Parsing succeeds if and only if s matches this format exactly, with no remaining input. This function is intended for use within the authority codebase.
parse_sui_type_tag
Parse s as a type: Either a struct type (see parse_sui_struct_tag), a primitive type, or a vector with a type parameter. Parsing succeeds if and only if s matches this format exactly, with no remaining input. This function is intended for use within the authority codebase.
resolve_address
Resolve well-known named addresses into numeric addresses.
sui_framework_address_concat_string