Package-level declarations

Types

Link copied to clipboard
@Serializable
enum EventFilterType : Enum<EventFilterType>

Type of event filter for getEvents requests and responses.

Link copied to clipboard
@Serializable
data class Events(val diagnosticEventsXdr: List<String>? = null, val transactionEventsXdr: List<String>? = null, val contractEventsXdr: List<List<String>>? = null)

Container for Soroban events emitted during transaction execution or simulation.

Link copied to clipboard
@Serializable
data class GetEventsResponse(val events: List<GetEventsResponse.EventInfo>, val cursor: String? = null, val latestLedger: Long, val oldestLedger: Long? = null, val latestLedgerCloseTime: Long? = null, val oldestLedgerCloseTime: Long? = null)

Response for JSON-RPC method getEvents.

Link copied to clipboard
@Serializable
data class GetFeeStatsResponse(val sorobanInclusionFee: GetFeeStatsResponse.FeeDistribution, val inclusionFee: GetFeeStatsResponse.FeeDistribution, val latestLedger: Long)

Response for JSON-RPC method getFeeStats.

Link copied to clipboard
@Serializable
data class GetHealthResponse(val status: String, val latestLedger: Long? = null, val oldestLedger: Long? = null, val ledgerRetentionWindow: Long? = null)

Response for JSON-RPC method getHealth.

Link copied to clipboard
@Serializable
data class GetLatestLedgerResponse(val id: String, val protocolVersion: Int, val sequence: Long)

Response for JSON-RPC method getLatestLedger.

Link copied to clipboard
@Serializable
data class GetLedgerEntriesResponse(val entries: List<GetLedgerEntriesResponse.LedgerEntryResult>? = null, val latestLedger: Long)

Response for JSON-RPC method getLedgerEntries.

Link copied to clipboard
@Serializable
data class GetLedgersResponse(val ledgers: List<GetLedgersResponse.LedgerInfo>, val latestLedger: Long, val latestLedgerCloseTime: Long, val oldestLedger: Long, val oldestLedgerCloseTime: Long, val cursor: String)

Response for JSON-RPC method getLedgers.

Link copied to clipboard
@Serializable
data class GetNetworkResponse(val friendbotUrl: String? = null, val passphrase: String, val protocolVersion: Int)

Response for JSON-RPC method getNetwork.

Link copied to clipboard
@Serializable
data class GetSACBalanceResponse(val balanceEntry: GetSACBalanceResponse.BalanceEntry? = null, val latestLedger: Long)

Response for the getSACBalance operation.

Link copied to clipboard
@Serializable
data class GetTransactionResponse(val status: GetTransactionStatus, val txHash: String? = null, val latestLedger: Long? = null, val latestLedgerCloseTime: Long? = null, val oldestLedger: Long? = null, val oldestLedgerCloseTime: Long? = null, val applicationOrder: Int? = null, val feeBump: Boolean? = null, val envelopeXdr: String? = null, val resultXdr: String? = null, val resultMetaXdr: String? = null, val ledger: Long? = null, val createdAt: Long? = null, val events: Events? = null)

Response for JSON-RPC method getTransaction.

Link copied to clipboard
@Serializable
data class GetTransactionsResponse(val transactions: List<GetTransactionsResponse.TransactionInfo>, val latestLedger: Long, val latestLedgerCloseTimestamp: Long, val oldestLedger: Long, val oldestLedgerCloseTimestamp: Long, val cursor: String)

Response for JSON-RPC method getTransactions.

Link copied to clipboard

Status of a transaction in the Soroban RPC response.

Link copied to clipboard
@Serializable
data class GetVersionInfoResponse(val version: String, val commitHash: String, val buildTimestamp: String, val captiveCoreVersion: String, val protocolVersion: Int)

Response for JSON-RPC method getVersionInfo.

Link copied to clipboard
@Serializable
data class SendTransactionResponse(val status: SendTransactionStatus, val hash: String? = null, val latestLedger: Long? = null, val latestLedgerCloseTime: Long? = null, val errorResultXdr: String? = null, val diagnosticEventsXdr: List<String>? = null)

Response for JSON-RPC method sendTransaction.

Link copied to clipboard

Status of a transaction submission.

Link copied to clipboard
@Serializable
data class SimulateTransactionResponse(val error: String? = null, val transactionData: String? = null, val events: List<String>? = null, val minResourceFee: Long? = null, val results: List<SimulateTransactionResponse.SimulateHostFunctionResult>? = null, val restorePreamble: SimulateTransactionResponse.RestorePreamble? = null, val stateChanges: List<SimulateTransactionResponse.LedgerEntryChange>? = null, val latestLedger: Long? = null)

Response for JSON-RPC method simulateTransaction.

Link copied to clipboard
@Serializable
data class SorobanRpcResponse<T>(val jsonRpc: String, val id: String, val result: T? = null, val error: SorobanRpcResponse.Error? = null)

Represents a JSON-RPC 2.0 response returned by the Soroban RPC server.

Link copied to clipboard

Status of a transaction in the getTransactions response.