sui-client
Comprehensive SuiClient skill for interacting with the Sui blockchain using @mysten/sui SDK. Use this skill when you need to connect to Sui blockchain, read data, execute transactions, manage staking positions, or query network information.
When & Why to Use This Skill
The SuiClient skill provides a comprehensive interface for Claude to interact with the Sui blockchain via the @mysten/sui SDK. It streamlines blockchain development by enabling AI-powered data querying, transaction execution, staking management, and real-time network monitoring, making it an essential tool for Web3 developers building on the Sui ecosystem.
Use Cases
- Blockchain Data Retrieval: Seamlessly fetch account balances, token holdings, and object metadata from Sui Mainnet, Testnet, or Devnet.
- Transaction Workflow Automation: Build, sign, and execute complex programmable transaction blocks with automated error handling and gas price optimization.
- Smart Contract Interaction: Query normalized Move data and interact with on-chain Move packages to accelerate dApp development and debugging.
- Staking and Asset Management: Programmatically manage staking positions, track rewards, and monitor system states for decentralized finance (DeFi) applications.
- Real-time Event Monitoring: Query and subscribe to blockchain events to trigger external workflows or maintain synchronized application states.
| name | sui-client |
|---|---|
| description | Comprehensive SuiClient skill for interacting with the Sui blockchain using @mysten/sui SDK. Use this skill when you need to connect to Sui blockchain, read data, execute transactions, manage staking positions, or query network information. |
SuiClient Skill
A comprehensive Claude Code skill for interacting with the Sui blockchain using the official @mysten/sui SDK.
Instructions
Use this skill when you need to interact with the Sui blockchain. Includes:
- Network Connection: Connect to mainnet, testnet, devnet, or localnet
- Data Reading: Get tokens, objects, transactions, and balances
- Transaction Execution: Build, sign, and execute transactions
- Network Information: Get system state, gas prices, and protocol configuration
- Move Package Interactions: Query normalized Move data
- Event Handling: Query and subscribe to blockchain events
- Staking Operations: Manage staking positions
- Error Handling: Implement comprehensive error handling patterns
Quick Start
import { SuiClient } from '@mysten/sui/client';
// Connect to mainnet
const client = new SuiClient({
url: 'https://sui-mainnet.nodeinfra.com'
});
// Get account balance
const balance = await client.getBalance({
owner: '0x123...',
coinType: '0x2::sui::SUI'
});
Installation
# Install the skill
claude skills install sui-client
# Install dependencies
bun add @mysten/sui
Features
- Client Management: Connect to mainnet, testnet, devnet, and localnet
- Data Reading: Get tokens, objects, transactions, and balances
- Transaction Execution: Build, sign, and execute transactions
- Network Information: Get system state, gas prices, and protocol configuration
- Move Package Interactions: Query normalized Move data
- Event Handling: Query and subscribe to blockchain events
- Staking Operations: Manage staking positions
- Error Handling: Comprehensive error handling patterns
Examples
Check the examples/ directory for complete usage examples:
basic-usage.ts- Basic client setup and data readingtransactions.ts- Transaction building and executionadvanced.ts- Advanced patterns and error handling
API Reference
This skill provides comprehensive coverage of the SuiClient API including:
- Reading Data:
getObject(),getCoins(),getTransactionBlock() - Writing Data:
signAndExecuteTransaction(),executeTransactionBlock() - Network Information:
getLatestSuiSystemState(),getReferenceGasPrice() - Events:
queryEvents(),subscribeEvent() - Staking:
getStakes(),getStakesByIds()
Detailed Documentation
- Source Code - Complete SuiClient API implementation
- Type Definitions - TypeScript type definitions
- Code Templates - Common code templates
- Example Code - Complete usage examples
Dependencies
@mysten/sui: ^1.45.0 (managed via package.json)
Contributing
Contributions are welcome! Please see the CONTRIBUTING.md file for details.
License
MIT