Skip to main content

sui-service

Functions

<dl> <dt><a href="#getChainConfig">getChainConfig()</a></dt> <dd><p>Get chain config by name</p> </dd> <dt><a href="#createClient">createClient()</a></dt> <dd><p>Create a Sui client with fallback RPCs</p> </dd> <dt><a href="#getClient">getClient()</a></dt> <dd><p>Get or create a cached client</p> </dd> <dt><a href="#getSupportedChains">getSupportedChains()</a></dt> <dd><p>Get supported chains</p> </dd> <dt><a href="#generateKeypair">generateKeypair()</a></dt> <dd><p>Generate a random keypair (wallet)</p> </dd> <dt><a href="#createWallet">createWallet()</a></dt> <dd><p>Create a new wallet on Sui</p> </dd> <dt><a href="#getKeypairFromBase64">getKeypairFromBase64()</a></dt> <dd><p>Get wallet from base64 private key</p> </dd> <dt><a href="#getBalance">getBalance()</a></dt> <dd><p>Get wallet balance (SUI)</p> </dd> <dt><a href="#getNativeBalance">getNativeBalance()</a></dt> <dd><p>Get native token balance (SUI)</p> </dd> <dt><a href="#transfer">transfer()</a></dt> <dd><p>Transfer native tokens (SUI)</p> </dd> <dt><a href="#getAllBalances">getAllBalances()</a></dt> <dd><p>Get all coin balances for a wallet</p> </dd> <dt><a href="#getCoinMetadata">getCoinMetadata()</a></dt> <dd><p>Get coin metadata</p> </dd> <dt><a href="#getOwnedObjects">getOwnedObjects()</a></dt> <dd><p>Get objects owned by an address</p> </dd> <dt><a href="#getTransaction">getTransaction()</a></dt> <dd><p>Get transaction by digest</p> </dd> <dt><a href="#moveCall">moveCall()</a></dt> <dd><p>Execute a move call transaction</p> </dd> <dt><a href="#estimateGas">estimateGas()</a></dt> <dd><p>Estimate gas for a transaction</p> </dd> <dt><a href="#getChainId">getChainId()</a></dt> <dd><p>Get chain ID</p> </dd> <dt><a href="#isValidAddress">isValidAddress()</a></dt> <dd><p>Validate address format (Sui address)</p> </dd> <dt><a href="#requestFaucet">requestFaucet()</a></dt> <dd><p>Request faucet (testnet/devnet only)</p> </dd> </dl>

<a name="getChainConfig"></a>

getChainConfig()

Get chain config by name

Kind: global function
<a name="createClient"></a>

createClient()

Create a Sui client with fallback RPCs

Kind: global function
<a name="getClient"></a>

getClient()

Get or create a cached client

Kind: global function
<a name="getSupportedChains"></a>

getSupportedChains()

Get supported chains

Kind: global function
<a name="generateKeypair"></a>

generateKeypair()

Generate a random keypair (wallet)

Kind: global function
<a name="createWallet"></a>

createWallet()

Create a new wallet on Sui

Kind: global function
<a name="getKeypairFromBase64"></a>

getKeypairFromBase64()

Get wallet from base64 private key

Kind: global function
<a name="getBalance"></a>

getBalance()

Get wallet balance (SUI)

Kind: global function
<a name="getNativeBalance"></a>

getNativeBalance()

Get native token balance (SUI)

Kind: global function
<a name="transfer"></a>

transfer()

Transfer native tokens (SUI)

Kind: global function
<a name="getAllBalances"></a>

getAllBalances()

Get all coin balances for a wallet

Kind: global function
<a name="getCoinMetadata"></a>

getCoinMetadata()

Get coin metadata

Kind: global function
<a name="getOwnedObjects"></a>

getOwnedObjects()

Get objects owned by an address

Kind: global function
<a name="getTransaction"></a>

getTransaction()

Get transaction by digest

Kind: global function
<a name="moveCall"></a>

moveCall()

Execute a move call transaction

Kind: global function
<a name="estimateGas"></a>

estimateGas()

Estimate gas for a transaction

Kind: global function
<a name="getChainId"></a>

getChainId()

Get chain ID

Kind: global function
<a name="isValidAddress"></a>

isValidAddress()

Validate address format (Sui address)

Kind: global function
<a name="requestFaucet"></a>

requestFaucet()

Request faucet (testnet/devnet only)

Kind: global function