Sui Documentation

https://docs.sui.io
Admin
Comprehensive documentation for Sui, a next-generation smart contract platform with high throughput,...
Tokens:2,220,527
Snippets:16,161
Trust Score:9.9
Update:1 day ago
Show doc for...
Tokens:
Raw
### Set up environment and install dependencies

Source: https://docs.sui.io/onchain-finance/tokenized-assets/deploy-tokenized-asset

Copy the environment template to .env and install npm dependencies in the setup directory. This prepares the deployment scripts and environment file for the rest of the guide.

```sh
$ cp setup/.env.template setup/.env
$ cd setup && npm install
```

--------------------------------

### Agent prompt for Sui development setup

Source: https://docs.sui.io/getting-started/onboarding/sui-install

Use this prompt with an AI agent to automate Sui CLI installation and initial setup. It instructs the agent to install the CLI, run suiup install sui@testnet, generate keys with sui client, and guide the user to fund the address via faucet.sui.io.

```text
Set up this machine for Sui development: Install the Sui CLI with curl -sSfL https://raw.githubusercontent.com/MystenLabs/suiup/main/install.sh | sh, then run suiup install sui@testnet to get the Testnet-compatible toolchain. Run sui client to generate your keys and config, then prompt me to visit faucet.sui.io, enter the generated address, and fund it with test tokens.
```

--------------------------------

### Configure the frontend

Source: https://docs.sui.io/sui-stack/enoki/solitaire

Changes to the app directory, installs dependencies with pnpm, and copies the example environment file.

```bash
$ cd ../../app
$ pnpm install
$ cp .env.example .env
```

--------------------------------

### Example output with instance ID and public IP

Source: https://docs.sui.io/sui-stack/nautilus/using-nautilus

Example output from the provisioning script. Save the public IP for later steps.

```text
Instance launched with ID: i-0728fc72a13834bc8
Public IP: 18.208.226.122
```

--------------------------------

### Start key server with master share

Source: https://docs.sui.io/sui-stack/seal/key-server-committee-ops

Start the key server with the config path and your master key share from dkg.yaml. Replace 0x... with your MASTER_SHARE_V0 value.

```bash
CONFIG_PATH=crates/key-server/key-server-config.yaml MASTER_SHARE_V0=0x... cargo run --bin key-server
```

--------------------------------

### start

Source: https://docs.sui.io/onchain-finance/fungible-tokens/token-vesting-strategies

Gets the start time of the vesting schedule.

```APIDOC
## start

### Description
Gets the start time of the vesting schedule.

### Function Signature
public fun start<T>(self: &Wallet<T>): u64

### Parameters
- **self** (&Wallet<T>) - Required - The vesting wallet.

### Returns
- **u64** - The start time of the vesting schedule.
```

--------------------------------

### Create dkg-state directory and copy rotation example config

Source: https://docs.sui.io/sui-stack/seal/key-server-committee-ops

Creates a clean working directory named 'dkg-state' and copies the rotation example configuration file into it.

```bash
# in seal/
rm -rf dkg-state && mkdir dkg-state
cp crates/seal-committee-cli/dkg-rotation.example.yaml dkg-state/dkg.yaml
```

--------------------------------

### GET /all_historical_volume request example

Source: https://docs.sui.io/onchain-finance/deepbook/deepbookv3/deepbookv3-indexer

Example request to the /all_historical_volume endpoint with start_time, end_time, and volume_in_base parameters.

```http
/all_historical_volume?start_time=1731260703&end_time=1731692703&volume_in_base=true
```

--------------------------------

### Start local dev server

Source: https://docs.sui.io/references/contribute/contribution-process

Run this command to start the local development server, then open http://localhost:3000 to preview your changes.

```bash
pnpm start
```

--------------------------------

### GET /historical_volume request example

Source: https://docs.sui.io/onchain-finance/deepbook/deepbookv3/deepbookv3-indexer

Example request to the /historical_volume endpoint with start_time, end_time, and volume_in_base parameters.

```http
/historical_volume/DEEP_SUI,SUI_USDC?start_time=1731260703&end_time=1731692703&volume_in_base=true
```

--------------------------------

### Install Walrus CLI with suiup

Source: https://docs.sui.io/getting-started/tooling

Installs the Walrus CLI for interacting with the Walrus platform for configuration, orchestration, and environment setup.

```bash
suiup install walrus
```

--------------------------------

### sui start options and flags

Source: https://docs.sui.io/getting-started/onboarding/local-network

