Skip to Content
Connect to Software

API Reference

Complete reference for OneKey’s Sui provider methods and types.


Methods

MethodDescription
hasPermissions()Check if connected
requestPermissions()Request connection
disconnect()Disconnect wallet
getAccounts()Get connected accounts
getActiveChain()Get current chain
isConnected()Check connection status
signAndExecuteTransactionBlock(input)Sign and execute transaction
signTransactionBlock(input)Sign transaction only
signAndExecuteTransaction(input)Sign and execute (new API)
signTransaction(input)Sign transaction (new API)
signMessage(input)Sign message (legacy)
signPersonalMessage(input)Sign personal message
onAccountChange(callback)Listen for account changes
onNetworkChange(callback)Listen for network changes

Types

Wallet Account

interface WalletAccount { address: string publicKey: Uint8Array chains: string[] features: string[] }

Sign and Execute Transaction Block Input

interface SignAndExecuteTransactionBlockInput { transactionBlock: TransactionBlock options?: { showEffects?: boolean showEvents?: boolean showObjectChanges?: boolean showBalanceChanges?: boolean showInput?: boolean showRawInput?: boolean } }

Sign Transaction Block Output

interface SignTransactionBlockOutput { transactionBlockBytes: string signature: string }

Sign Personal Message Input

interface SignPersonalMessageInput { message: Uint8Array }

Sign Personal Message Output

interface SignPersonalMessageOutput { signature: string bytes: string }

Supported Chains

ChainIdentifier
Mainnetsui:mainnet
Testnetsui:testnet
Devnetsui:devnet
Localnetsui:localnet

Events

EventCallback ParametersDescription
accountChanged{ address, publicKey } | nullAccount changed
networkChangenetwork: string | nullNetwork changed
connectaddress: stringConnected
disconnect-Disconnected

Error Codes

CodeDescription
4001User rejected request
4100Unauthorized
-32603Internal error
Last updated on