Build
SDK
Typescript SDK
SDK Method List

Rooch TypeScript SDK Method List

  1. Client Initialization
// Create client
new RoochClient(config: RoochClientConfig)
 
// Get node URL
getRoochNodeUrl(network: 'testnet' | 'mainnet')
 
// Create WebSocket transport
new RoochWebSocketTransport(config: WebSocketConfig)
  1. Account and Session Management
// Create session
createSession(params: CreateSessionParams)
 
// Generate key pair
Secp256k1Keypair.generate()
 
// Get account information
getAccount(params: GetAccountParams)
 
// Get account balances
getBalances(params: GetBalancesParams)
  1. Transactions
// Create transaction
new Transaction()
 
// Call contract function
callFunction(params: CallFunctionParams)
 
// Sign and execute transaction
signAndExecuteTransaction(params: SignAndExecuteTransactionParams)
 
// Get transaction information
getTransaction(params: GetTransactionParams)
 
// Get transaction status
getTransactionStatus(params: GetTransactionStatusParams)
 
// Wait for transaction completion
waitForTransaction(params: WaitForTransactionParams)
  1. Contract Interaction
// Execute view function
executeViewFunction(params: ExecuteViewFunctionParams)
 
// Get module
getModule(params: GetModuleParams)
 
// Get resource
getResource(params: GetResourceParams)
 
// Get events
getEvents(params: GetEventsParams)
  1. State Queries
// Get states
getStates(params: GetStatesParams) 
 
// Get chain information
getChainId()
 
// Get latest block height
getLatestBlockHeight()
  1. Utility Methods
// Address conversion
addressToHex(address: string)
hexToAddress(hex: string)
 
// Encoding and decoding
encodeStruct(data: any)
decodeStruct(data: any)
 
// Gas estimation
estimateGasPrice()
estimateGasUsage(transaction: Transaction)
  1. WebSocket Specific
// Subscribe to events
subscribe(params: SubscribeParams)
 
// Unsubscribe from events
unsubscribe(params: UnsubscribeParams)
 
// Close connection
destroy()
  1. Error Handling
// Get error message
getErrorMessage(error: RoochError)
 
// Check error type
isRoochError(error: any)