Lists the available options and flags for the sui start command. Use sui start --help to see these options in your console. Some options require PostgreSQL/libpq.

```text
--network.config <CONFIG_DIR>
          Config directory that will be used to store network config, node db,
          keystore. sui genesis -f --with-faucet generates a genesis config that
          can be used to start this process. Use with caution as the `-f` flag
          will overwrite the existing config directory. We can use any config
          dir that is generated by the `sui genesis`

      --force-regenesis
          A new genesis is created each time this flag is set, and state is not
          persisted between runs. Only use this flag when you want to start the
          network from scratch every time you run this command.
          
          To run with persisted state, do not pass this flag and use the `sui
          genesis` command to generate a genesis that can be used to start the
          network with.

      --with-faucet[=<FAUCET_HOST_PORT>]
          Start a faucet with default host and port: 0.0.0.0:9123. This flag
          accepts also a port, a host, or both (e.g., 0.0.0.0:9123). When
          providing a specific value, please use the = sign between the flag and
          value: `--with-faucet=6124` or `--with-faucet=0.0.0.0`, or
          `--with-faucet=0.0.0.0:9123`

      --with-indexer[=<DATABASE_URL>]
          Start an indexer with a PostgreSQL database.
          
          Three modes of operation: - Not specified: No indexer is started
          (unless --with-graphql is set) - `--with-indexer`: Create/use a
          temporary database in the network's configuration directory -
          `--with-indexer=<URL>`: Use the provided PostgreSQL database URL
          
          When providing a database URL, use the = sign:
          `--with-indexer=postgres://user:pass@host:5432/db`

      --with-consistent-store[=<CONSISTENT_STORE_HOST_PORT>]
          Start a Consistent Store with default host and port: 0.0.0.0:9124.
          This flag accepts also a port, a host, or both (e.g., 0.0.0.0:9124).
          
          When providing a specific value, please use the = sign between the
          flag and value: `--with-consistent-store=9124` or
          `--with-consistent-store=0.0.0.0`, or
          `--with-consistent-store=0.0.0.0:9124` The Consistent Store will be
          automatically enabled when `--with-graphql` is set.

      --with-graphql[=<GRAPHQL_HOST_PORT>]
          Start a GraphQL server with default host and port: 0.0.0.0:9125. This
          flag accepts also a port, a host, or both (e.g., 0.0.0.0:9125).
          
          When providing a specific value, please use the = sign between the
          flag and value: `--with-graphql=9125` or `--with-graphql=0.0.0.0`, or
          `--with-graphql=0.0.0.0:9125`
          
          Note that GraphQL requires a running indexer and consistent store,
          which will be enabled by default even if those flags are not set.

      --fullnode-rpc-port <FULLNODE_RPC_PORT>
          Port to start the Fullnode RPC server on. Default port is 9000
          
          [default: 9000]

      --epoch-duration-ms <EPOCH_DURATION_MS>
          Set the epoch duration. Can only be used when `--force-regenesis` flag
          is passed or if there's no genesis config and one will be
          auto-generated. When this flag is not set but `--force-regenesis` is
          set, the epoch duration will be set to 60 seconds

      --data-ingestion-dir <DATA_INGESTION_DIR>
          Make the fullnode dump executed checkpoints as files to this
          directory. This is incompatible with --no-full-node.
          
          If --with-indexer is set, this defaults to a temporary directory.

      --no-full-node
          Start the network without a fullnode

      --committee-size <COMMITTEE_SIZE>
          Set the number of validators in the network. If a genesis was already
          generated with a specific number of validators, this will not override
          it; the user should recreate the genesis with the desired number of
          validators
```

--------------------------------

### GET /ohclv/SUI_USDC example request and response

Source: https://docs.sui.io/onchain-finance/deepbook/deepbookv3/deepbookv3-indexer

Example request to /ohclv/SUI_USDC with interval=1h and limit=10, and the corresponding response with sample candle data.

```http
/ohclv/SUI_USDC?interval=1h&limit=10
```

```json
{
    "candles": [
        [1738000000, 3.5, 3.6, 3.4, 3.55, 1000000],
        [1738003600, 3.55, 3.7, 3.5, 3.65, 1500000],
        ...
    ]
}
```

--------------------------------

### Example publish-and-init output in dkg.yaml

Source: https://docs.sui.io/sui-stack/seal/key-server-committee-ops

Example of the `publish-and-init` section appended to `dkg.yaml` after running the command, showing the committee package ID, committee ID, and coordinator address.

```yaml
publish-and-init:
  COMMITTEE_PKG: 0x5b788ac96879a752afbd3608a202207d75cf0f03387bcb744bfb4930cc544a70
  COMMITTEE_ID: 0x55241859c52f51dd149763769b8aa1e54de39b55acacda3f3a67629691247985
  COORDINATOR_ADDRESS: 0xef91ea73b4423e3a6176b0a1c9c6e4619de45c9c4e7c0b4aae358e292707d8c2
