mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-20 12:15:51 +00:00
348 lines
51 KiB
HTML
348 lines
51 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
<div class="tsd-toolbar-contents container">
|
|
<div class="table-cell" id="tsd-search" data-base="..">
|
|
<div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></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"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
<div class="container container-main">
|
|
<div class="col-8 col-content">
|
|
<div class="tsd-page-title">
|
|
<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>
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography"><p>Response expected from a <a href="ServerInfoRequest.html">ServerInfoRequest</a>.</p>
|
|
</div></section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h4>Hierarchy</h4>
|
|
<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><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/serverInfo.ts#L41">packages/xrpl/src/models/methods/serverInfo.ts:41</a></li></ul></aside>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
|
<div class="tsd-accordion-details">
|
|
<section class="tsd-index-section">
|
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
<div class="tsd-index-list"><a href="ServerInfoResponse.html#api_version" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>api_<wbr/>version</span></a>
|
|
<a href="ServerInfoResponse.html#forwarded" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>forwarded</span></a>
|
|
<a href="ServerInfoResponse.html#id" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>id</span></a>
|
|
<a href="ServerInfoResponse.html#result" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>result</span></a>
|
|
<a href="ServerInfoResponse.html#status" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>status</span></a>
|
|
<a href="ServerInfoResponse.html#type" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>type</span></a>
|
|
<a href="ServerInfoResponse.html#warning" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>warning</span></a>
|
|
<a href="ServerInfoResponse.html#warnings" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>warnings</span></a>
|
|
</div></section></div></details></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 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api_<wbr/>version</span><a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
|
|
<div class="tsd-signature">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/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/baseMethod.ts#L31">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 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>forwarded</span><a href="#forwarded" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">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/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/baseMethod.ts#L30">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 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">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/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/baseMethod.ts#L24">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"><a id="result" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>result</span><a href="#result" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">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>
|
|
<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><code class="tsd-tag ts-flagOptional">Optional</code> amendment_<wbr/>blocked<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>If true, this server is amendment blocked. If the server is not
|
|
amendment blocked, the response omits this field.</p>
|
|
</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"><p>The version number of the running rippled version.</p>
|
|
</div></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><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>
|
|
<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"><p>Range expression indicating the sequence numbers of the ledger
|
|
versions the local rippled has in its database.</p>
|
|
</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"><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></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"><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></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"><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></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"><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>
|
|
<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"><p>The amount of time it took to reach a consensus on the most recently
|
|
validated ledger version, in seconds.</p>
|
|
</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"><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></li></ul></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><p>(Admin only) Detailed information about the current load state of the
|
|
server.</p>
|
|
</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"><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></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"><p>(Admin only) The number of threads in the server's main job pool.</p>
|
|
</div></li></ul></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> load_<wbr/>factor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography"><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></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><p>Current multiplier to the transaction cost based on load to servers
|
|
in this cluster.</p>
|
|
</div></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><p>The current multiplier to the transaction cost that a transaction must
|
|
pay to get into the open ledger.</p>
|
|
</div></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><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></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><p>Current multiplier to the transaction cost based on
|
|
load to this server.</p>
|
|
</div></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><p>Current multiplier to the transaction cost being used by the rest of
|
|
the network.</p>
|
|
</div></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><p>The load factor the server is enforcing, not including the open ledger
|
|
cost.</p>
|
|
</div></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><p>How many other rippled servers this one is currently connected to.</p>
|
|
</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"><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></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> pubkey_<wbr/>validator<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Public key used by this node to sign ledger validations.</p>
|
|
</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"><p>A string indicating to what extent the server is participating in the
|
|
network.</p>
|
|
</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"><p>The number of consecutive microseconds the server has been in the
|
|
current state.</p>
|
|
</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"><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></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"><p>The current time in UTC, according to the server's clock.</p>
|
|
</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"><p>Number of consecutive seconds that the server has been operational.</p>
|
|
</div></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><p>Information about the most recent fully-validated ledger.</p>
|
|
</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"><p>The time since the ledger was closed, in seconds.</p>
|
|
</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"><p>Base fee, in XRP. This may be represented in scientific notation.
|
|
Such as 1e-05 for 0.00005.</p>
|
|
</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"><p>Unique hash for the ledger, as hexadecimal.</p>
|
|
</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"><p>Minimum amount of XRP (not drops) necessary for every account to.
|
|
Keep in reserve .</p>
|
|
</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"><p>Amount of XRP (not drops) added to the account reserve for each
|
|
object an account owns in the ledger.</p>
|
|
</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"><p>The ledger index of the latest validated ledger.</p>
|
|
</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"><p>Minimum number of trusted validations required to validate a ledger
|
|
version. Some circumstances may cause the server to require more
|
|
validations.</p>
|
|
</div></li>
|
|
<li class="tsd-parameter">
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> 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"><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></li></ul></li></ul></div><aside class="tsd-sources">
|
|
<p>Overrides BaseResponse.result</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/serverInfo.ts#L42">packages/xrpl/src/models/methods/serverInfo.ts:42</a></li></ul></aside></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 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">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/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/baseMethod.ts#L25">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 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">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/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/baseMethod.ts#L26">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 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>warning</span><a href="#warning" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">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/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/baseMethod.ts#L28">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 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>warnings</span><a href="#warnings" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">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/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/baseMethod.ts#L29">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">
|
|
<div class="tsd-navigation settings">
|
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<div class="tsd-filter-visibility">
|
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
<ul id="tsd-filter-options">
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
<div class="tsd-theme-toggle">
|
|
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
<nav class="tsd-navigation primary">
|
|
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<ul>
|
|
<li><a href="../modules.html">xrpl</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></li></ul></div></details></nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul>
|
|
<li class="current tsd-kind-interface"><a href="ServerInfoResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Server<wbr/>Info<wbr/>Response</span></a>
|
|
<ul>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#api_version" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>api_<wbr/>version</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#forwarded" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>forwarded</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>id</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ServerInfoResponse.html#result" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>result</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#status" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>status</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>type</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#warning" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>warning</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ServerInfoResponse.html#warnings" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>warnings</a></li></ul></li></ul></nav></div></div>
|
|
<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> |