TypeScript SDK
Typescript SDK

Getting Started

The Sui Typescript SDK is a modular library of tool for interacting with the SUi blockchain. It can be used to send queries to RPC nodes, build and sign transactions, and more.

Installation

npm i -D @mysten/sui.js

Overview

The SDK is split into a set of modular packages that can be used independently or together. So you can import just what you need.

  • @mysten/sui.js/client - A client for interacting with Sui RPC nodes.
  • @mysten/sui.js/transaction - Utilities for building and interacting with transactions.
  • @mysten/sui.js/keypairs/* - Modular exports for specific KeyPair implementations.
  • @mysten/sui.js/verify - Methods for verifying transactions and messages.
  • @mysten/sui.js/cryptography - Shared types and classes for cryptography.
  • @mysten/sui.js/multisig - Utilities for working with multisig signatures.
  • @mysten/sui.js/utils - Utilities for formatting and parsing various Sui types.
  • @mysten/sui.js/faucet - Methods for requesting sui from a faucet.