```

--------------------------------

### GET /historical_volume_by_balance_manager_id request example

Source: https://docs.sui.io/onchain-finance/deepbook/deepbookv3/deepbookv3-indexer

Example request to the /historical_volume_by_balance_manager_id endpoint with pool names, balance manager ID, and time range.

```http
/historical_volume_by_balance_manager_id/SUI_USDC,DEEP_SUI/0x344c2734b1d211bd15212bfb7847c66a3b18803f3f5ab00f5ff6f87b6fe6d27d?start_time=1731260703&end_time=1731692703&volume_in_base=true
```

--------------------------------

### Install ZetaChain CLI

Source: https://docs.sui.io/onchain-finance/fungible-tokens/sui-bridging

Install the ZetaChain CLI globally using npm. This is the first step to explore example contracts and tutorials.

```bash
npm install -g zetachain
```

--------------------------------

### Clone the Hello World example repository

Source: https://docs.sui.io/getting-started/onboarding/hello-world

Clones the sui-stack-hello-world repository and changes into the move/hello-world directory. Requires Git and the Sui prerequisites.

```text
$ git clone \
  https://github.com/MystenLabs/sui-stack-hello-world.git
$ cd sui-stack-hello-world/move/hello-world
```

--------------------------------

### Start the key server

Source: https://docs.sui.io/sui-stack/seal/key-server-ops

Starts the key server with the config file and master key. Verify it is serving with a curl command that returns the service ID and proof of possession.

```shell
CONFIG_PATH=key-server-config.yaml MASTER_KEY=<MASTER_KEY> cargo run --bin key-server
```

--------------------------------

### Get points example request and response

Source: https://docs.sui.io/onchain-finance/deepbook/deepbookv3/deepbookv3-indexer

Example request and response for the get_points endpoint, showing a successful call with two addresses and their total points.

```http
/get_points?addresses=0x344c2734b1d211bd15212bfb7847c66a3b18803f3f5ab00f5ff6f87b6fe6d27d,0x47dcbbc8561fe3d52198336855f0983878152a12524749e054357ac2e3573d58
```

```json
[
    {
        "address": "0x344c2734b1d211bd15212bfb7847c66a3b18803f3f5ab00f5ff6f87b6fe6d27d",
        "total_points": 1250000
    },
    {
        "address": "0x47dcbbc8561fe3d52198336855f0983878152a12524749e054357ac2e3573d58",
        "total_points": 750000
    }
]
```

--------------------------------

### Discover installed wallets with getWallets

Source: https://docs.sui.io/onchain-finance/asset-custody/wallets/wallet-standard

Use the get function of getWallets to query installed wallets in the user's browser. The returned array may be empty if no compatible wallets are installed, so check its length before use.

```tsx
import { getWallets } from '@mysten/wallet-standard';

const availableWallets = getWallets().get();
```

--------------------------------

### Example: Run sui-indexer-alt-graphql with multiple indexer configs

Source: https://docs.sui.io/operators/data-management/indexer-stack-setup

Example command that sets FULLNODE_GRPC_URL and runs the server with seven indexer config files. With these addresses, GraphQL is available at http://127.0.0.1:7000/graphql, health check at http://127.0.0.1:7000/health, and Prometheus metrics at http://127.0.0.1:9185/metrics. Assign a different metrics address to every co-located indexer process; all 3 binaries otherwise default to port 9184.

```sh
$ export FULLNODE_GRPC_URL=https://your-rpc-provider.example:443

$ sui-indexer-alt-graphql rpc \
    --config graphql.toml \
    --indexer-config events.toml \
    --indexer-config obj_versions.toml \
    --indexer-config tx_affected_addresses.toml \
    --indexer-config tx_affected_objects.toml \
    --indexer-config tx_calls.toml \
    --indexer-config tx_kinds.toml \
    --indexer-config unpruned.toml \
    --ledger-grpc-url https://archive.mainnet.sui.io:443 \
    --consistent-store-url http://127.0.0.1:7001 \
    --database-url postgres://username:password@localhost:5432/database \
    --fullnode-rpc-url "$FULLNODE_GRPC_URL" \
    --rpc-listen-address 127.0.0.1:7000 \
    --metrics-address 127.0.0.1:9185
