Modules§
Structs§
- Active
Jwk - Address
- Address
Parse Error - Authenticator
State Expire - Authenticator
State Update - Balance
Change - Bls12381
Public Key - Bls12381
Signature - Bn254
Field Element - Cancelled
Transaction - Change
Epoch - Changed
Object - Checkpoint
Contents - Checkpoint
Contents Digest - Checkpoint
Data - Checkpoint
Digest - Checkpoint
Summary - Checkpoint
Transaction - Checkpoint
Transaction Info - Circom
G1 - A G1 point in BN254 serialized as a vector of three strings which is the canonical decimal representation of the projective coordinates in Fq.
- Circom
G2 - A G2 point in BN254 serialized as a vector of three vectors each being a vector of two strings which are the canonical decimal representation of the coefficients of the projective coordinates in Fq2.
- Claim
- A claim consists of value and index_mod_4.
- Consensus
Commit Digest - Consensus
Commit Prologue - Only commit_timestamp_ms is passed to the move call currently. However we include epoch and round to make sure each ConsensusCommitPrologue has a unique tx digest.
- Consensus
Commit Prologue V2 - Consensus
Commit Prologue V3 - Digest
- A representation of a 32 byte digest
- Digest
Parse Error - Ed25519
Public Key - Ed25519
Signature - Effects
Auxiliary Data Digest - EndOf
Epoch Data - Event
- Specific type of event
- GasCost
Summary - Summary of gas charges.
- GasPayment
- Genesis
Object - Genesis
Transaction - Identifier
- Intent
- A Signing Intent
- Jwk
- Struct that contains info for a JWK. A list of them for different kids can be retrieved from the JWK endpoint (e.g. https://www.googleapis.com/oauth2/v3/certs). The JWK is used to verify the JWT token.
- JwkId
- Key to identify a JWK, consists of iss and kid.
- Make
Move Vector - Merge
Coins - Modified
AtVersion - Move
Call - The command for calling a Move function, either an entry function or a public function (which cannot return references).
- Move
Location - Move
Package - Move
Struct - Multisig
Aggregated Signature - The struct that contains signatures and public keys necessary for authenticating a Multisig.
- Multisig
Committee - Multisig
Member - Object
- Object
Digest - Object
Id - Object
Reference - Object
Reference With Owner - Passkey
Authenticator - An passkey authenticator with parsed fields. See field defition below. Can be initialized from [struct RawPasskeyAuthenticator].
- Passkey
Public Key - Personal
Message - Programmable
Transaction - A series of commands where the results of one command can be used in future commands
- Publish
- Randomness
State Update - Secp256k1
Public Key - Secp256k1
Signature - Secp256r1
Public Key - Secp256r1
Signature - Signed
Checkpoint Summary - Signed
Transaction - Split
Coins - Struct
Tag - System
Package - Transaction
- Transaction
Digest - Transaction
Effects Digest - Transaction
Effects V1 - The response from processing a transaction or a certified transaction
- Transaction
Effects V2 - The response from processing a transaction or a certified transaction
- Transaction
Events - Transaction
Events Digest - Transfer
Objects - Type
Origin - Identifies a struct and the module it was defined in
- Type
Parse Error - Unchanged
Shared Object - Upgrade
- Upgrade
Info - Upgraded package info for the linkage table
- Validator
Aggregated Signature - Validator
Committee - Validator
Committee Member - Validator
Signature - Version
Assignment - ZkLogin
Authenticator - An zk login authenticator with all the necessary fields.
- ZkLogin
Inputs - All inputs required for the zk login proof verification and other public inputs.
- ZkLogin
Proof - The struct for zk login proof.
- ZkLogin
Public Identifier - A wrapper struct to retrofit in [enum PublicKey] for zkLogin. Useful to construct [struct MultiSigPublicKey].
Enums§
- Argument
- An argument to a programmable transaction command
- Checkpoint
Commitment - Command
- A single command in a programmable transaction.
- Command
Argument Error - Consensus
Determined Version Assignments - EndOf
Epoch Transaction Kind - EndOfEpochTransactionKind
- Execution
Error - Execution
Status - IdOperation
- Input
- Intent
AppId - Intent
Scope - Intent
Version - Multisig
Member Public Key - Multisig
Member Signature - Object
Data - Object
In - If an object exists (at root-level) in the store prior to this transaction, it should be Exist, otherwise it’s NonExist, e.g. wrapped objects should be NonExist.
- Object
Out - Object
Type - Type of a Sui object
- Owner
- Package
Upgrade Error - Signature
Scheme - Simple
Signature - Transaction
Effects - The response from processing a transaction or a certified transaction
- Transaction
Expiration - Transaction
Kind - Type
Argument Error - TypeTag
- Unchanged
Shared Kind - User
Signature