Skip to Content
dApp 接入Sui
本页目录

Sui

下方签名示例使用快速开始中的 connectSuiAccount()，获取 Wallet Standard 账户及其当前链。示例使用 @mysten/[email protected]；在 @mysten/[email protected] 中，即使旧版 *TransactionBlock 方法也声明接收 Transaction。

使用 OneKey 的 Provider 集成 Sui 区块链。通过 window.$onekey.sui 访问。

OneKey 实现 Sui Wallet Standard，可用于兼容该标准的集成。

快速链接

Provider 检测

// Detect OneKey Sui provider
const provider = window.$onekey?.sui
 
if (!provider) {
  throw new Error('OneKey Sui provider not detected')
}

快速开始

检查权限

// Check if already connected
const hasPermission = await provider.hasPermissions()
 
if (hasPermission) {
  const accounts = await provider.getAccounts()
  console.log('Connected accounts:', accounts)
}

请求连接

// Request permissions to connect
const result = await provider.requestPermissions()
 
if (result) {
  const accounts = await provider.getAccounts()
  console.log('Connected:', accounts[0].address)
}

断开连接

await provider.disconnect()

账户管理

获取账户

const accounts = await provider.getAccounts()
 
accounts.forEach(account => {
  console.log({
    address: account.address,     // Sui address
    publicKey: account.publicKey, // Public key (hex string)
  })
})

获取当前链

const chain = await provider.getActiveChain()
 
console.log('Active chain:', chain) // e.g., 'sui:testnet'

交易

签名并执行交易块

当前注入式 provider 不会转发 signAndExecuteTransactionBlock 中的 options。如需 effects、events 或 object changes，请使用同一链上的 Sui 客户端，根据返回的 digest 查询交易。

import { Transaction } from '@mysten/sui/transactions'
 
// Create transaction block
const txb = new Transaction()
 
// Add a transfer
txb.transferObjects(
  [txb.object('0xobject_id')],
  txb.pure.address('RECIPIENT_SUI_ADDRESS')
)
 
// Or send SUI
const [coin] = txb.splitCoins(txb.gas, [txb.pure.u64(1000000000)]) // 1 SUI
txb.transferObjects([coin], txb.pure.address('RECIPIENT_SUI_ADDRESS'))
 
const { account, chain } = await connectSuiAccount()
 
// Sign and execute
const result = await provider.signAndExecuteTransactionBlock({
  account,
  chain,
  transactionBlock: txb,
})
 
console.log({
  digest: result.digest,
})

签名交易块（不执行）

const txb = new Transaction()
// ... build transaction
 
const { account, chain } = await connectSuiAccount()
 
const signedTxb = await provider.signTransactionBlock({
  account,
  chain,
  transactionBlock: txb,
})
 
console.log({
  transactionBlockBytes: signedTxb.transactionBlockBytes,
  signature: signedTxb.signature,
})
 
// Execute later using Sui SDK
// const result = await suiClient.executeTransactionBlock({
//   transactionBlock: signedTxb.transactionBlockBytes,
//   signature: signedTxb.signature,
// })

签名并执行交易（新 API）

// Using the newer signAndExecuteTransaction API (Transaction type)
import { Transaction } from '@mysten/sui/transactions'
 
const tx = new Transaction()
// ... build transaction
 
const { account, chain } = await connectSuiAccount()
 
const result = await provider.signAndExecuteTransaction({
  account,
  chain,
  transaction: tx,
})

签名交易（新 API）

import { Transaction } from '@mysten/sui/transactions'
 
const tx = new Transaction()
// ... build transaction
 
const { account, chain } = await connectSuiAccount()
 
const signedTxn = await provider.signTransaction({
  account,
  chain,
  transaction: tx,
})

消息签名

签名个人消息

签名任意消息用于身份验证：

const message = new TextEncoder().encode('Hello, Sui!')
const { account, chain } = await connectSuiAccount()
 
const result = await provider.signPersonalMessage({
  account,
  chain,
  message,
})
 
console.log({
  signature: result.signature,   // Base64 encoded signature
  bytes: result.bytes,           // Signed message bytes
})

签名消息（旧版）

const message = new TextEncoder().encode('Hello, Sui!')
const { account, chain } = await connectSuiAccount()
 
const result = await provider.signMessage({
  account,
  message,
})
 
console.log({
  signature: result.signature,
  messageBytes: result.messageBytes,
})

验证签名

import { verifyPersonalMessageSignature } from '@mysten/sui/verify'
 
const message = new TextEncoder().encode('Hello, Sui!')
const { account, chain } = await connectSuiAccount()
const { signature } = await provider.signPersonalMessage({ message, account, chain })
 