```

--------------------------------

### Install all Linux prerequisites at once

Source: https://docs.sui.io/getting-started/onboarding/install-source

Installs all required Linux prerequisites (curl, git, cmake, gcc, libssl-dev, pkg-config, libclang-dev, libpq-dev, build-essential) in a single command using apt.

```sh
$ sudo apt-get install curl git-all cmake gcc libssl-dev pkg-config libclang-dev libpq-dev build-essential
```

--------------------------------

### Get all pools example request and response

Source: https://docs.sui.io/onchain-finance/deepbook/deepbookv3/deepbookv3-indexer

Example HTTP request to /get_pools and the corresponding JSON response showing two pools (DEEP_SUI and DEEP_USDC) with their details.

```http
/get_pools
```

```json
[
	{
		"pool_id": "0xb663828d6217467c8a1838a03793da896cbe745b150ebd57d82f814ca579fc22",
		"pool_name": "DEEP_SUI",
		"base_asset_id": "0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270::deep::DEEP",
		"base_asset_decimals": 6,
		"base_asset_symbol": "DEEP",
		"base_asset_name": "DeepBook Token",
		"quote_asset_id": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
		"quote_asset_decimals": 9,
		"quote_asset_symbol": "SUI",
		"quote_asset_name": "Sui",
		"min_size": 100000000,
		"lot_size": 10000000,
		"tick_size": 10000000
	},
	{
		"pool_id": "0xf948981b806057580f91622417534f491da5f61aeaf33d0ed8e69fd5691c95ce",
		"pool_name": "DEEP_USDC",
		"base_asset_id": "0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270::deep::DEEP",
		"base_asset_decimals": 6,
		"base_asset_symbol": "DEEP",
		"base_asset_name": "DeepBook Token",
		"quote_asset_id": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
		"quote_asset_decimals": 6,
		"quote_asset_symbol": "USDC",
		"quote_asset_name": "USDC",
		"min_size": 100000000,
		"lot_size": 10000000,
		"tick_size": 10000
	}
]
```

--------------------------------

### Start key server with full node authentication

Source: https://docs.sui.io/sui-stack/seal/key-server-committee-ops

Include FULL_NODE_RPC_API_NAME and FULL_NODE_RPC_API_KEY environment variables if your Sui fullnode requires authentication. Replace placeholders with your values.

```bash
FULL_NODE_RPC_API_NAME=<fullnode-api-key-name> \
  FULL_NODE_RPC_API_KEY=<fullnode-api-key> \
  CONFIG_PATH=crates/key-server/key-server-config.yaml \
  MASTER_SHARE_V0=0x... \
  cargo run --bin key-server
```

--------------------------------

### Clone the basic-sui-indexer example project

Source: https://docs.sui.io/develop/accessing-data/custom-indexer/integrate

Clones the Sui repository and changes into the basic-sui-indexer example directory, which contains the Cargo.toml, Diesel migrations, and all source files referenced in this guide.

```sh
$ git clone https://github.com/MystenLabs/sui.git
$ cd sui/examples/rust/basic-sui-indexer
```

--------------------------------

### Start Sui with tracing enabled

Source: https://docs.sui.io/operators/observability

Starts Sui with tracing enabled and sets the log level to trace for sui_core to get the most detailed spans. Requires the Jaeger container to be running.

```sh
$ SUI_TRACING_ENABLE=1 RUST_LOG="info,sui_core=trace" ./sui start
```

--------------------------------

### Create dkg-state directory and copy example config

Source: https://docs.sui.io/sui-stack/seal/key-server-committee-ops

Create a clean working directory named `dkg-state` and copy the example configuration file `crates/seal-committee-cli/dkg.example.yaml` to `dkg-state/dkg.yaml`.

```bash
# in seal/
rm -rf dkg-state && mkdir dkg-state
cp crates/seal-committee-cli/dkg.example.yaml dkg-state/dkg.yaml
```

--------------------------------

### Example: Unprunable pipeline from genesis

Source: https://docs.sui.io/operators/data-management/indexer-stack-setup

Concrete example of starting an unprunable pipeline from genesis using the unpruned.toml config and the Mainnet GCS bucket. The metrics address is set to 127.0.0.1:9184.

```sh
$ sui-indexer-alt indexer \
    --config unpruned.toml \
    --database-url postgres://username:password@localhost:5432/database \
    --remote-store-gcs mysten-mainnet-checkpoints-use4 \
    --remote-store-header "x-goog-user-project:${GOOGLE_CLOUD_PROJECT}" \
    --metrics-address 127.0.0.1:9184
