Skip to content

Latest commit

 

History

History

src

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
effects
effects
 
 
gas_model
gas_model
 
 
storage
storage
 
 
sui_system_state
sui_system_state
 
 
unit_tests
unit_tests
 
 
README.md
README.md
 
 
accumulator.rs
accumulator.rs
 
 
authenticator_state.rs
authenticator_state.rs
 
 
balance.rs
balance.rs
 
 
base_types.rs
base_types.rs
 
 
bridge.rs
bridge.rs
 
 
clock.rs
clock.rs
 
 
coin.rs
coin.rs
 
 
collection_types.rs
collection_types.rs
 
 
committee.rs
committee.rs
 
 
crypto.rs
crypto.rs
 
 
deny_list.rs
deny_list.rs
 
 
digests.rs
digests.rs
 
 
display.rs
display.rs
 
 
dynamic_field.rs
dynamic_field.rs
 
 
epoch_data.rs
epoch_data.rs
 
 
error.rs
error.rs
 
 
event.rs
event.rs
 
 
executable_transaction.rs
executable_transaction.rs
 
 
execution.rs
execution.rs
 
 
execution_mode.rs
execution_mode.rs
 
 
execution_status.rs
execution_status.rs
 
 
full_checkpoint_content.rs
full_checkpoint_content.rs
 
 
gas.rs
gas.rs
 
 
gas_coin.rs
gas_coin.rs
 
 
governance.rs
governance.rs
 
 
id.rs
id.rs
 
 
in_memory_storage.rs
in_memory_storage.rs
 
 
inner_temporary_store.rs
inner_temporary_store.rs
 
 
lib.rs
lib.rs
 
 
message_envelope.rs
message_envelope.rs
 
 
messages_checkpoint.rs
messages_checkpoint.rs
 
 
messages_consensus.rs
messages_consensus.rs
 
 
messages_grpc.rs
messages_grpc.rs
 
 
messages_safe_client.rs
messages_safe_client.rs
 
 
metrics.rs
metrics.rs
 
 
mock_checkpoint_builder.rs
mock_checkpoint_builder.rs
 
 
move_package.rs
move_package.rs
 
 
multisig.rs
multisig.rs
 
 
multisig_legacy.rs
multisig_legacy.rs
 
 
object.rs
object.rs
 
 
programmable_transaction_builder.rs
programmable_transaction_builder.rs
 
 
quorum_driver_types.rs
quorum_driver_types.rs
 
 
randomness_state.rs
randomness_state.rs
 
 
signature.rs
signature.rs
 
 
sui_serde.rs
sui_serde.rs
 
 
transaction.rs
transaction.rs
 
 
transfer.rs
transfer.rs
 
 
type_resolver.rs
type_resolver.rs
 
 
versioned.rs
versioned.rs
 
 
zk_login_authenticator.rs
zk_login_authenticator.rs
 
 
zk_login_util.rs
zk_login_util.rs
 
 

README.md

sui-types README

Note: this README file currently covers cryptography-related structs and methods.

Currently, three files are equipped with signature and hashing functionality (crypto.rs, signature_seed and messages.rs). See Sui Signatures for supported signature schemes and its requirments for user and authority signatures. See fastcrypto for concrete implementation of various cryptography libraries.

Quick links

  • crypto.rs, the main library for cryptography (sign/verify/hash) structs and functions.
  • signature_seed.rs, deterministic signer using a seed, domain and some key identifier. Potential usage includes custodial services, in which user keys are not deterministically derived from BIP44/BIP32, but from their username (i.e., email address).
  • messages.rs, functionality for adding/verifying signatures to transactions (for both account holders and validators).

Tests

Unit tests exist under the unit_tests folder, in particular

  • messages_tests: to handle signed values, aggregation and certificates.
  • signature_seed_tests: for deterministic key derivation functionality.