Sui TypeScript SDK

Sui TypeScript SDK

Provides expert guidance for using the Sui TypeScript SDK (@mysten/sui) to build applications that interact with the Sui blockchain. This skill covers client setup, transaction building, data querying, and RPC operations.

Overview

The Sui TypeScript SDK is the official library for interacting with Sui from JavaScript/TypeScript applications. It provides type-safe APIs for querying blockchain data, building transactions, and managing cryptographic operations.

Key features:

• SuiClient - Main interface for RPC calls and data queries
• Transaction - Builder API for programmable transaction blocks (PTBs)
• Cryptography - Key pair management and signing
• Type safety - Full TypeScript support with proper types
• BCS - Efficient binary serialization for on-chain data

Official documentation: https://sdk.mystenlabs.com/sui

Installation

Install SDK Package

# Using npm
npm install @mysten/sui

# Using yarn
yarn add @mysten/sui

# Using pnpm
pnpm add @mysten/sui

Version compatibility:

• SDK version should match the Sui network version
• Use latest version for testnet/mainnet development
• Check release notes for breaking changes

TypeScript Configuration

Ensure tsconfig.json includes proper module resolution:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ES2020",
    "moduleResolution": "bundler",
    "esModuleInterop": true,
    "skipLibCheck": true,
    "strict": true
  }
}

Client Setup

Initialize SuiClient

import { SuiClient, getFullnodeUrl } from '@mysten/sui/client';

// Connect to testnet
const client = new SuiClient({ url: getFullnodeUrl('testnet') });

// Connect to mainnet
const mainnetClient = new SuiClient({ url: getFullnodeUrl('mainnet') });

// Connect to devnet
const devnetClient = new SuiClient({ url: getFullnodeUrl('devnet') });

// Connect to custom RPC
const customClient = new SuiClient({ url: 'https://custom-rpc.example.com' });