```

--------------------------------

### Start Prover with Docker Compose

Source: https://docs.sui.io/sui-stack/zklogin-integration/integration-guide

Starts the self-hosted prover. Set ZKEY to the path of the zkey file and PROVER_PORT to the desired port. The backend requires at least 16 cores and 16 GB RAM.

```sh
ZKEY=<path_to_zkLogin.zkey> PROVER_PORT=<port> docker compose up
```

--------------------------------

### Initialize Sui client

Source: https://docs.sui.io/develop/transactions/transaction-auth/multisig

Run this command to set up the Sui CLI environment. On first run, it prompts for a full node URL and environment alias, and generates an address with a random key pair in sui.keystore and a config client.yaml.

```sh
$ sui client
```

--------------------------------

### Start local network with indexer and GraphQL

Source: https://docs.sui.io/getting-started/onboarding/local-network

Starts a local Sui network with forced genesis, a faucet, an indexer, and GraphQL support. Required before generating example data with the TypeScript SDK.

```sh
sui start --force-regenesis --with-faucet --with-indexer --with-graphql
```

--------------------------------

### storage

Source: https://docs.sui.io/references/framework/sui_sui/kiosk_extension

Get immutable access to the extension storage. Can only be performed by the extension as long as the extension is installed.

```APIDOC
## Function storage

### Description
Get immutable access to the extension storage. Can only be performed by the extension as long as the extension is installed.

### Function Signature
public fun storage<Ext: drop>(_ext: Ext, self: &sui::kiosk::Kiosk): &sui::bag::Bag

### Parameters
- `_ext` (Ext) - The extension type, used to authorize access.
- `self` (&sui::kiosk::Kiosk) - The Kiosk object.

### Return Value
- `&sui::bag::Bag` - Immutable reference to the extension storage bag.
```

--------------------------------

### Install site-builder using suiup

Source: https://docs.sui.io/sui-stack/walrus/sui-stack-walrus-sites

Installs the site-builder CLI using suiup, the recommended tool for managing Sui ecosystem tooling. Ensure $HOME/.local/bin is in your PATH after installation.

```bash
$ curl -sSfL https://raw.githubusercontent.com/Mystenlabs/suiup/main/install.sh | sh
$ suiup install site-builder@mainnet
```

--------------------------------

### Navigate to Move package directory

Source: https://docs.sui.io/references/cli/client

Change to the first_package example directory in the Sui repository.

```sh
$ cd examples/move/first_package
```

--------------------------------

### get_level2_ticks_from_mid

Source: https://docs.sui.io/onchain-finance/deepbook/deepbookv3/contract-information/query-the-pool

Gets prices and quantities across the level2 order book starting from the mid price.

```APIDOC
## get_level2_ticks_from_mid

### Description
Gets prices and quantities across the level2 order book starting from the mid price.

### Method
Function call

### Parameters
None documented.

### Response
Returns level2 order book data.
```

--------------------------------

### Install libpq-dev on Linux

Source: https://docs.sui.io/getting-started/onboarding/install-source

Installs libpq-dev, the PostgreSQL development library, using the apt package manager on Linux. Required for using the --with-indexer and --with-graphql options with sui start.

```sh
$ sudo apt-get install libpq-dev
```

--------------------------------

### Switch environment and verify source

Source: https://docs.sui.io/develop/manage-packages/source-verification

Switch to the mainnet environment before verifying, then run `verify-source` on a package. Verification runs against the network your CLI is pointed at. On success it prints `Source verification succeeded!` and exits with status 0.

```bash
sui client switch --env mainnet
sui client verify-source ./my-package
```

--------------------------------

### Start main service with address and config

Source: https://docs.sui.io/develop/accessing-data/graphql/graphql-rpc

Parses the server address from configuration and starts the main service. The service is started with the given address and server configuration, then the main loop is awaited.

```rust
let addr = config.address().parse()?;
server
    .start_service(addr, server_config)
    .await?
    .main()
    .await?;
Ok(())
```
Tokens:
Raw