Class Info

Inheritance

object

BaseMethodResult

Info

Inherited Members

BaseMethodResult.UnknownFields

Namespace: Xrpl.Models.Methods

Assembly: Xrpl.dll

Syntax

public class Info : BaseMethodResult

Properties

AccountingStateSummary

A map of various server states with information about the time the server spends in each.
This can be useful for tracking the long-term health of your server's connectivity to the network.

Declaration

[JsonPropertyName("state_accounting")]
public AccountingStateSummary AccountingStateSummary { get; set; }

Property Value

Type	Description
AccountingStateSummary

BuildVersion

The version number of the running rippled version.

Declaration

[JsonPropertyName("build_version")]
public string BuildVersion { get; set; }

Property Value

Type	Description
string

CompleteLedgers

Range expression indicating the sequence numbers of the ledger versions the local rippled has in its database.

Declaration

[JsonPropertyName("complete_ledgers")]
public string CompleteLedgers { get; set; }

Property Value

Type	Description
string

Git

Which source revision this server was built from.

Declaration

[JsonPropertyName("git")]
public GitInfo Git { get; set; }

Property Value

Type	Description
GitInfo

Remarks

Not sent by every build - absent leaves this null rather than raising.

HostId

On an admin request, returns the hostname of the server running the rippled instance;
otherwise, returns a single RFC-1751 word based on the node public key.

Declaration

[JsonPropertyName("hostid")]
public string HostId { get; set; }

Property Value

Type	Description
string

InitialSyncDurationUs

How long it took this server to reach a synchronised state after starting, in microseconds. A string, as the node sends it.

Declaration

[JsonPropertyName("initial_sync_duration_us")]
public string InitialSyncDurationUs { get; set; }

Property Value

Type	Description
string

IoLatencyMs

Amount of time spent waiting for I/O operations, in milliseconds.
If this number is not very, very low, then the rippled server is probably having serious load issues.

Declaration

[JsonPropertyName("io_latency_ms")]
public int IoLatencyMs { get; set; }

Property Value

Type	Description
int

JqTransOverflow

How many times this server's job queue has overflowed since it started.

Declaration

[JsonPropertyName("jq_trans_overflow")]
public string JqTransOverflow { get; set; }

Property Value

Type	Description
string

Remarks

Declared as a string because that is what the node sends - the same field on server_state is already modelled that way.

LastClose

Information about the last time the server closed a ledger, including the amount of time it took to reach a consensus and the number of trusted validators participating.

Declaration

[JsonPropertyName("last_close")]
public LastClose LastClose { get; set; }

Property Value

Type	Description
LastClose

Load

(Admin only) Detailed information about the current load state of the server.

Declaration

[JsonPropertyName("load")]
public Load Load { get; set; }

Property Value

Type	Description
Load

LoadFactor

The load-scaled open ledger transaction cost the server is currently enforcing, as a multiplier on the base transaction cost.
For example, at 1000 load factor and a reference transaction cost of 10 drops of XRP, the load-scaled transaction cost is 10,000 drops (0.01 XRP).
The load factor is determined by the highest of the individual server's load factor, the cluster's load factor, the open ledger cost and the overall network's load factor.

Declaration

[JsonPropertyName("load_factor")]
public double? LoadFactor { get; set; }

Property Value

Type	Description
double?

LoadFactorNet

Current multiplier to the transaction cost being used by the rest of the network.

Declaration

[JsonPropertyName("load_factor_net")]
public double? LoadFactorNet { get; set; }

Property Value

Type	Description
double?

NetworkID

he NetworkID field is a protection against "cross-chain" transaction replay attacks,
preventing the same transaction from being copied over
and executing on a parallel network that it wasn't intended for.
For compatibility with existing chains, the NetworkID field
must be omitted on any network with a Network ID of 1024 or less,
but must be included on any network with a Network ID of 1025 or greater.

Declaration

[JsonPropertyName("network_id")]
public uint? NetworkID { get; set; }

