GetLedgerEntriesResponse
extends SorobanRpcResponse
in package
Response when reading the current values of ledger entries.
Tags
Table of Contents
Properties
- $entries : array<string|int, LedgerEntry>|null
- $error : SorobanRpcErrorResponse|null
- $jsonResponse : array<string|int, mixed>
- $latestLedger : int|null
Methods
- __construct() : mixed
- fromJson() : static
- Creates an instance from JSON-RPC response data
- getEntries() : array<string|int, LedgerEntry>|null
- getError() : SorobanRpcErrorResponse|null
- getJsonResponse() : array<string|int, mixed>
- getLatestLedger() : int|null
- setEntries() : void
- setError() : void
- setJsonResponse() : void
- setLatestLedger() : void
Properties
$entries
public
array<string|int, LedgerEntry>|null
$entries
= null
Array of found ledger entries
$error
public
SorobanRpcErrorResponse|null
$error
= null
Error data if the response is an error response
$jsonResponse
public
array<string|int, mixed>
$jsonResponse
$latestLedger
public
int|null
$latestLedger
= null
The sequence number of the latest ledger known to Soroban RPC at the time it handled the request
Methods
__construct()
public
__construct(array<string|int, mixed> $jsonResponse) : mixed
Parameters
- $jsonResponse : array<string|int, mixed>
-
The complete JSON response as data array
fromJson()
Creates an instance from JSON-RPC response data
public
static fromJson(array<string, mixed> $json) : static
Parameters
- $json : array<string, mixed>
-
The JSON response data
Return values
static —The created instance
getEntries()
public
getEntries() : array<string|int, LedgerEntry>|null
Return values
array<string|int, LedgerEntry>|null —Array of found ledger entries
getError()
public
getError() : SorobanRpcErrorResponse|null
Return values
SorobanRpcErrorResponse|null —Error data if the response is an error response
getJsonResponse()
public
getJsonResponse() : array<string|int, mixed>
Return values
array<string|int, mixed> —The complete JSON response as data array
getLatestLedger()
public
getLatestLedger() : int|null
Return values
int|null —The sequence number of the latest ledger known to Soroban RPC at the time it handled the request
setEntries()
public
setEntries(array<string|int, LedgerEntry>|null $entries) : void
Parameters
- $entries : array<string|int, LedgerEntry>|null
-
Array of found ledger entries
setError()
public
setError(SorobanRpcErrorResponse|null $error) : void
Parameters
- $error : SorobanRpcErrorResponse|null
-
Error data if the response is an error response
setJsonResponse()
public
setJsonResponse(array<string|int, mixed> $jsonResponse) : void
Parameters
- $jsonResponse : array<string|int, mixed>
-
The complete JSON response as data array
setLatestLedger()
public
setLatestLedger(int|null $latestLedger) : void
Parameters
- $latestLedger : int|null
-
The sequence number of the latest ledger