stellar-sdk/com.soneso.stellar.sdk.rpc.requests/SorobanRpcRequest

SorobanRpcRequest

@Serializable

data class SorobanRpcRequest<T>(val jsonRpc: String = "2.0", val id: String, val method: String, val params: T? = null)

Represents a JSON-RPC 2.0 request sent to the Soroban RPC server.

All Soroban RPC API calls use the JSON-RPC 2.0 protocol over HTTP. This class provides a type-safe wrapper for constructing requests with proper serialization.

JSON-RPC 2.0 Request Structure

A valid JSON-RPC 2.0 request contains:

jsonrpc: Protocol version (always "2.0")
id: Unique identifier for matching requests to responses
method: Name of the RPC method to invoke
params: Method-specific parameters (optional, can be null)

Example Usage

// Create a request to get health status
val request = SorobanRpcRequest(
    id = "1",
    method = "getHealth",
    params = null
)

// Create a request with parameters
val ledgerRequest = SorobanRpcRequest(
    id = "2",
    method = "getLedgerEntries",
    params = GetLedgerEntriesRequest(keys = listOf("..."))
)

Serialization

This class uses kotlinx.serialization for JSON encoding/decoding. The jsonrpc field is serialized as "jsonrpc" (not "jsonRpc") to comply with the JSON-RPC specification.