Property Value

Type	Description
uint?

NodeSize

The rough size of this server's configured node, e.g. tiny, small, huge.

Declaration

[JsonPropertyName("node_size")]
public string NodeSize { get; set; }

Property Value

Type	Description
string

PeerDisconnects

How many peers this server has disconnected since it started.

Declaration

[JsonPropertyName("peer_disconnects")]
public string PeerDisconnects { get; set; }

Property Value

Type	Description
string

PeerDisconnectsResources

How many peers this server has disconnected for exceeding a resource limit.

Declaration

[JsonPropertyName("peer_disconnects_resources")]
public string PeerDisconnectsResources { get; set; }

Property Value

Type	Description
string

Peers

How many other rippled servers this one is currently connected to.

Declaration

[JsonPropertyName("peers")]
public int Peers { get; set; }

Property Value

Type	Description
int

Ports

The ports this server is listening on, and what speaks on each.

Declaration

[JsonPropertyName("ports")]
public List<ServerPort> Ports { get; set; }

Property Value

Type	Description
List<ServerPort>

PubkeyNode

Public key used to verify this server for peer-to-peer communications.
This node key pair is automatically generated by the server the first time it starts up.
(If deleted, the server can create a new pair of Keys).

Declaration

[JsonPropertyName("pubkey_node")]
public string PubkeyNode { get; set; }

Property Value

Type	Description
string

PubkeyValidator

Public key used by this node to sign ledger validations.

Declaration

[JsonPropertyName("pubkey_validator")]
public string PubkeyValidator { get; set; }

Property Value

Type	Description
string

ServerState

A string indicating to what extent the server is participating in the network.

Declaration

[JsonPropertyName("server_state")]
[JsonConverter(typeof(EnumMemberValueConverter<ServerStateInner>))]
public ServerStateInner ServerState { get; set; }

Property Value

Type	Description
ServerStateInner

ServerStateDurationUs

How long the server has been in its current ServerState, in microseconds.

Declaration

[JsonPropertyName("server_state_duration_us")]
public string ServerStateDurationUs { get; set; }

Property Value

Type	Description
string

Remarks

A string here, although ServerState.State declares the same field as a number. Measured against a node rather than assumed: server_info sends "25380868", quoted.

Time

The server's current time in UTC, as a human-readable string.

Declaration

[JsonPropertyName("time")]
public string Time { get; set; }

Property Value

Type	Description
string

Uptime

Number of consecutive seconds that the server has been operational.

Declaration

[JsonPropertyName("uptime")]
public int Uptime { get; set; }

Property Value

Type	Description
int

UptimeTimeSpan

Declaration

[JsonIgnore]
public TimeSpan UptimeTimeSpan { get; }

Property Value

Type	Description
TimeSpan

ValidatedLedger

Information about the most recent fully-validated ledger.

Declaration

[JsonPropertyName("validated_ledger")]
public ValidatedLedger? ValidatedLedger { get; set; }

Property Value

Type	Description
ValidatedLedger

ValidationQuorum

Minimum number of trusted validations required to validate a ledger version.
Some circumstances may cause the server to require more validations.

Declaration

[JsonPropertyName("validation_quorum")]
public long ValidationQuorum { get; set; }

Property Value

Type	Description
long

ValidatorList

The state of the published validator list this server is following.

Declaration

[JsonPropertyName("validator_list")]
public ValidatorListInfo ValidatorList { get; set; }

Property Value

Type	Description
ValidatorListInfo

Remarks

Supersedes ValidatorListExpires, which modern rippled does not send.

ValidatorListExpires

Either the human readable time, in UTC, when the current validator list will expire, the string unknown if the server has yet to load a published validator list or the string never if the server uses a static validator list.

Declaration

[JsonPropertyName("validator_list_expires")]
[JsonConverter(typeof(NumberOrStringConverter))]
public string ValidatorListExpires { get; set; }

Property Value

Type	Description
string