Sui
The primary entry point for interacting with the Sui network.
This class provides a unified API surface by delegating to various specialized API clients (e.g., Coin
, Events
, Transaction
). This composition pattern allows for clean separation of concerns while offering a simple, cohesive interface.
Upon instantiation, this class can automatically configure a default, globally-accessible client instance via the SuiKit object. This enables the use of convenient top-level functions like ptb { ... }
without needing to pass the client instance explicitly.
Parameters
The SuiConfig used to configure the connection and behavior of all underlying API clients.
If true
, this instance will be set as the default client in SuiKit, making it available for global functions. This is useful for setting up a primary client at application startup. Set to false
to create a temporary or secondary client without overwriting the default.
Constructors
Properties
Functions
Runs a special developer-focused inspection of a transaction block.
Simulates the execution of a transaction block without committing it to the network.
Submits a pre-signed transaction block to the Sui network for execution.
Fetches all coin balances for a given Sui address.
Fetches the balance of a specific coin type for a given address.
Fetches the first 4 bytes of the chain's genesis checkpoint digest.
Fetches the details of a specific checkpoint.
Fetches the metadata for a specific coin type.
Fetches the committee of validators for a specific epoch.
Fetches details about the current epoch.
Fetches an object that is stored as a dynamic field on a parent object.
Fetches the sequence number of the most recently processed checkpoint.
Fetches the most recent SuiSystemState
object.
Fetches the argument types for a specific Move function.
Fetches the normalized (desugared and with types expanded) representation of a Move function.
Fetches the normalized representation of a specific module within a package.
Fetches a paginated list of all normalized modules within a given package.
Fetches the normalized representation of a Move struct.
Fetches a paginated list of objects owned by a specific address.
Fetches the protocol configuration for a specific version.
Fetches the current reference gas price for the network.
Fetches the total supply for a given coin type.
Fetches the total number of transaction blocks processed by the network.
Fetches the details of a specific transaction block by its digest.
Resolves the on-chain memory layout for a specified Move type.
Fetches the Annual Percentage Yield (APY) for all active validators.
Fetches the details of multiple objects in a single batch request.
Fetches a paginated list of transaction blocks for a given checkpoint.
Fetches a paginated list of validators for a specific epoch.
Fetches paginated lists of components within a Move module.
Fetches paginated lists of components within a specific transaction block.
Queries for events on the Sui network based on a specified filter.
Fetches a paginated list of transaction blocks matching a specified filter.
Resolves a .sui
domain name to its corresponding Sui address.
Performs a reverse lookup to find all .sui
domain names associated with a given address.
A convenience method that signs and executes a transaction block in a single step.
Creates a cryptographic signature for a given message using a signer's private key.
Fetches a historical version of a specific object.