@mysten/sui
Version:
Sui TypeScript API
61 lines (58 loc) • 4.09 kB
Markdown
# Sui SDK
> TypeScript interfaces for Sui
- [Sui TypeScript SDK Quick Start](./index.md): TypeScript SDK for building on the Sui blockchain
- [Install Sui TypeScript SDK](./install.md): Install the @mysten/sui package and configure your
project
- [LLM Documentation](./llm-docs.md): Give AI agents access to Sui SDK documentation in your project
- [Hello Sui](./hello-sui.md): Build your first Sui application with the TypeScript SDK
- [Faucet](./faucet.md): Request test SUI tokens from the faucet
- [Sui Clients](./clients/index.md): Choose and configure gRPC, GraphQL, or JSON-RPC clients
- [Core API](./clients/core.md): Transport-agnostic Core API shared by all Sui clients
- [SuiGrpcClient](./clients/grpc.md): Connect to Sui via gRPC with SuiGrpcClient
- [SuiGraphQLClient](./clients/graphql.md): Connect to Sui via GraphQL with SuiGraphQLClient
- [SuiJsonRpcClient](./clients/json-rpc.md): Connect to Sui via JSON-RPC with SuiJsonRpcClient
- [Sui Programmable Transaction Basics](./transaction-building/basics.md): Construct programmable
transaction blocks with the Transaction API
- [Paying for Sui Transactions with Gas Coins](./transaction-building/gas.md): Configure gas budget,
price, and coin selection for transactions
- [Transaction Intents](./transaction-building/intents.md): Use high-level intents to simplify
transaction building
- [Building Offline](./transaction-building/offline.md): Build transactions without a network
connection
- [Sponsored Transactions](./transaction-building/sponsored-transactions.md): Pay gas fees on behalf
of other users with sponsored transactions
- [Key pairs](./cryptography/keypairs.md): Create and manage Ed25519, Secp256k1, and Secp256r1
keypairs
- [Multi-Signature Transactions](./cryptography/multisig.md): Create multi-signature transactions
with multiple signers
- [Passkey](./cryptography/passkey.md): Use WebAuthn passkeys for Sui transaction signing
- [Web Crypto Signer](./cryptography/webcrypto-signer.md): Sign transactions using the Web Crypto
API
- [The `@mysten/sui/utils` package](./utils/index.md): Utility functions for addresses, coins, and
common operations
- [Derived Objects](./utils/derived_objects.md): Compute derived object IDs from parent objects
- [BCS](./bcs.md): Binary Canonical Serialization for encoding Sui Move types
- [ZkLogin](./zklogin.md): Zero-knowledge authentication with OAuth providers on Sui
- [Transaction Executors](./executors.md): Manage transaction execution with queuing and parallel
strategies
- [Transaction Plugins](./plugins.md): Extend transaction building with reusable plugins
- [Building SDKs](./sdk-building.md): Build custom SDKs on top of the Sui TypeScript SDK
- [Migrate to 2.0](./migrations/sui-2.0/index.md): Migration guide for Sui TypeScript SDK 2.0
- [Agent Migration Prompt](./migrations/sui-2.0/agent-prompt.md): AI agent prompt for automated SDK
2.0 migration
- [@mysten/sui](./migrations/sui-2.0/sui.md): Migrate @mysten/sui from 1.x to 2.0
- [Migrating from JSON-RPC](./migrations/sui-2.0/json-rpc-migration.md): Migrate from JSON-RPC to
the new Core API
- [@mysten/dapp-kit](./migrations/sui-2.0/dapp-kit.md): Migrate @mysten/dapp-kit to 2.0
- [@mysten/kiosk](./migrations/sui-2.0/kiosk.md): Migrate @mysten/kiosk to 2.0
- [@mysten/zksend](./migrations/sui-2.0/zksend.md): Migrate @mysten/zksend to 2.0
- [@mysten/suins](./migrations/sui-2.0/suins.md): Migrate @mysten/suins to 2.0
- [@mysten/deepbook-v3](./migrations/sui-2.0/deepbook-v3.md): Migrate @mysten/deepbook-v3 to 2.0
- [@mysten/walrus](./migrations/sui-2.0/walrus.md): Migrate @mysten/walrus to 2.0
- [@mysten/seal](./migrations/sui-2.0/seal.md): Migrate @mysten/seal to 2.0
- [Wallet Builders](./migrations/sui-2.0/wallet-builders.md): Migration guide for wallet extension
developers
- [SDK Maintainers](./migrations/sui-2.0/sdk-maintainers.md): Migration guide for SDK maintainers
and library authors
- [Migrate to 1.0](./migrations/sui-1.0.md): Migrate to Sui TypeScript SDK 1.0
- [Migrate to 0.38.0](./migrations/0.38.md): Migrate from SDK version 0.37 to 0.38