mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-19 11:45:49 +00:00
3e55066b70
* rename: branch develop -> main; master -> old-master * Update all references to `master` and `develop` * Update the GitHub pages docs Co-authored-by: Jackson Mills <jmills@ripple.com>, Elliot Lee <intelliot@ripple.com>
124 lines
43 KiB
HTML
124 lines
43 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerInfoResponse | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="ServerInfoResponse.html">ServerInfoResponse</a></li></ul><h1>Interface ServerInfoResponse</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Response expected from a <a href="ServerInfoRequest.html">ServerInfoRequest</a>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseResponse</span><ul class="tsd-hierarchy"><li><span class="target">ServerInfoResponse</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ServerInfoResponse.html#result" class="tsd-kind-icon">result</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#status" class="tsd-kind-icon">status</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#warning" class="tsd-kind-icon">warning</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#warnings" class="tsd-kind-icon">warnings</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L31">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="forwarded" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> forwarded</h3><div class="tsd-signature tsd-kind-icon">forwarded<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.forwarded</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L30">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L24">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="result" class="tsd-anchor"></a><h3>result</h3><div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>amendment_blocked<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>build_version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>closed_ledger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>age<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>base_fee_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>reserve_base_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>reserve_inc_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>complete_ledgers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hostid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>io_latency_ms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>jq_trans_overflow<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>last_close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>converge_time_s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>proposers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>load<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>job_types<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JobType</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>threads<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>load_factor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_cluster<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_fee_escalation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_fee_queue<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_net<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_server<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>network_ledger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"waiting"</span><span class="tsd-signature-symbol">; </span>peers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pubkey_node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pubkey_validator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>server_state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerState</span><span class="tsd-signature-symbol">; </span>server_state_duration_us<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>state_accounting<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ServerState</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">StateAccounting</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>uptime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>validated_ledger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>age<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>base_fee_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>reserve_base_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>reserve_inc_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>validation_quorum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>validator_list_expires<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><p>Overrides BaseResponse.result</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/serverInfo.ts#L42">ripple-lib/packages/xrpl/src/models/methods/serverInfo.ts:42</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>amendment_blocked<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>build_version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>closed_ledger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>age<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>base_fee_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>reserve_base_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>reserve_inc_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>complete_ledgers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>hostid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>io_latency_ms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>jq_trans_overflow<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>last_close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>converge_time_s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>proposers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>load<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>job_types<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JobType</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>threads<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>load_factor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_cluster<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_fee_escalation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_fee_queue<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_net<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>load_factor_server<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>network_ledger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"waiting"</span><span class="tsd-signature-symbol">; </span>peers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pubkey_node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>pubkey_validator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>server_state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerState</span><span class="tsd-signature-symbol">; </span>server_state_duration_us<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>state_accounting<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ServerState</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">StateAccounting</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>uptime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>validated_ledger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>age<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>base_fee_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>reserve_base_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>reserve_inc_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>validation_quorum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>validator_list_expires<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> amendment_<wbr/>blocked<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If true, this server is amendment blocked. If the server is not
|
|
amendment blocked, the response omits this field.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>build_<wbr/>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The version number of the running rippled version.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> closed_<wbr/>ledger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>age<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>base_fee_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>reserve_base_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>reserve_inc_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Information on the most recently closed ledger that has not been
|
|
validated by consensus. If the most recently validated ledger is
|
|
available, the response omits this field and includes
|
|
<code>validated_ledger</code> instead. The member fields are the same as the.
|
|
<code>validated_ledger</code> field.</p>
|
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>age<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>base_<wbr/>fee_<wbr/>xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>reserve_<wbr/>base_<wbr/>xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>reserve_<wbr/>inc_<wbr/>xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5>complete_<wbr/>ledgers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Range expression indicating the sequence numbers of the ledger
|
|
versions the local rippled has in its database.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>hostid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>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.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>io_<wbr/>latency_<wbr/>ms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>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.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>jq_<wbr/>trans_<wbr/>overflow<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The number of times (since starting up) that this server has had over
|
|
250 transactions waiting to be processed at once. A large number here
|
|
may mean that your server is unable to handle the transaction load of
|
|
the XRP Ledger network.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>last_<wbr/>close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>converge_time_s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>proposers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>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.</p>
|
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>converge_<wbr/>time_<wbr/>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The amount of time it took to reach a consensus on the most recently
|
|
validated ledger version, in seconds.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>proposers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>How many trusted validators the server considered (including itself,
|
|
if configured as a validator) in the consensus process for the most
|
|
recently validated ledger version.</p>
|
|
</div></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> load<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>job_types<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JobType</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>threads<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>(Admin only) Detailed information about the current load state of the
|
|
server.</p>
|
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>job_<wbr/>types<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JobType</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>(Admin only) Information about the rate of different types of jobs
|
|
the server is doing and how much time it spends on each.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>threads<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>(Admin only) The number of threads in the server's main job pool.</p>
|
|
</div></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> load_<wbr/>factor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>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.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> load_<wbr/>factor_<wbr/>cluster<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Current multiplier to the transaction cost based on load to servers
|
|
in this cluster.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> load_<wbr/>factor_<wbr/>fee_<wbr/>escalation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The current multiplier to the transaction cost that a transaction must
|
|
pay to get into the open ledger.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> load_<wbr/>factor_<wbr/>fee_<wbr/>queue<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The current multiplier to the transaction cost that a transaction must
|
|
pay to get into the queue, if the queue is full.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> load_<wbr/>factor_<wbr/>local<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Current multiplier to the transaction cost based on
|
|
load to this server.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> load_<wbr/>factor_<wbr/>net<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Current multiplier to the transaction cost being used by the rest of
|
|
the network.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> load_<wbr/>factor_<wbr/>server<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The load factor the server is enforcing, not including the open ledger
|
|
cost.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> network_<wbr/>ledger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"waiting"</span></h5></li><li class="tsd-parameter"><h5>peers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>How many other rippled servers this one is currently connected to.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>pubkey_<wbr/>node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>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.).</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> pubkey_<wbr/>validator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Public key used by this node to sign ledger validations.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>server_<wbr/>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerState</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A string indicating to what extent the server is participating in the
|
|
network.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>server_<wbr/>state_<wbr/>duration_<wbr/>us<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The number of consecutive microseconds the server has been in the
|
|
current state.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>state_<wbr/>accounting<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ServerState</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">StateAccounting</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>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.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The current time in UTC, according to the server's clock.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>uptime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Number of consecutive seconds that the server has been operational.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> validated_<wbr/>ledger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>age<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>base_fee_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>reserve_base_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>reserve_inc_xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Information about the most recent fully-validated ledger.</p>
|
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>age<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The time since the ledger was closed, in seconds.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>base_<wbr/>fee_<wbr/>xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Base fee, in XRP. This may be represented in scientific notation.
|
|
Such as 1e-05 for 0.00005.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Unique hash for the ledger, as hexadecimal.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>reserve_<wbr/>base_<wbr/>xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Minimum amount of XRP (not drops) necessary for every account to.
|
|
Keep in reserve .</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>reserve_<wbr/>inc_<wbr/>xrp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Amount of XRP (not drops) added to the account reserve for each
|
|
object an account owns in the ledger.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The ledger index of the latest validated ledger.</p>
|
|
</div></div></li></ul></li><li class="tsd-parameter"><h5>validation_<wbr/>quorum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Minimum number of trusted validations required to validate a ledger
|
|
version. Some circumstances may cause the server to require more
|
|
validations.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> validator_<wbr/>list_<wbr/>expires<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>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.</p>
|
|
</div></div></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="status" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3><div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.status</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L25">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.type</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L26">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="warning" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> warning</h3><div class="tsd-signature tsd-kind-icon">warning<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"load"</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.warning</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L28">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="warnings" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> warnings</h3><div class="tsd-signature tsd-kind-icon">warnings<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Warning</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseResponse.warnings</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L29">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:29</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ServerInfoResponse.html" class="tsd-kind-icon">Server<wbr/>Info<wbr/>Response</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ServerInfoResponse.html#result" class="tsd-kind-icon">result</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#status" class="tsd-kind-icon">status</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#warning" class="tsd-kind-icon">warning</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#warnings" class="tsd-kind-icon">warnings</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |