SorobanServer

Main client class for connecting to a Soroban RPC instance and making requests.

Soroban RPC is Stellar's smart contract platform RPC server that provides APIs to:

• Simulate and submit smart contract transactions

• Query contract state and ledger entries

• Monitor transaction status and events

• Fetch network metadata and fee statistics

JSON-RPC 2.0 Protocol

All Soroban RPC methods use JSON-RPC 2.0 over HTTP. This client handles:

• Request/response serialization

• Error handling and exception mapping

• Automatic request ID generation

• HTTP connection management

Basic Usage

// Create server instance
val server = SorobanServer("https://soroban-testnet.stellar.org:443")

// Check server health
val health = server.getHealth()
println("Server status: ${health.status}")

// Get account for transaction building
val account = server.getAccount("GABC...")

// Simulate a transaction
val simulation = server.simulateTransaction(transaction)

// Prepare transaction with simulation results
val prepared = server.prepareTransaction(transaction)

// Sign and submit
prepared.sign(keypair)
val response = server.sendTransaction(prepared)

// Poll for completion
val result = server.pollTransaction(response.hash!!)

// Close when done
server.close()

Transaction Preparation Flow

Soroban transactions require simulation before submission to:

1. Calculate resource requirements (CPU, memory, storage)

2. Determine authorization entries needed

3. Estimate resource fees

The typical flow is:

1. Build transaction with com.soneso.stellar.sdk.TransactionBuilder

2. Call simulateTransaction to get resource estimates

3. Call prepareTransaction to apply estimates to transaction

4. Sign the prepared transaction

5. Submit with sendTransaction

6. Poll for completion with pollTransaction

Or use the simplified flow:

val prepared = server.prepareTransaction(transaction)  // Simulates internally
prepared.sign(keypair)
val response = server.sendTransaction(prepared)

Resource Management

This class implements AutoCloseable and should be closed when no longer needed to release HTTP client resources:

SorobanServer(url).use { server ->
    // Use server
}

Error Handling

Methods throw:

• SorobanRpcException - RPC-level errors (server returns error response)

• PrepareTransactionException - Transaction preparation failures

• kotlinx.coroutines.TimeoutCancellationException - Request timeout

• Exception - Network/connection errors

See also