const signerKey = await verifyPersonalMessageSignature(message, signature)
const isExpectedSigner = signerKey.toSuiAddress() === account.address
console.log('Expected signer:', isExpectedSigner)

智能合约交互

Move 调用

const txb = new Transaction()
 
// Call a Move function
txb.moveCall({
  target: '0xpackage::module::function',
  arguments: [
    txb.pure.string('arg1'),
    txb.object('0xobject_id'),
  ],
  typeArguments: ['0x2::sui::SUI'],
})
 
const { account, chain } = await connectSuiAccount()
 
const result = await provider.signAndExecuteTransactionBlock({
  account,
  chain,
  transactionBlock: txb,
})

发布包

const txb = new Transaction()
 
const [upgradeCap] = txb.publish({
  modules: compiledModules,
  dependencies: [
    '0x1', // Move stdlib
    '0x2', // Sui framework
  ],
})
 
const { account, chain } = await connectSuiAccount()
txb.transferObjects([upgradeCap], txb.pure.address(account.address))
 
const result = await provider.signAndExecuteTransactionBlock({
  account,
  chain,
  transactionBlock: txb,
})

API 参考

方法

方法说明
hasPermissions()检查是否已连接
requestPermissions()请求连接
disconnect()断开钱包连接
getAccounts()获取已连接账户，仅包含 address 和 publicKey
getActiveChain()获取当前链
signAndExecuteTransactionBlock(input)签名并执行；需要 account / chain
signTransactionBlock(input)仅签名；需要 account / chain
signAndExecuteTransaction(input)新版签名并执行 API；使用 Transaction，需要 account / chain
signTransaction(input)新版交易签名 API；使用 Transaction，需要 account / chain
signMessage(input)旧版消息签名；需要 account
signPersonalMessage(input)签署个人消息；需要 account / chain

类型

getAccounts() 返回 AccountInfo[]。签名参数需要 Wallet Standard 的 WalletAccount，其 publicKey 为字节数组，并包含 chains 和 features。请通过 standard:connect 获取，不能将 AccountInfo 强制转换为 WalletAccount。

import type { WalletAccount, IdentifierString } from '@mysten/wallet-standard'
import type { Transaction } from '@mysten/sui/transactions'
 
// provider.getAccounts()
interface AccountInfo {
  address: string
  publicKey: string // Hex-encoded public key
}
 
interface SignAndExecuteTransactionBlockInput {
  account: WalletAccount
  chain: IdentifierString
  transactionBlock: Transaction
  options?: {
    showEffects?: boolean
    showEvents?: boolean
    showObjectChanges?: boolean
    showBalanceChanges?: boolean
    showInput?: boolean
    showRawInput?: boolean
  }
}
 
interface SignTransactionBlockOutput {
  transactionBlockBytes: string
  signature: string
}
 
interface SignPersonalMessageInput {
  account: WalletAccount
  chain?: IdentifierString
  message: Uint8Array
}
 
interface SignPersonalMessageOutput {
  signature: string
  bytes: string
}

支持的链

网络标识
主网sui:mainnet
测试网sui:testnet
开发网sui:devnet

错误处理

try {
  await provider.requestPermissions()
} catch (error) {
  if (error.code === 4001) {
    console.log('User rejected the connection request')
  } else {
    console.error('Connection error:', error.message)
  }
}

常见错误码

错误码说明
4001用户拒绝请求
4100未授权
-32603内部错误

使用 Sui Wallet Kit

此 React 示例使用下方锁定的兼容版本：

npm install @mysten/[email protected] @mysten/[email protected] @tanstack/react-query@^5
import { SuiClientProvider, WalletProvider } from '@mysten/dapp-kit'
import { getFullnodeUrl } from '@mysten/sui/client'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
 
const queryClient = new QueryClient()
const networks = {
  mainnet: { url: getFullnodeUrl('mainnet') },
  testnet: { url: getFullnodeUrl('testnet') },
}
 
function App() {
  return (
    <QueryClientProvider client={queryClient}>
      <SuiClientProvider networks={networks} defaultNetwork="mainnet">
        <WalletProvider>
          <YourApp />
        </WalletProvider>
      </SuiClientProvider>
    </QueryClientProvider>
  )
}

OneKey 会通过 Sui Wallet Standard 自动被检测到。

使用 Sui SDK

import { SuiClient } from '@mysten/sui/client'
 
const client = new SuiClient({ url: 'https://fullnode.mainnet.sui.io' })
 
// Get balance
const balance = await client.getBalance({
  owner: accountAddress,
})
 
// Get objects
const objects = await client.getOwnedObjects({
  owner: accountAddress,
})
 
// Get transaction
const txn = await client.getTransactionBlock({
  digest: txDigest,
  options: { showEffects: true },
})
最后更新于
API 参考快速开始