diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css new file mode 100644 index 00000000..46571c27 --- /dev/null +++ b/docs/assets/css/main.css @@ -0,0 +1,2660 @@ +:root { + --color-background: #fdfdfd; + --color-text: #222; + --color-text-aside: #707070; + --color-link: #4da6ff; + --color-menu-divider: #eee; + --color-menu-divider-focus: #000; + --color-menu-label: #707070; + --color-panel: #fff; + --color-panel-divider: #eee; + --color-comment-tag: #707070; + --color-comment-tag-text: #fff; + --color-code-background: rgba(0, 0, 0, 0.04); + --color-ts: #9600ff; + --color-ts-interface: #647f1b; + --color-ts-enum: #937210; + --color-ts-class: #0672de; + --color-ts-private: #707070; + --color-toolbar: #fff; + --color-toolbar-text: #333; +} + +/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ +/* ========================================================================== + * * HTML5 display definitions + * * ========================================================================== */ +/** + * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ +article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { + display: block; +} + +/** + * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ +audio, canvas, video { + display: inline-block; + *display: inline; + *zoom: 1; +} + +/** + * * Prevent modern browsers from displaying `audio` without controls. + * * Remove excess height in iOS 5 devices. */ +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. + * * Known issue: no IE 6 support. */ +[hidden] { + display: none; +} + +/* ========================================================================== + * * Base + * * ========================================================================== */ +/** + * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using + * * `em` units. + * * 2. Prevent iOS text size adjust after orientation change, without disabling + * * user zoom. */ +html { + font-size: 100%; + /* 1 */ + -ms-text-size-adjust: 100%; + /* 2 */ + -webkit-text-size-adjust: 100%; + /* 2 */ + font-family: sans-serif; +} + +/** + * * Address `font-family` inconsistency between `textarea` and other form + * * elements. */ +button, input, select, textarea { + font-family: sans-serif; +} + +/** + * * Address margins handled incorrectly in IE 6/7. */ +body { + margin: 0; +} + +/* ========================================================================== + * * Links + * * ========================================================================== */ +/** + * * Address `outline` inconsistency between Chrome and other browsers. */ +a:focus { + outline: thin dotted; +} +a:active, a:hover { + outline: 0; +} + +/** + * * Improve readability when focused and also mouse hovered in all browsers. */ +/* ========================================================================== + * * Typography + * * ========================================================================== */ +/** + * * Address font sizes and margins set differently in IE 6/7. + * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, + * * and Chrome. */ +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, .tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +/** + * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ +b, strong { + font-weight: bold; +} + +blockquote { + margin: 1em 40px; +} + +/** + * * Address styling not present in Safari 5 and Chrome. */ +dfn { + font-style: italic; +} + +/** + * * Address differences between Firefox and other browsers. + * * Known issue: no IE 6/7 normalization. */ +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * * Address styling not present in IE 6/7/8/9. */ +mark { + background: #ff0; + color: #000; +} + +/** + * * Address margins set differently in IE 6/7. */ +p, pre { + margin: 1em 0; +} + +/** + * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ +code, kbd, pre, samp { + font-family: monospace, serif; + _font-family: "courier new", monospace; + font-size: 1em; +} + +/** + * * Improve readability of pre-formatted text in all browsers. */ +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +/** + * * Address CSS quotes not supported in IE 6/7. */ +q { + quotes: none; +} +q:before, q:after { + content: ""; + content: none; +} + +/** + * * Address `quotes` property not supported in Safari 4. */ +/** + * * Address inconsistent and variable font size in all browsers. */ +small { + font-size: 80%; +} + +/** + * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ +sub { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* ========================================================================== + * * Lists + * * ========================================================================== */ +/** + * * Address margins set differently in IE 6/7. */ +dl, menu, ol, ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +/** + * * Address paddings set differently in IE 6/7. */ +menu, ol, ul { + padding: 0 0 0 40px; +} + +/** + * * Correct list images handled incorrectly in IE 7. */ +nav ul, nav ol { + list-style: none; + list-style-image: none; +} + +/* ========================================================================== + * * Embedded content + * * ========================================================================== */ +/** + * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. + * * 2. Improve image quality when scaled in IE 7. */ +img { + border: 0; + /* 1 */ + -ms-interpolation-mode: bicubic; +} + +/* 2 */ +/** + * * Correct overflow displayed oddly in IE 9. */ +svg:not(:root) { + overflow: hidden; +} + +/* ========================================================================== + * * Figures + * * ========================================================================== */ +/** + * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ +figure, form { + margin: 0; +} + +/* ========================================================================== + * * Forms + * * ========================================================================== */ +/** + * * Correct margin displayed oddly in IE 6/7. */ +/** + * * Define consistent border, margin, and padding. */ +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * * 1. Correct color not being inherited in IE 6/7/8/9. + * * 2. Correct text not wrapping in Firefox 3. + * * 3. Correct alignment displayed oddly in IE 6/7. */ +legend { + border: 0; + /* 1 */ + padding: 0; + white-space: normal; + /* 2 */ + *margin-left: -7px; +} + +/* 3 */ +/** + * * 1. Correct font size not being inherited in all browsers. + * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, + * * and Chrome. + * * 3. Improve appearance and consistency in all browsers. */ +button, input, select, textarea { + font-size: 100%; + /* 1 */ + margin: 0; + /* 2 */ + vertical-align: baseline; + /* 3 */ + *vertical-align: middle; +} + +/* 3 */ +/** + * * Address Firefox 3+ setting `line-height` on `input` using `!important` in + * * the UA stylesheet. */ +button, input { + line-height: normal; +} + +/** + * * Address inconsistent `text-transform` inheritance for `button` and `select`. + * * All other form control elements do not inherit `text-transform` values. + * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. + * * Correct `select` style inheritance in Firefox 4+ and Opera. */ +button, select { + text-transform: none; +} + +/** + * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * * and `video` controls. + * * 2. Correct inability to style clickable `input` types in iOS. + * * 3. Improve usability and consistency of cursor style between image-type + * * `input` and others. + * * 4. Remove inner spacing in IE 7 without affecting normal text inputs. + * * Known issue: inner spacing remains in IE 6. */ +button, html input[type=button] { + -webkit-appearance: button; + /* 2 */ + cursor: pointer; + /* 3 */ + *overflow: visible; +} + +/* 4 */ +input[type=reset], input[type=submit] { + -webkit-appearance: button; + /* 2 */ + cursor: pointer; + /* 3 */ + *overflow: visible; +} + +/* 4 */ +/** + * * Re-set default cursor for disabled elements. */ +button[disabled], html input[disabled] { + cursor: default; +} + +/** + * * 1. Address box sizing set to content-box in IE 8/9. + * * 2. Remove excess padding in IE 8/9. + * * 3. Remove excess padding in IE 7. + * * Known issue: excess padding remains in IE 6. */ +input { + /* 3 */ +} +input[type=checkbox], input[type=radio] { + box-sizing: border-box; + /* 1 */ + padding: 0; + /* 2 */ + *height: 13px; + /* 3 */ + *width: 13px; +} +input[type=search] { + -webkit-appearance: textfield; + /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; + /* 2 */ + box-sizing: content-box; +} +input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. + * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome + * * (include `-moz` to future-proof). */ +/** + * * Remove inner padding and search cancel button in Safari 5 and Chrome + * * on OS X. */ +/** + * * Remove inner padding and border in Firefox 3+. */ +button::-moz-focus-inner, input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * * 1. Remove default vertical scrollbar in IE 6/7/8/9. + * * 2. Improve readability and alignment in all browsers. */ +textarea { + overflow: auto; + /* 1 */ + vertical-align: top; +} + +/* 2 */ +/* ========================================================================== + * * Tables + * * ========================================================================== */ +/** + * * Remove most spacing between table cells. */ +table { + border-collapse: collapse; + border-spacing: 0; +} + +ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col > :first-child > :first-child, +.col-11 > :first-child > :first-child, +.col-10 > :first-child > :first-child, +.col-9 > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-7 > :first-child > :first-child, +.col-6 > :first-child > :first-child, +.col-5 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +.col-3 > :first-child > :first-child, +.col-2 > :first-child > :first-child, +.col-1 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col > :first-child > :first-child > :first-child, +.col-11 > :first-child > :first-child > :first-child, +.col-10 > :first-child > :first-child > :first-child, +.col-9 > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-7 > :first-child > :first-child > :first-child, +.col-6 > :first-child > :first-child > :first-child, +.col-5 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child, +.col-3 > :first-child > :first-child > :first-child, +.col-2 > :first-child > :first-child > :first-child, +.col-1 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col > :last-child > :last-child, +.col-11 > :last-child > :last-child, +.col-10 > :last-child > :last-child, +.col-9 > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-7 > :last-child > :last-child, +.col-6 > :last-child > :last-child, +.col-5 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +.col-3 > :last-child > :last-child, +.col-2 > :last-child > :last-child, +.col-1 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col > :last-child > :last-child > :last-child, +.col-11 > :last-child > :last-child > :last-child, +.col-10 > :last-child > :last-child > :last-child, +.col-9 > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-7 > :last-child > :last-child > :last-child, +.col-6 > :last-child > :last-child > :last-child, +.col-5 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child, +.col-3 > :last-child > :last-child > :last-child, +.col-2 > :last-child > :last-child > :last-child, +.col-1 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-1 { + width: 8.3333333333%; +} + +.offset-1 { + margin-left: 8.3333333333%; +} + +.col-2 { + width: 16.6666666667%; +} + +.offset-2 { + margin-left: 16.6666666667%; +} + +.col-3 { + width: 25%; +} + +.offset-3 { + margin-left: 25%; +} + +.col-4 { + width: 33.3333333333%; +} + +.offset-4 { + margin-left: 33.3333333333%; +} + +.col-5 { + width: 41.6666666667%; +} + +.offset-5 { + margin-left: 41.6666666667%; +} + +.col-6 { + width: 50%; +} + +.offset-6 { + margin-left: 50%; +} + +.col-7 { + width: 58.3333333333%; +} + +.offset-7 { + margin-left: 58.3333333333%; +} + +.col-8 { + width: 66.6666666667%; +} + +.offset-8 { + margin-left: 66.6666666667%; +} + +.col-9 { + width: 75%; +} + +.offset-9 { + margin-left: 75%; +} + +.col-10 { + width: 83.3333333333%; +} + +.offset-10 { + margin-left: 83.3333333333%; +} + +.col-11 { + width: 91.6666666667%; +} + +.offset-11 { + margin-left: 91.6666666667%; +} + +.tsd-kind-icon { + display: block; + position: relative; + padding-left: 20px; + text-indent: -20px; +} +.tsd-kind-icon:before { + content: ""; + display: inline-block; + vertical-align: middle; + width: 17px; + height: 17px; + margin: 0 3px 2px 0; + background-image: url(../images/icons.png); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-kind-icon:before { + background-image: url(../images/icons@2x.png); + background-size: 238px 204px; + } +} + +.tsd-signature.tsd-kind-icon:before { + background-position: 0 -153px; +} + +.tsd-kind-object-literal > .tsd-kind-icon:before { + background-position: 0px -17px; +} +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -17px; +} +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -17px; +} + +.tsd-kind-class > .tsd-kind-icon:before { + background-position: 0px -34px; +} +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -34px; +} +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -34px; +} + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -51px; +} + +.tsd-kind-interface > .tsd-kind-icon:before { + background-position: 0px -68px; +} +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -68px; +} +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -68px; +} + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -85px; +} + +.tsd-kind-namespace > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-module > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-enum > .tsd-kind-icon:before { + background-position: 0px -119px; +} +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -119px; +} +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -119px; +} + +.tsd-kind-enum-member > .tsd-kind-icon:before { + background-position: 0px -136px; +} +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -136px; +} +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -136px; +} + +.tsd-kind-signature > .tsd-kind-icon:before { + background-position: 0px -153px; +} +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -153px; +} +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -153px; +} + +.tsd-kind-type-alias > .tsd-kind-icon:before { + background-position: 0px -170px; +} +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -170px; +} +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -170px; +} + +.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -187px; +} + +.tsd-kind-variable > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-property > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-get-signature > .tsd-kind-icon:before { + background-position: -136px -17px; +} +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -17px; +} +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -17px; +} + +.tsd-kind-set-signature > .tsd-kind-icon:before { + background-position: -136px -34px; +} +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -34px; +} +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -34px; +} + +.tsd-kind-accessor > .tsd-kind-icon:before { + background-position: -136px -51px; +} +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -51px; +} +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -51px; +} + +.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-constructor > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-index-signature > .tsd-kind-icon:before { + background-position: -136px -119px; +} +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -119px; +} +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -119px; +} + +.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -136px; +} +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -136px; +} +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -136px; +} + +.tsd-is-static > .tsd-kind-icon:before { + background-position: -136px -153px; +} +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -153px; +} +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -153px; +} +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -153px; +} + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -187px; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} + +code, pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; + background-color: var(--color-code-background); +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; + background-color: transparent; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, .tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, .tsd-typography ul, .tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html.default .col-content { + width: 72%; + } + html.default .col-menu { + width: 28%; + } + html.default .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html.default .col-content { + float: none; + width: 100%; + } + html.default .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: var(--color-panel); + transform: translate(100%, 0); + } + html.default .col-menu > *:last-child { + padding-bottom: 20px; + } + html.default .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + html.default.to-has-menu .overlay { + animation: fade-in 0.4s; + } + html.default.to-has-menu header, +html.default.to-has-menu footer, +html.default.to-has-menu .col-content { + animation: shift-to-left 0.4s; + } + html.default.to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + html.default.from-has-menu .overlay { + animation: fade-out 0.4s; + } + html.default.from-has-menu header, +html.default.from-has-menu footer, +html.default.from-has-menu .col-content { + animation: unshift-to-left 0.4s; + } + html.default.from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + html.default.has-menu body { + overflow: hidden; + } + html.default.has-menu .overlay { + visibility: visible; + } + html.default.has-menu header, +html.default.has-menu footer, +html.default.has-menu .col-content { + transform: translate(-25%, 0); + } + html.default.has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: var(--color-panel); + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +html.minimal .container { + margin: 0; +} +html.minimal .container-main { + padding-top: 50px; + padding-bottom: 0; +} +html.minimal .content-wrap { + padding-left: 300px; +} +html.minimal .tsd-navigation { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + box-sizing: border-box; + z-index: 1; + left: 0; + top: 40px; + bottom: 0; + width: 300px; + padding: 20px; + margin: 0; +} +html.minimal .tsd-member .tsd-member { + margin-left: 0; +} +html.minimal .tsd-page-toolbar { + position: fixed; + z-index: 2; +} +html.minimal #tsd-filter .tsd-filter-group { + right: 0; + transform: none; +} +html.minimal footer { + background-color: transparent; +} +html.minimal footer .container { + padding: 0; +} +html.minimal .tsd-generator { + padding: 0; +} +@media (max-width: 900px) { + html.minimal .tsd-navigation { + display: none; + } + html.minimal .content-wrap { + padding-left: 0; + } +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid var(--color-comment-tag); + color: var(--color-comment-tag); + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: var(--color-panel); + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, +#tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid var(--color-panel-divider); + background-color: var(--color-panel); +} +footer.with-border-bottom { + border-bottom: 1px solid var(--color-panel-divider); +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 1; + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 2; + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-parent-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-is-private a { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 1px 5px; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 14px; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member a[data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member a[data-tsd-kind=Interface] { + color: var(--color-ts-interface); +} +.tsd-member a[data-tsd-kind=Enum] { + color: var(--color-ts-enum); +} +.tsd-member a[data-tsd-kind=Class] { + color: var(--color-ts-class); +} +.tsd-member a[data-tsd-kind=Private] { + color: var(--color-ts-private); +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li { + border-top: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: var(--color-menu-label); +} +.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: -webkit-sticky; + position: sticky; + top: calc(.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: var(--color-menu-divider-focus); +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: var(--color-panel); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, .tsd-panel table td { + padding: 6px 13px; + border: 1px solid #ddd; +} +.tsd-panel table tr { + background-color: #fff; + border-top: 1px solid #ccc; +} +.tsd-panel table tr:nth-child(2n) { + background-color: #f8f8f8; +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-panel); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-panel-divider); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-panel-divider); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid var(--color-panel-divider); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid var(--color-panel-divider); +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: var(--color-panel-divider); +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: var(--color-text-aside); + margin: 0 0 1em 0; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul, .tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: var(--color-toolbar-text); + background: var(--color-toolbar); + border-bottom: 1px solid var(--color-panel-divider); + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: var(--color-toolbar-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(../images/widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { + background-image: url(../images/widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.6; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.8; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-panel-divider); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, .tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, .tsd-widget.menu { + display: inline-block; + } +} +input[type=checkbox] + .tsd-widget:before { + background-position: -120px 0; +} +input[type=checkbox]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: var(--color-background); +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: var(--color-panel); +} +.tsd-select .tsd-select-list li:hover { + background-color: var(--color-panel-divider); +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} diff --git a/docs/assets/images/icons.png b/docs/assets/images/icons.png new file mode 100644 index 00000000..3836d5fe Binary files /dev/null and b/docs/assets/images/icons.png differ diff --git a/docs/assets/images/icons@2x.png b/docs/assets/images/icons@2x.png new file mode 100644 index 00000000..5a209e2f Binary files /dev/null and b/docs/assets/images/icons@2x.png differ diff --git a/docs/assets/images/widgets.png b/docs/assets/images/widgets.png new file mode 100644 index 00000000..c7380532 Binary files /dev/null and b/docs/assets/images/widgets.png differ diff --git a/docs/assets/images/widgets@2x.png b/docs/assets/images/widgets@2x.png new file mode 100644 index 00000000..4bbbd572 Binary files /dev/null and b/docs/assets/images/widgets@2x.png differ diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js new file mode 100644 index 00000000..dc257a86 --- /dev/null +++ b/docs/assets/js/main.js @@ -0,0 +1,248 @@ +/* + * ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development"). + * This devtool is not neither made for production nor for readable output files. + * It uses "eval()" calls to create a separate source file in the browser devtools. + * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/) + * or disable the default devtool with "devtool: false". + * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/). + */ +/******/ (() => { // webpackBootstrap +/******/ var __webpack_modules__ = ({ + +/***/ "../node_modules/lunr/lunr.js": +/*!************************************!*\ + !*** ../node_modules/lunr/lunr.js ***! + \************************************/ +/***/ ((module, exports, __webpack_require__) => { + +eval("var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_RESULT__;/**\n * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9\n * Copyright (C) 2020 Oliver Nightingale\n * @license MIT\n */\n\n;(function(){\n\n/**\n * A convenience function for configuring and constructing\n * a new lunr Index.\n *\n * A lunr.Builder instance is created and the pipeline setup\n * with a trimmer, stop word filter and stemmer.\n *\n * This builder object is yielded to the configuration function\n * that is passed as a parameter, allowing the list of fields\n * and other builder parameters to be customised.\n *\n * All documents _must_ be added within the passed config function.\n *\n * @example\n * var idx = lunr(function () {\n * this.field('title')\n * this.field('body')\n * this.ref('id')\n *\n * documents.forEach(function (doc) {\n * this.add(doc)\n * }, this)\n * })\n *\n * @see {@link lunr.Builder}\n * @see {@link lunr.Pipeline}\n * @see {@link lunr.trimmer}\n * @see {@link lunr.stopWordFilter}\n * @see {@link lunr.stemmer}\n * @namespace {function} lunr\n */\nvar lunr = function (config) {\n var builder = new lunr.Builder\n\n builder.pipeline.add(\n lunr.trimmer,\n lunr.stopWordFilter,\n lunr.stemmer\n )\n\n builder.searchPipeline.add(\n lunr.stemmer\n )\n\n config.call(builder, builder)\n return builder.build()\n}\n\nlunr.version = \"2.3.9\"\n/*!\n * lunr.utils\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A namespace containing utils for the rest of the lunr library\n * @namespace lunr.utils\n */\nlunr.utils = {}\n\n/**\n * Print a warning message to the console.\n *\n * @param {String} message The message to be printed.\n * @memberOf lunr.utils\n * @function\n */\nlunr.utils.warn = (function (global) {\n /* eslint-disable no-console */\n return function (message) {\n if (global.console && console.warn) {\n console.warn(message)\n }\n }\n /* eslint-enable no-console */\n})(this)\n\n/**\n * Convert an object to a string.\n *\n * In the case of `null` and `undefined` the function returns\n * the empty string, in all other cases the result of calling\n * `toString` on the passed object is returned.\n *\n * @param {Any} obj The object to convert to a string.\n * @return {String} string representation of the passed object.\n * @memberOf lunr.utils\n */\nlunr.utils.asString = function (obj) {\n if (obj === void 0 || obj === null) {\n return \"\"\n } else {\n return obj.toString()\n }\n}\n\n/**\n * Clones an object.\n *\n * Will create a copy of an existing object such that any mutations\n * on the copy cannot affect the original.\n *\n * Only shallow objects are supported, passing a nested object to this\n * function will cause a TypeError.\n *\n * Objects with primitives, and arrays of primitives are supported.\n *\n * @param {Object} obj The object to clone.\n * @return {Object} a clone of the passed object.\n * @throws {TypeError} when a nested object is passed.\n * @memberOf Utils\n */\nlunr.utils.clone = function (obj) {\n if (obj === null || obj === undefined) {\n return obj\n }\n\n var clone = Object.create(null),\n keys = Object.keys(obj)\n\n for (var i = 0; i < keys.length; i++) {\n var key = keys[i],\n val = obj[key]\n\n if (Array.isArray(val)) {\n clone[key] = val.slice()\n continue\n }\n\n if (typeof val === 'string' ||\n typeof val === 'number' ||\n typeof val === 'boolean') {\n clone[key] = val\n continue\n }\n\n throw new TypeError(\"clone is not deep and does not support nested objects\")\n }\n\n return clone\n}\nlunr.FieldRef = function (docRef, fieldName, stringValue) {\n this.docRef = docRef\n this.fieldName = fieldName\n this._stringValue = stringValue\n}\n\nlunr.FieldRef.joiner = \"/\"\n\nlunr.FieldRef.fromString = function (s) {\n var n = s.indexOf(lunr.FieldRef.joiner)\n\n if (n === -1) {\n throw \"malformed field ref string\"\n }\n\n var fieldRef = s.slice(0, n),\n docRef = s.slice(n + 1)\n\n return new lunr.FieldRef (docRef, fieldRef, s)\n}\n\nlunr.FieldRef.prototype.toString = function () {\n if (this._stringValue == undefined) {\n this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef\n }\n\n return this._stringValue\n}\n/*!\n * lunr.Set\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A lunr set.\n *\n * @constructor\n */\nlunr.Set = function (elements) {\n this.elements = Object.create(null)\n\n if (elements) {\n this.length = elements.length\n\n for (var i = 0; i < this.length; i++) {\n this.elements[elements[i]] = true\n }\n } else {\n this.length = 0\n }\n}\n\n/**\n * A complete set that contains all elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.complete = {\n intersect: function (other) {\n return other\n },\n\n union: function () {\n return this\n },\n\n contains: function () {\n return true\n }\n}\n\n/**\n * An empty set that contains no elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.empty = {\n intersect: function () {\n return this\n },\n\n union: function (other) {\n return other\n },\n\n contains: function () {\n return false\n }\n}\n\n/**\n * Returns true if this set contains the specified object.\n *\n * @param {object} object - Object whose presence in this set is to be tested.\n * @returns {boolean} - True if this set contains the specified object.\n */\nlunr.Set.prototype.contains = function (object) {\n return !!this.elements[object]\n}\n\n/**\n * Returns a new set containing only the elements that are present in both\n * this set and the specified set.\n *\n * @param {lunr.Set} other - set to intersect with this set.\n * @returns {lunr.Set} a new set that is the intersection of this and the specified set.\n */\n\nlunr.Set.prototype.intersect = function (other) {\n var a, b, elements, intersection = []\n\n if (other === lunr.Set.complete) {\n return this\n }\n\n if (other === lunr.Set.empty) {\n return other\n }\n\n if (this.length < other.length) {\n a = this\n b = other\n } else {\n a = other\n b = this\n }\n\n elements = Object.keys(a.elements)\n\n for (var i = 0; i < elements.length; i++) {\n var element = elements[i]\n if (element in b.elements) {\n intersection.push(element)\n }\n }\n\n return new lunr.Set (intersection)\n}\n\n/**\n * Returns a new set combining the elements of this and the specified set.\n *\n * @param {lunr.Set} other - set to union with this set.\n * @return {lunr.Set} a new set that is the union of this and the specified set.\n */\n\nlunr.Set.prototype.union = function (other) {\n if (other === lunr.Set.complete) {\n return lunr.Set.complete\n }\n\n if (other === lunr.Set.empty) {\n return this\n }\n\n return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))\n}\n/**\n * A function to calculate the inverse document frequency for\n * a posting. This is shared between the builder and the index\n *\n * @private\n * @param {object} posting - The posting for a given term\n * @param {number} documentCount - The total number of documents.\n */\nlunr.idf = function (posting, documentCount) {\n var documentsWithTerm = 0\n\n for (var fieldName in posting) {\n if (fieldName == '_index') continue // Ignore the term index, its not a field\n documentsWithTerm += Object.keys(posting[fieldName]).length\n }\n\n var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)\n\n return Math.log(1 + Math.abs(x))\n}\n\n/**\n * A token wraps a string representation of a token\n * as it is passed through the text processing pipeline.\n *\n * @constructor\n * @param {string} [str=''] - The string token being wrapped.\n * @param {object} [metadata={}] - Metadata associated with this token.\n */\nlunr.Token = function (str, metadata) {\n this.str = str || \"\"\n this.metadata = metadata || {}\n}\n\n/**\n * Returns the token string that is being wrapped by this object.\n *\n * @returns {string}\n */\nlunr.Token.prototype.toString = function () {\n return this.str\n}\n\n/**\n * A token update function is used when updating or optionally\n * when cloning a token.\n *\n * @callback lunr.Token~updateFunction\n * @param {string} str - The string representation of the token.\n * @param {Object} metadata - All metadata associated with this token.\n */\n\n/**\n * Applies the given function to the wrapped string token.\n *\n * @example\n * token.update(function (str, metadata) {\n * return str.toUpperCase()\n * })\n *\n * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.update = function (fn) {\n this.str = fn(this.str, this.metadata)\n return this\n}\n\n/**\n * Creates a clone of this token. Optionally a function can be\n * applied to the cloned token.\n *\n * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.clone = function (fn) {\n fn = fn || function (s) { return s }\n return new lunr.Token (fn(this.str, this.metadata), this.metadata)\n}\n/*!\n * lunr.tokenizer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A function for splitting a string into tokens ready to be inserted into\n * the search index. Uses `lunr.tokenizer.separator` to split strings, change\n * the value of this property to change how strings are split into tokens.\n *\n * This tokenizer will convert its parameter to a string by calling `toString` and\n * then will split this string on the character in `lunr.tokenizer.separator`.\n * Arrays will have their elements converted to strings and wrapped in a lunr.Token.\n *\n * Optional metadata can be passed to the tokenizer, this metadata will be cloned and\n * added as metadata to every token that is created from the object to be tokenized.\n *\n * @static\n * @param {?(string|object|object[])} obj - The object to convert into tokens\n * @param {?object} metadata - Optional metadata to associate with every token\n * @returns {lunr.Token[]}\n * @see {@link lunr.Pipeline}\n */\nlunr.tokenizer = function (obj, metadata) {\n if (obj == null || obj == undefined) {\n return []\n }\n\n if (Array.isArray(obj)) {\n return obj.map(function (t) {\n return new lunr.Token(\n lunr.utils.asString(t).toLowerCase(),\n lunr.utils.clone(metadata)\n )\n })\n }\n\n var str = obj.toString().toLowerCase(),\n len = str.length,\n tokens = []\n\n for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {\n var char = str.charAt(sliceEnd),\n sliceLength = sliceEnd - sliceStart\n\n if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {\n\n if (sliceLength > 0) {\n var tokenMetadata = lunr.utils.clone(metadata) || {}\n tokenMetadata[\"position\"] = [sliceStart, sliceLength]\n tokenMetadata[\"index\"] = tokens.length\n\n tokens.push(\n new lunr.Token (\n str.slice(sliceStart, sliceEnd),\n tokenMetadata\n )\n )\n }\n\n sliceStart = sliceEnd + 1\n }\n\n }\n\n return tokens\n}\n\n/**\n * The separator used to split a string into tokens. Override this property to change the behaviour of\n * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.\n *\n * @static\n * @see lunr.tokenizer\n */\nlunr.tokenizer.separator = /[\\s\\-]+/\n/*!\n * lunr.Pipeline\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Pipelines maintain an ordered list of functions to be applied to all\n * tokens in documents entering the search index and queries being ran against\n * the index.\n *\n * An instance of lunr.Index created with the lunr shortcut will contain a\n * pipeline with a stop word filter and an English language stemmer. Extra\n * functions can be added before or after either of these functions or these\n * default functions can be removed.\n *\n * When run the pipeline will call each function in turn, passing a token, the\n * index of that token in the original list of all tokens and finally a list of\n * all the original tokens.\n *\n * The output of functions in the pipeline will be passed to the next function\n * in the pipeline. To exclude a token from entering the index the function\n * should return undefined, the rest of the pipeline will not be called with\n * this token.\n *\n * For serialisation of pipelines to work, all functions used in an instance of\n * a pipeline should be registered with lunr.Pipeline. Registered functions can\n * then be loaded. If trying to load a serialised pipeline that uses functions\n * that are not registered an error will be thrown.\n *\n * If not planning on serialising the pipeline then registering pipeline functions\n * is not necessary.\n *\n * @constructor\n */\nlunr.Pipeline = function () {\n this._stack = []\n}\n\nlunr.Pipeline.registeredFunctions = Object.create(null)\n\n/**\n * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token\n * string as well as all known metadata. A pipeline function can mutate the token string\n * or mutate (or add) metadata for a given token.\n *\n * A pipeline function can indicate that the passed token should be discarded by returning\n * null, undefined or an empty string. This token will not be passed to any downstream pipeline\n * functions and will not be added to the index.\n *\n * Multiple tokens can be returned by returning an array of tokens. Each token will be passed\n * to any downstream pipeline functions and all will returned tokens will be added to the index.\n *\n * Any number of pipeline functions may be chained together using a lunr.Pipeline.\n *\n * @interface lunr.PipelineFunction\n * @param {lunr.Token} token - A token from the document being processed.\n * @param {number} i - The index of this token in the complete list of tokens for this document/field.\n * @param {lunr.Token[]} tokens - All tokens for this document/field.\n * @returns {(?lunr.Token|lunr.Token[])}\n */\n\n/**\n * Register a function with the pipeline.\n *\n * Functions that are used in the pipeline should be registered if the pipeline\n * needs to be serialised, or a serialised pipeline needs to be loaded.\n *\n * Registering a function does not add it to a pipeline, functions must still be\n * added to instances of the pipeline for them to be used when running a pipeline.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @param {String} label - The label to register this function with\n */\nlunr.Pipeline.registerFunction = function (fn, label) {\n if (label in this.registeredFunctions) {\n lunr.utils.warn('Overwriting existing registered function: ' + label)\n }\n\n fn.label = label\n lunr.Pipeline.registeredFunctions[fn.label] = fn\n}\n\n/**\n * Warns if the function is not registered as a Pipeline function.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @private\n */\nlunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {\n var isRegistered = fn.label && (fn.label in this.registeredFunctions)\n\n if (!isRegistered) {\n lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\\n', fn)\n }\n}\n\n/**\n * Loads a previously serialised pipeline.\n *\n * All functions to be loaded must already be registered with lunr.Pipeline.\n * If any function from the serialised data has not been registered then an\n * error will be thrown.\n *\n * @param {Object} serialised - The serialised pipeline to load.\n * @returns {lunr.Pipeline}\n */\nlunr.Pipeline.load = function (serialised) {\n var pipeline = new lunr.Pipeline\n\n serialised.forEach(function (fnName) {\n var fn = lunr.Pipeline.registeredFunctions[fnName]\n\n if (fn) {\n pipeline.add(fn)\n } else {\n throw new Error('Cannot load unregistered function: ' + fnName)\n }\n })\n\n return pipeline\n}\n\n/**\n * Adds new functions to the end of the pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.\n */\nlunr.Pipeline.prototype.add = function () {\n var fns = Array.prototype.slice.call(arguments)\n\n fns.forEach(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n this._stack.push(fn)\n }, this)\n}\n\n/**\n * Adds a single function after a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.after = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n pos = pos + 1\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Adds a single function before a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.before = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Removes a function from the pipeline.\n *\n * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.\n */\nlunr.Pipeline.prototype.remove = function (fn) {\n var pos = this._stack.indexOf(fn)\n if (pos == -1) {\n return\n }\n\n this._stack.splice(pos, 1)\n}\n\n/**\n * Runs the current list of functions that make up the pipeline against the\n * passed tokens.\n *\n * @param {Array} tokens The tokens to run through the pipeline.\n * @returns {Array}\n */\nlunr.Pipeline.prototype.run = function (tokens) {\n var stackLength = this._stack.length\n\n for (var i = 0; i < stackLength; i++) {\n var fn = this._stack[i]\n var memo = []\n\n for (var j = 0; j < tokens.length; j++) {\n var result = fn(tokens[j], j, tokens)\n\n if (result === null || result === void 0 || result === '') continue\n\n if (Array.isArray(result)) {\n for (var k = 0; k < result.length; k++) {\n memo.push(result[k])\n }\n } else {\n memo.push(result)\n }\n }\n\n tokens = memo\n }\n\n return tokens\n}\n\n/**\n * Convenience method for passing a string through a pipeline and getting\n * strings out. This method takes care of wrapping the passed string in a\n * token and mapping the resulting tokens back to strings.\n *\n * @param {string} str - The string to pass through the pipeline.\n * @param {?object} metadata - Optional metadata to associate with the token\n * passed to the pipeline.\n * @returns {string[]}\n */\nlunr.Pipeline.prototype.runString = function (str, metadata) {\n var token = new lunr.Token (str, metadata)\n\n return this.run([token]).map(function (t) {\n return t.toString()\n })\n}\n\n/**\n * Resets the pipeline by removing any existing processors.\n *\n */\nlunr.Pipeline.prototype.reset = function () {\n this._stack = []\n}\n\n/**\n * Returns a representation of the pipeline ready for serialisation.\n *\n * Logs a warning if the function has not been registered.\n *\n * @returns {Array}\n */\nlunr.Pipeline.prototype.toJSON = function () {\n return this._stack.map(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n\n return fn.label\n })\n}\n/*!\n * lunr.Vector\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A vector is used to construct the vector space of documents and queries. These\n * vectors support operations to determine the similarity between two documents or\n * a document and a query.\n *\n * Normally no parameters are required for initializing a vector, but in the case of\n * loading a previously dumped vector the raw elements can be provided to the constructor.\n *\n * For performance reasons vectors are implemented with a flat array, where an elements\n * index is immediately followed by its value. E.g. [index, value, index, value]. This\n * allows the underlying array to be as sparse as possible and still offer decent\n * performance when being used for vector calculations.\n *\n * @constructor\n * @param {Number[]} [elements] - The flat list of element index and element value pairs.\n */\nlunr.Vector = function (elements) {\n this._magnitude = 0\n this.elements = elements || []\n}\n\n\n/**\n * Calculates the position within the vector to insert a given index.\n *\n * This is used internally by insert and upsert. If there are duplicate indexes then\n * the position is returned as if the value for that index were to be updated, but it\n * is the callers responsibility to check whether there is a duplicate at that index\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @returns {Number}\n */\nlunr.Vector.prototype.positionForIndex = function (index) {\n // For an empty vector the tuple can be inserted at the beginning\n if (this.elements.length == 0) {\n return 0\n }\n\n var start = 0,\n end = this.elements.length / 2,\n sliceLength = end - start,\n pivotPoint = Math.floor(sliceLength / 2),\n pivotIndex = this.elements[pivotPoint * 2]\n\n while (sliceLength > 1) {\n if (pivotIndex < index) {\n start = pivotPoint\n }\n\n if (pivotIndex > index) {\n end = pivotPoint\n }\n\n if (pivotIndex == index) {\n break\n }\n\n sliceLength = end - start\n pivotPoint = start + Math.floor(sliceLength / 2)\n pivotIndex = this.elements[pivotPoint * 2]\n }\n\n if (pivotIndex == index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex > index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex < index) {\n return (pivotPoint + 1) * 2\n }\n}\n\n/**\n * Inserts an element at an index within the vector.\n *\n * Does not allow duplicates, will throw an error if there is already an entry\n * for this index.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n */\nlunr.Vector.prototype.insert = function (insertIdx, val) {\n this.upsert(insertIdx, val, function () {\n throw \"duplicate index\"\n })\n}\n\n/**\n * Inserts or updates an existing index within the vector.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n * @param {function} fn - A function that is called for updates, the existing value and the\n * requested value are passed as arguments\n */\nlunr.Vector.prototype.upsert = function (insertIdx, val, fn) {\n this._magnitude = 0\n var position = this.positionForIndex(insertIdx)\n\n if (this.elements[position] == insertIdx) {\n this.elements[position + 1] = fn(this.elements[position + 1], val)\n } else {\n this.elements.splice(position, 0, insertIdx, val)\n }\n}\n\n/**\n * Calculates the magnitude of this vector.\n *\n * @returns {Number}\n */\nlunr.Vector.prototype.magnitude = function () {\n if (this._magnitude) return this._magnitude\n\n var sumOfSquares = 0,\n elementsLength = this.elements.length\n\n for (var i = 1; i < elementsLength; i += 2) {\n var val = this.elements[i]\n sumOfSquares += val * val\n }\n\n return this._magnitude = Math.sqrt(sumOfSquares)\n}\n\n/**\n * Calculates the dot product of this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The vector to compute the dot product with.\n * @returns {Number}\n */\nlunr.Vector.prototype.dot = function (otherVector) {\n var dotProduct = 0,\n a = this.elements, b = otherVector.elements,\n aLen = a.length, bLen = b.length,\n aVal = 0, bVal = 0,\n i = 0, j = 0\n\n while (i < aLen && j < bLen) {\n aVal = a[i], bVal = b[j]\n if (aVal < bVal) {\n i += 2\n } else if (aVal > bVal) {\n j += 2\n } else if (aVal == bVal) {\n dotProduct += a[i + 1] * b[j + 1]\n i += 2\n j += 2\n }\n }\n\n return dotProduct\n}\n\n/**\n * Calculates the similarity between this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The other vector to calculate the\n * similarity with.\n * @returns {Number}\n */\nlunr.Vector.prototype.similarity = function (otherVector) {\n return this.dot(otherVector) / this.magnitude() || 0\n}\n\n/**\n * Converts the vector to an array of the elements within the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toArray = function () {\n var output = new Array (this.elements.length / 2)\n\n for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {\n output[j] = this.elements[i]\n }\n\n return output\n}\n\n/**\n * A JSON serializable representation of the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toJSON = function () {\n return this.elements\n}\n/* eslint-disable */\n/*!\n * lunr.stemmer\n * Copyright (C) 2020 Oliver Nightingale\n * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt\n */\n\n/**\n * lunr.stemmer is an english language stemmer, this is a JavaScript\n * implementation of the PorterStemmer taken from http://tartarus.org/~martin\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token - The string to stem\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n * @function\n */\nlunr.stemmer = (function(){\n var step2list = {\n \"ational\" : \"ate\",\n \"tional\" : \"tion\",\n \"enci\" : \"ence\",\n \"anci\" : \"ance\",\n \"izer\" : \"ize\",\n \"bli\" : \"ble\",\n \"alli\" : \"al\",\n \"entli\" : \"ent\",\n \"eli\" : \"e\",\n \"ousli\" : \"ous\",\n \"ization\" : \"ize\",\n \"ation\" : \"ate\",\n \"ator\" : \"ate\",\n \"alism\" : \"al\",\n \"iveness\" : \"ive\",\n \"fulness\" : \"ful\",\n \"ousness\" : \"ous\",\n \"aliti\" : \"al\",\n \"iviti\" : \"ive\",\n \"biliti\" : \"ble\",\n \"logi\" : \"log\"\n },\n\n step3list = {\n \"icate\" : \"ic\",\n \"ative\" : \"\",\n \"alize\" : \"al\",\n \"iciti\" : \"ic\",\n \"ical\" : \"ic\",\n \"ful\" : \"\",\n \"ness\" : \"\"\n },\n\n c = \"[^aeiou]\", // consonant\n v = \"[aeiouy]\", // vowel\n C = c + \"[^aeiouy]*\", // consonant sequence\n V = v + \"[aeiou]*\", // vowel sequence\n\n mgr0 = \"^(\" + C + \")?\" + V + C, // [C]VC... is m>0\n meq1 = \"^(\" + C + \")?\" + V + C + \"(\" + V + \")?$\", // [C]VC[V] is m=1\n mgr1 = \"^(\" + C + \")?\" + V + C + V + C, // [C]VCVC... is m>1\n s_v = \"^(\" + C + \")?\" + v; // vowel in stem\n\n var re_mgr0 = new RegExp(mgr0);\n var re_mgr1 = new RegExp(mgr1);\n var re_meq1 = new RegExp(meq1);\n var re_s_v = new RegExp(s_v);\n\n var re_1a = /^(.+?)(ss|i)es$/;\n var re2_1a = /^(.+?)([^s])s$/;\n var re_1b = /^(.+?)eed$/;\n var re2_1b = /^(.+?)(ed|ing)$/;\n var re_1b_2 = /.$/;\n var re2_1b_2 = /(at|bl|iz)$/;\n var re3_1b_2 = new RegExp(\"([^aeiouylsz])\\\\1$\");\n var re4_1b_2 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var re_1c = /^(.+?[^aeiou])y$/;\n var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;\n\n var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;\n\n var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;\n var re2_4 = /^(.+?)(s|t)(ion)$/;\n\n var re_5 = /^(.+?)e$/;\n var re_5_1 = /ll$/;\n var re3_5 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var porterStemmer = function porterStemmer(w) {\n var stem,\n suffix,\n firstch,\n re,\n re2,\n re3,\n re4;\n\n if (w.length < 3) { return w; }\n\n firstch = w.substr(0,1);\n if (firstch == \"y\") {\n w = firstch.toUpperCase() + w.substr(1);\n }\n\n // Step 1a\n re = re_1a\n re2 = re2_1a;\n\n if (re.test(w)) { w = w.replace(re,\"$1$2\"); }\n else if (re2.test(w)) { w = w.replace(re2,\"$1$2\"); }\n\n // Step 1b\n re = re_1b;\n re2 = re2_1b;\n if (re.test(w)) {\n var fp = re.exec(w);\n re = re_mgr0;\n if (re.test(fp[1])) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1];\n re2 = re_s_v;\n if (re2.test(stem)) {\n w = stem;\n re2 = re2_1b_2;\n re3 = re3_1b_2;\n re4 = re4_1b_2;\n if (re2.test(w)) { w = w + \"e\"; }\n else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,\"\"); }\n else if (re4.test(w)) { w = w + \"e\"; }\n }\n }\n\n // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)\n re = re_1c;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n w = stem + \"i\";\n }\n\n // Step 2\n re = re_2;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step2list[suffix];\n }\n }\n\n // Step 3\n re = re_3;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step3list[suffix];\n }\n }\n\n // Step 4\n re = re_4;\n re2 = re2_4;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n if (re.test(stem)) {\n w = stem;\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1] + fp[2];\n re2 = re_mgr1;\n if (re2.test(stem)) {\n w = stem;\n }\n }\n\n // Step 5\n re = re_5;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n re2 = re_meq1;\n re3 = re3_5;\n if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {\n w = stem;\n }\n }\n\n re = re_5_1;\n re2 = re_mgr1;\n if (re.test(w) && re2.test(w)) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n\n // and turn initial Y back to y\n\n if (firstch == \"y\") {\n w = firstch.toLowerCase() + w.substr(1);\n }\n\n return w;\n };\n\n return function (token) {\n return token.update(porterStemmer);\n }\n})();\n\nlunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')\n/*!\n * lunr.stopWordFilter\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.generateStopWordFilter builds a stopWordFilter function from the provided\n * list of stop words.\n *\n * The built in lunr.stopWordFilter is built using this generator and can be used\n * to generate custom stopWordFilters for applications or non English languages.\n *\n * @function\n * @param {Array} token The token to pass through the filter\n * @returns {lunr.PipelineFunction}\n * @see lunr.Pipeline\n * @see lunr.stopWordFilter\n */\nlunr.generateStopWordFilter = function (stopWords) {\n var words = stopWords.reduce(function (memo, stopWord) {\n memo[stopWord] = stopWord\n return memo\n }, {})\n\n return function (token) {\n if (token && words[token.toString()] !== token.toString()) return token\n }\n}\n\n/**\n * lunr.stopWordFilter is an English language stop word list filter, any words\n * contained in the list will not be passed through the filter.\n *\n * This is intended to be used in the Pipeline. If the token does not pass the\n * filter then undefined will be returned.\n *\n * @function\n * @implements {lunr.PipelineFunction}\n * @params {lunr.Token} token - A token to check for being a stop word.\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n */\nlunr.stopWordFilter = lunr.generateStopWordFilter([\n 'a',\n 'able',\n 'about',\n 'across',\n 'after',\n 'all',\n 'almost',\n 'also',\n 'am',\n 'among',\n 'an',\n 'and',\n 'any',\n 'are',\n 'as',\n 'at',\n 'be',\n 'because',\n 'been',\n 'but',\n 'by',\n 'can',\n 'cannot',\n 'could',\n 'dear',\n 'did',\n 'do',\n 'does',\n 'either',\n 'else',\n 'ever',\n 'every',\n 'for',\n 'from',\n 'get',\n 'got',\n 'had',\n 'has',\n 'have',\n 'he',\n 'her',\n 'hers',\n 'him',\n 'his',\n 'how',\n 'however',\n 'i',\n 'if',\n 'in',\n 'into',\n 'is',\n 'it',\n 'its',\n 'just',\n 'least',\n 'let',\n 'like',\n 'likely',\n 'may',\n 'me',\n 'might',\n 'most',\n 'must',\n 'my',\n 'neither',\n 'no',\n 'nor',\n 'not',\n 'of',\n 'off',\n 'often',\n 'on',\n 'only',\n 'or',\n 'other',\n 'our',\n 'own',\n 'rather',\n 'said',\n 'say',\n 'says',\n 'she',\n 'should',\n 'since',\n 'so',\n 'some',\n 'than',\n 'that',\n 'the',\n 'their',\n 'them',\n 'then',\n 'there',\n 'these',\n 'they',\n 'this',\n 'tis',\n 'to',\n 'too',\n 'twas',\n 'us',\n 'wants',\n 'was',\n 'we',\n 'were',\n 'what',\n 'when',\n 'where',\n 'which',\n 'while',\n 'who',\n 'whom',\n 'why',\n 'will',\n 'with',\n 'would',\n 'yet',\n 'you',\n 'your'\n])\n\nlunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')\n/*!\n * lunr.trimmer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.trimmer is a pipeline function for trimming non word\n * characters from the beginning and end of tokens before they\n * enter the index.\n *\n * This implementation may not work correctly for non latin\n * characters and should either be removed or adapted for use\n * with languages with non-latin characters.\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token The token to pass through the filter\n * @returns {lunr.Token}\n * @see lunr.Pipeline\n */\nlunr.trimmer = function (token) {\n return token.update(function (s) {\n return s.replace(/^\\W+/, '').replace(/\\W+$/, '')\n })\n}\n\nlunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')\n/*!\n * lunr.TokenSet\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A token set is used to store the unique list of all tokens\n * within an index. Token sets are also used to represent an\n * incoming query to the index, this query token set and index\n * token set are then intersected to find which tokens to look\n * up in the inverted index.\n *\n * A token set can hold multiple tokens, as in the case of the\n * index token set, or it can hold a single token as in the\n * case of a simple query token set.\n *\n * Additionally token sets are used to perform wildcard matching.\n * Leading, contained and trailing wildcards are supported, and\n * from this edit distance matching can also be provided.\n *\n * Token sets are implemented as a minimal finite state automata,\n * where both common prefixes and suffixes are shared between tokens.\n * This helps to reduce the space used for storing the token set.\n *\n * @constructor\n */\nlunr.TokenSet = function () {\n this.final = false\n this.edges = {}\n this.id = lunr.TokenSet._nextId\n lunr.TokenSet._nextId += 1\n}\n\n/**\n * Keeps track of the next, auto increment, identifier to assign\n * to a new tokenSet.\n *\n * TokenSets require a unique identifier to be correctly minimised.\n *\n * @private\n */\nlunr.TokenSet._nextId = 1\n\n/**\n * Creates a TokenSet instance from the given sorted array of words.\n *\n * @param {String[]} arr - A sorted array of strings to create the set from.\n * @returns {lunr.TokenSet}\n * @throws Will throw an error if the input array is not sorted.\n */\nlunr.TokenSet.fromArray = function (arr) {\n var builder = new lunr.TokenSet.Builder\n\n for (var i = 0, len = arr.length; i < len; i++) {\n builder.insert(arr[i])\n }\n\n builder.finish()\n return builder.root\n}\n\n/**\n * Creates a token set from a query clause.\n *\n * @private\n * @param {Object} clause - A single clause from lunr.Query.\n * @param {string} clause.term - The query clause term.\n * @param {number} [clause.editDistance] - The optional edit distance for the term.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromClause = function (clause) {\n if ('editDistance' in clause) {\n return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)\n } else {\n return lunr.TokenSet.fromString(clause.term)\n }\n}\n\n/**\n * Creates a token set representing a single string with a specified\n * edit distance.\n *\n * Insertions, deletions, substitutions and transpositions are each\n * treated as an edit distance of 1.\n *\n * Increasing the allowed edit distance will have a dramatic impact\n * on the performance of both creating and intersecting these TokenSets.\n * It is advised to keep the edit distance less than 3.\n *\n * @param {string} str - The string to create the token set from.\n * @param {number} editDistance - The allowed edit distance to match.\n * @returns {lunr.Vector}\n */\nlunr.TokenSet.fromFuzzyString = function (str, editDistance) {\n var root = new lunr.TokenSet\n\n var stack = [{\n node: root,\n editsRemaining: editDistance,\n str: str\n }]\n\n while (stack.length) {\n var frame = stack.pop()\n\n // no edit\n if (frame.str.length > 0) {\n var char = frame.str.charAt(0),\n noEditNode\n\n if (char in frame.node.edges) {\n noEditNode = frame.node.edges[char]\n } else {\n noEditNode = new lunr.TokenSet\n frame.node.edges[char] = noEditNode\n }\n\n if (frame.str.length == 1) {\n noEditNode.final = true\n }\n\n stack.push({\n node: noEditNode,\n editsRemaining: frame.editsRemaining,\n str: frame.str.slice(1)\n })\n }\n\n if (frame.editsRemaining == 0) {\n continue\n }\n\n // insertion\n if (\"*\" in frame.node.edges) {\n var insertionNode = frame.node.edges[\"*\"]\n } else {\n var insertionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = insertionNode\n }\n\n if (frame.str.length == 0) {\n insertionNode.final = true\n }\n\n stack.push({\n node: insertionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str\n })\n\n // deletion\n // can only do a deletion if we have enough edits remaining\n // and if there are characters left to delete in the string\n if (frame.str.length > 1) {\n stack.push({\n node: frame.node,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // deletion\n // just removing the last character from the str\n if (frame.str.length == 1) {\n frame.node.final = true\n }\n\n // substitution\n // can only do a substitution if we have enough edits remaining\n // and if there are characters left to substitute\n if (frame.str.length >= 1) {\n if (\"*\" in frame.node.edges) {\n var substitutionNode = frame.node.edges[\"*\"]\n } else {\n var substitutionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = substitutionNode\n }\n\n if (frame.str.length == 1) {\n substitutionNode.final = true\n }\n\n stack.push({\n node: substitutionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // transposition\n // can only do a transposition if there are edits remaining\n // and there are enough characters to transpose\n if (frame.str.length > 1) {\n var charA = frame.str.charAt(0),\n charB = frame.str.charAt(1),\n transposeNode\n\n if (charB in frame.node.edges) {\n transposeNode = frame.node.edges[charB]\n } else {\n transposeNode = new lunr.TokenSet\n frame.node.edges[charB] = transposeNode\n }\n\n if (frame.str.length == 1) {\n transposeNode.final = true\n }\n\n stack.push({\n node: transposeNode,\n editsRemaining: frame.editsRemaining - 1,\n str: charA + frame.str.slice(2)\n })\n }\n }\n\n return root\n}\n\n/**\n * Creates a TokenSet from a string.\n *\n * The string may contain one or more wildcard characters (*)\n * that will allow wildcard matching when intersecting with\n * another TokenSet.\n *\n * @param {string} str - The string to create a TokenSet from.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromString = function (str) {\n var node = new lunr.TokenSet,\n root = node\n\n /*\n * Iterates through all characters within the passed string\n * appending a node for each character.\n *\n * When a wildcard character is found then a self\n * referencing edge is introduced to continually match\n * any number of any characters.\n */\n for (var i = 0, len = str.length; i < len; i++) {\n var char = str[i],\n final = (i == len - 1)\n\n if (char == \"*\") {\n node.edges[char] = node\n node.final = final\n\n } else {\n var next = new lunr.TokenSet\n next.final = final\n\n node.edges[char] = next\n node = next\n }\n }\n\n return root\n}\n\n/**\n * Converts this TokenSet into an array of strings\n * contained within the TokenSet.\n *\n * This is not intended to be used on a TokenSet that\n * contains wildcards, in these cases the results are\n * undefined and are likely to cause an infinite loop.\n *\n * @returns {string[]}\n */\nlunr.TokenSet.prototype.toArray = function () {\n var words = []\n\n var stack = [{\n prefix: \"\",\n node: this\n }]\n\n while (stack.length) {\n var frame = stack.pop(),\n edges = Object.keys(frame.node.edges),\n len = edges.length\n\n if (frame.node.final) {\n /* In Safari, at this point the prefix is sometimes corrupted, see:\n * https://github.com/olivernn/lunr.js/issues/279 Calling any\n * String.prototype method forces Safari to \"cast\" this string to what\n * it's supposed to be, fixing the bug. */\n frame.prefix.charAt(0)\n words.push(frame.prefix)\n }\n\n for (var i = 0; i < len; i++) {\n var edge = edges[i]\n\n stack.push({\n prefix: frame.prefix.concat(edge),\n node: frame.node.edges[edge]\n })\n }\n }\n\n return words\n}\n\n/**\n * Generates a string representation of a TokenSet.\n *\n * This is intended to allow TokenSets to be used as keys\n * in objects, largely to aid the construction and minimisation\n * of a TokenSet. As such it is not designed to be a human\n * friendly representation of the TokenSet.\n *\n * @returns {string}\n */\nlunr.TokenSet.prototype.toString = function () {\n // NOTE: Using Object.keys here as this.edges is very likely\n // to enter 'hash-mode' with many keys being added\n //\n // avoiding a for-in loop here as it leads to the function\n // being de-optimised (at least in V8). From some simple\n // benchmarks the performance is comparable, but allowing\n // V8 to optimize may mean easy performance wins in the future.\n\n if (this._str) {\n return this._str\n }\n\n var str = this.final ? '1' : '0',\n labels = Object.keys(this.edges).sort(),\n len = labels.length\n\n for (var i = 0; i < len; i++) {\n var label = labels[i],\n node = this.edges[label]\n\n str = str + label + node.id\n }\n\n return str\n}\n\n/**\n * Returns a new TokenSet that is the intersection of\n * this TokenSet and the passed TokenSet.\n *\n * This intersection will take into account any wildcards\n * contained within the TokenSet.\n *\n * @param {lunr.TokenSet} b - An other TokenSet to intersect with.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.prototype.intersect = function (b) {\n var output = new lunr.TokenSet,\n frame = undefined\n\n var stack = [{\n qNode: b,\n output: output,\n node: this\n }]\n\n while (stack.length) {\n frame = stack.pop()\n\n // NOTE: As with the #toString method, we are using\n // Object.keys and a for loop instead of a for-in loop\n // as both of these objects enter 'hash' mode, causing\n // the function to be de-optimised in V8\n var qEdges = Object.keys(frame.qNode.edges),\n qLen = qEdges.length,\n nEdges = Object.keys(frame.node.edges),\n nLen = nEdges.length\n\n for (var q = 0; q < qLen; q++) {\n var qEdge = qEdges[q]\n\n for (var n = 0; n < nLen; n++) {\n var nEdge = nEdges[n]\n\n if (nEdge == qEdge || qEdge == '*') {\n var node = frame.node.edges[nEdge],\n qNode = frame.qNode.edges[qEdge],\n final = node.final && qNode.final,\n next = undefined\n\n if (nEdge in frame.output.edges) {\n // an edge already exists for this character\n // no need to create a new node, just set the finality\n // bit unless this node is already final\n next = frame.output.edges[nEdge]\n next.final = next.final || final\n\n } else {\n // no edge exists yet, must create one\n // set the finality bit and insert it\n // into the output\n next = new lunr.TokenSet\n next.final = final\n frame.output.edges[nEdge] = next\n }\n\n stack.push({\n qNode: qNode,\n output: next,\n node: node\n })\n }\n }\n }\n }\n\n return output\n}\nlunr.TokenSet.Builder = function () {\n this.previousWord = \"\"\n this.root = new lunr.TokenSet\n this.uncheckedNodes = []\n this.minimizedNodes = {}\n}\n\nlunr.TokenSet.Builder.prototype.insert = function (word) {\n var node,\n commonPrefix = 0\n\n if (word < this.previousWord) {\n throw new Error (\"Out of order word insertion\")\n }\n\n for (var i = 0; i < word.length && i < this.previousWord.length; i++) {\n if (word[i] != this.previousWord[i]) break\n commonPrefix++\n }\n\n this.minimize(commonPrefix)\n\n if (this.uncheckedNodes.length == 0) {\n node = this.root\n } else {\n node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child\n }\n\n for (var i = commonPrefix; i < word.length; i++) {\n var nextNode = new lunr.TokenSet,\n char = word[i]\n\n node.edges[char] = nextNode\n\n this.uncheckedNodes.push({\n parent: node,\n char: char,\n child: nextNode\n })\n\n node = nextNode\n }\n\n node.final = true\n this.previousWord = word\n}\n\nlunr.TokenSet.Builder.prototype.finish = function () {\n this.minimize(0)\n}\n\nlunr.TokenSet.Builder.prototype.minimize = function (downTo) {\n for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {\n var node = this.uncheckedNodes[i],\n childKey = node.child.toString()\n\n if (childKey in this.minimizedNodes) {\n node.parent.edges[node.char] = this.minimizedNodes[childKey]\n } else {\n // Cache the key for this node since\n // we know it can't change anymore\n node.child._str = childKey\n\n this.minimizedNodes[childKey] = node.child\n }\n\n this.uncheckedNodes.pop()\n }\n}\n/*!\n * lunr.Index\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * An index contains the built index of all documents and provides a query interface\n * to the index.\n *\n * Usually instances of lunr.Index will not be created using this constructor, instead\n * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be\n * used to load previously built and serialized indexes.\n *\n * @constructor\n * @param {Object} attrs - The attributes of the built search index.\n * @param {Object} attrs.invertedIndex - An index of term/field to document reference.\n * @param {Object} attrs.fieldVectors - Field vectors\n * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens.\n * @param {string[]} attrs.fields - The names of indexed document fields.\n * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms.\n */\nlunr.Index = function (attrs) {\n this.invertedIndex = attrs.invertedIndex\n this.fieldVectors = attrs.fieldVectors\n this.tokenSet = attrs.tokenSet\n this.fields = attrs.fields\n this.pipeline = attrs.pipeline\n}\n\n/**\n * A result contains details of a document matching a search query.\n * @typedef {Object} lunr.Index~Result\n * @property {string} ref - The reference of the document this result represents.\n * @property {number} score - A number between 0 and 1 representing how similar this document is to the query.\n * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match.\n */\n\n/**\n * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple\n * query language which itself is parsed into an instance of lunr.Query.\n *\n * For programmatically building queries it is advised to directly use lunr.Query, the query language\n * is best used for human entered text rather than program generated text.\n *\n * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported\n * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello'\n * or 'world', though those that contain both will rank higher in the results.\n *\n * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can\n * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding\n * wildcards will increase the number of documents that will be found but can also have a negative\n * impact on query performance, especially with wildcards at the beginning of a term.\n *\n * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term\n * hello in the title field will match this query. Using a field not present in the index will lead\n * to an error being thrown.\n *\n * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term\n * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported\n * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2.\n * Avoid large values for edit distance to improve query performance.\n *\n * Each term also supports a presence modifier. By default a term's presence in document is optional, however\n * this can be changed to either required or prohibited. For a term's presence to be required in a document the\n * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and\n * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not\n * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'.\n *\n * To escape special characters the backslash character '\\' can be used, this allows searches to include\n * characters that would normally be considered modifiers, e.g. `foo\\~2` will search for a term \"foo~2\" instead\n * of attempting to apply a boost of 2 to the search term \"foo\".\n *\n * @typedef {string} lunr.Index~QueryString\n * @example Simple single term query\n * hello\n * @example Multiple term query\n * hello world\n * @example term scoped to a field\n * title:hello\n * @example term with a boost of 10\n * hello^10\n * @example term with an edit distance of 2\n * hello~2\n * @example terms with presence modifiers\n * -foo +bar baz\n */\n\n/**\n * Performs a search against the index using lunr query syntax.\n *\n * Results will be returned sorted by their score, the most relevant results\n * will be returned first. For details on how the score is calculated, please see\n * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}.\n *\n * For more programmatic querying use lunr.Index#query.\n *\n * @param {lunr.Index~QueryString} queryString - A string containing a lunr query.\n * @throws {lunr.QueryParseError} If the passed query string cannot be parsed.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.search = function (queryString) {\n return this.query(function (query) {\n var parser = new lunr.QueryParser(queryString, query)\n parser.parse()\n })\n}\n\n/**\n * A query builder callback provides a query object to be used to express\n * the query to perform on the index.\n *\n * @callback lunr.Index~queryBuilder\n * @param {lunr.Query} query - The query object to build up.\n * @this lunr.Query\n */\n\n/**\n * Performs a query against the index using the yielded lunr.Query object.\n *\n * If performing programmatic queries against the index, this method is preferred\n * over lunr.Index#search so as to avoid the additional query parsing overhead.\n *\n * A query object is yielded to the supplied function which should be used to\n * express the query to be run against the index.\n *\n * Note that although this function takes a callback parameter it is _not_ an\n * asynchronous operation, the callback is just yielded a query object to be\n * customized.\n *\n * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.query = function (fn) {\n // for each query clause\n // * process terms\n // * expand terms from token set\n // * find matching documents and metadata\n // * get document vectors\n // * score documents\n\n var query = new lunr.Query(this.fields),\n matchingFields = Object.create(null),\n queryVectors = Object.create(null),\n termFieldCache = Object.create(null),\n requiredMatches = Object.create(null),\n prohibitedMatches = Object.create(null)\n\n /*\n * To support field level boosts a query vector is created per\n * field. An empty vector is eagerly created to support negated\n * queries.\n */\n for (var i = 0; i < this.fields.length; i++) {\n queryVectors[this.fields[i]] = new lunr.Vector\n }\n\n fn.call(query, query)\n\n for (var i = 0; i < query.clauses.length; i++) {\n /*\n * Unless the pipeline has been disabled for this term, which is\n * the case for terms with wildcards, we need to pass the clause\n * term through the search pipeline. A pipeline returns an array\n * of processed terms. Pipeline functions may expand the passed\n * term, which means we may end up performing multiple index lookups\n * for a single query term.\n */\n var clause = query.clauses[i],\n terms = null,\n clauseMatches = lunr.Set.empty\n\n if (clause.usePipeline) {\n terms = this.pipeline.runString(clause.term, {\n fields: clause.fields\n })\n } else {\n terms = [clause.term]\n }\n\n for (var m = 0; m < terms.length; m++) {\n var term = terms[m]\n\n /*\n * Each term returned from the pipeline needs to use the same query\n * clause object, e.g. the same boost and or edit distance. The\n * simplest way to do this is to re-use the clause object but mutate\n * its term property.\n */\n clause.term = term\n\n /*\n * From the term in the clause we create a token set which will then\n * be used to intersect the indexes token set to get a list of terms\n * to lookup in the inverted index\n */\n var termTokenSet = lunr.TokenSet.fromClause(clause),\n expandedTerms = this.tokenSet.intersect(termTokenSet).toArray()\n\n /*\n * If a term marked as required does not exist in the tokenSet it is\n * impossible for the search to return any matches. We set all the field\n * scoped required matches set to empty and stop examining any further\n * clauses.\n */\n if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = lunr.Set.empty\n }\n\n break\n }\n\n for (var j = 0; j < expandedTerms.length; j++) {\n /*\n * For each term get the posting and termIndex, this is required for\n * building the query vector.\n */\n var expandedTerm = expandedTerms[j],\n posting = this.invertedIndex[expandedTerm],\n termIndex = posting._index\n\n for (var k = 0; k < clause.fields.length; k++) {\n /*\n * For each field that this query term is scoped by (by default\n * all fields are in scope) we need to get all the document refs\n * that have this term in that field.\n *\n * The posting is the entry in the invertedIndex for the matching\n * term from above.\n */\n var field = clause.fields[k],\n fieldPosting = posting[field],\n matchingDocumentRefs = Object.keys(fieldPosting),\n termField = expandedTerm + \"/\" + field,\n matchingDocumentsSet = new lunr.Set(matchingDocumentRefs)\n\n /*\n * if the presence of this term is required ensure that the matching\n * documents are added to the set of required matches for this clause.\n *\n */\n if (clause.presence == lunr.Query.presence.REQUIRED) {\n clauseMatches = clauseMatches.union(matchingDocumentsSet)\n\n if (requiredMatches[field] === undefined) {\n requiredMatches[field] = lunr.Set.complete\n }\n }\n\n /*\n * if the presence of this term is prohibited ensure that the matching\n * documents are added to the set of prohibited matches for this field,\n * creating that set if it does not yet exist.\n */\n if (clause.presence == lunr.Query.presence.PROHIBITED) {\n if (prohibitedMatches[field] === undefined) {\n prohibitedMatches[field] = lunr.Set.empty\n }\n\n prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet)\n\n /*\n * Prohibited matches should not be part of the query vector used for\n * similarity scoring and no metadata should be extracted so we continue\n * to the next field\n */\n continue\n }\n\n /*\n * The query field vector is populated using the termIndex found for\n * the term and a unit value with the appropriate boost applied.\n * Using upsert because there could already be an entry in the vector\n * for the term we are working with. In that case we just add the scores\n * together.\n */\n queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b })\n\n /**\n * If we've already seen this term, field combo then we've already collected\n * the matching documents and metadata, no need to go through all that again\n */\n if (termFieldCache[termField]) {\n continue\n }\n\n for (var l = 0; l < matchingDocumentRefs.length; l++) {\n /*\n * All metadata for this term/field/document triple\n * are then extracted and collected into an instance\n * of lunr.MatchData ready to be returned in the query\n * results\n */\n var matchingDocumentRef = matchingDocumentRefs[l],\n matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field),\n metadata = fieldPosting[matchingDocumentRef],\n fieldMatch\n\n if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) {\n matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata)\n } else {\n fieldMatch.add(expandedTerm, field, metadata)\n }\n\n }\n\n termFieldCache[termField] = true\n }\n }\n }\n\n /**\n * If the presence was required we need to update the requiredMatches field sets.\n * We do this after all fields for the term have collected their matches because\n * the clause terms presence is required in _any_ of the fields not _all_ of the\n * fields.\n */\n if (clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = requiredMatches[field].intersect(clauseMatches)\n }\n }\n }\n\n /**\n * Need to combine the field scoped required and prohibited\n * matching documents into a global set of required and prohibited\n * matches\n */\n var allRequiredMatches = lunr.Set.complete,\n allProhibitedMatches = lunr.Set.empty\n\n for (var i = 0; i < this.fields.length; i++) {\n var field = this.fields[i]\n\n if (requiredMatches[field]) {\n allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field])\n }\n\n if (prohibitedMatches[field]) {\n allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field])\n }\n }\n\n var matchingFieldRefs = Object.keys(matchingFields),\n results = [],\n matches = Object.create(null)\n\n /*\n * If the query is negated (contains only prohibited terms)\n * we need to get _all_ fieldRefs currently existing in the\n * index. This is only done when we know that the query is\n * entirely prohibited terms to avoid any cost of getting all\n * fieldRefs unnecessarily.\n *\n * Additionally, blank MatchData must be created to correctly\n * populate the results.\n */\n if (query.isNegated()) {\n matchingFieldRefs = Object.keys(this.fieldVectors)\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n var matchingFieldRef = matchingFieldRefs[i]\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRef)\n matchingFields[matchingFieldRef] = new lunr.MatchData\n }\n }\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n /*\n * Currently we have document fields that match the query, but we\n * need to return documents. The matchData and scores are combined\n * from multiple fields belonging to the same document.\n *\n * Scores are calculated by field, using the query vectors created\n * above, and combined into a final document score using addition.\n */\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]),\n docRef = fieldRef.docRef\n\n if (!allRequiredMatches.contains(docRef)) {\n continue\n }\n\n if (allProhibitedMatches.contains(docRef)) {\n continue\n }\n\n var fieldVector = this.fieldVectors[fieldRef],\n score = queryVectors[fieldRef.fieldName].similarity(fieldVector),\n docMatch\n\n if ((docMatch = matches[docRef]) !== undefined) {\n docMatch.score += score\n docMatch.matchData.combine(matchingFields[fieldRef])\n } else {\n var match = {\n ref: docRef,\n score: score,\n matchData: matchingFields[fieldRef]\n }\n matches[docRef] = match\n results.push(match)\n }\n }\n\n /*\n * Sort the results objects by score, highest first.\n */\n return results.sort(function (a, b) {\n return b.score - a.score\n })\n}\n\n/**\n * Prepares the index for JSON serialization.\n *\n * The schema for this JSON blob will be described in a\n * separate JSON schema file.\n *\n * @returns {Object}\n */\nlunr.Index.prototype.toJSON = function () {\n var invertedIndex = Object.keys(this.invertedIndex)\n .sort()\n .map(function (term) {\n return [term, this.invertedIndex[term]]\n }, this)\n\n var fieldVectors = Object.keys(this.fieldVectors)\n .map(function (ref) {\n return [ref, this.fieldVectors[ref].toJSON()]\n }, this)\n\n return {\n version: lunr.version,\n fields: this.fields,\n fieldVectors: fieldVectors,\n invertedIndex: invertedIndex,\n pipeline: this.pipeline.toJSON()\n }\n}\n\n/**\n * Loads a previously serialized lunr.Index\n *\n * @param {Object} serializedIndex - A previously serialized lunr.Index\n * @returns {lunr.Index}\n */\nlunr.Index.load = function (serializedIndex) {\n var attrs = {},\n fieldVectors = {},\n serializedVectors = serializedIndex.fieldVectors,\n invertedIndex = Object.create(null),\n serializedInvertedIndex = serializedIndex.invertedIndex,\n tokenSetBuilder = new lunr.TokenSet.Builder,\n pipeline = lunr.Pipeline.load(serializedIndex.pipeline)\n\n if (serializedIndex.version != lunr.version) {\n lunr.utils.warn(\"Version mismatch when loading serialised index. Current version of lunr '\" + lunr.version + \"' does not match serialized index '\" + serializedIndex.version + \"'\")\n }\n\n for (var i = 0; i < serializedVectors.length; i++) {\n var tuple = serializedVectors[i],\n ref = tuple[0],\n elements = tuple[1]\n\n fieldVectors[ref] = new lunr.Vector(elements)\n }\n\n for (var i = 0; i < serializedInvertedIndex.length; i++) {\n var tuple = serializedInvertedIndex[i],\n term = tuple[0],\n posting = tuple[1]\n\n tokenSetBuilder.insert(term)\n invertedIndex[term] = posting\n }\n\n tokenSetBuilder.finish()\n\n attrs.fields = serializedIndex.fields\n\n attrs.fieldVectors = fieldVectors\n attrs.invertedIndex = invertedIndex\n attrs.tokenSet = tokenSetBuilder.root\n attrs.pipeline = pipeline\n\n return new lunr.Index(attrs)\n}\n/*!\n * lunr.Builder\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Builder performs indexing on a set of documents and\n * returns instances of lunr.Index ready for querying.\n *\n * All configuration of the index is done via the builder, the\n * fields to index, the document reference, the text processing\n * pipeline and document scoring parameters are all set on the\n * builder before indexing.\n *\n * @constructor\n * @property {string} _ref - Internal reference to the document reference field.\n * @property {string[]} _fields - Internal reference to the document fields to index.\n * @property {object} invertedIndex - The inverted index maps terms to document fields.\n * @property {object} documentTermFrequencies - Keeps track of document term frequencies.\n * @property {object} documentLengths - Keeps track of the length of documents added to the index.\n * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing.\n * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing.\n * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index.\n * @property {number} documentCount - Keeps track of the total number of documents indexed.\n * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75.\n * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2.\n * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space.\n * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index.\n */\nlunr.Builder = function () {\n this._ref = \"id\"\n this._fields = Object.create(null)\n this._documents = Object.create(null)\n this.invertedIndex = Object.create(null)\n this.fieldTermFrequencies = {}\n this.fieldLengths = {}\n this.tokenizer = lunr.tokenizer\n this.pipeline = new lunr.Pipeline\n this.searchPipeline = new lunr.Pipeline\n this.documentCount = 0\n this._b = 0.75\n this._k1 = 1.2\n this.termIndex = 0\n this.metadataWhitelist = []\n}\n\n/**\n * Sets the document field used as the document reference. Every document must have this field.\n * The type of this field in the document should be a string, if it is not a string it will be\n * coerced into a string by calling toString.\n *\n * The default ref is 'id'.\n *\n * The ref should _not_ be changed during indexing, it should be set before any documents are\n * added to the index. Changing it during indexing can lead to inconsistent results.\n *\n * @param {string} ref - The name of the reference field in the document.\n */\nlunr.Builder.prototype.ref = function (ref) {\n this._ref = ref\n}\n\n/**\n * A function that is used to extract a field from a document.\n *\n * Lunr expects a field to be at the top level of a document, if however the field\n * is deeply nested within a document an extractor function can be used to extract\n * the right field for indexing.\n *\n * @callback fieldExtractor\n * @param {object} doc - The document being added to the index.\n * @returns {?(string|object|object[])} obj - The object that will be indexed for this field.\n * @example Extracting a nested field\n * function (doc) { return doc.nested.field }\n */\n\n/**\n * Adds a field to the list of document fields that will be indexed. Every document being\n * indexed should have this field. Null values for this field in indexed documents will\n * not cause errors but will limit the chance of that document being retrieved by searches.\n *\n * All fields should be added before adding documents to the index. Adding fields after\n * a document has been indexed will have no effect on already indexed documents.\n *\n * Fields can be boosted at build time. This allows terms within that field to have more\n * importance when ranking search results. Use a field boost to specify that matches within\n * one field are more important than other fields.\n *\n * @param {string} fieldName - The name of a field to index in all documents.\n * @param {object} attributes - Optional attributes associated with this field.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this field.\n * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document.\n * @throws {RangeError} fieldName cannot contain unsupported characters '/'\n */\nlunr.Builder.prototype.field = function (fieldName, attributes) {\n if (/\\//.test(fieldName)) {\n throw new RangeError (\"Field '\" + fieldName + \"' contains illegal character '/'\")\n }\n\n this._fields[fieldName] = attributes || {}\n}\n\n/**\n * A parameter to tune the amount of field length normalisation that is applied when\n * calculating relevance scores. A value of 0 will completely disable any normalisation\n * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b\n * will be clamped to the range 0 - 1.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.b = function (number) {\n if (number < 0) {\n this._b = 0\n } else if (number > 1) {\n this._b = 1\n } else {\n this._b = number\n }\n}\n\n/**\n * A parameter that controls the speed at which a rise in term frequency results in term\n * frequency saturation. The default value is 1.2. Setting this to a higher value will give\n * slower saturation levels, a lower value will result in quicker saturation.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.k1 = function (number) {\n this._k1 = number\n}\n\n/**\n * Adds a document to the index.\n *\n * Before adding fields to the index the index should have been fully setup, with the document\n * ref and all fields to index already having been specified.\n *\n * The document must have a field name as specified by the ref (by default this is 'id') and\n * it should have all fields defined for indexing, though null or undefined values will not\n * cause errors.\n *\n * Entire documents can be boosted at build time. Applying a boost to a document indicates that\n * this document should rank higher in search results than other documents.\n *\n * @param {object} doc - The document to add to the index.\n * @param {object} attributes - Optional attributes associated with this document.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this document.\n */\nlunr.Builder.prototype.add = function (doc, attributes) {\n var docRef = doc[this._ref],\n fields = Object.keys(this._fields)\n\n this._documents[docRef] = attributes || {}\n this.documentCount += 1\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i],\n extractor = this._fields[fieldName].extractor,\n field = extractor ? extractor(doc) : doc[fieldName],\n tokens = this.tokenizer(field, {\n fields: [fieldName]\n }),\n terms = this.pipeline.run(tokens),\n fieldRef = new lunr.FieldRef (docRef, fieldName),\n fieldTerms = Object.create(null)\n\n this.fieldTermFrequencies[fieldRef] = fieldTerms\n this.fieldLengths[fieldRef] = 0\n\n // store the length of this field for this document\n this.fieldLengths[fieldRef] += terms.length\n\n // calculate term frequencies for this field\n for (var j = 0; j < terms.length; j++) {\n var term = terms[j]\n\n if (fieldTerms[term] == undefined) {\n fieldTerms[term] = 0\n }\n\n fieldTerms[term] += 1\n\n // add to inverted index\n // create an initial posting if one doesn't exist\n if (this.invertedIndex[term] == undefined) {\n var posting = Object.create(null)\n posting[\"_index\"] = this.termIndex\n this.termIndex += 1\n\n for (var k = 0; k < fields.length; k++) {\n posting[fields[k]] = Object.create(null)\n }\n\n this.invertedIndex[term] = posting\n }\n\n // add an entry for this term/fieldName/docRef to the invertedIndex\n if (this.invertedIndex[term][fieldName][docRef] == undefined) {\n this.invertedIndex[term][fieldName][docRef] = Object.create(null)\n }\n\n // store all whitelisted metadata about this token in the\n // inverted index\n for (var l = 0; l < this.metadataWhitelist.length; l++) {\n var metadataKey = this.metadataWhitelist[l],\n metadata = term.metadata[metadataKey]\n\n if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) {\n this.invertedIndex[term][fieldName][docRef][metadataKey] = []\n }\n\n this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata)\n }\n }\n\n }\n}\n\n/**\n * Calculates the average document length for this index\n *\n * @private\n */\nlunr.Builder.prototype.calculateAverageFieldLengths = function () {\n\n var fieldRefs = Object.keys(this.fieldLengths),\n numberOfFields = fieldRefs.length,\n accumulator = {},\n documentsWithField = {}\n\n for (var i = 0; i < numberOfFields; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n field = fieldRef.fieldName\n\n documentsWithField[field] || (documentsWithField[field] = 0)\n documentsWithField[field] += 1\n\n accumulator[field] || (accumulator[field] = 0)\n accumulator[field] += this.fieldLengths[fieldRef]\n }\n\n var fields = Object.keys(this._fields)\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i]\n accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName]\n }\n\n this.averageFieldLength = accumulator\n}\n\n/**\n * Builds a vector space model of every document using lunr.Vector\n *\n * @private\n */\nlunr.Builder.prototype.createFieldVectors = function () {\n var fieldVectors = {},\n fieldRefs = Object.keys(this.fieldTermFrequencies),\n fieldRefsLength = fieldRefs.length,\n termIdfCache = Object.create(null)\n\n for (var i = 0; i < fieldRefsLength; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n fieldName = fieldRef.fieldName,\n fieldLength = this.fieldLengths[fieldRef],\n fieldVector = new lunr.Vector,\n termFrequencies = this.fieldTermFrequencies[fieldRef],\n terms = Object.keys(termFrequencies),\n termsLength = terms.length\n\n\n var fieldBoost = this._fields[fieldName].boost || 1,\n docBoost = this._documents[fieldRef.docRef].boost || 1\n\n for (var j = 0; j < termsLength; j++) {\n var term = terms[j],\n tf = termFrequencies[term],\n termIndex = this.invertedIndex[term]._index,\n idf, score, scoreWithPrecision\n\n if (termIdfCache[term] === undefined) {\n idf = lunr.idf(this.invertedIndex[term], this.documentCount)\n termIdfCache[term] = idf\n } else {\n idf = termIdfCache[term]\n }\n\n score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf)\n score *= fieldBoost\n score *= docBoost\n scoreWithPrecision = Math.round(score * 1000) / 1000\n // Converts 1.23456789 to 1.234.\n // Reducing the precision so that the vectors take up less\n // space when serialised. Doing it now so that they behave\n // the same before and after serialisation. Also, this is\n // the fastest approach to reducing a number's precision in\n // JavaScript.\n\n fieldVector.insert(termIndex, scoreWithPrecision)\n }\n\n fieldVectors[fieldRef] = fieldVector\n }\n\n this.fieldVectors = fieldVectors\n}\n\n/**\n * Creates a token set of all tokens in the index using lunr.TokenSet\n *\n * @private\n */\nlunr.Builder.prototype.createTokenSet = function () {\n this.tokenSet = lunr.TokenSet.fromArray(\n Object.keys(this.invertedIndex).sort()\n )\n}\n\n/**\n * Builds the index, creating an instance of lunr.Index.\n *\n * This completes the indexing process and should only be called\n * once all documents have been added to the index.\n *\n * @returns {lunr.Index}\n */\nlunr.Builder.prototype.build = function () {\n this.calculateAverageFieldLengths()\n this.createFieldVectors()\n this.createTokenSet()\n\n return new lunr.Index({\n invertedIndex: this.invertedIndex,\n fieldVectors: this.fieldVectors,\n tokenSet: this.tokenSet,\n fields: Object.keys(this._fields),\n pipeline: this.searchPipeline\n })\n}\n\n/**\n * Applies a plugin to the index builder.\n *\n * A plugin is a function that is called with the index builder as its context.\n * Plugins can be used to customise or extend the behaviour of the index\n * in some way. A plugin is just a function, that encapsulated the custom\n * behaviour that should be applied when building the index.\n *\n * The plugin function will be called with the index builder as its argument, additional\n * arguments can also be passed when calling use. The function will be called\n * with the index builder as its context.\n *\n * @param {Function} plugin The plugin to apply.\n */\nlunr.Builder.prototype.use = function (fn) {\n var args = Array.prototype.slice.call(arguments, 1)\n args.unshift(this)\n fn.apply(this, args)\n}\n/**\n * Contains and collects metadata about a matching document.\n * A single instance of lunr.MatchData is returned as part of every\n * lunr.Index~Result.\n *\n * @constructor\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n * @property {object} metadata - A cloned collection of metadata associated with this document.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData = function (term, field, metadata) {\n var clonedMetadata = Object.create(null),\n metadataKeys = Object.keys(metadata || {})\n\n // Cloning the metadata to prevent the original\n // being mutated during match data combination.\n // Metadata is kept in an array within the inverted\n // index so cloning the data can be done with\n // Array#slice\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n clonedMetadata[key] = metadata[key].slice()\n }\n\n this.metadata = Object.create(null)\n\n if (term !== undefined) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = clonedMetadata\n }\n}\n\n/**\n * An instance of lunr.MatchData will be created for every term that matches a\n * document. However only one instance is required in a lunr.Index~Result. This\n * method combines metadata from another instance of lunr.MatchData with this\n * objects metadata.\n *\n * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData.prototype.combine = function (otherMatchData) {\n var terms = Object.keys(otherMatchData.metadata)\n\n for (var i = 0; i < terms.length; i++) {\n var term = terms[i],\n fields = Object.keys(otherMatchData.metadata[term])\n\n if (this.metadata[term] == undefined) {\n this.metadata[term] = Object.create(null)\n }\n\n for (var j = 0; j < fields.length; j++) {\n var field = fields[j],\n keys = Object.keys(otherMatchData.metadata[term][field])\n\n if (this.metadata[term][field] == undefined) {\n this.metadata[term][field] = Object.create(null)\n }\n\n for (var k = 0; k < keys.length; k++) {\n var key = keys[k]\n\n if (this.metadata[term][field][key] == undefined) {\n this.metadata[term][field][key] = otherMatchData.metadata[term][field][key]\n } else {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key])\n }\n\n }\n }\n }\n}\n\n/**\n * Add metadata for a term/field pair to this instance of match data.\n *\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n */\nlunr.MatchData.prototype.add = function (term, field, metadata) {\n if (!(term in this.metadata)) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = metadata\n return\n }\n\n if (!(field in this.metadata[term])) {\n this.metadata[term][field] = metadata\n return\n }\n\n var metadataKeys = Object.keys(metadata)\n\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n\n if (key in this.metadata[term][field]) {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key])\n } else {\n this.metadata[term][field][key] = metadata[key]\n }\n }\n}\n/**\n * A lunr.Query provides a programmatic way of defining queries to be performed\n * against a {@link lunr.Index}.\n *\n * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method\n * so the query object is pre-initialized with the right index fields.\n *\n * @constructor\n * @property {lunr.Query~Clause[]} clauses - An array of query clauses.\n * @property {string[]} allFields - An array of all available fields in a lunr.Index.\n */\nlunr.Query = function (allFields) {\n this.clauses = []\n this.allFields = allFields\n}\n\n/**\n * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause.\n *\n * This allows wildcards to be added to the beginning and end of a term without having to manually do any string\n * concatenation.\n *\n * The wildcard constants can be bitwise combined to select both leading and trailing wildcards.\n *\n * @constant\n * @default\n * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour\n * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists\n * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with trailing wildcard\n * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING })\n * @example query term with leading and trailing wildcard\n * query.term('foo', {\n * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING\n * })\n */\n\nlunr.Query.wildcard = new String (\"*\")\nlunr.Query.wildcard.NONE = 0\nlunr.Query.wildcard.LEADING = 1\nlunr.Query.wildcard.TRAILING = 2\n\n/**\n * Constants for indicating what kind of presence a term must have in matching documents.\n *\n * @constant\n * @enum {number}\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with required presence\n * query.term('foo', { presence: lunr.Query.presence.REQUIRED })\n */\nlunr.Query.presence = {\n /**\n * Term's presence in a document is optional, this is the default value.\n */\n OPTIONAL: 1,\n\n /**\n * Term's presence in a document is required, documents that do not contain\n * this term will not be returned.\n */\n REQUIRED: 2,\n\n /**\n * Term's presence in a document is prohibited, documents that do contain\n * this term will not be returned.\n */\n PROHIBITED: 3\n}\n\n/**\n * A single clause in a {@link lunr.Query} contains a term and details on how to\n * match that term against a {@link lunr.Index}.\n *\n * @typedef {Object} lunr.Query~Clause\n * @property {string[]} fields - The fields in an index this clause should be matched against.\n * @property {number} [boost=1] - Any boost that should be applied when matching this clause.\n * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be.\n * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline.\n * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended.\n * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents.\n */\n\n/**\n * Adds a {@link lunr.Query~Clause} to this query.\n *\n * Unless the clause contains the fields to be matched all fields will be matched. In addition\n * a default boost of 1 is applied to the clause.\n *\n * @param {lunr.Query~Clause} clause - The clause to add to this query.\n * @see lunr.Query~Clause\n * @returns {lunr.Query}\n */\nlunr.Query.prototype.clause = function (clause) {\n if (!('fields' in clause)) {\n clause.fields = this.allFields\n }\n\n if (!('boost' in clause)) {\n clause.boost = 1\n }\n\n if (!('usePipeline' in clause)) {\n clause.usePipeline = true\n }\n\n if (!('wildcard' in clause)) {\n clause.wildcard = lunr.Query.wildcard.NONE\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) {\n clause.term = \"*\" + clause.term\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) {\n clause.term = \"\" + clause.term + \"*\"\n }\n\n if (!('presence' in clause)) {\n clause.presence = lunr.Query.presence.OPTIONAL\n }\n\n this.clauses.push(clause)\n\n return this\n}\n\n/**\n * A negated query is one in which every clause has a presence of\n * prohibited. These queries require some special processing to return\n * the expected results.\n *\n * @returns boolean\n */\nlunr.Query.prototype.isNegated = function () {\n for (var i = 0; i < this.clauses.length; i++) {\n if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) {\n return false\n }\n }\n\n return true\n}\n\n/**\n * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause}\n * to the list of clauses that make up this query.\n *\n * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion\n * to a token or token-like string should be done before calling this method.\n *\n * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an\n * array, each term in the array will share the same options.\n *\n * @param {object|object[]} term - The term(s) to add to the query.\n * @param {object} [options] - Any additional properties to add to the query clause.\n * @returns {lunr.Query}\n * @see lunr.Query#clause\n * @see lunr.Query~Clause\n * @example adding a single term to a query\n * query.term(\"foo\")\n * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard\n * query.term(\"foo\", {\n * fields: [\"title\"],\n * boost: 10,\n * wildcard: lunr.Query.wildcard.TRAILING\n * })\n * @example using lunr.tokenizer to convert a string to tokens before using them as terms\n * query.term(lunr.tokenizer(\"foo bar\"))\n */\nlunr.Query.prototype.term = function (term, options) {\n if (Array.isArray(term)) {\n term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this)\n return this\n }\n\n var clause = options || {}\n clause.term = term.toString()\n\n this.clause(clause)\n\n return this\n}\nlunr.QueryParseError = function (message, start, end) {\n this.name = \"QueryParseError\"\n this.message = message\n this.start = start\n this.end = end\n}\n\nlunr.QueryParseError.prototype = new Error\nlunr.QueryLexer = function (str) {\n this.lexemes = []\n this.str = str\n this.length = str.length\n this.pos = 0\n this.start = 0\n this.escapeCharPositions = []\n}\n\nlunr.QueryLexer.prototype.run = function () {\n var state = lunr.QueryLexer.lexText\n\n while (state) {\n state = state(this)\n }\n}\n\nlunr.QueryLexer.prototype.sliceString = function () {\n var subSlices = [],\n sliceStart = this.start,\n sliceEnd = this.pos\n\n for (var i = 0; i < this.escapeCharPositions.length; i++) {\n sliceEnd = this.escapeCharPositions[i]\n subSlices.push(this.str.slice(sliceStart, sliceEnd))\n sliceStart = sliceEnd + 1\n }\n\n subSlices.push(this.str.slice(sliceStart, this.pos))\n this.escapeCharPositions.length = 0\n\n return subSlices.join('')\n}\n\nlunr.QueryLexer.prototype.emit = function (type) {\n this.lexemes.push({\n type: type,\n str: this.sliceString(),\n start: this.start,\n end: this.pos\n })\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.escapeCharacter = function () {\n this.escapeCharPositions.push(this.pos - 1)\n this.pos += 1\n}\n\nlunr.QueryLexer.prototype.next = function () {\n if (this.pos >= this.length) {\n return lunr.QueryLexer.EOS\n }\n\n var char = this.str.charAt(this.pos)\n this.pos += 1\n return char\n}\n\nlunr.QueryLexer.prototype.width = function () {\n return this.pos - this.start\n}\n\nlunr.QueryLexer.prototype.ignore = function () {\n if (this.start == this.pos) {\n this.pos += 1\n }\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.backup = function () {\n this.pos -= 1\n}\n\nlunr.QueryLexer.prototype.acceptDigitRun = function () {\n var char, charCode\n\n do {\n char = this.next()\n charCode = char.charCodeAt(0)\n } while (charCode > 47 && charCode < 58)\n\n if (char != lunr.QueryLexer.EOS) {\n this.backup()\n }\n}\n\nlunr.QueryLexer.prototype.more = function () {\n return this.pos < this.length\n}\n\nlunr.QueryLexer.EOS = 'EOS'\nlunr.QueryLexer.FIELD = 'FIELD'\nlunr.QueryLexer.TERM = 'TERM'\nlunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'\nlunr.QueryLexer.BOOST = 'BOOST'\nlunr.QueryLexer.PRESENCE = 'PRESENCE'\n\nlunr.QueryLexer.lexField = function (lexer) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.FIELD)\n lexer.ignore()\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexTerm = function (lexer) {\n if (lexer.width() > 1) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.TERM)\n }\n\n lexer.ignore()\n\n if (lexer.more()) {\n return lunr.QueryLexer.lexText\n }\n}\n\nlunr.QueryLexer.lexEditDistance = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.EDIT_DISTANCE)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexBoost = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.BOOST)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexEOS = function (lexer) {\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n}\n\n// This matches the separator used when tokenising fields\n// within a document. These should match otherwise it is\n// not possible to search for some tokens within a document.\n//\n// It is possible for the user to change the separator on the\n// tokenizer so it _might_ clash with any other of the special\n// characters already used within the search string, e.g. :.\n//\n// This means that it is possible to change the separator in\n// such a way that makes some words unsearchable using a search\n// string.\nlunr.QueryLexer.termSeparator = lunr.tokenizer.separator\n\nlunr.QueryLexer.lexText = function (lexer) {\n while (true) {\n var char = lexer.next()\n\n if (char == lunr.QueryLexer.EOS) {\n return lunr.QueryLexer.lexEOS\n }\n\n // Escape character is '\\'\n if (char.charCodeAt(0) == 92) {\n lexer.escapeCharacter()\n continue\n }\n\n if (char == \":\") {\n return lunr.QueryLexer.lexField\n }\n\n if (char == \"~\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexEditDistance\n }\n\n if (char == \"^\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexBoost\n }\n\n // \"+\" indicates term presence is required\n // checking for length to ensure that only\n // leading \"+\" are considered\n if (char == \"+\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n // \"-\" indicates term presence is prohibited\n // checking for length to ensure that only\n // leading \"-\" are considered\n if (char == \"-\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n if (char.match(lunr.QueryLexer.termSeparator)) {\n return lunr.QueryLexer.lexTerm\n }\n }\n}\n\nlunr.QueryParser = function (str, query) {\n this.lexer = new lunr.QueryLexer (str)\n this.query = query\n this.currentClause = {}\n this.lexemeIdx = 0\n}\n\nlunr.QueryParser.prototype.parse = function () {\n this.lexer.run()\n this.lexemes = this.lexer.lexemes\n\n var state = lunr.QueryParser.parseClause\n\n while (state) {\n state = state(this)\n }\n\n return this.query\n}\n\nlunr.QueryParser.prototype.peekLexeme = function () {\n return this.lexemes[this.lexemeIdx]\n}\n\nlunr.QueryParser.prototype.consumeLexeme = function () {\n var lexeme = this.peekLexeme()\n this.lexemeIdx += 1\n return lexeme\n}\n\nlunr.QueryParser.prototype.nextClause = function () {\n var completedClause = this.currentClause\n this.query.clause(completedClause)\n this.currentClause = {}\n}\n\nlunr.QueryParser.parseClause = function (parser) {\n var lexeme = parser.peekLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.type) {\n case lunr.QueryLexer.PRESENCE:\n return lunr.QueryParser.parsePresence\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expected either a field or a term, found \" + lexeme.type\n\n if (lexeme.str.length >= 1) {\n errorMessage += \" with value '\" + lexeme.str + \"'\"\n }\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n}\n\nlunr.QueryParser.parsePresence = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.str) {\n case \"-\":\n parser.currentClause.presence = lunr.Query.presence.PROHIBITED\n break\n case \"+\":\n parser.currentClause.presence = lunr.Query.presence.REQUIRED\n break\n default:\n var errorMessage = \"unrecognised presence operator'\" + lexeme.str + \"'\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term or field, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term or field, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseField = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n if (parser.query.allFields.indexOf(lexeme.str) == -1) {\n var possibleFields = parser.query.allFields.map(function (f) { return \"'\" + f + \"'\" }).join(', '),\n errorMessage = \"unrecognised field '\" + lexeme.str + \"', possible fields: \" + possibleFields\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.fields = [lexeme.str]\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseTerm = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n parser.currentClause.term = lexeme.str.toLowerCase()\n\n if (lexeme.str.indexOf(\"*\") != -1) {\n parser.currentClause.usePipeline = false\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseEditDistance = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var editDistance = parseInt(lexeme.str, 10)\n\n if (isNaN(editDistance)) {\n var errorMessage = \"edit distance must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.editDistance = editDistance\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseBoost = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var boost = parseInt(lexeme.str, 10)\n\n if (isNaN(boost)) {\n var errorMessage = \"boost must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.boost = boost\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\n /**\n * export the module via AMD, CommonJS or as a browser global\n * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js\n */\n ;(function (root, factory) {\n if (true) {\n // AMD. Register as an anonymous module.\n !(__WEBPACK_AMD_DEFINE_FACTORY__ = (factory),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ = (typeof __WEBPACK_AMD_DEFINE_FACTORY__ === 'function' ?\n\t\t(__WEBPACK_AMD_DEFINE_FACTORY__.call(exports, __webpack_require__, exports, module)) :\n\t\t__WEBPACK_AMD_DEFINE_FACTORY__),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ !== undefined && (module.exports = __WEBPACK_AMD_DEFINE_RESULT__))\n } else {}\n }(this, function () {\n /**\n * Just return a value to define the module export.\n * This example returns an object, but the module\n * can return a function as the exported value.\n */\n return lunr\n }))\n})();\n\n\n//# sourceURL=webpack:///../node_modules/lunr/lunr.js?"); + +/***/ }), + +/***/ "./default/assets/css/main.sass": +/*!**************************************!*\ + !*** ./default/assets/css/main.sass ***! + \**************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack:///./default/assets/css/main.sass?"); + +/***/ }), + +/***/ "./default/assets/js/src/bootstrap.ts": +/*!********************************************!*\ + !*** ./default/assets/js/src/bootstrap.ts ***! + \********************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./typedoc/Application */ \"./default/assets/js/src/typedoc/Application.ts\");\n/* harmony import */ var _typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./typedoc/components/MenuHighlight */ \"./default/assets/js/src/typedoc/components/MenuHighlight.ts\");\n/* harmony import */ var _typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./typedoc/components/Search */ \"./default/assets/js/src/typedoc/components/Search.ts\");\n/* harmony import */ var _typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./typedoc/components/Signature */ \"./default/assets/js/src/typedoc/components/Signature.ts\");\n/* harmony import */ var _typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./typedoc/components/Toggle */ \"./default/assets/js/src/typedoc/components/Toggle.ts\");\n/* harmony import */ var _typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./typedoc/components/Filter */ \"./default/assets/js/src/typedoc/components/Filter.ts\");\n/* harmony import */ var _css_main_sass__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(/*! ../../css/main.sass */ \"./default/assets/css/main.sass\");\n\n\n\n\n\n\n\n(0,_typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__.initSearch)();\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__.MenuHighlight, \".menu-highlight\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__.Signature, \".tsd-signatures\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__.Toggle, \"a[data-toggle]\");\nif (_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter.isSupported()) {\n (0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter, \"#tsd-filter\");\n}\nelse {\n document.documentElement.classList.add(\"no-filter\");\n}\nvar app = new _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.Application();\nObject.defineProperty(window, \"app\", { value: app });\n\n\n//# sourceURL=webpack:///./default/assets/js/src/bootstrap.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/Application.ts": +/*!******************************************************!*\ + !*** ./default/assets/js/src/typedoc/Application.ts ***! + \******************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"registerComponent\": () => /* binding */ registerComponent,\n/* harmony export */ \"Application\": () => /* binding */ Application\n/* harmony export */ });\n/**\n * List of all known components.\n */\nvar components = [];\n/**\n * Register a new component.\n */\nfunction registerComponent(constructor, selector) {\n components.push({\n selector: selector,\n constructor: constructor,\n });\n}\n/**\n * TypeDoc application class.\n */\nvar Application = /** @class */ (function () {\n /**\n * Create a new Application instance.\n */\n function Application() {\n this.createComponents(document.body);\n }\n /**\n * Create all components beneath the given jQuery element.\n */\n Application.prototype.createComponents = function (context) {\n components.forEach(function (c) {\n context.querySelectorAll(c.selector).forEach(function (el) {\n if (!el.dataset.hasInstance) {\n new c.constructor({ el: el });\n el.dataset.hasInstance = String(true);\n }\n });\n });\n };\n return Application;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Application.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/Component.ts": +/*!****************************************************!*\ + !*** ./default/assets/js/src/typedoc/Component.ts ***! + \****************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Component\": () => /* binding */ Component\n/* harmony export */ });\n/**\n * TypeDoc component class.\n */\nvar Component = /** @class */ (function () {\n function Component(options) {\n this.el = options.el;\n }\n return Component;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Component.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/EventTarget.ts": +/*!******************************************************!*\ + !*** ./default/assets/js/src/typedoc/EventTarget.ts ***! + \******************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"EventTarget\": () => /* binding */ EventTarget\n/* harmony export */ });\n/**\n * TypeDoc event target class.\n */\nvar EventTarget = /** @class */ (function () {\n function EventTarget() {\n this.listeners = {};\n }\n EventTarget.prototype.addEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n this.listeners[type] = [];\n }\n this.listeners[type].push(callback);\n };\n EventTarget.prototype.removeEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n return;\n }\n var stack = this.listeners[type];\n for (var i = 0, l = stack.length; i < l; i++) {\n if (stack[i] === callback) {\n stack.splice(i, 1);\n return;\n }\n }\n };\n EventTarget.prototype.dispatchEvent = function (event) {\n if (!(event.type in this.listeners)) {\n return true;\n }\n var stack = this.listeners[event.type].slice();\n for (var i = 0, l = stack.length; i < l; i++) {\n stack[i].call(this, event);\n }\n return !event.defaultPrevented;\n };\n return EventTarget;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/EventTarget.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Filter.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Filter.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Filter\": () => /* binding */ Filter\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar FilterItem = /** @class */ (function () {\n function FilterItem(key, value) {\n this.key = key;\n this.value = value;\n this.defaultValue = value;\n this.initialize();\n if (window.localStorage[this.key]) {\n this.setValue(this.fromLocalStorage(window.localStorage[this.key]));\n }\n }\n FilterItem.prototype.initialize = function () { };\n FilterItem.prototype.setValue = function (value) {\n if (this.value == value)\n return;\n var oldValue = this.value;\n this.value = value;\n window.localStorage[this.key] = this.toLocalStorage(value);\n this.handleValueChange(oldValue, value);\n };\n return FilterItem;\n}());\nvar FilterItemCheckbox = /** @class */ (function (_super) {\n __extends(FilterItemCheckbox, _super);\n function FilterItemCheckbox() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemCheckbox.prototype.initialize = function () {\n var _this = this;\n var checkbox = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!checkbox)\n return;\n this.checkbox = checkbox;\n this.checkbox.addEventListener(\"change\", function () {\n _this.setValue(_this.checkbox.checked);\n });\n };\n FilterItemCheckbox.prototype.handleValueChange = function (oldValue, newValue) {\n if (!this.checkbox)\n return;\n this.checkbox.checked = this.value;\n document.documentElement.classList.toggle(\"toggle-\" + this.key, this.value != this.defaultValue);\n };\n FilterItemCheckbox.prototype.fromLocalStorage = function (value) {\n return value == \"true\";\n };\n FilterItemCheckbox.prototype.toLocalStorage = function (value) {\n return value ? \"true\" : \"false\";\n };\n return FilterItemCheckbox;\n}(FilterItem));\nvar FilterItemSelect = /** @class */ (function (_super) {\n __extends(FilterItemSelect, _super);\n function FilterItemSelect() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemSelect.prototype.initialize = function () {\n var _this = this;\n document.documentElement.classList.add(\"toggle-\" + this.key + this.value);\n var select = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!select)\n return;\n this.select = select;\n var onActivate = function () {\n _this.select.classList.add(\"active\");\n };\n var onDeactivate = function () {\n _this.select.classList.remove(\"active\");\n };\n this.select.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, onActivate);\n this.select.addEventListener(\"mouseover\", onActivate);\n this.select.addEventListener(\"mouseleave\", onDeactivate);\n this.select.querySelectorAll(\"li\").forEach(function (el) {\n el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n select.classList.remove(\"active\");\n _this.setValue(e.target.dataset.value || \"\");\n });\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n if (_this.select.contains(e.target))\n return;\n _this.select.classList.remove(\"active\");\n });\n };\n FilterItemSelect.prototype.handleValueChange = function (oldValue, newValue) {\n this.select.querySelectorAll(\"li.selected\").forEach(function (el) {\n el.classList.remove(\"selected\");\n });\n var selected = this.select.querySelector('li[data-value=\"' + newValue + '\"]');\n var label = this.select.querySelector(\".tsd-select-label\");\n if (selected && label) {\n selected.classList.add(\"selected\");\n label.textContent = selected.textContent;\n }\n document.documentElement.classList.remove(\"toggle-\" + oldValue);\n document.documentElement.classList.add(\"toggle-\" + newValue);\n };\n FilterItemSelect.prototype.fromLocalStorage = function (value) {\n return value;\n };\n FilterItemSelect.prototype.toLocalStorage = function (value) {\n return value;\n };\n return FilterItemSelect;\n}(FilterItem));\nvar Filter = /** @class */ (function (_super) {\n __extends(Filter, _super);\n function Filter(options) {\n var _this = _super.call(this, options) || this;\n _this.optionVisibility = new FilterItemSelect(\"visibility\", \"private\");\n _this.optionInherited = new FilterItemCheckbox(\"inherited\", true);\n _this.optionExternals = new FilterItemCheckbox(\"externals\", true);\n return _this;\n }\n Filter.isSupported = function () {\n try {\n return typeof window.localStorage != \"undefined\";\n }\n catch (e) {\n return false;\n }\n };\n return Filter;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Filter.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/MenuHighlight.ts": +/*!*******************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/MenuHighlight.ts ***! + \*******************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"MenuHighlight\": () => /* binding */ MenuHighlight\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Manages the sticky state of the navigation and moves the highlight\n * to the current navigation item.\n */\nvar MenuHighlight = /** @class */ (function (_super) {\n __extends(MenuHighlight, _super);\n /**\n * Create a new MenuHighlight instance.\n *\n * @param options Backbone view constructor options.\n */\n function MenuHighlight(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of all discovered anchors.\n */\n _this.anchors = [];\n /**\n * Index of the currently highlighted anchor.\n */\n _this.index = -1;\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"resize\", function () { return _this.onResize(); });\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"scroll\", function (e) { return _this.onScroll(e); });\n _this.createAnchors();\n return _this;\n }\n /**\n * Find all anchors on the current page.\n */\n MenuHighlight.prototype.createAnchors = function () {\n var _this = this;\n var base = window.location.href;\n if (base.indexOf(\"#\") != -1) {\n base = base.substr(0, base.indexOf(\"#\"));\n }\n this.el.querySelectorAll(\"a\").forEach(function (el) {\n var href = el.href;\n if (href.indexOf(\"#\") == -1)\n return;\n if (href.substr(0, base.length) != base)\n return;\n var hash = href.substr(href.indexOf(\"#\") + 1);\n var anchor = document.querySelector(\"a.tsd-anchor[name=\" + hash + \"]\");\n var link = el.parentNode;\n if (!anchor || !link)\n return;\n _this.anchors.push({\n link: link,\n anchor: anchor,\n position: 0,\n });\n });\n this.onResize();\n };\n /**\n * Triggered after the viewport was resized.\n */\n MenuHighlight.prototype.onResize = function () {\n var anchor;\n for (var index = 0, count = this.anchors.length; index < count; index++) {\n anchor = this.anchors[index];\n var rect = anchor.anchor.getBoundingClientRect();\n anchor.position = rect.top + document.body.scrollTop;\n }\n this.anchors.sort(function (a, b) {\n return a.position - b.position;\n });\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.scrollTop,\n },\n });\n this.onScroll(event);\n };\n /**\n * Triggered after the viewport was scrolled.\n *\n * @param event The custom event with the current vertical scroll position.\n */\n MenuHighlight.prototype.onScroll = function (event) {\n var scrollTop = event.detail.scrollTop + 5;\n var anchors = this.anchors;\n var count = anchors.length - 1;\n var index = this.index;\n while (index > -1 && anchors[index].position > scrollTop) {\n index -= 1;\n }\n while (index < count && anchors[index + 1].position < scrollTop) {\n index += 1;\n }\n if (this.index != index) {\n if (this.index > -1)\n this.anchors[this.index].link.classList.remove(\"focus\");\n this.index = index;\n if (this.index > -1)\n this.anchors[this.index].link.classList.add(\"focus\");\n }\n };\n return MenuHighlight;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/MenuHighlight.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Search.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Search.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"initSearch\": () => /* binding */ initSearch\n/* harmony export */ });\n/* harmony import */ var _utils_debounce__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../utils/debounce */ \"./default/assets/js/src/typedoc/utils/debounce.ts\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! lunr */ \"../node_modules/lunr/lunr.js\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(lunr__WEBPACK_IMPORTED_MODULE_1__);\n\n\nfunction initSearch() {\n var searchEl = document.getElementById(\"tsd-search\");\n if (!searchEl)\n return;\n var searchScript = document.getElementById(\"search-script\");\n searchEl.classList.add(\"loading\");\n if (searchScript) {\n searchScript.addEventListener(\"error\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"failure\");\n });\n searchScript.addEventListener(\"load\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n });\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n }\n }\n var field = document.querySelector(\"#tsd-search-field\");\n var results = document.querySelector(\".results\");\n if (!field || !results) {\n throw new Error(\"The input field or the result list wrapper was not found\");\n }\n var resultClicked = false;\n results.addEventListener(\"mousedown\", function () { return (resultClicked = true); });\n results.addEventListener(\"mouseup\", function () {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n });\n field.addEventListener(\"focus\", function () { return searchEl.classList.add(\"has-focus\"); });\n field.addEventListener(\"blur\", function () {\n if (!resultClicked) {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n }\n });\n var state = {\n base: searchEl.dataset.base + \"/\",\n };\n bindEvents(searchEl, results, field, state);\n}\nfunction bindEvents(searchEl, results, field, state) {\n field.addEventListener(\"input\", (0,_utils_debounce__WEBPACK_IMPORTED_MODULE_0__.debounce)(function () {\n updateResults(searchEl, results, field, state);\n }, 200));\n var preventPress = false;\n field.addEventListener(\"keydown\", function (e) {\n preventPress = true;\n if (e.key == \"Enter\") {\n gotoCurrentResult(results, field);\n }\n else if (e.key == \"Escape\") {\n field.blur();\n }\n else if (e.key == \"ArrowUp\") {\n setCurrentResult(results, -1);\n }\n else if (e.key === \"ArrowDown\") {\n setCurrentResult(results, 1);\n }\n else {\n preventPress = false;\n }\n });\n field.addEventListener(\"keypress\", function (e) {\n if (preventPress)\n e.preventDefault();\n });\n /**\n * Start searching by pressing slash.\n */\n document.body.addEventListener(\"keydown\", function (e) {\n if (e.altKey || e.ctrlKey || e.metaKey)\n return;\n if (!field.matches(\":focus\") && e.key === \"/\") {\n field.focus();\n e.preventDefault();\n }\n });\n}\nfunction checkIndex(state, searchEl) {\n if (state.index)\n return;\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n state.data = window.searchData;\n state.index = lunr__WEBPACK_IMPORTED_MODULE_1__.Index.load(window.searchData.index);\n }\n}\nfunction updateResults(searchEl, results, query, state) {\n checkIndex(state, searchEl);\n // Don't clear results if loading state is not ready,\n // because loading or error message can be removed.\n if (!state.index || !state.data)\n return;\n results.textContent = \"\";\n var searchText = query.value.trim();\n // Perform a wildcard search\n var res = state.index.search(\"*\" + searchText + \"*\");\n for (var i = 0, c = Math.min(10, res.length); i < c; i++) {\n var row = state.data.rows[Number(res[i].ref)];\n // Bold the matched part of the query in the search results\n var name_1 = boldMatches(row.name, searchText);\n if (row.parent) {\n name_1 = \"\" + boldMatches(row.parent, searchText) + \".\" + name_1;\n }\n var item = document.createElement(\"li\");\n item.classList.value = row.classes;\n var anchor = document.createElement(\"a\");\n anchor.href = state.base + row.url;\n anchor.classList.add(\"tsd-kind-icon\");\n anchor.innerHTML = name_1;\n item.append(anchor);\n results.appendChild(item);\n }\n}\n/**\n * Move the highlight within the result set.\n */\nfunction setCurrentResult(results, dir) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(dir == 1 ? \"li:first-child\" : \"li:last-child\");\n if (current) {\n current.classList.add(\"current\");\n }\n }\n else {\n var rel = dir == 1\n ? current.nextElementSibling\n : current.previousElementSibling;\n if (rel) {\n current.classList.remove(\"current\");\n rel.classList.add(\"current\");\n }\n }\n}\n/**\n * Navigate to the highlighted result.\n */\nfunction gotoCurrentResult(results, field) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(\"li:first-child\");\n }\n if (current) {\n var link = current.querySelector(\"a\");\n if (link) {\n window.location.href = link.href;\n }\n field.blur();\n }\n}\nfunction boldMatches(text, search) {\n if (search === \"\") {\n return text;\n }\n var lowerText = text.toLocaleLowerCase();\n var lowerSearch = search.toLocaleLowerCase();\n var parts = [];\n var lastIndex = 0;\n var index = lowerText.indexOf(lowerSearch);\n while (index != -1) {\n parts.push(escapeHtml(text.substring(lastIndex, index)), \"\" + escapeHtml(text.substring(index, index + lowerSearch.length)) + \"\");\n lastIndex = index + lowerSearch.length;\n index = lowerText.indexOf(lowerSearch, lastIndex);\n }\n parts.push(escapeHtml(text.substring(lastIndex)));\n return parts.join(\"\");\n}\nvar SPECIAL_HTML = {\n \"&\": \"&\",\n \"<\": \"<\",\n \">\": \">\",\n \"'\": \"'\",\n '\"': \""\",\n};\nfunction escapeHtml(text) {\n return text.replace(/[&<>\"'\"]/g, function (match) { return SPECIAL_HTML[match]; });\n}\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Search.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Signature.ts": +/*!***************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Signature.ts ***! + \***************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Signature\": () => /* binding */ Signature\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Holds a signature and its description.\n */\nvar SignatureGroup = /** @class */ (function () {\n /**\n * Create a new SignatureGroup instance.\n *\n * @param signature The target signature.\n * @param description The description for the signature.\n */\n function SignatureGroup(signature, description) {\n this.signature = signature;\n this.description = description;\n }\n /**\n * Add the given class to all elements of the group.\n *\n * @param className The class name to add.\n */\n SignatureGroup.prototype.addClass = function (className) {\n this.signature.classList.add(className);\n this.description.classList.add(className);\n return this;\n };\n /**\n * Remove the given class from all elements of the group.\n *\n * @param className The class name to remove.\n */\n SignatureGroup.prototype.removeClass = function (className) {\n this.signature.classList.remove(className);\n this.description.classList.remove(className);\n return this;\n };\n return SignatureGroup;\n}());\n/**\n * Controls the tab like behaviour of methods and functions with multiple signatures.\n */\nvar Signature = /** @class */ (function (_super) {\n __extends(Signature, _super);\n /**\n * Create a new Signature instance.\n *\n * @param options Backbone view constructor options.\n */\n function Signature(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of found signature groups.\n */\n _this.groups = [];\n /**\n * The index of the currently displayed signature.\n */\n _this.index = -1;\n _this.createGroups();\n if (_this.container) {\n _this.el.classList.add(\"active\");\n Array.from(_this.el.children).forEach(function (signature) {\n signature.addEventListener(\"touchstart\", function (event) {\n return _this.onClick(event);\n });\n signature.addEventListener(\"click\", function (event) {\n return _this.onClick(event);\n });\n });\n _this.container.classList.add(\"active\");\n _this.setIndex(0);\n }\n return _this;\n }\n /**\n * Set the index of the active signature.\n *\n * @param index The index of the signature to activate.\n */\n Signature.prototype.setIndex = function (index) {\n if (index < 0)\n index = 0;\n if (index > this.groups.length - 1)\n index = this.groups.length - 1;\n if (this.index == index)\n return;\n var to = this.groups[index];\n if (this.index > -1) {\n var from_1 = this.groups[this.index];\n from_1.removeClass(\"current\").addClass(\"fade-out\");\n to.addClass(\"current\");\n to.addClass(\"fade-in\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n setTimeout(function () {\n from_1.removeClass(\"fade-out\");\n to.removeClass(\"fade-in\");\n }, 300);\n }\n else {\n to.addClass(\"current\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n }\n this.index = index;\n };\n /**\n * Find all signature/description groups.\n */\n Signature.prototype.createGroups = function () {\n var signatures = this.el.children;\n if (signatures.length < 2)\n return;\n this.container = this.el.nextElementSibling;\n var descriptions = this.container.children;\n this.groups = [];\n for (var index = 0; index < signatures.length; index++) {\n this.groups.push(new SignatureGroup(signatures[index], descriptions[index]));\n }\n };\n /**\n * Triggered when the user clicks onto a signature header.\n *\n * @param e The related event object.\n */\n Signature.prototype.onClick = function (e) {\n var _this = this;\n this.groups.forEach(function (group, index) {\n if (group.signature === e.currentTarget) {\n _this.setIndex(index);\n }\n });\n };\n return Signature;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Signature.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Toggle.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Toggle.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Toggle\": () => /* binding */ Toggle\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar Toggle = /** @class */ (function (_super) {\n __extends(Toggle, _super);\n function Toggle(options) {\n var _this = _super.call(this, options) || this;\n _this.className = _this.el.dataset.toggle || \"\";\n _this.el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) { return _this.onPointerUp(e); });\n _this.el.addEventListener(\"click\", function (e) { return e.preventDefault(); });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n return _this.onDocumentPointerDown(e);\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n return _this.onDocumentPointerUp(e);\n });\n return _this;\n }\n Toggle.prototype.setActive = function (value) {\n if (this.active == value)\n return;\n this.active = value;\n document.documentElement.classList.toggle(\"has-\" + this.className, value);\n this.el.classList.toggle(\"active\", value);\n var transition = (this.active ? \"to-has-\" : \"from-has-\") + this.className;\n document.documentElement.classList.add(transition);\n setTimeout(function () { return document.documentElement.classList.remove(transition); }, 500);\n };\n Toggle.prototype.onPointerUp = function (event) {\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n this.setActive(true);\n event.preventDefault();\n };\n Toggle.prototype.onDocumentPointerDown = function (e) {\n if (this.active) {\n if (e.target.closest(\".col-menu, .tsd-filter-group\")) {\n return;\n }\n this.setActive(false);\n }\n };\n Toggle.prototype.onDocumentPointerUp = function (e) {\n var _this = this;\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n if (this.active) {\n if (e.target.closest(\".col-menu\")) {\n var link = e.target.closest(\"a\");\n if (link) {\n var href = window.location.href;\n if (href.indexOf(\"#\") != -1) {\n href = href.substr(0, href.indexOf(\"#\"));\n }\n if (link.href.substr(0, href.length) == href) {\n setTimeout(function () { return _this.setActive(false); }, 250);\n }\n }\n }\n }\n };\n return Toggle;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Toggle.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/services/Viewport.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/services/Viewport.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Viewport\": () => /* binding */ Viewport\n/* harmony export */ });\n/* harmony import */ var _EventTarget__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../EventTarget */ \"./default/assets/js/src/typedoc/EventTarget.ts\");\n/* harmony import */ var _utils_trottle__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/trottle */ \"./default/assets/js/src/typedoc/utils/trottle.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * A global service that monitors the window size and scroll position.\n */\nvar Viewport = /** @class */ (function (_super) {\n __extends(Viewport, _super);\n /**\n * Create new Viewport instance.\n */\n function Viewport() {\n var _this = _super.call(this) || this;\n /**\n * The current scroll position.\n */\n _this.scrollTop = 0;\n /**\n * The previous scrollTop.\n */\n _this.lastY = 0;\n /**\n * The width of the window.\n */\n _this.width = 0;\n /**\n * The height of the window.\n */\n _this.height = 0;\n /**\n * Boolean indicating whether the toolbar is shown.\n */\n _this.showToolbar = true;\n _this.toolbar = (document.querySelector(\".tsd-page-toolbar\"));\n _this.secondaryNav = (document.querySelector(\".tsd-navigation.secondary\"));\n window.addEventListener(\"scroll\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onScroll(); }, 10));\n window.addEventListener(\"resize\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onResize(); }, 10));\n _this.onResize();\n _this.onScroll();\n return _this;\n }\n /**\n * Trigger a resize event.\n */\n Viewport.prototype.triggerResize = function () {\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the size of the window has changed.\n */\n Viewport.prototype.onResize = function () {\n this.width = window.innerWidth || 0;\n this.height = window.innerHeight || 0;\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the user scrolled the viewport.\n */\n Viewport.prototype.onScroll = function () {\n this.scrollTop = window.scrollY || 0;\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: this.scrollTop,\n },\n });\n this.dispatchEvent(event);\n this.hideShowToolbar();\n };\n /**\n * Handle hiding/showing of the toolbar.\n */\n Viewport.prototype.hideShowToolbar = function () {\n var isShown = this.showToolbar;\n this.showToolbar = this.lastY >= this.scrollTop || this.scrollTop <= 0;\n if (isShown !== this.showToolbar) {\n this.toolbar.classList.toggle(\"tsd-page-toolbar--hide\");\n this.secondaryNav.classList.toggle(\"tsd-navigation--toolbar-hide\");\n }\n this.lastY = this.scrollTop;\n };\n Viewport.instance = new Viewport();\n return Viewport;\n}(_EventTarget__WEBPACK_IMPORTED_MODULE_0__.EventTarget));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/services/Viewport.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/utils/debounce.ts": +/*!*********************************************************!*\ + !*** ./default/assets/js/src/typedoc/utils/debounce.ts ***! + \*********************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"debounce\": () => /* binding */ debounce\n/* harmony export */ });\nvar debounce = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var timeout;\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n clearTimeout(timeout);\n timeout = setTimeout(function () { return fn(args); }, wait);\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/debounce.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/utils/pointer.ts": +/*!********************************************************!*\ + !*** ./default/assets/js/src/typedoc/utils/pointer.ts ***! + \********************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"pointerDown\": () => /* binding */ pointerDown,\n/* harmony export */ \"pointerMove\": () => /* binding */ pointerMove,\n/* harmony export */ \"pointerUp\": () => /* binding */ pointerUp,\n/* harmony export */ \"pointerDownPosition\": () => /* binding */ pointerDownPosition,\n/* harmony export */ \"preventNextClick\": () => /* binding */ preventNextClick,\n/* harmony export */ \"isPointerDown\": () => /* binding */ isPointerDown,\n/* harmony export */ \"isPointerTouch\": () => /* binding */ isPointerTouch,\n/* harmony export */ \"hasPointerMoved\": () => /* binding */ hasPointerMoved,\n/* harmony export */ \"isMobile\": () => /* binding */ isMobile\n/* harmony export */ });\n/**\n * Event name of the pointer down event.\n */\nvar pointerDown = \"mousedown\";\n/**\n * Event name of the pointer move event.\n */\nvar pointerMove = \"mousemove\";\n/**\n * Event name of the pointer up event.\n */\nvar pointerUp = \"mouseup\";\n/**\n * Position the pointer was pressed at.\n */\nvar pointerDownPosition = { x: 0, y: 0 };\n/**\n * Should the next click on the document be supressed?\n */\nvar preventNextClick = false;\n/**\n * Is the pointer down?\n */\nvar isPointerDown = false;\n/**\n * Is the pointer a touch point?\n */\nvar isPointerTouch = false;\n/**\n * Did the pointer move since the last down event?\n */\nvar hasPointerMoved = false;\n/**\n * Is the user agent a mobile agent?\n */\nvar isMobile = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);\ndocument.documentElement.classList.add(isMobile ? \"is-mobile\" : \"not-mobile\");\nif (isMobile && \"ontouchstart\" in document.documentElement) {\n isPointerTouch = true;\n pointerDown = \"touchstart\";\n pointerMove = \"touchmove\";\n pointerUp = \"touchend\";\n}\ndocument.addEventListener(pointerDown, function (e) {\n isPointerDown = true;\n hasPointerMoved = false;\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n pointerDownPosition.y = t.pageY || 0;\n pointerDownPosition.x = t.pageX || 0;\n});\ndocument.addEventListener(pointerMove, function (e) {\n if (!isPointerDown)\n return;\n if (!hasPointerMoved) {\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n var x = pointerDownPosition.x - (t.pageX || 0);\n var y = pointerDownPosition.y - (t.pageY || 0);\n hasPointerMoved = Math.sqrt(x * x + y * y) > 10;\n }\n});\ndocument.addEventListener(pointerUp, function () {\n isPointerDown = false;\n});\ndocument.addEventListener(\"click\", function (e) {\n if (preventNextClick) {\n e.preventDefault();\n e.stopImmediatePropagation();\n preventNextClick = false;\n }\n});\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/pointer.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/utils/trottle.ts": +/*!********************************************************!*\ + !*** ./default/assets/js/src/typedoc/utils/trottle.ts ***! + \********************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"throttle\": () => /* binding */ throttle\n/* harmony export */ });\nvar throttle = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var time = Date.now();\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n if (time + wait - Date.now() < 0) {\n fn.apply(void 0, args);\n time = Date.now();\n }\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/trottle.ts?"); + +/***/ }) + +/******/ }); +/************************************************************************/ +/******/ // The module cache +/******/ var __webpack_module_cache__ = {}; +/******/ +/******/ // The require function +/******/ function __webpack_require__(moduleId) { +/******/ // Check if module is in cache +/******/ if(__webpack_module_cache__[moduleId]) { +/******/ return __webpack_module_cache__[moduleId].exports; +/******/ } +/******/ // Create a new module (and put it into the cache) +/******/ var module = __webpack_module_cache__[moduleId] = { +/******/ // no module.id needed +/******/ // no module.loaded needed +/******/ exports: {} +/******/ }; +/******/ +/******/ // Execute the module function +/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__); +/******/ +/******/ // Return the exports of the module +/******/ return module.exports; +/******/ } +/******/ +/************************************************************************/ +/******/ /* webpack/runtime/compat get default export */ +/******/ (() => { +/******/ // getDefaultExport function for compatibility with non-harmony modules +/******/ __webpack_require__.n = (module) => { +/******/ var getter = module && module.__esModule ? +/******/ () => module['default'] : +/******/ () => module; +/******/ __webpack_require__.d(getter, { a: getter }); +/******/ return getter; +/******/ }; +/******/ })(); +/******/ +/******/ /* webpack/runtime/define property getters */ +/******/ (() => { +/******/ // define getter functions for harmony exports +/******/ __webpack_require__.d = (exports, definition) => { +/******/ for(var key in definition) { +/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) { +/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] }); +/******/ } +/******/ } +/******/ }; +/******/ })(); +/******/ +/******/ /* webpack/runtime/hasOwnProperty shorthand */ +/******/ (() => { +/******/ __webpack_require__.o = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop) +/******/ })(); +/******/ +/******/ /* webpack/runtime/make namespace object */ +/******/ (() => { +/******/ // define __esModule on exports +/******/ __webpack_require__.r = (exports) => { +/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) { +/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' }); +/******/ } +/******/ Object.defineProperty(exports, '__esModule', { value: true }); +/******/ }; +/******/ })(); +/******/ +/************************************************************************/ +/******/ // startup +/******/ // Load entry module +/******/ __webpack_require__("./default/assets/js/src/bootstrap.ts"); +/******/ // This entry module used 'exports' so it can't be inlined +/******/ })() +; \ No newline at end of file diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js new file mode 100644 index 00000000..97310bb2 --- /dev/null +++ b/docs/assets/js/search.js @@ -0,0 +1 @@ +window.searchData = {"kinds":{"64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","4194304":"Type alias","16777216":"Reference"},"rows":[{"id":0,"kind":128,"name":"Client","url":"classes/Client.html","classes":"tsd-kind-class"},{"id":1,"kind":2048,"name":"hasNextPage","url":"classes/Client.html#hasNextPage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":2,"kind":1024,"name":"deriveXAddress","url":"classes/Client.html#deriveXAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":3,"kind":65536,"name":"__type","url":"classes/Client.html#__type-38","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":4,"kind":1024,"name":"deriveClassicAddress","url":"classes/Client.html#deriveClassicAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":5,"kind":65536,"name":"__type","url":"classes/Client.html#__type-37","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":6,"kind":1024,"name":"formatBidsAndAsks","url":"classes/Client.html#formatBidsAndAsks","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":7,"kind":65536,"name":"__type","url":"classes/Client.html#__type-44","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":8,"kind":1024,"name":"classicAddressToXAddress","url":"classes/Client.html#classicAddressToXAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":9,"kind":65536,"name":"__type","url":"classes/Client.html#__type-31","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":10,"kind":1024,"name":"xAddressToClassicAddress","url":"classes/Client.html#xAddressToClassicAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":11,"kind":65536,"name":"__type","url":"classes/Client.html#__type-47","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":12,"kind":1024,"name":"isValidXAddress","url":"classes/Client.html#isValidXAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":13,"kind":65536,"name":"__type","url":"classes/Client.html#__type-46","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":14,"kind":1024,"name":"isValidClassicAddress","url":"classes/Client.html#isValidClassicAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":15,"kind":65536,"name":"__type","url":"classes/Client.html#__type-45","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":16,"kind":1024,"name":"encodeSeed","url":"classes/Client.html#encodeSeed","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":17,"kind":65536,"name":"__type","url":"classes/Client.html#__type-42","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":18,"kind":1024,"name":"decodeSeed","url":"classes/Client.html#decodeSeed","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":19,"kind":65536,"name":"__type","url":"classes/Client.html#__type-35","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":20,"kind":1024,"name":"encodeAccountID","url":"classes/Client.html#encodeAccountID","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":21,"kind":65536,"name":"__type","url":"classes/Client.html#__type-39","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":22,"kind":1024,"name":"decodeAccountID","url":"classes/Client.html#decodeAccountID","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":23,"kind":65536,"name":"__type","url":"classes/Client.html#__type-32","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":24,"kind":1024,"name":"encodeNodePublic","url":"classes/Client.html#encodeNodePublic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":25,"kind":65536,"name":"__type","url":"classes/Client.html#__type-41","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":26,"kind":1024,"name":"decodeNodePublic","url":"classes/Client.html#decodeNodePublic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":27,"kind":65536,"name":"__type","url":"classes/Client.html#__type-34","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":28,"kind":1024,"name":"encodeAccountPublic","url":"classes/Client.html#encodeAccountPublic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":29,"kind":65536,"name":"__type","url":"classes/Client.html#__type-40","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":30,"kind":1024,"name":"decodeAccountPublic","url":"classes/Client.html#decodeAccountPublic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":31,"kind":65536,"name":"__type","url":"classes/Client.html#__type-33","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":32,"kind":1024,"name":"encodeXAddress","url":"classes/Client.html#encodeXAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":33,"kind":65536,"name":"__type","url":"classes/Client.html#__type-43","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":34,"kind":1024,"name":"decodeXAddress","url":"classes/Client.html#decodeXAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":35,"kind":65536,"name":"__type","url":"classes/Client.html#__type-36","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":36,"kind":1024,"name":"accountSetFlags","url":"classes/Client.html#accountSetFlags","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"Client"},{"id":37,"kind":65536,"name":"__type","url":"classes/Client.html#__type-30","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":38,"kind":1024,"name":"requireDestinationTag","url":"classes/Client.html#__type-30.requireDestinationTag","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":39,"kind":1024,"name":"requireAuthorization","url":"classes/Client.html#__type-30.requireAuthorization","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":40,"kind":1024,"name":"depositAuth","url":"classes/Client.html#__type-30.depositAuth","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":41,"kind":1024,"name":"disallowIncomingXRP","url":"classes/Client.html#__type-30.disallowIncomingXRP","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":42,"kind":1024,"name":"disableMasterKey","url":"classes/Client.html#__type-30.disableMasterKey","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":43,"kind":1024,"name":"enableTransactionIDTracking","url":"classes/Client.html#__type-30.enableTransactionIDTracking","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":44,"kind":1024,"name":"noFreeze","url":"classes/Client.html#__type-30.noFreeze","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":45,"kind":1024,"name":"globalFreeze","url":"classes/Client.html#__type-30.globalFreeze","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":46,"kind":1024,"name":"defaultRipple","url":"classes/Client.html#__type-30.defaultRipple","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":47,"kind":512,"name":"constructor","url":"classes/Client.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"Client"},{"id":48,"kind":1024,"name":"connection","url":"classes/Client.html#connection","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":49,"kind":1024,"name":"feeCushion","url":"classes/Client.html#feeCushion","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":50,"kind":1024,"name":"maxFeeXRP","url":"classes/Client.html#maxFeeXRP","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":51,"kind":2048,"name":"request","url":"classes/Client.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Client"},{"id":52,"kind":2048,"name":"requestNextPage","url":"classes/Client.html#requestNextPage","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Client"},{"id":53,"kind":2048,"name":"on","url":"classes/Client.html#on","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-overwrite","parent":"Client"},{"id":54,"kind":2048,"name":"prepareTransaction","url":"classes/Client.html#prepareTransaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Client"},{"id":55,"kind":2048,"name":"requestAll","url":"classes/Client.html#requestAll","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Client"},{"id":56,"kind":2048,"name":"connect","url":"classes/Client.html#connect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Client"},{"id":57,"kind":2048,"name":"disconnect","url":"classes/Client.html#disconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Client"},{"id":58,"kind":2048,"name":"isConnected","url":"classes/Client.html#isConnected","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Client"},{"id":59,"kind":1024,"name":"getFee","url":"classes/Client.html#getFee","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":60,"kind":65536,"name":"__type","url":"classes/Client.html#__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":61,"kind":1024,"name":"getTrustlines","url":"classes/Client.html#getTrustlines","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":62,"kind":65536,"name":"__type","url":"classes/Client.html#__type-6","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":63,"kind":1024,"name":"getBalances","url":"classes/Client.html#getBalances","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":64,"kind":65536,"name":"__type","url":"classes/Client.html#__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":65,"kind":1024,"name":"getPaths","url":"classes/Client.html#getPaths","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":66,"kind":65536,"name":"__type","url":"classes/Client.html#__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":67,"kind":1024,"name":"getOrderbook","url":"classes/Client.html#getOrderbook","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":68,"kind":65536,"name":"__type","url":"classes/Client.html#__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":69,"kind":1024,"name":"preparePayment","url":"classes/Client.html#preparePayment","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":70,"kind":65536,"name":"__type","url":"classes/Client.html#__type-15","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":71,"kind":1024,"name":"prepareTrustline","url":"classes/Client.html#prepareTrustline","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":72,"kind":65536,"name":"__type","url":"classes/Client.html#__type-21","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":73,"kind":1024,"name":"prepareOrder","url":"classes/Client.html#prepareOrder","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":74,"kind":65536,"name":"__type","url":"classes/Client.html#__type-13","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":75,"kind":1024,"name":"prepareOrderCancellation","url":"classes/Client.html#prepareOrderCancellation","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":76,"kind":65536,"name":"__type","url":"classes/Client.html#__type-14","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":77,"kind":1024,"name":"prepareEscrowCreation","url":"classes/Client.html#prepareEscrowCreation","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":78,"kind":65536,"name":"__type","url":"classes/Client.html#__type-11","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":79,"kind":1024,"name":"prepareEscrowExecution","url":"classes/Client.html#prepareEscrowExecution","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":80,"kind":65536,"name":"__type","url":"classes/Client.html#__type-12","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":81,"kind":1024,"name":"prepareEscrowCancellation","url":"classes/Client.html#prepareEscrowCancellation","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":82,"kind":65536,"name":"__type","url":"classes/Client.html#__type-10","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":83,"kind":1024,"name":"preparePaymentChannelCreate","url":"classes/Client.html#preparePaymentChannelCreate","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":84,"kind":65536,"name":"__type","url":"classes/Client.html#__type-17","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":85,"kind":1024,"name":"preparePaymentChannelFund","url":"classes/Client.html#preparePaymentChannelFund","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":86,"kind":65536,"name":"__type","url":"classes/Client.html#__type-18","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":87,"kind":1024,"name":"preparePaymentChannelClaim","url":"classes/Client.html#preparePaymentChannelClaim","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":88,"kind":65536,"name":"__type","url":"classes/Client.html#__type-16","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":89,"kind":1024,"name":"prepareCheckCreate","url":"classes/Client.html#prepareCheckCreate","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":90,"kind":65536,"name":"__type","url":"classes/Client.html#__type-9","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":91,"kind":1024,"name":"prepareCheckCash","url":"classes/Client.html#prepareCheckCash","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":92,"kind":65536,"name":"__type","url":"classes/Client.html#__type-8","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":93,"kind":1024,"name":"prepareCheckCancel","url":"classes/Client.html#prepareCheckCancel","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":94,"kind":65536,"name":"__type","url":"classes/Client.html#__type-7","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":95,"kind":1024,"name":"prepareTicketCreate","url":"classes/Client.html#prepareTicketCreate","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":96,"kind":65536,"name":"__type","url":"classes/Client.html#__type-20","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":97,"kind":1024,"name":"prepareSettings","url":"classes/Client.html#prepareSettings","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":98,"kind":65536,"name":"__type","url":"classes/Client.html#__type-19","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":99,"kind":1024,"name":"sign","url":"classes/Client.html#sign","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":100,"kind":65536,"name":"__type","url":"classes/Client.html#__type-22","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":101,"kind":1024,"name":"combine","url":"classes/Client.html#combine","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":102,"kind":65536,"name":"__type","url":"classes/Client.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":103,"kind":1024,"name":"generateFaucetWallet","url":"classes/Client.html#generateFaucetWallet","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":104,"kind":65536,"name":"__type","url":"classes/Client.html#__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":105,"kind":1024,"name":"errors","url":"classes/Client.html#errors","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":106,"kind":1024,"name":"txFlags","url":"classes/Client.html#txFlags","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Client"},{"id":107,"kind":65536,"name":"__type","url":"classes/Client.html#__type-23","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"Client"},{"id":108,"kind":1024,"name":"Universal","url":"classes/Client.html#__type-23.Universal","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":109,"kind":65536,"name":"__type","url":"classes/Client.html#__type-23.__type-29","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":110,"kind":1024,"name":"FullyCanonicalSig","url":"classes/Client.html#__type-23.__type-29.FullyCanonicalSig","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":111,"kind":1024,"name":"AccountSet","url":"classes/Client.html#__type-23.AccountSet","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":112,"kind":65536,"name":"__type","url":"classes/Client.html#__type-23.__type-24","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":113,"kind":1024,"name":"RequireDestTag","url":"classes/Client.html#__type-23.__type-24.RequireDestTag","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":114,"kind":1024,"name":"OptionalDestTag","url":"classes/Client.html#__type-23.__type-24.OptionalDestTag","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":115,"kind":1024,"name":"RequireAuth","url":"classes/Client.html#__type-23.__type-24.RequireAuth","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":116,"kind":1024,"name":"OptionalAuth","url":"classes/Client.html#__type-23.__type-24.OptionalAuth","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":117,"kind":1024,"name":"DisallowXRP","url":"classes/Client.html#__type-23.__type-24.DisallowXRP","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":118,"kind":1024,"name":"AllowXRP","url":"classes/Client.html#__type-23.__type-24.AllowXRP","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":119,"kind":1024,"name":"TrustSet","url":"classes/Client.html#__type-23.TrustSet","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":120,"kind":65536,"name":"__type","url":"classes/Client.html#__type-23.__type-28","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":121,"kind":1024,"name":"SetAuth","url":"classes/Client.html#__type-23.__type-28.SetAuth","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":122,"kind":1024,"name":"NoRipple","url":"classes/Client.html#__type-23.__type-28.NoRipple","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":123,"kind":1024,"name":"SetNoRipple","url":"classes/Client.html#__type-23.__type-28.SetNoRipple","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":124,"kind":1024,"name":"ClearNoRipple","url":"classes/Client.html#__type-23.__type-28.ClearNoRipple","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":125,"kind":1024,"name":"SetFreeze","url":"classes/Client.html#__type-23.__type-28.SetFreeze","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":126,"kind":1024,"name":"ClearFreeze","url":"classes/Client.html#__type-23.__type-28.ClearFreeze","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":127,"kind":1024,"name":"OfferCreate","url":"classes/Client.html#__type-23.OfferCreate","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":128,"kind":65536,"name":"__type","url":"classes/Client.html#__type-23.__type-25","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":129,"kind":1024,"name":"Passive","url":"classes/Client.html#__type-23.__type-25.Passive","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":130,"kind":1024,"name":"ImmediateOrCancel","url":"classes/Client.html#__type-23.__type-25.ImmediateOrCancel","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":131,"kind":1024,"name":"FillOrKill","url":"classes/Client.html#__type-23.__type-25.FillOrKill","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":132,"kind":1024,"name":"Sell","url":"classes/Client.html#__type-23.__type-25.Sell","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":133,"kind":1024,"name":"Payment","url":"classes/Client.html#__type-23.Payment","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":134,"kind":65536,"name":"__type","url":"classes/Client.html#__type-23.__type-26","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":135,"kind":1024,"name":"NoRippleDirect","url":"classes/Client.html#__type-23.__type-26.NoRippleDirect","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":136,"kind":1024,"name":"PartialPayment","url":"classes/Client.html#__type-23.__type-26.PartialPayment","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":137,"kind":1024,"name":"LimitQuality","url":"classes/Client.html#__type-23.__type-26.LimitQuality","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":138,"kind":1024,"name":"PaymentChannelClaim","url":"classes/Client.html#__type-23.PaymentChannelClaim","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":139,"kind":65536,"name":"__type","url":"classes/Client.html#__type-23.__type-27","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"Client.__type"},{"id":140,"kind":1024,"name":"Renew","url":"classes/Client.html#__type-23.__type-27.Renew","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":141,"kind":1024,"name":"Close","url":"classes/Client.html#__type-23.__type-27.Close","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Client.__type.__type"},{"id":142,"kind":128,"name":"BroadcastClient","url":"classes/BroadcastClient.html","classes":"tsd-kind-class"},{"id":143,"kind":2048,"name":"hasNextPage","url":"classes/BroadcastClient.html#hasNextPage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":144,"kind":1024,"name":"deriveXAddress","url":"classes/BroadcastClient.html#deriveXAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":145,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-38","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":146,"kind":1024,"name":"deriveClassicAddress","url":"classes/BroadcastClient.html#deriveClassicAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":147,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-37","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":148,"kind":1024,"name":"formatBidsAndAsks","url":"classes/BroadcastClient.html#formatBidsAndAsks","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":149,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-44","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":150,"kind":1024,"name":"classicAddressToXAddress","url":"classes/BroadcastClient.html#classicAddressToXAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":151,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-31","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":152,"kind":1024,"name":"xAddressToClassicAddress","url":"classes/BroadcastClient.html#xAddressToClassicAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":153,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-47","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":154,"kind":1024,"name":"isValidXAddress","url":"classes/BroadcastClient.html#isValidXAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":155,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-46","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":156,"kind":1024,"name":"isValidClassicAddress","url":"classes/BroadcastClient.html#isValidClassicAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":157,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-45","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":158,"kind":1024,"name":"encodeSeed","url":"classes/BroadcastClient.html#encodeSeed","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":159,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-42","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":160,"kind":1024,"name":"decodeSeed","url":"classes/BroadcastClient.html#decodeSeed","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":161,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-35","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":162,"kind":1024,"name":"encodeAccountID","url":"classes/BroadcastClient.html#encodeAccountID","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":163,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-39","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":164,"kind":1024,"name":"decodeAccountID","url":"classes/BroadcastClient.html#decodeAccountID","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":165,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-32","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":166,"kind":1024,"name":"encodeNodePublic","url":"classes/BroadcastClient.html#encodeNodePublic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":167,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-41","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":168,"kind":1024,"name":"decodeNodePublic","url":"classes/BroadcastClient.html#decodeNodePublic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":169,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-34","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":170,"kind":1024,"name":"encodeAccountPublic","url":"classes/BroadcastClient.html#encodeAccountPublic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":171,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-40","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":172,"kind":1024,"name":"decodeAccountPublic","url":"classes/BroadcastClient.html#decodeAccountPublic","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":173,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-33","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":174,"kind":1024,"name":"encodeXAddress","url":"classes/BroadcastClient.html#encodeXAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":175,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-43","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":176,"kind":1024,"name":"decodeXAddress","url":"classes/BroadcastClient.html#decodeXAddress","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":177,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-36","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":178,"kind":1024,"name":"accountSetFlags","url":"classes/BroadcastClient.html#accountSetFlags","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static","parent":"BroadcastClient"},{"id":179,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-30","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":180,"kind":1024,"name":"requireDestinationTag","url":"classes/BroadcastClient.html#__type-30.requireDestinationTag","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":181,"kind":1024,"name":"requireAuthorization","url":"classes/BroadcastClient.html#__type-30.requireAuthorization","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":182,"kind":1024,"name":"depositAuth","url":"classes/BroadcastClient.html#__type-30.depositAuth","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":183,"kind":1024,"name":"disallowIncomingXRP","url":"classes/BroadcastClient.html#__type-30.disallowIncomingXRP","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":184,"kind":1024,"name":"disableMasterKey","url":"classes/BroadcastClient.html#__type-30.disableMasterKey","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":185,"kind":1024,"name":"enableTransactionIDTracking","url":"classes/BroadcastClient.html#__type-30.enableTransactionIDTracking","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":186,"kind":1024,"name":"noFreeze","url":"classes/BroadcastClient.html#__type-30.noFreeze","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":187,"kind":1024,"name":"globalFreeze","url":"classes/BroadcastClient.html#__type-30.globalFreeze","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":188,"kind":1024,"name":"defaultRipple","url":"classes/BroadcastClient.html#__type-30.defaultRipple","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":189,"kind":512,"name":"constructor","url":"classes/BroadcastClient.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"BroadcastClient"},{"id":190,"kind":1024,"name":"clients","url":"classes/BroadcastClient.html#clients","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"BroadcastClient"},{"id":191,"kind":2048,"name":"getMethodNames","url":"classes/BroadcastClient.html#getMethodNames","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"BroadcastClient"},{"id":192,"kind":1024,"name":"connection","url":"classes/BroadcastClient.html#connection","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":193,"kind":1024,"name":"feeCushion","url":"classes/BroadcastClient.html#feeCushion","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":194,"kind":1024,"name":"maxFeeXRP","url":"classes/BroadcastClient.html#maxFeeXRP","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":195,"kind":2048,"name":"request","url":"classes/BroadcastClient.html#request","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":196,"kind":2048,"name":"requestNextPage","url":"classes/BroadcastClient.html#requestNextPage","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":197,"kind":2048,"name":"on","url":"classes/BroadcastClient.html#on","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":198,"kind":2048,"name":"prepareTransaction","url":"classes/BroadcastClient.html#prepareTransaction","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":199,"kind":2048,"name":"requestAll","url":"classes/BroadcastClient.html#requestAll","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":200,"kind":2048,"name":"connect","url":"classes/BroadcastClient.html#connect","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":201,"kind":2048,"name":"disconnect","url":"classes/BroadcastClient.html#disconnect","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":202,"kind":2048,"name":"isConnected","url":"classes/BroadcastClient.html#isConnected","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":203,"kind":1024,"name":"getFee","url":"classes/BroadcastClient.html#getFee","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":204,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":205,"kind":1024,"name":"getTrustlines","url":"classes/BroadcastClient.html#getTrustlines","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":206,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-6","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":207,"kind":1024,"name":"getBalances","url":"classes/BroadcastClient.html#getBalances","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":208,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":209,"kind":1024,"name":"getPaths","url":"classes/BroadcastClient.html#getPaths","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":210,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":211,"kind":1024,"name":"getOrderbook","url":"classes/BroadcastClient.html#getOrderbook","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":212,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":213,"kind":1024,"name":"preparePayment","url":"classes/BroadcastClient.html#preparePayment","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":214,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-15","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":215,"kind":1024,"name":"prepareTrustline","url":"classes/BroadcastClient.html#prepareTrustline","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":216,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-21","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":217,"kind":1024,"name":"prepareOrder","url":"classes/BroadcastClient.html#prepareOrder","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":218,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-13","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":219,"kind":1024,"name":"prepareOrderCancellation","url":"classes/BroadcastClient.html#prepareOrderCancellation","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":220,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-14","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":221,"kind":1024,"name":"prepareEscrowCreation","url":"classes/BroadcastClient.html#prepareEscrowCreation","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":222,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-11","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":223,"kind":1024,"name":"prepareEscrowExecution","url":"classes/BroadcastClient.html#prepareEscrowExecution","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":224,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-12","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":225,"kind":1024,"name":"prepareEscrowCancellation","url":"classes/BroadcastClient.html#prepareEscrowCancellation","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":226,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-10","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":227,"kind":1024,"name":"preparePaymentChannelCreate","url":"classes/BroadcastClient.html#preparePaymentChannelCreate","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":228,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-17","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":229,"kind":1024,"name":"preparePaymentChannelFund","url":"classes/BroadcastClient.html#preparePaymentChannelFund","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":230,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-18","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":231,"kind":1024,"name":"preparePaymentChannelClaim","url":"classes/BroadcastClient.html#preparePaymentChannelClaim","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":232,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-16","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":233,"kind":1024,"name":"prepareCheckCreate","url":"classes/BroadcastClient.html#prepareCheckCreate","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":234,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-9","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":235,"kind":1024,"name":"prepareCheckCash","url":"classes/BroadcastClient.html#prepareCheckCash","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":236,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-8","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":237,"kind":1024,"name":"prepareCheckCancel","url":"classes/BroadcastClient.html#prepareCheckCancel","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":238,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-7","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":239,"kind":1024,"name":"prepareTicketCreate","url":"classes/BroadcastClient.html#prepareTicketCreate","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":240,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-20","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":241,"kind":1024,"name":"prepareSettings","url":"classes/BroadcastClient.html#prepareSettings","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":242,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-19","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":243,"kind":1024,"name":"sign","url":"classes/BroadcastClient.html#sign","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":244,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-22","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":245,"kind":1024,"name":"combine","url":"classes/BroadcastClient.html#combine","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":246,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":247,"kind":1024,"name":"generateFaucetWallet","url":"classes/BroadcastClient.html#generateFaucetWallet","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":248,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":249,"kind":1024,"name":"errors","url":"classes/BroadcastClient.html#errors","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":250,"kind":1024,"name":"txFlags","url":"classes/BroadcastClient.html#txFlags","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"BroadcastClient"},{"id":251,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-23","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"BroadcastClient"},{"id":252,"kind":1024,"name":"Universal","url":"classes/BroadcastClient.html#__type-23.Universal","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":253,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-23.__type-29","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":254,"kind":1024,"name":"FullyCanonicalSig","url":"classes/BroadcastClient.html#__type-23.__type-29.FullyCanonicalSig","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":255,"kind":1024,"name":"AccountSet","url":"classes/BroadcastClient.html#__type-23.AccountSet","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":256,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-23.__type-24","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":257,"kind":1024,"name":"RequireDestTag","url":"classes/BroadcastClient.html#__type-23.__type-24.RequireDestTag","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":258,"kind":1024,"name":"OptionalDestTag","url":"classes/BroadcastClient.html#__type-23.__type-24.OptionalDestTag","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":259,"kind":1024,"name":"RequireAuth","url":"classes/BroadcastClient.html#__type-23.__type-24.RequireAuth","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":260,"kind":1024,"name":"OptionalAuth","url":"classes/BroadcastClient.html#__type-23.__type-24.OptionalAuth","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":261,"kind":1024,"name":"DisallowXRP","url":"classes/BroadcastClient.html#__type-23.__type-24.DisallowXRP","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":262,"kind":1024,"name":"AllowXRP","url":"classes/BroadcastClient.html#__type-23.__type-24.AllowXRP","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":263,"kind":1024,"name":"TrustSet","url":"classes/BroadcastClient.html#__type-23.TrustSet","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":264,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-23.__type-28","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":265,"kind":1024,"name":"SetAuth","url":"classes/BroadcastClient.html#__type-23.__type-28.SetAuth","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":266,"kind":1024,"name":"NoRipple","url":"classes/BroadcastClient.html#__type-23.__type-28.NoRipple","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":267,"kind":1024,"name":"SetNoRipple","url":"classes/BroadcastClient.html#__type-23.__type-28.SetNoRipple","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":268,"kind":1024,"name":"ClearNoRipple","url":"classes/BroadcastClient.html#__type-23.__type-28.ClearNoRipple","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":269,"kind":1024,"name":"SetFreeze","url":"classes/BroadcastClient.html#__type-23.__type-28.SetFreeze","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":270,"kind":1024,"name":"ClearFreeze","url":"classes/BroadcastClient.html#__type-23.__type-28.ClearFreeze","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":271,"kind":1024,"name":"OfferCreate","url":"classes/BroadcastClient.html#__type-23.OfferCreate","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":272,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-23.__type-25","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":273,"kind":1024,"name":"Passive","url":"classes/BroadcastClient.html#__type-23.__type-25.Passive","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":274,"kind":1024,"name":"ImmediateOrCancel","url":"classes/BroadcastClient.html#__type-23.__type-25.ImmediateOrCancel","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":275,"kind":1024,"name":"FillOrKill","url":"classes/BroadcastClient.html#__type-23.__type-25.FillOrKill","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":276,"kind":1024,"name":"Sell","url":"classes/BroadcastClient.html#__type-23.__type-25.Sell","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":277,"kind":1024,"name":"Payment","url":"classes/BroadcastClient.html#__type-23.Payment","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":278,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-23.__type-26","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":279,"kind":1024,"name":"NoRippleDirect","url":"classes/BroadcastClient.html#__type-23.__type-26.NoRippleDirect","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":280,"kind":1024,"name":"PartialPayment","url":"classes/BroadcastClient.html#__type-23.__type-26.PartialPayment","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":281,"kind":1024,"name":"LimitQuality","url":"classes/BroadcastClient.html#__type-23.__type-26.LimitQuality","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":282,"kind":1024,"name":"PaymentChannelClaim","url":"classes/BroadcastClient.html#__type-23.PaymentChannelClaim","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":283,"kind":65536,"name":"__type","url":"classes/BroadcastClient.html#__type-23.__type-27","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"BroadcastClient.__type"},{"id":284,"kind":1024,"name":"Renew","url":"classes/BroadcastClient.html#__type-23.__type-27.Renew","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":285,"kind":1024,"name":"Close","url":"classes/BroadcastClient.html#__type-23.__type-27.Close","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BroadcastClient.__type.__type"},{"id":286,"kind":128,"name":"Wallet","url":"classes/Wallet.html","classes":"tsd-kind-class"},{"id":287,"kind":1024,"name":"defaultAlgorithm","url":"classes/Wallet.html#defaultAlgorithm","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"Wallet"},{"id":288,"kind":1024,"name":"defaultDerivationPath","url":"classes/Wallet.html#defaultDerivationPath","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"Wallet"},{"id":289,"kind":2048,"name":"generate","url":"classes/Wallet.html#generate","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Wallet"},{"id":290,"kind":2048,"name":"fromSeed","url":"classes/Wallet.html#fromSeed","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Wallet"},{"id":291,"kind":2048,"name":"fromMnemonic","url":"classes/Wallet.html#fromMnemonic","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Wallet"},{"id":292,"kind":2048,"name":"fromEntropy","url":"classes/Wallet.html#fromEntropy","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-static","parent":"Wallet"},{"id":293,"kind":2048,"name":"hexFromBuffer","url":"classes/Wallet.html#hexFromBuffer","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"Wallet"},{"id":294,"kind":2048,"name":"deriveWallet","url":"classes/Wallet.html#deriveWallet","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static","parent":"Wallet"},{"id":295,"kind":512,"name":"constructor","url":"classes/Wallet.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Wallet"},{"id":296,"kind":1024,"name":"publicKey","url":"classes/Wallet.html#publicKey","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Wallet"},{"id":297,"kind":1024,"name":"privateKey","url":"classes/Wallet.html#privateKey","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Wallet"},{"id":298,"kind":1024,"name":"classicAddress","url":"classes/Wallet.html#classicAddress","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Wallet"},{"id":299,"kind":1024,"name":"seed","url":"classes/Wallet.html#seed","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Wallet"},{"id":300,"kind":2048,"name":"signTransaction","url":"classes/Wallet.html#signTransaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Wallet"},{"id":301,"kind":2048,"name":"verifyTransaction","url":"classes/Wallet.html#verifyTransaction","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Wallet"},{"id":302,"kind":2048,"name":"getXAddress","url":"classes/Wallet.html#getXAddress","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Wallet"},{"id":303,"kind":256,"name":"TransactionJSON","url":"interfaces/TransactionJSON.html","classes":"tsd-kind-interface"},{"id":304,"kind":1024,"name":"Account","url":"interfaces/TransactionJSON.html#Account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionJSON"},{"id":305,"kind":1024,"name":"TransactionType","url":"interfaces/TransactionJSON.html#TransactionType","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionJSON"},{"id":306,"kind":1024,"name":"Memos","url":"interfaces/TransactionJSON.html#Memos","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionJSON"},{"id":307,"kind":1024,"name":"Flags","url":"interfaces/TransactionJSON.html#Flags","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionJSON"},{"id":308,"kind":1024,"name":"Fulfillment","url":"interfaces/TransactionJSON.html#Fulfillment","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionJSON"},{"id":309,"kind":256,"name":"Instructions","url":"interfaces/Instructions.html","classes":"tsd-kind-interface"},{"id":310,"kind":1024,"name":"sequence","url":"interfaces/Instructions.html#sequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Instructions"},{"id":311,"kind":1024,"name":"ticketSequence","url":"interfaces/Instructions.html#ticketSequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Instructions"},{"id":312,"kind":1024,"name":"fee","url":"interfaces/Instructions.html#fee","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Instructions"},{"id":313,"kind":1024,"name":"maxFee","url":"interfaces/Instructions.html#maxFee","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Instructions"},{"id":314,"kind":1024,"name":"maxLedgerVersion","url":"interfaces/Instructions.html#maxLedgerVersion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Instructions"},{"id":315,"kind":1024,"name":"maxLedgerVersionOffset","url":"interfaces/Instructions.html#maxLedgerVersionOffset","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Instructions"},{"id":316,"kind":1024,"name":"signersCount","url":"interfaces/Instructions.html#signersCount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Instructions"},{"id":317,"kind":256,"name":"Prepare","url":"interfaces/Prepare.html","classes":"tsd-kind-interface"},{"id":318,"kind":1024,"name":"txJSON","url":"interfaces/Prepare.html#txJSON","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Prepare"},{"id":319,"kind":1024,"name":"instructions","url":"interfaces/Prepare.html#instructions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Prepare"},{"id":320,"kind":65536,"name":"__type","url":"interfaces/Prepare.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"Prepare"},{"id":321,"kind":1024,"name":"fee","url":"interfaces/Prepare.html#__type.fee","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Prepare.__type"},{"id":322,"kind":1024,"name":"sequence","url":"interfaces/Prepare.html#__type.sequence","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Prepare.__type"},{"id":323,"kind":1024,"name":"ticketSequence","url":"interfaces/Prepare.html#__type.ticketSequence","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Prepare.__type"},{"id":324,"kind":1024,"name":"maxLedgerVersion","url":"interfaces/Prepare.html#__type.maxLedgerVersion","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Prepare.__type"},{"id":325,"kind":256,"name":"Submit","url":"interfaces/Submit.html","classes":"tsd-kind-interface"},{"id":326,"kind":1024,"name":"success","url":"interfaces/Submit.html#success","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Submit"},{"id":327,"kind":1024,"name":"engineResult","url":"interfaces/Submit.html#engineResult","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Submit"},{"id":328,"kind":1024,"name":"engineResultCode","url":"interfaces/Submit.html#engineResultCode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Submit"},{"id":329,"kind":1024,"name":"engineResultMessage","url":"interfaces/Submit.html#engineResultMessage","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Submit"},{"id":330,"kind":1024,"name":"txBlob","url":"interfaces/Submit.html#txBlob","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Submit"},{"id":331,"kind":1024,"name":"txJson","url":"interfaces/Submit.html#txJson","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Submit"},{"id":332,"kind":256,"name":"OfferCreateTransaction","url":"interfaces/OfferCreateTransaction.html","classes":"tsd-kind-interface"},{"id":333,"kind":1024,"name":"TransactionType","url":"interfaces/OfferCreateTransaction.html#TransactionType","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"OfferCreateTransaction"},{"id":334,"kind":1024,"name":"Account","url":"interfaces/OfferCreateTransaction.html#Account","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"OfferCreateTransaction"},{"id":335,"kind":1024,"name":"Fee","url":"interfaces/OfferCreateTransaction.html#Fee","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OfferCreateTransaction"},{"id":336,"kind":1024,"name":"Flags","url":"interfaces/OfferCreateTransaction.html#Flags","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"OfferCreateTransaction"},{"id":337,"kind":1024,"name":"LastLedgerSequence","url":"interfaces/OfferCreateTransaction.html#LastLedgerSequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OfferCreateTransaction"},{"id":338,"kind":1024,"name":"Sequence","url":"interfaces/OfferCreateTransaction.html#Sequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OfferCreateTransaction"},{"id":339,"kind":1024,"name":"TakerGets","url":"interfaces/OfferCreateTransaction.html#TakerGets","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OfferCreateTransaction"},{"id":340,"kind":1024,"name":"TakerPays","url":"interfaces/OfferCreateTransaction.html#TakerPays","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OfferCreateTransaction"},{"id":341,"kind":1024,"name":"Expiration","url":"interfaces/OfferCreateTransaction.html#Expiration","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OfferCreateTransaction"},{"id":342,"kind":1024,"name":"OfferSequence","url":"interfaces/OfferCreateTransaction.html#OfferSequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OfferCreateTransaction"},{"id":343,"kind":1024,"name":"Memos","url":"interfaces/OfferCreateTransaction.html#Memos","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"OfferCreateTransaction"},{"id":344,"kind":1024,"name":"Fulfillment","url":"interfaces/OfferCreateTransaction.html#Fulfillment","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"OfferCreateTransaction"},{"id":345,"kind":256,"name":"SettingsTransaction","url":"interfaces/SettingsTransaction.html","classes":"tsd-kind-interface"},{"id":346,"kind":1024,"name":"TransferRate","url":"interfaces/SettingsTransaction.html#TransferRate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SettingsTransaction"},{"id":347,"kind":1024,"name":"Account","url":"interfaces/SettingsTransaction.html#Account","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SettingsTransaction"},{"id":348,"kind":1024,"name":"TransactionType","url":"interfaces/SettingsTransaction.html#TransactionType","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SettingsTransaction"},{"id":349,"kind":1024,"name":"Memos","url":"interfaces/SettingsTransaction.html#Memos","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SettingsTransaction"},{"id":350,"kind":1024,"name":"Flags","url":"interfaces/SettingsTransaction.html#Flags","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SettingsTransaction"},{"id":351,"kind":1024,"name":"Fulfillment","url":"interfaces/SettingsTransaction.html#Fulfillment","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SettingsTransaction"},{"id":352,"kind":256,"name":"KeyPair","url":"interfaces/KeyPair.html","classes":"tsd-kind-interface"},{"id":353,"kind":1024,"name":"publicKey","url":"interfaces/KeyPair.html#publicKey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"KeyPair"},{"id":354,"kind":1024,"name":"privateKey","url":"interfaces/KeyPair.html#privateKey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"KeyPair"},{"id":355,"kind":256,"name":"SignOptions","url":"interfaces/SignOptions.html","classes":"tsd-kind-interface"},{"id":356,"kind":1024,"name":"signAs","url":"interfaces/SignOptions.html#signAs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SignOptions"},{"id":357,"kind":256,"name":"Outcome","url":"interfaces/Outcome.html","classes":"tsd-kind-interface"},{"id":358,"kind":1024,"name":"result","url":"interfaces/Outcome.html#result","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Outcome"},{"id":359,"kind":1024,"name":"ledgerVersion","url":"interfaces/Outcome.html#ledgerVersion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Outcome"},{"id":360,"kind":1024,"name":"indexInLedger","url":"interfaces/Outcome.html#indexInLedger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Outcome"},{"id":361,"kind":1024,"name":"fee","url":"interfaces/Outcome.html#fee","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Outcome"},{"id":362,"kind":1024,"name":"balanceChanges","url":"interfaces/Outcome.html#balanceChanges","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Outcome"},{"id":363,"kind":65536,"name":"__type","url":"interfaces/Outcome.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"Outcome"},{"id":364,"kind":1024,"name":"orderbookChanges","url":"interfaces/Outcome.html#orderbookChanges","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Outcome"},{"id":365,"kind":1024,"name":"deliveredAmount","url":"interfaces/Outcome.html#deliveredAmount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Outcome"},{"id":366,"kind":65536,"name":"__type","url":"interfaces/Outcome.html#__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"Outcome"},{"id":367,"kind":1024,"name":"currency","url":"interfaces/Outcome.html#__type-1.currency","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Outcome.__type"},{"id":368,"kind":1024,"name":"counterparty","url":"interfaces/Outcome.html#__type-1.counterparty","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Outcome.__type"},{"id":369,"kind":1024,"name":"value","url":"interfaces/Outcome.html#__type-1.value","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"Outcome.__type"},{"id":370,"kind":1024,"name":"timestamp","url":"interfaces/Outcome.html#timestamp","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Outcome"},{"id":371,"kind":256,"name":"FormattedOrderCancellation","url":"interfaces/FormattedOrderCancellation.html","classes":"tsd-kind-interface"},{"id":372,"kind":1024,"name":"orderSequence","url":"interfaces/FormattedOrderCancellation.html#orderSequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderCancellation"},{"id":373,"kind":256,"name":"FormattedPayment","url":"interfaces/FormattedPayment.html","classes":"tsd-kind-interface"},{"id":374,"kind":1024,"name":"source","url":"interfaces/FormattedPayment.html#source","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPayment"},{"id":375,"kind":1024,"name":"destination","url":"interfaces/FormattedPayment.html#destination","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPayment"},{"id":376,"kind":1024,"name":"paths","url":"interfaces/FormattedPayment.html#paths","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPayment"},{"id":377,"kind":1024,"name":"memos","url":"interfaces/FormattedPayment.html#memos","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPayment"},{"id":378,"kind":1024,"name":"invoiceID","url":"interfaces/FormattedPayment.html#invoiceID","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPayment"},{"id":379,"kind":1024,"name":"allowPartialPayment","url":"interfaces/FormattedPayment.html#allowPartialPayment","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPayment"},{"id":380,"kind":1024,"name":"noDirectRipple","url":"interfaces/FormattedPayment.html#noDirectRipple","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPayment"},{"id":381,"kind":1024,"name":"limitQuality","url":"interfaces/FormattedPayment.html#limitQuality","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPayment"},{"id":382,"kind":256,"name":"FormattedPaymentTransaction","url":"interfaces/FormattedPaymentTransaction.html","classes":"tsd-kind-interface"},{"id":383,"kind":1024,"name":"type","url":"interfaces/FormattedPaymentTransaction.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPaymentTransaction"},{"id":384,"kind":1024,"name":"specification","url":"interfaces/FormattedPaymentTransaction.html#specification","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPaymentTransaction"},{"id":385,"kind":1024,"name":"outcome","url":"interfaces/FormattedPaymentTransaction.html#outcome","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPaymentTransaction"},{"id":386,"kind":1024,"name":"id","url":"interfaces/FormattedPaymentTransaction.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPaymentTransaction"},{"id":387,"kind":1024,"name":"address","url":"interfaces/FormattedPaymentTransaction.html#address","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPaymentTransaction"},{"id":388,"kind":1024,"name":"sequence","url":"interfaces/FormattedPaymentTransaction.html#sequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedPaymentTransaction"},{"id":389,"kind":256,"name":"FormattedOrderTransaction","url":"interfaces/FormattedOrderTransaction.html","classes":"tsd-kind-interface"},{"id":390,"kind":1024,"name":"type","url":"interfaces/FormattedOrderTransaction.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderTransaction"},{"id":391,"kind":1024,"name":"specification","url":"interfaces/FormattedOrderTransaction.html#specification","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderTransaction"},{"id":392,"kind":1024,"name":"outcome","url":"interfaces/FormattedOrderTransaction.html#outcome","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderTransaction"},{"id":393,"kind":1024,"name":"id","url":"interfaces/FormattedOrderTransaction.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderTransaction"},{"id":394,"kind":1024,"name":"address","url":"interfaces/FormattedOrderTransaction.html#address","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderTransaction"},{"id":395,"kind":1024,"name":"sequence","url":"interfaces/FormattedOrderTransaction.html#sequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderTransaction"},{"id":396,"kind":256,"name":"FormattedOrderCancellationTransaction","url":"interfaces/FormattedOrderCancellationTransaction.html","classes":"tsd-kind-interface"},{"id":397,"kind":1024,"name":"type","url":"interfaces/FormattedOrderCancellationTransaction.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderCancellationTransaction"},{"id":398,"kind":1024,"name":"specification","url":"interfaces/FormattedOrderCancellationTransaction.html#specification","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderCancellationTransaction"},{"id":399,"kind":1024,"name":"outcome","url":"interfaces/FormattedOrderCancellationTransaction.html#outcome","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderCancellationTransaction"},{"id":400,"kind":1024,"name":"id","url":"interfaces/FormattedOrderCancellationTransaction.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderCancellationTransaction"},{"id":401,"kind":1024,"name":"address","url":"interfaces/FormattedOrderCancellationTransaction.html#address","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderCancellationTransaction"},{"id":402,"kind":1024,"name":"sequence","url":"interfaces/FormattedOrderCancellationTransaction.html#sequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedOrderCancellationTransaction"},{"id":403,"kind":256,"name":"FormattedTrustlineTransaction","url":"interfaces/FormattedTrustlineTransaction.html","classes":"tsd-kind-interface"},{"id":404,"kind":1024,"name":"type","url":"interfaces/FormattedTrustlineTransaction.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedTrustlineTransaction"},{"id":405,"kind":1024,"name":"specification","url":"interfaces/FormattedTrustlineTransaction.html#specification","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedTrustlineTransaction"},{"id":406,"kind":1024,"name":"outcome","url":"interfaces/FormattedTrustlineTransaction.html#outcome","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedTrustlineTransaction"},{"id":407,"kind":1024,"name":"id","url":"interfaces/FormattedTrustlineTransaction.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedTrustlineTransaction"},{"id":408,"kind":1024,"name":"address","url":"interfaces/FormattedTrustlineTransaction.html#address","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedTrustlineTransaction"},{"id":409,"kind":1024,"name":"sequence","url":"interfaces/FormattedTrustlineTransaction.html#sequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedTrustlineTransaction"},{"id":410,"kind":256,"name":"FormattedSettingsTransaction","url":"interfaces/FormattedSettingsTransaction.html","classes":"tsd-kind-interface"},{"id":411,"kind":1024,"name":"type","url":"interfaces/FormattedSettingsTransaction.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedSettingsTransaction"},{"id":412,"kind":1024,"name":"specification","url":"interfaces/FormattedSettingsTransaction.html#specification","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedSettingsTransaction"},{"id":413,"kind":1024,"name":"outcome","url":"interfaces/FormattedSettingsTransaction.html#outcome","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedSettingsTransaction"},{"id":414,"kind":1024,"name":"id","url":"interfaces/FormattedSettingsTransaction.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedSettingsTransaction"},{"id":415,"kind":1024,"name":"address","url":"interfaces/FormattedSettingsTransaction.html#address","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedSettingsTransaction"},{"id":416,"kind":1024,"name":"sequence","url":"interfaces/FormattedSettingsTransaction.html#sequence","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattedSettingsTransaction"},{"id":417,"kind":4194304,"name":"FormattedTransactionType","url":"modules.html#FormattedTransactionType","classes":"tsd-kind-type-alias"},{"id":418,"kind":256,"name":"Ledger","url":"interfaces/Ledger.html","classes":"tsd-kind-interface"},{"id":419,"kind":1024,"name":"account_hash","url":"interfaces/Ledger.html#account_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":420,"kind":1024,"name":"close_time","url":"interfaces/Ledger.html#close_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":421,"kind":1024,"name":"close_time_human","url":"interfaces/Ledger.html#close_time_human","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":422,"kind":1024,"name":"close_time_resolution","url":"interfaces/Ledger.html#close_time_resolution","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":423,"kind":1024,"name":"closed","url":"interfaces/Ledger.html#closed","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":424,"kind":1024,"name":"ledger_hash","url":"interfaces/Ledger.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":425,"kind":1024,"name":"ledger_index","url":"interfaces/Ledger.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":426,"kind":1024,"name":"parent_hash","url":"interfaces/Ledger.html#parent_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":427,"kind":1024,"name":"total_coins","url":"interfaces/Ledger.html#total_coins","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":428,"kind":1024,"name":"transaction_hash","url":"interfaces/Ledger.html#transaction_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":429,"kind":1024,"name":"transactions","url":"interfaces/Ledger.html#transactions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":430,"kind":1024,"name":"close_flags","url":"interfaces/Ledger.html#close_flags","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":431,"kind":1024,"name":"parent_close_time","url":"interfaces/Ledger.html#parent_close_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":432,"kind":1024,"name":"accountState","url":"interfaces/Ledger.html#accountState","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":433,"kind":1024,"name":"validated","url":"interfaces/Ledger.html#validated","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Ledger"},{"id":434,"kind":256,"name":"LedgerClosedEvent","url":"interfaces/LedgerClosedEvent.html","classes":"tsd-kind-interface"},{"id":435,"kind":1024,"name":"type","url":"interfaces/LedgerClosedEvent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerClosedEvent"},{"id":436,"kind":1024,"name":"fee_base","url":"interfaces/LedgerClosedEvent.html#fee_base","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerClosedEvent"},{"id":437,"kind":1024,"name":"fee_ref","url":"interfaces/LedgerClosedEvent.html#fee_ref","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerClosedEvent"},{"id":438,"kind":1024,"name":"ledger_hash","url":"interfaces/LedgerClosedEvent.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerClosedEvent"},{"id":439,"kind":1024,"name":"ledger_index","url":"interfaces/LedgerClosedEvent.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerClosedEvent"},{"id":440,"kind":1024,"name":"ledger_time","url":"interfaces/LedgerClosedEvent.html#ledger_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerClosedEvent"},{"id":441,"kind":1024,"name":"reserve_base","url":"interfaces/LedgerClosedEvent.html#reserve_base","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerClosedEvent"},{"id":442,"kind":1024,"name":"reserve_inc","url":"interfaces/LedgerClosedEvent.html#reserve_inc","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerClosedEvent"},{"id":443,"kind":1024,"name":"txn_count","url":"interfaces/LedgerClosedEvent.html#txn_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerClosedEvent"},{"id":444,"kind":1024,"name":"validated_ledgers","url":"interfaces/LedgerClosedEvent.html#validated_ledgers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerClosedEvent"},{"id":445,"kind":4194304,"name":"Request","url":"modules.html#Request","classes":"tsd-kind-type-alias"},{"id":446,"kind":4194304,"name":"Response","url":"modules.html#Response","classes":"tsd-kind-type-alias"},{"id":447,"kind":256,"name":"AccountChannelsRequest","url":"interfaces/AccountChannelsRequest.html","classes":"tsd-kind-interface"},{"id":448,"kind":1024,"name":"command","url":"interfaces/AccountChannelsRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountChannelsRequest"},{"id":449,"kind":1024,"name":"account","url":"interfaces/AccountChannelsRequest.html#account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountChannelsRequest"},{"id":450,"kind":1024,"name":"destination_account","url":"interfaces/AccountChannelsRequest.html#destination_account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountChannelsRequest"},{"id":451,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountChannelsRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountChannelsRequest"},{"id":452,"kind":1024,"name":"ledger_index","url":"interfaces/AccountChannelsRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountChannelsRequest"},{"id":453,"kind":1024,"name":"limit","url":"interfaces/AccountChannelsRequest.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountChannelsRequest"},{"id":454,"kind":1024,"name":"marker","url":"interfaces/AccountChannelsRequest.html#marker","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountChannelsRequest"},{"id":455,"kind":1024,"name":"id","url":"interfaces/AccountChannelsRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsRequest"},{"id":456,"kind":1024,"name":"api_version","url":"interfaces/AccountChannelsRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsRequest"},{"id":457,"kind":256,"name":"AccountChannelsResponse","url":"interfaces/AccountChannelsResponse.html","classes":"tsd-kind-interface"},{"id":458,"kind":1024,"name":"result","url":"interfaces/AccountChannelsResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountChannelsResponse"},{"id":459,"kind":65536,"name":"__type","url":"interfaces/AccountChannelsResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"AccountChannelsResponse"},{"id":460,"kind":1024,"name":"account","url":"interfaces/AccountChannelsResponse.html#__type.account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountChannelsResponse.__type"},{"id":461,"kind":1024,"name":"channels","url":"interfaces/AccountChannelsResponse.html#__type.channels","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountChannelsResponse.__type"},{"id":462,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountChannelsResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountChannelsResponse.__type"},{"id":463,"kind":1024,"name":"ledger_index","url":"interfaces/AccountChannelsResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountChannelsResponse.__type"},{"id":464,"kind":1024,"name":"validated","url":"interfaces/AccountChannelsResponse.html#__type.validated","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountChannelsResponse.__type"},{"id":465,"kind":1024,"name":"limit","url":"interfaces/AccountChannelsResponse.html#__type.limit","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountChannelsResponse.__type"},{"id":466,"kind":1024,"name":"marker","url":"interfaces/AccountChannelsResponse.html#__type.marker","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountChannelsResponse.__type"},{"id":467,"kind":1024,"name":"id","url":"interfaces/AccountChannelsResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsResponse"},{"id":468,"kind":1024,"name":"status","url":"interfaces/AccountChannelsResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsResponse"},{"id":469,"kind":1024,"name":"type","url":"interfaces/AccountChannelsResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsResponse"},{"id":470,"kind":1024,"name":"warning","url":"interfaces/AccountChannelsResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsResponse"},{"id":471,"kind":1024,"name":"warnings","url":"interfaces/AccountChannelsResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsResponse"},{"id":472,"kind":1024,"name":"forwarded","url":"interfaces/AccountChannelsResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsResponse"},{"id":473,"kind":1024,"name":"error","url":"interfaces/AccountChannelsResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsResponse"},{"id":474,"kind":1024,"name":"error_message","url":"interfaces/AccountChannelsResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsResponse"},{"id":475,"kind":1024,"name":"request","url":"interfaces/AccountChannelsResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsResponse"},{"id":476,"kind":1024,"name":"api_version","url":"interfaces/AccountChannelsResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountChannelsResponse"},{"id":477,"kind":256,"name":"AccountCurrenciesRequest","url":"interfaces/AccountCurrenciesRequest.html","classes":"tsd-kind-interface"},{"id":478,"kind":1024,"name":"command","url":"interfaces/AccountCurrenciesRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountCurrenciesRequest"},{"id":479,"kind":1024,"name":"account","url":"interfaces/AccountCurrenciesRequest.html#account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountCurrenciesRequest"},{"id":480,"kind":1024,"name":"destination_account","url":"interfaces/AccountCurrenciesRequest.html#destination_account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountCurrenciesRequest"},{"id":481,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountCurrenciesRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountCurrenciesRequest"},{"id":482,"kind":1024,"name":"ledger_index","url":"interfaces/AccountCurrenciesRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountCurrenciesRequest"},{"id":483,"kind":1024,"name":"strict","url":"interfaces/AccountCurrenciesRequest.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountCurrenciesRequest"},{"id":484,"kind":1024,"name":"id","url":"interfaces/AccountCurrenciesRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesRequest"},{"id":485,"kind":1024,"name":"api_version","url":"interfaces/AccountCurrenciesRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesRequest"},{"id":486,"kind":256,"name":"AccountCurrenciesResponse","url":"interfaces/AccountCurrenciesResponse.html","classes":"tsd-kind-interface"},{"id":487,"kind":1024,"name":"result","url":"interfaces/AccountCurrenciesResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountCurrenciesResponse"},{"id":488,"kind":65536,"name":"__type","url":"interfaces/AccountCurrenciesResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"AccountCurrenciesResponse"},{"id":489,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountCurrenciesResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountCurrenciesResponse.__type"},{"id":490,"kind":1024,"name":"ledger_index","url":"interfaces/AccountCurrenciesResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountCurrenciesResponse.__type"},{"id":491,"kind":1024,"name":"receive_currencies","url":"interfaces/AccountCurrenciesResponse.html#__type.receive_currencies","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountCurrenciesResponse.__type"},{"id":492,"kind":1024,"name":"send_currencies","url":"interfaces/AccountCurrenciesResponse.html#__type.send_currencies","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountCurrenciesResponse.__type"},{"id":493,"kind":1024,"name":"validated","url":"interfaces/AccountCurrenciesResponse.html#__type.validated","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountCurrenciesResponse.__type"},{"id":494,"kind":1024,"name":"id","url":"interfaces/AccountCurrenciesResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesResponse"},{"id":495,"kind":1024,"name":"status","url":"interfaces/AccountCurrenciesResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesResponse"},{"id":496,"kind":1024,"name":"type","url":"interfaces/AccountCurrenciesResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesResponse"},{"id":497,"kind":1024,"name":"warning","url":"interfaces/AccountCurrenciesResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesResponse"},{"id":498,"kind":1024,"name":"warnings","url":"interfaces/AccountCurrenciesResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesResponse"},{"id":499,"kind":1024,"name":"forwarded","url":"interfaces/AccountCurrenciesResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesResponse"},{"id":500,"kind":1024,"name":"error","url":"interfaces/AccountCurrenciesResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesResponse"},{"id":501,"kind":1024,"name":"error_message","url":"interfaces/AccountCurrenciesResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesResponse"},{"id":502,"kind":1024,"name":"request","url":"interfaces/AccountCurrenciesResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesResponse"},{"id":503,"kind":1024,"name":"api_version","url":"interfaces/AccountCurrenciesResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountCurrenciesResponse"},{"id":504,"kind":256,"name":"AccountInfoRequest","url":"interfaces/AccountInfoRequest.html","classes":"tsd-kind-interface"},{"id":505,"kind":1024,"name":"command","url":"interfaces/AccountInfoRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountInfoRequest"},{"id":506,"kind":1024,"name":"account","url":"interfaces/AccountInfoRequest.html#account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountInfoRequest"},{"id":507,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountInfoRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountInfoRequest"},{"id":508,"kind":1024,"name":"ledger_index","url":"interfaces/AccountInfoRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountInfoRequest"},{"id":509,"kind":1024,"name":"queue","url":"interfaces/AccountInfoRequest.html#queue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountInfoRequest"},{"id":510,"kind":1024,"name":"signer_lists","url":"interfaces/AccountInfoRequest.html#signer_lists","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountInfoRequest"},{"id":511,"kind":1024,"name":"strict","url":"interfaces/AccountInfoRequest.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountInfoRequest"},{"id":512,"kind":1024,"name":"id","url":"interfaces/AccountInfoRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoRequest"},{"id":513,"kind":1024,"name":"api_version","url":"interfaces/AccountInfoRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoRequest"},{"id":514,"kind":256,"name":"AccountInfoResponse","url":"interfaces/AccountInfoResponse.html","classes":"tsd-kind-interface"},{"id":515,"kind":1024,"name":"result","url":"interfaces/AccountInfoResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountInfoResponse"},{"id":516,"kind":65536,"name":"__type","url":"interfaces/AccountInfoResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"AccountInfoResponse"},{"id":517,"kind":1024,"name":"account_data","url":"interfaces/AccountInfoResponse.html#__type.account_data","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountInfoResponse.__type"},{"id":518,"kind":1024,"name":"signer_lists","url":"interfaces/AccountInfoResponse.html#__type.signer_lists","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountInfoResponse.__type"},{"id":519,"kind":1024,"name":"ledger_current_index","url":"interfaces/AccountInfoResponse.html#__type.ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountInfoResponse.__type"},{"id":520,"kind":1024,"name":"ledger_index","url":"interfaces/AccountInfoResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountInfoResponse.__type"},{"id":521,"kind":1024,"name":"queue_data","url":"interfaces/AccountInfoResponse.html#__type.queue_data","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountInfoResponse.__type"},{"id":522,"kind":1024,"name":"validated","url":"interfaces/AccountInfoResponse.html#__type.validated","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountInfoResponse.__type"},{"id":523,"kind":1024,"name":"id","url":"interfaces/AccountInfoResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoResponse"},{"id":524,"kind":1024,"name":"status","url":"interfaces/AccountInfoResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoResponse"},{"id":525,"kind":1024,"name":"type","url":"interfaces/AccountInfoResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoResponse"},{"id":526,"kind":1024,"name":"warning","url":"interfaces/AccountInfoResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoResponse"},{"id":527,"kind":1024,"name":"warnings","url":"interfaces/AccountInfoResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoResponse"},{"id":528,"kind":1024,"name":"forwarded","url":"interfaces/AccountInfoResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoResponse"},{"id":529,"kind":1024,"name":"error","url":"interfaces/AccountInfoResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoResponse"},{"id":530,"kind":1024,"name":"error_message","url":"interfaces/AccountInfoResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoResponse"},{"id":531,"kind":1024,"name":"request","url":"interfaces/AccountInfoResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoResponse"},{"id":532,"kind":1024,"name":"api_version","url":"interfaces/AccountInfoResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountInfoResponse"},{"id":533,"kind":256,"name":"AccountLinesRequest","url":"interfaces/AccountLinesRequest.html","classes":"tsd-kind-interface"},{"id":534,"kind":1024,"name":"command","url":"interfaces/AccountLinesRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountLinesRequest"},{"id":535,"kind":1024,"name":"account","url":"interfaces/AccountLinesRequest.html#account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountLinesRequest"},{"id":536,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountLinesRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountLinesRequest"},{"id":537,"kind":1024,"name":"ledger_index","url":"interfaces/AccountLinesRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountLinesRequest"},{"id":538,"kind":1024,"name":"peer","url":"interfaces/AccountLinesRequest.html#peer","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountLinesRequest"},{"id":539,"kind":1024,"name":"limit","url":"interfaces/AccountLinesRequest.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountLinesRequest"},{"id":540,"kind":1024,"name":"marker","url":"interfaces/AccountLinesRequest.html#marker","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountLinesRequest"},{"id":541,"kind":1024,"name":"id","url":"interfaces/AccountLinesRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesRequest"},{"id":542,"kind":1024,"name":"api_version","url":"interfaces/AccountLinesRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesRequest"},{"id":543,"kind":256,"name":"AccountLinesResponse","url":"interfaces/AccountLinesResponse.html","classes":"tsd-kind-interface"},{"id":544,"kind":1024,"name":"result","url":"interfaces/AccountLinesResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountLinesResponse"},{"id":545,"kind":65536,"name":"__type","url":"interfaces/AccountLinesResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"AccountLinesResponse"},{"id":546,"kind":1024,"name":"account","url":"interfaces/AccountLinesResponse.html#__type.account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountLinesResponse.__type"},{"id":547,"kind":1024,"name":"lines","url":"interfaces/AccountLinesResponse.html#__type.lines","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountLinesResponse.__type"},{"id":548,"kind":1024,"name":"ledger_current_index","url":"interfaces/AccountLinesResponse.html#__type.ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountLinesResponse.__type"},{"id":549,"kind":1024,"name":"ledger_index","url":"interfaces/AccountLinesResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountLinesResponse.__type"},{"id":550,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountLinesResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountLinesResponse.__type"},{"id":551,"kind":1024,"name":"marker","url":"interfaces/AccountLinesResponse.html#__type.marker","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountLinesResponse.__type"},{"id":552,"kind":1024,"name":"id","url":"interfaces/AccountLinesResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesResponse"},{"id":553,"kind":1024,"name":"status","url":"interfaces/AccountLinesResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesResponse"},{"id":554,"kind":1024,"name":"type","url":"interfaces/AccountLinesResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesResponse"},{"id":555,"kind":1024,"name":"warning","url":"interfaces/AccountLinesResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesResponse"},{"id":556,"kind":1024,"name":"warnings","url":"interfaces/AccountLinesResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesResponse"},{"id":557,"kind":1024,"name":"forwarded","url":"interfaces/AccountLinesResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesResponse"},{"id":558,"kind":1024,"name":"error","url":"interfaces/AccountLinesResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesResponse"},{"id":559,"kind":1024,"name":"error_message","url":"interfaces/AccountLinesResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesResponse"},{"id":560,"kind":1024,"name":"request","url":"interfaces/AccountLinesResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesResponse"},{"id":561,"kind":1024,"name":"api_version","url":"interfaces/AccountLinesResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountLinesResponse"},{"id":562,"kind":256,"name":"AccountObjectsRequest","url":"interfaces/AccountObjectsRequest.html","classes":"tsd-kind-interface"},{"id":563,"kind":1024,"name":"command","url":"interfaces/AccountObjectsRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountObjectsRequest"},{"id":564,"kind":1024,"name":"account","url":"interfaces/AccountObjectsRequest.html#account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountObjectsRequest"},{"id":565,"kind":1024,"name":"type","url":"interfaces/AccountObjectsRequest.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountObjectsRequest"},{"id":566,"kind":1024,"name":"deletion_blockers_only","url":"interfaces/AccountObjectsRequest.html#deletion_blockers_only","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountObjectsRequest"},{"id":567,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountObjectsRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountObjectsRequest"},{"id":568,"kind":1024,"name":"ledger_index","url":"interfaces/AccountObjectsRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountObjectsRequest"},{"id":569,"kind":1024,"name":"limit","url":"interfaces/AccountObjectsRequest.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountObjectsRequest"},{"id":570,"kind":1024,"name":"marker","url":"interfaces/AccountObjectsRequest.html#marker","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountObjectsRequest"},{"id":571,"kind":1024,"name":"id","url":"interfaces/AccountObjectsRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsRequest"},{"id":572,"kind":1024,"name":"api_version","url":"interfaces/AccountObjectsRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsRequest"},{"id":573,"kind":256,"name":"AccountObjectsResponse","url":"interfaces/AccountObjectsResponse.html","classes":"tsd-kind-interface"},{"id":574,"kind":1024,"name":"result","url":"interfaces/AccountObjectsResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountObjectsResponse"},{"id":575,"kind":65536,"name":"__type","url":"interfaces/AccountObjectsResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"AccountObjectsResponse"},{"id":576,"kind":1024,"name":"account","url":"interfaces/AccountObjectsResponse.html#__type.account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountObjectsResponse.__type"},{"id":577,"kind":1024,"name":"account_objects","url":"interfaces/AccountObjectsResponse.html#__type.account_objects","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountObjectsResponse.__type"},{"id":578,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountObjectsResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountObjectsResponse.__type"},{"id":579,"kind":1024,"name":"ledger_index","url":"interfaces/AccountObjectsResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountObjectsResponse.__type"},{"id":580,"kind":1024,"name":"ledger_current_index","url":"interfaces/AccountObjectsResponse.html#__type.ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountObjectsResponse.__type"},{"id":581,"kind":1024,"name":"limit","url":"interfaces/AccountObjectsResponse.html#__type.limit","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountObjectsResponse.__type"},{"id":582,"kind":1024,"name":"marker","url":"interfaces/AccountObjectsResponse.html#__type.marker","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountObjectsResponse.__type"},{"id":583,"kind":1024,"name":"validated","url":"interfaces/AccountObjectsResponse.html#__type.validated","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountObjectsResponse.__type"},{"id":584,"kind":1024,"name":"id","url":"interfaces/AccountObjectsResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsResponse"},{"id":585,"kind":1024,"name":"status","url":"interfaces/AccountObjectsResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsResponse"},{"id":586,"kind":1024,"name":"type","url":"interfaces/AccountObjectsResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsResponse"},{"id":587,"kind":1024,"name":"warning","url":"interfaces/AccountObjectsResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsResponse"},{"id":588,"kind":1024,"name":"warnings","url":"interfaces/AccountObjectsResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsResponse"},{"id":589,"kind":1024,"name":"forwarded","url":"interfaces/AccountObjectsResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsResponse"},{"id":590,"kind":1024,"name":"error","url":"interfaces/AccountObjectsResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsResponse"},{"id":591,"kind":1024,"name":"error_message","url":"interfaces/AccountObjectsResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsResponse"},{"id":592,"kind":1024,"name":"request","url":"interfaces/AccountObjectsResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsResponse"},{"id":593,"kind":1024,"name":"api_version","url":"interfaces/AccountObjectsResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountObjectsResponse"},{"id":594,"kind":256,"name":"AccountOffersRequest","url":"interfaces/AccountOffersRequest.html","classes":"tsd-kind-interface"},{"id":595,"kind":1024,"name":"command","url":"interfaces/AccountOffersRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountOffersRequest"},{"id":596,"kind":1024,"name":"account","url":"interfaces/AccountOffersRequest.html#account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountOffersRequest"},{"id":597,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountOffersRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountOffersRequest"},{"id":598,"kind":1024,"name":"ledger_index","url":"interfaces/AccountOffersRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountOffersRequest"},{"id":599,"kind":1024,"name":"limit","url":"interfaces/AccountOffersRequest.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountOffersRequest"},{"id":600,"kind":1024,"name":"marker","url":"interfaces/AccountOffersRequest.html#marker","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountOffersRequest"},{"id":601,"kind":1024,"name":"strict","url":"interfaces/AccountOffersRequest.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountOffersRequest"},{"id":602,"kind":1024,"name":"id","url":"interfaces/AccountOffersRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersRequest"},{"id":603,"kind":1024,"name":"api_version","url":"interfaces/AccountOffersRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersRequest"},{"id":604,"kind":256,"name":"AccountOffersResponse","url":"interfaces/AccountOffersResponse.html","classes":"tsd-kind-interface"},{"id":605,"kind":1024,"name":"result","url":"interfaces/AccountOffersResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountOffersResponse"},{"id":606,"kind":65536,"name":"__type","url":"interfaces/AccountOffersResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"AccountOffersResponse"},{"id":607,"kind":1024,"name":"account","url":"interfaces/AccountOffersResponse.html#__type.account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountOffersResponse.__type"},{"id":608,"kind":1024,"name":"offers","url":"interfaces/AccountOffersResponse.html#__type.offers","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountOffersResponse.__type"},{"id":609,"kind":1024,"name":"ledger_current_index","url":"interfaces/AccountOffersResponse.html#__type.ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountOffersResponse.__type"},{"id":610,"kind":1024,"name":"ledger_index","url":"interfaces/AccountOffersResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountOffersResponse.__type"},{"id":611,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountOffersResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountOffersResponse.__type"},{"id":612,"kind":1024,"name":"marker","url":"interfaces/AccountOffersResponse.html#__type.marker","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountOffersResponse.__type"},{"id":613,"kind":1024,"name":"id","url":"interfaces/AccountOffersResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersResponse"},{"id":614,"kind":1024,"name":"status","url":"interfaces/AccountOffersResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersResponse"},{"id":615,"kind":1024,"name":"type","url":"interfaces/AccountOffersResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersResponse"},{"id":616,"kind":1024,"name":"warning","url":"interfaces/AccountOffersResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersResponse"},{"id":617,"kind":1024,"name":"warnings","url":"interfaces/AccountOffersResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersResponse"},{"id":618,"kind":1024,"name":"forwarded","url":"interfaces/AccountOffersResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersResponse"},{"id":619,"kind":1024,"name":"error","url":"interfaces/AccountOffersResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersResponse"},{"id":620,"kind":1024,"name":"error_message","url":"interfaces/AccountOffersResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersResponse"},{"id":621,"kind":1024,"name":"request","url":"interfaces/AccountOffersResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersResponse"},{"id":622,"kind":1024,"name":"api_version","url":"interfaces/AccountOffersResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountOffersResponse"},{"id":623,"kind":256,"name":"AccountTxRequest","url":"interfaces/AccountTxRequest.html","classes":"tsd-kind-interface"},{"id":624,"kind":1024,"name":"command","url":"interfaces/AccountTxRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountTxRequest"},{"id":625,"kind":1024,"name":"account","url":"interfaces/AccountTxRequest.html#account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountTxRequest"},{"id":626,"kind":1024,"name":"ledger_index_min","url":"interfaces/AccountTxRequest.html#ledger_index_min","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountTxRequest"},{"id":627,"kind":1024,"name":"ledger_index_max","url":"interfaces/AccountTxRequest.html#ledger_index_max","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountTxRequest"},{"id":628,"kind":1024,"name":"ledger_hash","url":"interfaces/AccountTxRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountTxRequest"},{"id":629,"kind":1024,"name":"ledger_index","url":"interfaces/AccountTxRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountTxRequest"},{"id":630,"kind":1024,"name":"binary","url":"interfaces/AccountTxRequest.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountTxRequest"},{"id":631,"kind":1024,"name":"forward","url":"interfaces/AccountTxRequest.html#forward","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountTxRequest"},{"id":632,"kind":1024,"name":"limit","url":"interfaces/AccountTxRequest.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountTxRequest"},{"id":633,"kind":1024,"name":"marker","url":"interfaces/AccountTxRequest.html#marker","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"AccountTxRequest"},{"id":634,"kind":1024,"name":"id","url":"interfaces/AccountTxRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxRequest"},{"id":635,"kind":1024,"name":"api_version","url":"interfaces/AccountTxRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxRequest"},{"id":636,"kind":256,"name":"AccountTxResponse","url":"interfaces/AccountTxResponse.html","classes":"tsd-kind-interface"},{"id":637,"kind":1024,"name":"result","url":"interfaces/AccountTxResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"AccountTxResponse"},{"id":638,"kind":65536,"name":"__type","url":"interfaces/AccountTxResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"AccountTxResponse"},{"id":639,"kind":1024,"name":"account","url":"interfaces/AccountTxResponse.html#__type.account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountTxResponse.__type"},{"id":640,"kind":1024,"name":"ledger_index_min","url":"interfaces/AccountTxResponse.html#__type.ledger_index_min","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountTxResponse.__type"},{"id":641,"kind":1024,"name":"ledger_index_max","url":"interfaces/AccountTxResponse.html#__type.ledger_index_max","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountTxResponse.__type"},{"id":642,"kind":1024,"name":"limit","url":"interfaces/AccountTxResponse.html#__type.limit","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountTxResponse.__type"},{"id":643,"kind":1024,"name":"marker","url":"interfaces/AccountTxResponse.html#__type.marker","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountTxResponse.__type"},{"id":644,"kind":1024,"name":"transactions","url":"interfaces/AccountTxResponse.html#__type.transactions","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountTxResponse.__type"},{"id":645,"kind":1024,"name":"validated","url":"interfaces/AccountTxResponse.html#__type.validated","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"AccountTxResponse.__type"},{"id":646,"kind":1024,"name":"id","url":"interfaces/AccountTxResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxResponse"},{"id":647,"kind":1024,"name":"status","url":"interfaces/AccountTxResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxResponse"},{"id":648,"kind":1024,"name":"type","url":"interfaces/AccountTxResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxResponse"},{"id":649,"kind":1024,"name":"warning","url":"interfaces/AccountTxResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxResponse"},{"id":650,"kind":1024,"name":"warnings","url":"interfaces/AccountTxResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxResponse"},{"id":651,"kind":1024,"name":"forwarded","url":"interfaces/AccountTxResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxResponse"},{"id":652,"kind":1024,"name":"error","url":"interfaces/AccountTxResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxResponse"},{"id":653,"kind":1024,"name":"error_message","url":"interfaces/AccountTxResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxResponse"},{"id":654,"kind":1024,"name":"request","url":"interfaces/AccountTxResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxResponse"},{"id":655,"kind":1024,"name":"api_version","url":"interfaces/AccountTxResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"AccountTxResponse"},{"id":656,"kind":256,"name":"GatewayBalancesRequest","url":"interfaces/GatewayBalancesRequest.html","classes":"tsd-kind-interface"},{"id":657,"kind":1024,"name":"command","url":"interfaces/GatewayBalancesRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"GatewayBalancesRequest"},{"id":658,"kind":1024,"name":"account","url":"interfaces/GatewayBalancesRequest.html#account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GatewayBalancesRequest"},{"id":659,"kind":1024,"name":"strict","url":"interfaces/GatewayBalancesRequest.html#strict","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GatewayBalancesRequest"},{"id":660,"kind":1024,"name":"hotwallet","url":"interfaces/GatewayBalancesRequest.html#hotwallet","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GatewayBalancesRequest"},{"id":661,"kind":1024,"name":"ledger_hash","url":"interfaces/GatewayBalancesRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GatewayBalancesRequest"},{"id":662,"kind":1024,"name":"ledger_index","url":"interfaces/GatewayBalancesRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GatewayBalancesRequest"},{"id":663,"kind":1024,"name":"id","url":"interfaces/GatewayBalancesRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesRequest"},{"id":664,"kind":1024,"name":"api_version","url":"interfaces/GatewayBalancesRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesRequest"},{"id":665,"kind":256,"name":"GatewayBalancesResponse","url":"interfaces/GatewayBalancesResponse.html","classes":"tsd-kind-interface"},{"id":666,"kind":1024,"name":"result","url":"interfaces/GatewayBalancesResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"GatewayBalancesResponse"},{"id":667,"kind":65536,"name":"__type","url":"interfaces/GatewayBalancesResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"GatewayBalancesResponse"},{"id":668,"kind":1024,"name":"account","url":"interfaces/GatewayBalancesResponse.html#__type.account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"GatewayBalancesResponse.__type"},{"id":669,"kind":1024,"name":"obligations","url":"interfaces/GatewayBalancesResponse.html#__type.obligations","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"GatewayBalancesResponse.__type"},{"id":670,"kind":65536,"name":"__type","url":"interfaces/GatewayBalancesResponse.html#__type.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"GatewayBalancesResponse.__type"},{"id":671,"kind":1024,"name":"balances","url":"interfaces/GatewayBalancesResponse.html#__type.balances","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"GatewayBalancesResponse.__type"},{"id":672,"kind":65536,"name":"__type","url":"interfaces/GatewayBalancesResponse.html#__type.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"GatewayBalancesResponse.__type"},{"id":673,"kind":1024,"name":"assets","url":"interfaces/GatewayBalancesResponse.html#__type.assets","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"GatewayBalancesResponse.__type"},{"id":674,"kind":65536,"name":"__type","url":"interfaces/GatewayBalancesResponse.html#__type.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"GatewayBalancesResponse.__type"},{"id":675,"kind":1024,"name":"ledger_hash","url":"interfaces/GatewayBalancesResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"GatewayBalancesResponse.__type"},{"id":676,"kind":1024,"name":"ledger_current_index","url":"interfaces/GatewayBalancesResponse.html#__type.ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"GatewayBalancesResponse.__type"},{"id":677,"kind":1024,"name":"ledger_index","url":"interfaces/GatewayBalancesResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"GatewayBalancesResponse.__type"},{"id":678,"kind":1024,"name":"id","url":"interfaces/GatewayBalancesResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesResponse"},{"id":679,"kind":1024,"name":"status","url":"interfaces/GatewayBalancesResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesResponse"},{"id":680,"kind":1024,"name":"type","url":"interfaces/GatewayBalancesResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesResponse"},{"id":681,"kind":1024,"name":"warning","url":"interfaces/GatewayBalancesResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesResponse"},{"id":682,"kind":1024,"name":"warnings","url":"interfaces/GatewayBalancesResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesResponse"},{"id":683,"kind":1024,"name":"forwarded","url":"interfaces/GatewayBalancesResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesResponse"},{"id":684,"kind":1024,"name":"error","url":"interfaces/GatewayBalancesResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesResponse"},{"id":685,"kind":1024,"name":"error_message","url":"interfaces/GatewayBalancesResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesResponse"},{"id":686,"kind":1024,"name":"request","url":"interfaces/GatewayBalancesResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesResponse"},{"id":687,"kind":1024,"name":"api_version","url":"interfaces/GatewayBalancesResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GatewayBalancesResponse"},{"id":688,"kind":256,"name":"NoRippleCheckRequest","url":"interfaces/NoRippleCheckRequest.html","classes":"tsd-kind-interface"},{"id":689,"kind":1024,"name":"command","url":"interfaces/NoRippleCheckRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"NoRippleCheckRequest"},{"id":690,"kind":1024,"name":"account","url":"interfaces/NoRippleCheckRequest.html#account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NoRippleCheckRequest"},{"id":691,"kind":1024,"name":"role","url":"interfaces/NoRippleCheckRequest.html#role","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NoRippleCheckRequest"},{"id":692,"kind":1024,"name":"transactions","url":"interfaces/NoRippleCheckRequest.html#transactions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NoRippleCheckRequest"},{"id":693,"kind":1024,"name":"ledger_hash","url":"interfaces/NoRippleCheckRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NoRippleCheckRequest"},{"id":694,"kind":1024,"name":"ledger_index","url":"interfaces/NoRippleCheckRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"NoRippleCheckRequest"},{"id":695,"kind":1024,"name":"id","url":"interfaces/NoRippleCheckRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckRequest"},{"id":696,"kind":1024,"name":"api_version","url":"interfaces/NoRippleCheckRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckRequest"},{"id":697,"kind":256,"name":"NoRippleCheckResponse","url":"interfaces/NoRippleCheckResponse.html","classes":"tsd-kind-interface"},{"id":698,"kind":1024,"name":"result","url":"interfaces/NoRippleCheckResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"NoRippleCheckResponse"},{"id":699,"kind":65536,"name":"__type","url":"interfaces/NoRippleCheckResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"NoRippleCheckResponse"},{"id":700,"kind":1024,"name":"ledger_current_index","url":"interfaces/NoRippleCheckResponse.html#__type.ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"NoRippleCheckResponse.__type"},{"id":701,"kind":1024,"name":"problems","url":"interfaces/NoRippleCheckResponse.html#__type.problems","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"NoRippleCheckResponse.__type"},{"id":702,"kind":1024,"name":"transactions","url":"interfaces/NoRippleCheckResponse.html#__type.transactions","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"NoRippleCheckResponse.__type"},{"id":703,"kind":1024,"name":"id","url":"interfaces/NoRippleCheckResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckResponse"},{"id":704,"kind":1024,"name":"status","url":"interfaces/NoRippleCheckResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckResponse"},{"id":705,"kind":1024,"name":"type","url":"interfaces/NoRippleCheckResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckResponse"},{"id":706,"kind":1024,"name":"warning","url":"interfaces/NoRippleCheckResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckResponse"},{"id":707,"kind":1024,"name":"warnings","url":"interfaces/NoRippleCheckResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckResponse"},{"id":708,"kind":1024,"name":"forwarded","url":"interfaces/NoRippleCheckResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckResponse"},{"id":709,"kind":1024,"name":"error","url":"interfaces/NoRippleCheckResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckResponse"},{"id":710,"kind":1024,"name":"error_message","url":"interfaces/NoRippleCheckResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckResponse"},{"id":711,"kind":1024,"name":"request","url":"interfaces/NoRippleCheckResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckResponse"},{"id":712,"kind":1024,"name":"api_version","url":"interfaces/NoRippleCheckResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"NoRippleCheckResponse"},{"id":713,"kind":256,"name":"LedgerRequest","url":"interfaces/LedgerRequest.html","classes":"tsd-kind-interface"},{"id":714,"kind":1024,"name":"command","url":"interfaces/LedgerRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerRequest"},{"id":715,"kind":1024,"name":"ledger_hash","url":"interfaces/LedgerRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerRequest"},{"id":716,"kind":1024,"name":"ledger_index","url":"interfaces/LedgerRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerRequest"},{"id":717,"kind":1024,"name":"full","url":"interfaces/LedgerRequest.html#full","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerRequest"},{"id":718,"kind":1024,"name":"accounts","url":"interfaces/LedgerRequest.html#accounts","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerRequest"},{"id":719,"kind":1024,"name":"transactions","url":"interfaces/LedgerRequest.html#transactions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerRequest"},{"id":720,"kind":1024,"name":"expand","url":"interfaces/LedgerRequest.html#expand","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerRequest"},{"id":721,"kind":1024,"name":"owner_funds","url":"interfaces/LedgerRequest.html#owner_funds","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerRequest"},{"id":722,"kind":1024,"name":"binary","url":"interfaces/LedgerRequest.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerRequest"},{"id":723,"kind":1024,"name":"queue","url":"interfaces/LedgerRequest.html#queue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerRequest"},{"id":724,"kind":1024,"name":"id","url":"interfaces/LedgerRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerRequest"},{"id":725,"kind":1024,"name":"api_version","url":"interfaces/LedgerRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerRequest"},{"id":726,"kind":256,"name":"LedgerResponse","url":"interfaces/LedgerResponse.html","classes":"tsd-kind-interface"},{"id":727,"kind":1024,"name":"result","url":"interfaces/LedgerResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerResponse"},{"id":728,"kind":65536,"name":"__type","url":"interfaces/LedgerResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"LedgerResponse"},{"id":729,"kind":1024,"name":"ledger","url":"interfaces/LedgerResponse.html#__type.ledger","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerResponse.__type"},{"id":730,"kind":1024,"name":"ledger_hash","url":"interfaces/LedgerResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerResponse.__type"},{"id":731,"kind":1024,"name":"ledger_index","url":"interfaces/LedgerResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerResponse.__type"},{"id":732,"kind":1024,"name":"queue_data","url":"interfaces/LedgerResponse.html#__type.queue_data","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerResponse.__type"},{"id":733,"kind":1024,"name":"validated","url":"interfaces/LedgerResponse.html#__type.validated","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerResponse.__type"},{"id":734,"kind":1024,"name":"id","url":"interfaces/LedgerResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerResponse"},{"id":735,"kind":1024,"name":"status","url":"interfaces/LedgerResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerResponse"},{"id":736,"kind":1024,"name":"type","url":"interfaces/LedgerResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerResponse"},{"id":737,"kind":1024,"name":"warning","url":"interfaces/LedgerResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerResponse"},{"id":738,"kind":1024,"name":"warnings","url":"interfaces/LedgerResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerResponse"},{"id":739,"kind":1024,"name":"forwarded","url":"interfaces/LedgerResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerResponse"},{"id":740,"kind":1024,"name":"error","url":"interfaces/LedgerResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerResponse"},{"id":741,"kind":1024,"name":"error_message","url":"interfaces/LedgerResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerResponse"},{"id":742,"kind":1024,"name":"request","url":"interfaces/LedgerResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerResponse"},{"id":743,"kind":1024,"name":"api_version","url":"interfaces/LedgerResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerResponse"},{"id":744,"kind":256,"name":"LedgerClosedRequest","url":"interfaces/LedgerClosedRequest.html","classes":"tsd-kind-interface"},{"id":745,"kind":1024,"name":"command","url":"interfaces/LedgerClosedRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerClosedRequest"},{"id":746,"kind":1024,"name":"id","url":"interfaces/LedgerClosedRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedRequest"},{"id":747,"kind":1024,"name":"api_version","url":"interfaces/LedgerClosedRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedRequest"},{"id":748,"kind":256,"name":"LedgerClosedResponse","url":"interfaces/LedgerClosedResponse.html","classes":"tsd-kind-interface"},{"id":749,"kind":1024,"name":"result","url":"interfaces/LedgerClosedResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerClosedResponse"},{"id":750,"kind":65536,"name":"__type","url":"interfaces/LedgerClosedResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"LedgerClosedResponse"},{"id":751,"kind":1024,"name":"ledger_hash","url":"interfaces/LedgerClosedResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerClosedResponse.__type"},{"id":752,"kind":1024,"name":"ledger_index","url":"interfaces/LedgerClosedResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerClosedResponse.__type"},{"id":753,"kind":1024,"name":"id","url":"interfaces/LedgerClosedResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedResponse"},{"id":754,"kind":1024,"name":"status","url":"interfaces/LedgerClosedResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedResponse"},{"id":755,"kind":1024,"name":"type","url":"interfaces/LedgerClosedResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedResponse"},{"id":756,"kind":1024,"name":"warning","url":"interfaces/LedgerClosedResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedResponse"},{"id":757,"kind":1024,"name":"warnings","url":"interfaces/LedgerClosedResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedResponse"},{"id":758,"kind":1024,"name":"forwarded","url":"interfaces/LedgerClosedResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedResponse"},{"id":759,"kind":1024,"name":"error","url":"interfaces/LedgerClosedResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedResponse"},{"id":760,"kind":1024,"name":"error_message","url":"interfaces/LedgerClosedResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedResponse"},{"id":761,"kind":1024,"name":"request","url":"interfaces/LedgerClosedResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedResponse"},{"id":762,"kind":1024,"name":"api_version","url":"interfaces/LedgerClosedResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerClosedResponse"},{"id":763,"kind":256,"name":"LedgerCurrentRequest","url":"interfaces/LedgerCurrentRequest.html","classes":"tsd-kind-interface"},{"id":764,"kind":1024,"name":"command","url":"interfaces/LedgerCurrentRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerCurrentRequest"},{"id":765,"kind":1024,"name":"id","url":"interfaces/LedgerCurrentRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentRequest"},{"id":766,"kind":1024,"name":"api_version","url":"interfaces/LedgerCurrentRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentRequest"},{"id":767,"kind":256,"name":"LedgerCurrentResponse","url":"interfaces/LedgerCurrentResponse.html","classes":"tsd-kind-interface"},{"id":768,"kind":1024,"name":"result","url":"interfaces/LedgerCurrentResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerCurrentResponse"},{"id":769,"kind":65536,"name":"__type","url":"interfaces/LedgerCurrentResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"LedgerCurrentResponse"},{"id":770,"kind":1024,"name":"ledger_current_index","url":"interfaces/LedgerCurrentResponse.html#__type.ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerCurrentResponse.__type"},{"id":771,"kind":1024,"name":"id","url":"interfaces/LedgerCurrentResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentResponse"},{"id":772,"kind":1024,"name":"status","url":"interfaces/LedgerCurrentResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentResponse"},{"id":773,"kind":1024,"name":"type","url":"interfaces/LedgerCurrentResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentResponse"},{"id":774,"kind":1024,"name":"warning","url":"interfaces/LedgerCurrentResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentResponse"},{"id":775,"kind":1024,"name":"warnings","url":"interfaces/LedgerCurrentResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentResponse"},{"id":776,"kind":1024,"name":"forwarded","url":"interfaces/LedgerCurrentResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentResponse"},{"id":777,"kind":1024,"name":"error","url":"interfaces/LedgerCurrentResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentResponse"},{"id":778,"kind":1024,"name":"error_message","url":"interfaces/LedgerCurrentResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentResponse"},{"id":779,"kind":1024,"name":"request","url":"interfaces/LedgerCurrentResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentResponse"},{"id":780,"kind":1024,"name":"api_version","url":"interfaces/LedgerCurrentResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerCurrentResponse"},{"id":781,"kind":256,"name":"LedgerDataRequest","url":"interfaces/LedgerDataRequest.html","classes":"tsd-kind-interface"},{"id":782,"kind":1024,"name":"command","url":"interfaces/LedgerDataRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerDataRequest"},{"id":783,"kind":1024,"name":"ledger_hash","url":"interfaces/LedgerDataRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerDataRequest"},{"id":784,"kind":1024,"name":"ledger_index","url":"interfaces/LedgerDataRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerDataRequest"},{"id":785,"kind":1024,"name":"binary","url":"interfaces/LedgerDataRequest.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerDataRequest"},{"id":786,"kind":1024,"name":"limit","url":"interfaces/LedgerDataRequest.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerDataRequest"},{"id":787,"kind":1024,"name":"marker","url":"interfaces/LedgerDataRequest.html#marker","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerDataRequest"},{"id":788,"kind":1024,"name":"id","url":"interfaces/LedgerDataRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataRequest"},{"id":789,"kind":1024,"name":"api_version","url":"interfaces/LedgerDataRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataRequest"},{"id":790,"kind":256,"name":"LedgerDataResponse","url":"interfaces/LedgerDataResponse.html","classes":"tsd-kind-interface"},{"id":791,"kind":1024,"name":"result","url":"interfaces/LedgerDataResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerDataResponse"},{"id":792,"kind":65536,"name":"__type","url":"interfaces/LedgerDataResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"LedgerDataResponse"},{"id":793,"kind":1024,"name":"ledger_index","url":"interfaces/LedgerDataResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerDataResponse.__type"},{"id":794,"kind":1024,"name":"ledger_hash","url":"interfaces/LedgerDataResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerDataResponse.__type"},{"id":795,"kind":1024,"name":"state","url":"interfaces/LedgerDataResponse.html#__type.state","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerDataResponse.__type"},{"id":796,"kind":1024,"name":"marker","url":"interfaces/LedgerDataResponse.html#__type.marker","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerDataResponse.__type"},{"id":797,"kind":1024,"name":"id","url":"interfaces/LedgerDataResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataResponse"},{"id":798,"kind":1024,"name":"status","url":"interfaces/LedgerDataResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataResponse"},{"id":799,"kind":1024,"name":"type","url":"interfaces/LedgerDataResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataResponse"},{"id":800,"kind":1024,"name":"warning","url":"interfaces/LedgerDataResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataResponse"},{"id":801,"kind":1024,"name":"warnings","url":"interfaces/LedgerDataResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataResponse"},{"id":802,"kind":1024,"name":"forwarded","url":"interfaces/LedgerDataResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataResponse"},{"id":803,"kind":1024,"name":"error","url":"interfaces/LedgerDataResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataResponse"},{"id":804,"kind":1024,"name":"error_message","url":"interfaces/LedgerDataResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataResponse"},{"id":805,"kind":1024,"name":"request","url":"interfaces/LedgerDataResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataResponse"},{"id":806,"kind":1024,"name":"api_version","url":"interfaces/LedgerDataResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerDataResponse"},{"id":807,"kind":256,"name":"LedgerEntryRequest","url":"interfaces/LedgerEntryRequest.html","classes":"tsd-kind-interface"},{"id":808,"kind":1024,"name":"command","url":"interfaces/LedgerEntryRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerEntryRequest"},{"id":809,"kind":1024,"name":"binary","url":"interfaces/LedgerEntryRequest.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":810,"kind":1024,"name":"ledger_hash","url":"interfaces/LedgerEntryRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":811,"kind":1024,"name":"ledger_index","url":"interfaces/LedgerEntryRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":812,"kind":1024,"name":"index","url":"interfaces/LedgerEntryRequest.html#index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":813,"kind":1024,"name":"account_root","url":"interfaces/LedgerEntryRequest.html#account_root","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":814,"kind":1024,"name":"directory","url":"interfaces/LedgerEntryRequest.html#directory","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":815,"kind":1024,"name":"offer","url":"interfaces/LedgerEntryRequest.html#offer","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":816,"kind":1024,"name":"ripple_state","url":"interfaces/LedgerEntryRequest.html#ripple_state","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":817,"kind":65536,"name":"__type","url":"interfaces/LedgerEntryRequest.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":818,"kind":1024,"name":"accounts","url":"interfaces/LedgerEntryRequest.html#__type.accounts","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerEntryRequest.__type"},{"id":819,"kind":1024,"name":"currency","url":"interfaces/LedgerEntryRequest.html#__type.currency","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerEntryRequest.__type"},{"id":820,"kind":1024,"name":"check","url":"interfaces/LedgerEntryRequest.html#check","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":821,"kind":1024,"name":"escrow","url":"interfaces/LedgerEntryRequest.html#escrow","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":822,"kind":1024,"name":"payment_channel","url":"interfaces/LedgerEntryRequest.html#payment_channel","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":823,"kind":1024,"name":"deposit_preauth","url":"interfaces/LedgerEntryRequest.html#deposit_preauth","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":824,"kind":1024,"name":"ticket","url":"interfaces/LedgerEntryRequest.html#ticket","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerEntryRequest"},{"id":825,"kind":1024,"name":"id","url":"interfaces/LedgerEntryRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryRequest"},{"id":826,"kind":1024,"name":"api_version","url":"interfaces/LedgerEntryRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryRequest"},{"id":827,"kind":256,"name":"LedgerEntryResponse","url":"interfaces/LedgerEntryResponse.html","classes":"tsd-kind-interface"},{"id":828,"kind":1024,"name":"result","url":"interfaces/LedgerEntryResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerEntryResponse"},{"id":829,"kind":65536,"name":"__type","url":"interfaces/LedgerEntryResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"LedgerEntryResponse"},{"id":830,"kind":1024,"name":"index","url":"interfaces/LedgerEntryResponse.html#__type.index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerEntryResponse.__type"},{"id":831,"kind":1024,"name":"ledger_index","url":"interfaces/LedgerEntryResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerEntryResponse.__type"},{"id":832,"kind":1024,"name":"node","url":"interfaces/LedgerEntryResponse.html#__type.node","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerEntryResponse.__type"},{"id":833,"kind":1024,"name":"node_binary","url":"interfaces/LedgerEntryResponse.html#__type.node_binary","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"LedgerEntryResponse.__type"},{"id":834,"kind":1024,"name":"id","url":"interfaces/LedgerEntryResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryResponse"},{"id":835,"kind":1024,"name":"status","url":"interfaces/LedgerEntryResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryResponse"},{"id":836,"kind":1024,"name":"type","url":"interfaces/LedgerEntryResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryResponse"},{"id":837,"kind":1024,"name":"warning","url":"interfaces/LedgerEntryResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryResponse"},{"id":838,"kind":1024,"name":"warnings","url":"interfaces/LedgerEntryResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryResponse"},{"id":839,"kind":1024,"name":"forwarded","url":"interfaces/LedgerEntryResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryResponse"},{"id":840,"kind":1024,"name":"error","url":"interfaces/LedgerEntryResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryResponse"},{"id":841,"kind":1024,"name":"error_message","url":"interfaces/LedgerEntryResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryResponse"},{"id":842,"kind":1024,"name":"request","url":"interfaces/LedgerEntryResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryResponse"},{"id":843,"kind":1024,"name":"api_version","url":"interfaces/LedgerEntryResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"LedgerEntryResponse"},{"id":844,"kind":256,"name":"SubmitRequest","url":"interfaces/SubmitRequest.html","classes":"tsd-kind-interface"},{"id":845,"kind":1024,"name":"command","url":"interfaces/SubmitRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"SubmitRequest"},{"id":846,"kind":1024,"name":"tx_blob","url":"interfaces/SubmitRequest.html#tx_blob","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubmitRequest"},{"id":847,"kind":1024,"name":"fail_hard","url":"interfaces/SubmitRequest.html#fail_hard","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubmitRequest"},{"id":848,"kind":1024,"name":"id","url":"interfaces/SubmitRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitRequest"},{"id":849,"kind":1024,"name":"api_version","url":"interfaces/SubmitRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitRequest"},{"id":850,"kind":256,"name":"SubmitResponse","url":"interfaces/SubmitResponse.html","classes":"tsd-kind-interface"},{"id":851,"kind":1024,"name":"result","url":"interfaces/SubmitResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"SubmitResponse"},{"id":852,"kind":65536,"name":"__type","url":"interfaces/SubmitResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"SubmitResponse"},{"id":853,"kind":1024,"name":"engine_result","url":"interfaces/SubmitResponse.html#__type.engine_result","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":854,"kind":1024,"name":"engine_result_code","url":"interfaces/SubmitResponse.html#__type.engine_result_code","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":855,"kind":1024,"name":"engine_result_message","url":"interfaces/SubmitResponse.html#__type.engine_result_message","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":856,"kind":1024,"name":"tx_blob","url":"interfaces/SubmitResponse.html#__type.tx_blob","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":857,"kind":1024,"name":"tx_json","url":"interfaces/SubmitResponse.html#__type.tx_json","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":858,"kind":1024,"name":"accepted","url":"interfaces/SubmitResponse.html#__type.accepted","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":859,"kind":1024,"name":"account_sequence_available","url":"interfaces/SubmitResponse.html#__type.account_sequence_available","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":860,"kind":1024,"name":"account_sequence_next","url":"interfaces/SubmitResponse.html#__type.account_sequence_next","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":861,"kind":1024,"name":"applied","url":"interfaces/SubmitResponse.html#__type.applied","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":862,"kind":1024,"name":"broadcast","url":"interfaces/SubmitResponse.html#__type.broadcast","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":863,"kind":1024,"name":"kept","url":"interfaces/SubmitResponse.html#__type.kept","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":864,"kind":1024,"name":"queued","url":"interfaces/SubmitResponse.html#__type.queued","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":865,"kind":1024,"name":"open_ledger_cost","url":"interfaces/SubmitResponse.html#__type.open_ledger_cost","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":866,"kind":1024,"name":"validated_ledger_index","url":"interfaces/SubmitResponse.html#__type.validated_ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitResponse.__type"},{"id":867,"kind":1024,"name":"id","url":"interfaces/SubmitResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitResponse"},{"id":868,"kind":1024,"name":"status","url":"interfaces/SubmitResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitResponse"},{"id":869,"kind":1024,"name":"type","url":"interfaces/SubmitResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitResponse"},{"id":870,"kind":1024,"name":"warning","url":"interfaces/SubmitResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitResponse"},{"id":871,"kind":1024,"name":"warnings","url":"interfaces/SubmitResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitResponse"},{"id":872,"kind":1024,"name":"forwarded","url":"interfaces/SubmitResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitResponse"},{"id":873,"kind":1024,"name":"error","url":"interfaces/SubmitResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitResponse"},{"id":874,"kind":1024,"name":"error_message","url":"interfaces/SubmitResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitResponse"},{"id":875,"kind":1024,"name":"request","url":"interfaces/SubmitResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitResponse"},{"id":876,"kind":1024,"name":"api_version","url":"interfaces/SubmitResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitResponse"},{"id":877,"kind":256,"name":"SubmitMultisignedRequest","url":"interfaces/SubmitMultisignedRequest.html","classes":"tsd-kind-interface"},{"id":878,"kind":1024,"name":"command","url":"interfaces/SubmitMultisignedRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"SubmitMultisignedRequest"},{"id":879,"kind":1024,"name":"tx_json","url":"interfaces/SubmitMultisignedRequest.html#tx_json","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubmitMultisignedRequest"},{"id":880,"kind":1024,"name":"fail_hard","url":"interfaces/SubmitMultisignedRequest.html#fail_hard","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubmitMultisignedRequest"},{"id":881,"kind":1024,"name":"id","url":"interfaces/SubmitMultisignedRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedRequest"},{"id":882,"kind":1024,"name":"api_version","url":"interfaces/SubmitMultisignedRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedRequest"},{"id":883,"kind":256,"name":"SubmitMultisignedResponse","url":"interfaces/SubmitMultisignedResponse.html","classes":"tsd-kind-interface"},{"id":884,"kind":1024,"name":"result","url":"interfaces/SubmitMultisignedResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"SubmitMultisignedResponse"},{"id":885,"kind":65536,"name":"__type","url":"interfaces/SubmitMultisignedResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"SubmitMultisignedResponse"},{"id":886,"kind":1024,"name":"engine_result","url":"interfaces/SubmitMultisignedResponse.html#__type.engine_result","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitMultisignedResponse.__type"},{"id":887,"kind":1024,"name":"engine_result_code","url":"interfaces/SubmitMultisignedResponse.html#__type.engine_result_code","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitMultisignedResponse.__type"},{"id":888,"kind":1024,"name":"engine_result_message","url":"interfaces/SubmitMultisignedResponse.html#__type.engine_result_message","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitMultisignedResponse.__type"},{"id":889,"kind":1024,"name":"tx_blob","url":"interfaces/SubmitMultisignedResponse.html#__type.tx_blob","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitMultisignedResponse.__type"},{"id":890,"kind":1024,"name":"tx_json","url":"interfaces/SubmitMultisignedResponse.html#__type.tx_json","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SubmitMultisignedResponse.__type"},{"id":891,"kind":1024,"name":"id","url":"interfaces/SubmitMultisignedResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedResponse"},{"id":892,"kind":1024,"name":"status","url":"interfaces/SubmitMultisignedResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedResponse"},{"id":893,"kind":1024,"name":"type","url":"interfaces/SubmitMultisignedResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedResponse"},{"id":894,"kind":1024,"name":"warning","url":"interfaces/SubmitMultisignedResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedResponse"},{"id":895,"kind":1024,"name":"warnings","url":"interfaces/SubmitMultisignedResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedResponse"},{"id":896,"kind":1024,"name":"forwarded","url":"interfaces/SubmitMultisignedResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedResponse"},{"id":897,"kind":1024,"name":"error","url":"interfaces/SubmitMultisignedResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedResponse"},{"id":898,"kind":1024,"name":"error_message","url":"interfaces/SubmitMultisignedResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedResponse"},{"id":899,"kind":1024,"name":"request","url":"interfaces/SubmitMultisignedResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedResponse"},{"id":900,"kind":1024,"name":"api_version","url":"interfaces/SubmitMultisignedResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubmitMultisignedResponse"},{"id":901,"kind":256,"name":"TransactionEntryRequest","url":"interfaces/TransactionEntryRequest.html","classes":"tsd-kind-interface"},{"id":902,"kind":1024,"name":"command","url":"interfaces/TransactionEntryRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"TransactionEntryRequest"},{"id":903,"kind":1024,"name":"ledger_hash","url":"interfaces/TransactionEntryRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionEntryRequest"},{"id":904,"kind":1024,"name":"ledger_index","url":"interfaces/TransactionEntryRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionEntryRequest"},{"id":905,"kind":1024,"name":"tx_hash","url":"interfaces/TransactionEntryRequest.html#tx_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionEntryRequest"},{"id":906,"kind":1024,"name":"id","url":"interfaces/TransactionEntryRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryRequest"},{"id":907,"kind":1024,"name":"api_version","url":"interfaces/TransactionEntryRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryRequest"},{"id":908,"kind":256,"name":"TransactionEntryResponse","url":"interfaces/TransactionEntryResponse.html","classes":"tsd-kind-interface"},{"id":909,"kind":1024,"name":"result","url":"interfaces/TransactionEntryResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"TransactionEntryResponse"},{"id":910,"kind":65536,"name":"__type","url":"interfaces/TransactionEntryResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"TransactionEntryResponse"},{"id":911,"kind":1024,"name":"ledger_hash","url":"interfaces/TransactionEntryResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"TransactionEntryResponse.__type"},{"id":912,"kind":1024,"name":"ledger_index","url":"interfaces/TransactionEntryResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"TransactionEntryResponse.__type"},{"id":913,"kind":1024,"name":"metadata","url":"interfaces/TransactionEntryResponse.html#__type.metadata","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"TransactionEntryResponse.__type"},{"id":914,"kind":1024,"name":"tx_json","url":"interfaces/TransactionEntryResponse.html#__type.tx_json","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"TransactionEntryResponse.__type"},{"id":915,"kind":1024,"name":"id","url":"interfaces/TransactionEntryResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryResponse"},{"id":916,"kind":1024,"name":"status","url":"interfaces/TransactionEntryResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryResponse"},{"id":917,"kind":1024,"name":"type","url":"interfaces/TransactionEntryResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryResponse"},{"id":918,"kind":1024,"name":"warning","url":"interfaces/TransactionEntryResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryResponse"},{"id":919,"kind":1024,"name":"warnings","url":"interfaces/TransactionEntryResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryResponse"},{"id":920,"kind":1024,"name":"forwarded","url":"interfaces/TransactionEntryResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryResponse"},{"id":921,"kind":1024,"name":"error","url":"interfaces/TransactionEntryResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryResponse"},{"id":922,"kind":1024,"name":"error_message","url":"interfaces/TransactionEntryResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryResponse"},{"id":923,"kind":1024,"name":"request","url":"interfaces/TransactionEntryResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryResponse"},{"id":924,"kind":1024,"name":"api_version","url":"interfaces/TransactionEntryResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TransactionEntryResponse"},{"id":925,"kind":256,"name":"TxRequest","url":"interfaces/TxRequest.html","classes":"tsd-kind-interface"},{"id":926,"kind":1024,"name":"command","url":"interfaces/TxRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"TxRequest"},{"id":927,"kind":1024,"name":"transaction","url":"interfaces/TxRequest.html#transaction","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TxRequest"},{"id":928,"kind":1024,"name":"binary","url":"interfaces/TxRequest.html#binary","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TxRequest"},{"id":929,"kind":1024,"name":"min_ledger","url":"interfaces/TxRequest.html#min_ledger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TxRequest"},{"id":930,"kind":1024,"name":"max_ledger","url":"interfaces/TxRequest.html#max_ledger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TxRequest"},{"id":931,"kind":1024,"name":"id","url":"interfaces/TxRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxRequest"},{"id":932,"kind":1024,"name":"api_version","url":"interfaces/TxRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxRequest"},{"id":933,"kind":256,"name":"TxResponse","url":"interfaces/TxResponse.html","classes":"tsd-kind-interface"},{"id":934,"kind":1024,"name":"result","url":"interfaces/TxResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"TxResponse"},{"id":935,"kind":1024,"name":"searched_all","url":"interfaces/TxResponse.html#searched_all","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TxResponse"},{"id":936,"kind":1024,"name":"id","url":"interfaces/TxResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxResponse"},{"id":937,"kind":1024,"name":"status","url":"interfaces/TxResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxResponse"},{"id":938,"kind":1024,"name":"type","url":"interfaces/TxResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxResponse"},{"id":939,"kind":1024,"name":"warning","url":"interfaces/TxResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxResponse"},{"id":940,"kind":1024,"name":"warnings","url":"interfaces/TxResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxResponse"},{"id":941,"kind":1024,"name":"forwarded","url":"interfaces/TxResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxResponse"},{"id":942,"kind":1024,"name":"error","url":"interfaces/TxResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxResponse"},{"id":943,"kind":1024,"name":"error_message","url":"interfaces/TxResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxResponse"},{"id":944,"kind":1024,"name":"request","url":"interfaces/TxResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxResponse"},{"id":945,"kind":1024,"name":"api_version","url":"interfaces/TxResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TxResponse"},{"id":946,"kind":256,"name":"BookOffersRequest","url":"interfaces/BookOffersRequest.html","classes":"tsd-kind-interface"},{"id":947,"kind":1024,"name":"command","url":"interfaces/BookOffersRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"BookOffersRequest"},{"id":948,"kind":1024,"name":"ledger_hash","url":"interfaces/BookOffersRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"BookOffersRequest"},{"id":949,"kind":1024,"name":"ledger_index","url":"interfaces/BookOffersRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"BookOffersRequest"},{"id":950,"kind":1024,"name":"limit","url":"interfaces/BookOffersRequest.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"BookOffersRequest"},{"id":951,"kind":1024,"name":"taker","url":"interfaces/BookOffersRequest.html#taker","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"BookOffersRequest"},{"id":952,"kind":1024,"name":"taker_gets","url":"interfaces/BookOffersRequest.html#taker_gets","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"BookOffersRequest"},{"id":953,"kind":1024,"name":"taker_pays","url":"interfaces/BookOffersRequest.html#taker_pays","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"BookOffersRequest"},{"id":954,"kind":1024,"name":"id","url":"interfaces/BookOffersRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersRequest"},{"id":955,"kind":1024,"name":"api_version","url":"interfaces/BookOffersRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersRequest"},{"id":956,"kind":256,"name":"BookOffersResponse","url":"interfaces/BookOffersResponse.html","classes":"tsd-kind-interface"},{"id":957,"kind":1024,"name":"result","url":"interfaces/BookOffersResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"BookOffersResponse"},{"id":958,"kind":65536,"name":"__type","url":"interfaces/BookOffersResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"BookOffersResponse"},{"id":959,"kind":1024,"name":"ledger_current_index","url":"interfaces/BookOffersResponse.html#__type.ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BookOffersResponse.__type"},{"id":960,"kind":1024,"name":"ledger_index","url":"interfaces/BookOffersResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BookOffersResponse.__type"},{"id":961,"kind":1024,"name":"ledger_hash","url":"interfaces/BookOffersResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BookOffersResponse.__type"},{"id":962,"kind":1024,"name":"offers","url":"interfaces/BookOffersResponse.html#__type.offers","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BookOffersResponse.__type"},{"id":963,"kind":1024,"name":"id","url":"interfaces/BookOffersResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersResponse"},{"id":964,"kind":1024,"name":"status","url":"interfaces/BookOffersResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersResponse"},{"id":965,"kind":1024,"name":"type","url":"interfaces/BookOffersResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersResponse"},{"id":966,"kind":1024,"name":"warning","url":"interfaces/BookOffersResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersResponse"},{"id":967,"kind":1024,"name":"warnings","url":"interfaces/BookOffersResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersResponse"},{"id":968,"kind":1024,"name":"forwarded","url":"interfaces/BookOffersResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersResponse"},{"id":969,"kind":1024,"name":"error","url":"interfaces/BookOffersResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersResponse"},{"id":970,"kind":1024,"name":"error_message","url":"interfaces/BookOffersResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersResponse"},{"id":971,"kind":1024,"name":"request","url":"interfaces/BookOffersResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersResponse"},{"id":972,"kind":1024,"name":"api_version","url":"interfaces/BookOffersResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"BookOffersResponse"},{"id":973,"kind":256,"name":"DepositAuthorizedRequest","url":"interfaces/DepositAuthorizedRequest.html","classes":"tsd-kind-interface"},{"id":974,"kind":1024,"name":"command","url":"interfaces/DepositAuthorizedRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"DepositAuthorizedRequest"},{"id":975,"kind":1024,"name":"source_account","url":"interfaces/DepositAuthorizedRequest.html#source_account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DepositAuthorizedRequest"},{"id":976,"kind":1024,"name":"destination_account","url":"interfaces/DepositAuthorizedRequest.html#destination_account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DepositAuthorizedRequest"},{"id":977,"kind":1024,"name":"ledger_hash","url":"interfaces/DepositAuthorizedRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DepositAuthorizedRequest"},{"id":978,"kind":1024,"name":"ledger_index","url":"interfaces/DepositAuthorizedRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DepositAuthorizedRequest"},{"id":979,"kind":1024,"name":"id","url":"interfaces/DepositAuthorizedRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedRequest"},{"id":980,"kind":1024,"name":"api_version","url":"interfaces/DepositAuthorizedRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedRequest"},{"id":981,"kind":256,"name":"DepositAuthorizedResponse","url":"interfaces/DepositAuthorizedResponse.html","classes":"tsd-kind-interface"},{"id":982,"kind":1024,"name":"result","url":"interfaces/DepositAuthorizedResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"DepositAuthorizedResponse"},{"id":983,"kind":65536,"name":"__type","url":"interfaces/DepositAuthorizedResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"DepositAuthorizedResponse"},{"id":984,"kind":1024,"name":"deposit_authorized","url":"interfaces/DepositAuthorizedResponse.html#__type.deposit_authorized","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"DepositAuthorizedResponse.__type"},{"id":985,"kind":1024,"name":"destination_account","url":"interfaces/DepositAuthorizedResponse.html#__type.destination_account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"DepositAuthorizedResponse.__type"},{"id":986,"kind":1024,"name":"ledger_hash","url":"interfaces/DepositAuthorizedResponse.html#__type.ledger_hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"DepositAuthorizedResponse.__type"},{"id":987,"kind":1024,"name":"ledger_index","url":"interfaces/DepositAuthorizedResponse.html#__type.ledger_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"DepositAuthorizedResponse.__type"},{"id":988,"kind":1024,"name":"ledger_current_index","url":"interfaces/DepositAuthorizedResponse.html#__type.ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"DepositAuthorizedResponse.__type"},{"id":989,"kind":1024,"name":"source_account","url":"interfaces/DepositAuthorizedResponse.html#__type.source_account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"DepositAuthorizedResponse.__type"},{"id":990,"kind":1024,"name":"validated","url":"interfaces/DepositAuthorizedResponse.html#__type.validated","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"DepositAuthorizedResponse.__type"},{"id":991,"kind":1024,"name":"id","url":"interfaces/DepositAuthorizedResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedResponse"},{"id":992,"kind":1024,"name":"status","url":"interfaces/DepositAuthorizedResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedResponse"},{"id":993,"kind":1024,"name":"type","url":"interfaces/DepositAuthorizedResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedResponse"},{"id":994,"kind":1024,"name":"warning","url":"interfaces/DepositAuthorizedResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedResponse"},{"id":995,"kind":1024,"name":"warnings","url":"interfaces/DepositAuthorizedResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedResponse"},{"id":996,"kind":1024,"name":"forwarded","url":"interfaces/DepositAuthorizedResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedResponse"},{"id":997,"kind":1024,"name":"error","url":"interfaces/DepositAuthorizedResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedResponse"},{"id":998,"kind":1024,"name":"error_message","url":"interfaces/DepositAuthorizedResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedResponse"},{"id":999,"kind":1024,"name":"request","url":"interfaces/DepositAuthorizedResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedResponse"},{"id":1000,"kind":1024,"name":"api_version","url":"interfaces/DepositAuthorizedResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DepositAuthorizedResponse"},{"id":1001,"kind":4194304,"name":"PathFindRequest","url":"modules.html#PathFindRequest","classes":"tsd-kind-type-alias"},{"id":1002,"kind":256,"name":"PathFindResponse","url":"interfaces/PathFindResponse.html","classes":"tsd-kind-interface"},{"id":1003,"kind":1024,"name":"result","url":"interfaces/PathFindResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"PathFindResponse"},{"id":1004,"kind":65536,"name":"__type","url":"interfaces/PathFindResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"PathFindResponse"},{"id":1005,"kind":1024,"name":"alternatives","url":"interfaces/PathFindResponse.html#__type.alternatives","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"PathFindResponse.__type"},{"id":1006,"kind":1024,"name":"destination_account","url":"interfaces/PathFindResponse.html#__type.destination_account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"PathFindResponse.__type"},{"id":1007,"kind":1024,"name":"destination_amount","url":"interfaces/PathFindResponse.html#__type.destination_amount","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"PathFindResponse.__type"},{"id":1008,"kind":1024,"name":"source_account","url":"interfaces/PathFindResponse.html#__type.source_account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"PathFindResponse.__type"},{"id":1009,"kind":1024,"name":"full_reply","url":"interfaces/PathFindResponse.html#__type.full_reply","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"PathFindResponse.__type"},{"id":1010,"kind":1024,"name":"id","url":"interfaces/PathFindResponse.html#__type.id-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"PathFindResponse.__type"},{"id":1011,"kind":1024,"name":"closed","url":"interfaces/PathFindResponse.html#__type.closed","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"PathFindResponse.__type"},{"id":1012,"kind":1024,"name":"status","url":"interfaces/PathFindResponse.html#__type.status","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"PathFindResponse.__type"},{"id":1013,"kind":1024,"name":"id","url":"interfaces/PathFindResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PathFindResponse"},{"id":1014,"kind":1024,"name":"status","url":"interfaces/PathFindResponse.html#status-1","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PathFindResponse"},{"id":1015,"kind":1024,"name":"type","url":"interfaces/PathFindResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PathFindResponse"},{"id":1016,"kind":1024,"name":"warning","url":"interfaces/PathFindResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PathFindResponse"},{"id":1017,"kind":1024,"name":"warnings","url":"interfaces/PathFindResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PathFindResponse"},{"id":1018,"kind":1024,"name":"forwarded","url":"interfaces/PathFindResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PathFindResponse"},{"id":1019,"kind":1024,"name":"error","url":"interfaces/PathFindResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PathFindResponse"},{"id":1020,"kind":1024,"name":"error_message","url":"interfaces/PathFindResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PathFindResponse"},{"id":1021,"kind":1024,"name":"request","url":"interfaces/PathFindResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PathFindResponse"},{"id":1022,"kind":1024,"name":"api_version","url":"interfaces/PathFindResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PathFindResponse"},{"id":1023,"kind":256,"name":"RipplePathFindRequest","url":"interfaces/RipplePathFindRequest.html","classes":"tsd-kind-interface"},{"id":1024,"kind":1024,"name":"command","url":"interfaces/RipplePathFindRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"RipplePathFindRequest"},{"id":1025,"kind":1024,"name":"source_account","url":"interfaces/RipplePathFindRequest.html#source_account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RipplePathFindRequest"},{"id":1026,"kind":1024,"name":"destination_account","url":"interfaces/RipplePathFindRequest.html#destination_account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RipplePathFindRequest"},{"id":1027,"kind":1024,"name":"destination_amount","url":"interfaces/RipplePathFindRequest.html#destination_amount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RipplePathFindRequest"},{"id":1028,"kind":1024,"name":"send_max","url":"interfaces/RipplePathFindRequest.html#send_max","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RipplePathFindRequest"},{"id":1029,"kind":1024,"name":"source_currencies","url":"interfaces/RipplePathFindRequest.html#source_currencies","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RipplePathFindRequest"},{"id":1030,"kind":1024,"name":"ledger_hash","url":"interfaces/RipplePathFindRequest.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RipplePathFindRequest"},{"id":1031,"kind":1024,"name":"ledger_index","url":"interfaces/RipplePathFindRequest.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RipplePathFindRequest"},{"id":1032,"kind":1024,"name":"id","url":"interfaces/RipplePathFindRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindRequest"},{"id":1033,"kind":1024,"name":"api_version","url":"interfaces/RipplePathFindRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindRequest"},{"id":1034,"kind":256,"name":"RipplePathFindResponse","url":"interfaces/RipplePathFindResponse.html","classes":"tsd-kind-interface"},{"id":1035,"kind":1024,"name":"result","url":"interfaces/RipplePathFindResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"RipplePathFindResponse"},{"id":1036,"kind":65536,"name":"__type","url":"interfaces/RipplePathFindResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"RipplePathFindResponse"},{"id":1037,"kind":1024,"name":"alternatives","url":"interfaces/RipplePathFindResponse.html#__type.alternatives","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"RipplePathFindResponse.__type"},{"id":1038,"kind":1024,"name":"destination_account","url":"interfaces/RipplePathFindResponse.html#__type.destination_account","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"RipplePathFindResponse.__type"},{"id":1039,"kind":1024,"name":"destination_currencies","url":"interfaces/RipplePathFindResponse.html#__type.destination_currencies","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"RipplePathFindResponse.__type"},{"id":1040,"kind":1024,"name":"id","url":"interfaces/RipplePathFindResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindResponse"},{"id":1041,"kind":1024,"name":"status","url":"interfaces/RipplePathFindResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindResponse"},{"id":1042,"kind":1024,"name":"type","url":"interfaces/RipplePathFindResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindResponse"},{"id":1043,"kind":1024,"name":"warning","url":"interfaces/RipplePathFindResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindResponse"},{"id":1044,"kind":1024,"name":"warnings","url":"interfaces/RipplePathFindResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindResponse"},{"id":1045,"kind":1024,"name":"forwarded","url":"interfaces/RipplePathFindResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindResponse"},{"id":1046,"kind":1024,"name":"error","url":"interfaces/RipplePathFindResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindResponse"},{"id":1047,"kind":1024,"name":"error_message","url":"interfaces/RipplePathFindResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindResponse"},{"id":1048,"kind":1024,"name":"request","url":"interfaces/RipplePathFindResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindResponse"},{"id":1049,"kind":1024,"name":"api_version","url":"interfaces/RipplePathFindResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RipplePathFindResponse"},{"id":1050,"kind":256,"name":"ChannelVerifyRequest","url":"interfaces/ChannelVerifyRequest.html","classes":"tsd-kind-interface"},{"id":1051,"kind":1024,"name":"command","url":"interfaces/ChannelVerifyRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"ChannelVerifyRequest"},{"id":1052,"kind":1024,"name":"amount","url":"interfaces/ChannelVerifyRequest.html#amount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChannelVerifyRequest"},{"id":1053,"kind":1024,"name":"channel_id","url":"interfaces/ChannelVerifyRequest.html#channel_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChannelVerifyRequest"},{"id":1054,"kind":1024,"name":"public_key","url":"interfaces/ChannelVerifyRequest.html#public_key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChannelVerifyRequest"},{"id":1055,"kind":1024,"name":"signature","url":"interfaces/ChannelVerifyRequest.html#signature","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ChannelVerifyRequest"},{"id":1056,"kind":1024,"name":"id","url":"interfaces/ChannelVerifyRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyRequest"},{"id":1057,"kind":1024,"name":"api_version","url":"interfaces/ChannelVerifyRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyRequest"},{"id":1058,"kind":256,"name":"ChannelVerifyResponse","url":"interfaces/ChannelVerifyResponse.html","classes":"tsd-kind-interface"},{"id":1059,"kind":1024,"name":"result","url":"interfaces/ChannelVerifyResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"ChannelVerifyResponse"},{"id":1060,"kind":65536,"name":"__type","url":"interfaces/ChannelVerifyResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"ChannelVerifyResponse"},{"id":1061,"kind":1024,"name":"signature_verified","url":"interfaces/ChannelVerifyResponse.html#__type.signature_verified","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ChannelVerifyResponse.__type"},{"id":1062,"kind":1024,"name":"id","url":"interfaces/ChannelVerifyResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyResponse"},{"id":1063,"kind":1024,"name":"status","url":"interfaces/ChannelVerifyResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyResponse"},{"id":1064,"kind":1024,"name":"type","url":"interfaces/ChannelVerifyResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyResponse"},{"id":1065,"kind":1024,"name":"warning","url":"interfaces/ChannelVerifyResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyResponse"},{"id":1066,"kind":1024,"name":"warnings","url":"interfaces/ChannelVerifyResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyResponse"},{"id":1067,"kind":1024,"name":"forwarded","url":"interfaces/ChannelVerifyResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyResponse"},{"id":1068,"kind":1024,"name":"error","url":"interfaces/ChannelVerifyResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyResponse"},{"id":1069,"kind":1024,"name":"error_message","url":"interfaces/ChannelVerifyResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyResponse"},{"id":1070,"kind":1024,"name":"request","url":"interfaces/ChannelVerifyResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyResponse"},{"id":1071,"kind":1024,"name":"api_version","url":"interfaces/ChannelVerifyResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ChannelVerifyResponse"},{"id":1072,"kind":256,"name":"SubscribeRequest","url":"interfaces/SubscribeRequest.html","classes":"tsd-kind-interface"},{"id":1073,"kind":1024,"name":"command","url":"interfaces/SubscribeRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"SubscribeRequest"},{"id":1074,"kind":1024,"name":"streams","url":"interfaces/SubscribeRequest.html#streams","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubscribeRequest"},{"id":1075,"kind":1024,"name":"accounts","url":"interfaces/SubscribeRequest.html#accounts","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubscribeRequest"},{"id":1076,"kind":1024,"name":"accounts_proposed","url":"interfaces/SubscribeRequest.html#accounts_proposed","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubscribeRequest"},{"id":1077,"kind":1024,"name":"books","url":"interfaces/SubscribeRequest.html#books","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubscribeRequest"},{"id":1078,"kind":1024,"name":"url","url":"interfaces/SubscribeRequest.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubscribeRequest"},{"id":1079,"kind":1024,"name":"url_username","url":"interfaces/SubscribeRequest.html#url_username","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubscribeRequest"},{"id":1080,"kind":1024,"name":"url_password","url":"interfaces/SubscribeRequest.html#url_password","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SubscribeRequest"},{"id":1081,"kind":1024,"name":"id","url":"interfaces/SubscribeRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeRequest"},{"id":1082,"kind":1024,"name":"api_version","url":"interfaces/SubscribeRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeRequest"},{"id":1083,"kind":256,"name":"SubscribeResponse","url":"interfaces/SubscribeResponse.html","classes":"tsd-kind-interface"},{"id":1084,"kind":1024,"name":"result","url":"interfaces/SubscribeResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"SubscribeResponse"},{"id":1085,"kind":1024,"name":"id","url":"interfaces/SubscribeResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeResponse"},{"id":1086,"kind":1024,"name":"status","url":"interfaces/SubscribeResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeResponse"},{"id":1087,"kind":1024,"name":"type","url":"interfaces/SubscribeResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeResponse"},{"id":1088,"kind":1024,"name":"warning","url":"interfaces/SubscribeResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeResponse"},{"id":1089,"kind":1024,"name":"warnings","url":"interfaces/SubscribeResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeResponse"},{"id":1090,"kind":1024,"name":"forwarded","url":"interfaces/SubscribeResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeResponse"},{"id":1091,"kind":1024,"name":"error","url":"interfaces/SubscribeResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeResponse"},{"id":1092,"kind":1024,"name":"error_message","url":"interfaces/SubscribeResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeResponse"},{"id":1093,"kind":1024,"name":"request","url":"interfaces/SubscribeResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeResponse"},{"id":1094,"kind":1024,"name":"api_version","url":"interfaces/SubscribeResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SubscribeResponse"},{"id":1095,"kind":4194304,"name":"Stream","url":"modules.html#Stream","classes":"tsd-kind-type-alias"},{"id":1096,"kind":256,"name":"LedgerStream","url":"interfaces/LedgerStream.html","classes":"tsd-kind-interface"},{"id":1097,"kind":1024,"name":"type","url":"interfaces/LedgerStream.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"LedgerStream"},{"id":1098,"kind":1024,"name":"fee_base","url":"interfaces/LedgerStream.html#fee_base","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerStream"},{"id":1099,"kind":1024,"name":"fee_ref","url":"interfaces/LedgerStream.html#fee_ref","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerStream"},{"id":1100,"kind":1024,"name":"ledger_hash","url":"interfaces/LedgerStream.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerStream"},{"id":1101,"kind":1024,"name":"ledger_index","url":"interfaces/LedgerStream.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerStream"},{"id":1102,"kind":1024,"name":"ledger_time","url":"interfaces/LedgerStream.html#ledger_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerStream"},{"id":1103,"kind":1024,"name":"reserve_base","url":"interfaces/LedgerStream.html#reserve_base","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerStream"},{"id":1104,"kind":1024,"name":"reserve_inc","url":"interfaces/LedgerStream.html#reserve_inc","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerStream"},{"id":1105,"kind":1024,"name":"txn_count","url":"interfaces/LedgerStream.html#txn_count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerStream"},{"id":1106,"kind":1024,"name":"validated_ledgers","url":"interfaces/LedgerStream.html#validated_ledgers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LedgerStream"},{"id":1107,"kind":256,"name":"ValidationStream","url":"interfaces/ValidationStream.html","classes":"tsd-kind-interface"},{"id":1108,"kind":1024,"name":"type","url":"interfaces/ValidationStream.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"ValidationStream"},{"id":1109,"kind":1024,"name":"amendments","url":"interfaces/ValidationStream.html#amendments","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1110,"kind":1024,"name":"base_fee","url":"interfaces/ValidationStream.html#base_fee","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1111,"kind":1024,"name":"flags","url":"interfaces/ValidationStream.html#flags","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1112,"kind":1024,"name":"full","url":"interfaces/ValidationStream.html#full","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1113,"kind":1024,"name":"ledger_hash","url":"interfaces/ValidationStream.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1114,"kind":1024,"name":"ledger_index","url":"interfaces/ValidationStream.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1115,"kind":1024,"name":"load_fee","url":"interfaces/ValidationStream.html#load_fee","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1116,"kind":1024,"name":"master_key","url":"interfaces/ValidationStream.html#master_key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1117,"kind":1024,"name":"reserve_base","url":"interfaces/ValidationStream.html#reserve_base","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1118,"kind":1024,"name":"reserve_inc","url":"interfaces/ValidationStream.html#reserve_inc","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1119,"kind":1024,"name":"signature","url":"interfaces/ValidationStream.html#signature","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1120,"kind":1024,"name":"signing_time","url":"interfaces/ValidationStream.html#signing_time","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1121,"kind":1024,"name":"validation_public_key","url":"interfaces/ValidationStream.html#validation_public_key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ValidationStream"},{"id":1122,"kind":256,"name":"TransactionStream","url":"interfaces/TransactionStream.html","classes":"tsd-kind-interface"},{"id":1123,"kind":1024,"name":"status","url":"interfaces/TransactionStream.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionStream"},{"id":1124,"kind":1024,"name":"type","url":"interfaces/TransactionStream.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"TransactionStream"},{"id":1125,"kind":1024,"name":"engine_result","url":"interfaces/TransactionStream.html#engine_result","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionStream"},{"id":1126,"kind":1024,"name":"engine_result_code","url":"interfaces/TransactionStream.html#engine_result_code","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionStream"},{"id":1127,"kind":1024,"name":"engine_result_message","url":"interfaces/TransactionStream.html#engine_result_message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionStream"},{"id":1128,"kind":1024,"name":"ledger_current_index","url":"interfaces/TransactionStream.html#ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionStream"},{"id":1129,"kind":1024,"name":"ledger_hash","url":"interfaces/TransactionStream.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionStream"},{"id":1130,"kind":1024,"name":"ledger_index","url":"interfaces/TransactionStream.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionStream"},{"id":1131,"kind":1024,"name":"meta","url":"interfaces/TransactionStream.html#meta","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionStream"},{"id":1132,"kind":1024,"name":"transaction","url":"interfaces/TransactionStream.html#transaction","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionStream"},{"id":1133,"kind":1024,"name":"validated","url":"interfaces/TransactionStream.html#validated","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TransactionStream"},{"id":1134,"kind":256,"name":"PathFindStream","url":"interfaces/PathFindStream.html","classes":"tsd-kind-interface"},{"id":1135,"kind":1024,"name":"type","url":"interfaces/PathFindStream.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"PathFindStream"},{"id":1136,"kind":1024,"name":"source_account","url":"interfaces/PathFindStream.html#source_account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PathFindStream"},{"id":1137,"kind":1024,"name":"destination_account","url":"interfaces/PathFindStream.html#destination_account","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PathFindStream"},{"id":1138,"kind":1024,"name":"destination_amount","url":"interfaces/PathFindStream.html#destination_amount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PathFindStream"},{"id":1139,"kind":1024,"name":"full_reply","url":"interfaces/PathFindStream.html#full_reply","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PathFindStream"},{"id":1140,"kind":1024,"name":"id","url":"interfaces/PathFindStream.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PathFindStream"},{"id":1141,"kind":1024,"name":"send_max","url":"interfaces/PathFindStream.html#send_max","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PathFindStream"},{"id":1142,"kind":1024,"name":"alternatives","url":"interfaces/PathFindStream.html#alternatives","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PathFindStream"},{"id":1143,"kind":65536,"name":"__type","url":"interfaces/PathFindStream.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"PathFindStream"},{"id":1144,"kind":1024,"name":"paths_computed","url":"interfaces/PathFindStream.html#__type.paths_computed","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"PathFindStream.__type"},{"id":1145,"kind":1024,"name":"source_amount","url":"interfaces/PathFindStream.html#__type.source_amount","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"PathFindStream.__type"},{"id":1146,"kind":256,"name":"PeerStatusStream","url":"interfaces/PeerStatusStream.html","classes":"tsd-kind-interface"},{"id":1147,"kind":1024,"name":"type","url":"interfaces/PeerStatusStream.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"PeerStatusStream"},{"id":1148,"kind":1024,"name":"action","url":"interfaces/PeerStatusStream.html#action","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PeerStatusStream"},{"id":1149,"kind":1024,"name":"date","url":"interfaces/PeerStatusStream.html#date","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PeerStatusStream"},{"id":1150,"kind":1024,"name":"ledger_hash","url":"interfaces/PeerStatusStream.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PeerStatusStream"},{"id":1151,"kind":1024,"name":"ledger_index","url":"interfaces/PeerStatusStream.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PeerStatusStream"},{"id":1152,"kind":1024,"name":"ledger_index_max","url":"interfaces/PeerStatusStream.html#ledger_index_max","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PeerStatusStream"},{"id":1153,"kind":1024,"name":"ledger_index_min","url":"interfaces/PeerStatusStream.html#ledger_index_min","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"PeerStatusStream"},{"id":1154,"kind":256,"name":"OrderBookStream","url":"interfaces/OrderBookStream.html","classes":"tsd-kind-interface"},{"id":1155,"kind":1024,"name":"status","url":"interfaces/OrderBookStream.html#status","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OrderBookStream"},{"id":1156,"kind":1024,"name":"type","url":"interfaces/OrderBookStream.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"OrderBookStream"},{"id":1157,"kind":1024,"name":"engine_result","url":"interfaces/OrderBookStream.html#engine_result","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OrderBookStream"},{"id":1158,"kind":1024,"name":"engine_result_code","url":"interfaces/OrderBookStream.html#engine_result_code","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OrderBookStream"},{"id":1159,"kind":1024,"name":"engine_result_message","url":"interfaces/OrderBookStream.html#engine_result_message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OrderBookStream"},{"id":1160,"kind":1024,"name":"ledger_current_index","url":"interfaces/OrderBookStream.html#ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OrderBookStream"},{"id":1161,"kind":1024,"name":"ledger_hash","url":"interfaces/OrderBookStream.html#ledger_hash","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OrderBookStream"},{"id":1162,"kind":1024,"name":"ledger_index","url":"interfaces/OrderBookStream.html#ledger_index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OrderBookStream"},{"id":1163,"kind":1024,"name":"meta","url":"interfaces/OrderBookStream.html#meta","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OrderBookStream"},{"id":1164,"kind":1024,"name":"transaction","url":"interfaces/OrderBookStream.html#transaction","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OrderBookStream"},{"id":1165,"kind":1024,"name":"validated","url":"interfaces/OrderBookStream.html#validated","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"OrderBookStream"},{"id":1166,"kind":256,"name":"ConsensusStream","url":"interfaces/ConsensusStream.html","classes":"tsd-kind-interface"},{"id":1167,"kind":1024,"name":"type","url":"interfaces/ConsensusStream.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"ConsensusStream"},{"id":1168,"kind":1024,"name":"consensus","url":"interfaces/ConsensusStream.html#consensus","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ConsensusStream"},{"id":1169,"kind":256,"name":"UnsubscribeRequest","url":"interfaces/UnsubscribeRequest.html","classes":"tsd-kind-interface"},{"id":1170,"kind":1024,"name":"command","url":"interfaces/UnsubscribeRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"UnsubscribeRequest"},{"id":1171,"kind":1024,"name":"streams","url":"interfaces/UnsubscribeRequest.html#streams","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"UnsubscribeRequest"},{"id":1172,"kind":1024,"name":"accounts","url":"interfaces/UnsubscribeRequest.html#accounts","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"UnsubscribeRequest"},{"id":1173,"kind":1024,"name":"accounts_proposed","url":"interfaces/UnsubscribeRequest.html#accounts_proposed","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"UnsubscribeRequest"},{"id":1174,"kind":1024,"name":"books","url":"interfaces/UnsubscribeRequest.html#books","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"UnsubscribeRequest"},{"id":1175,"kind":1024,"name":"id","url":"interfaces/UnsubscribeRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeRequest"},{"id":1176,"kind":1024,"name":"api_version","url":"interfaces/UnsubscribeRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeRequest"},{"id":1177,"kind":256,"name":"UnsubscribeResponse","url":"interfaces/UnsubscribeResponse.html","classes":"tsd-kind-interface"},{"id":1178,"kind":1024,"name":"result","url":"interfaces/UnsubscribeResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"UnsubscribeResponse"},{"id":1179,"kind":65536,"name":"__type","url":"interfaces/UnsubscribeResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"UnsubscribeResponse"},{"id":1180,"kind":1024,"name":"id","url":"interfaces/UnsubscribeResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeResponse"},{"id":1181,"kind":1024,"name":"status","url":"interfaces/UnsubscribeResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeResponse"},{"id":1182,"kind":1024,"name":"type","url":"interfaces/UnsubscribeResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeResponse"},{"id":1183,"kind":1024,"name":"warning","url":"interfaces/UnsubscribeResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeResponse"},{"id":1184,"kind":1024,"name":"warnings","url":"interfaces/UnsubscribeResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeResponse"},{"id":1185,"kind":1024,"name":"forwarded","url":"interfaces/UnsubscribeResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeResponse"},{"id":1186,"kind":1024,"name":"error","url":"interfaces/UnsubscribeResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeResponse"},{"id":1187,"kind":1024,"name":"error_message","url":"interfaces/UnsubscribeResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeResponse"},{"id":1188,"kind":1024,"name":"request","url":"interfaces/UnsubscribeResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeResponse"},{"id":1189,"kind":1024,"name":"api_version","url":"interfaces/UnsubscribeResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"UnsubscribeResponse"},{"id":1190,"kind":256,"name":"FeeRequest","url":"interfaces/FeeRequest.html","classes":"tsd-kind-interface"},{"id":1191,"kind":1024,"name":"command","url":"interfaces/FeeRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"FeeRequest"},{"id":1192,"kind":1024,"name":"id","url":"interfaces/FeeRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeRequest"},{"id":1193,"kind":1024,"name":"api_version","url":"interfaces/FeeRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeRequest"},{"id":1194,"kind":256,"name":"FeeResponse","url":"interfaces/FeeResponse.html","classes":"tsd-kind-interface"},{"id":1195,"kind":1024,"name":"result","url":"interfaces/FeeResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"FeeResponse"},{"id":1196,"kind":65536,"name":"__type","url":"interfaces/FeeResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"FeeResponse"},{"id":1197,"kind":1024,"name":"current_ledger_size","url":"interfaces/FeeResponse.html#__type.current_ledger_size","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type"},{"id":1198,"kind":1024,"name":"current_queue_size","url":"interfaces/FeeResponse.html#__type.current_queue_size","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type"},{"id":1199,"kind":1024,"name":"drops","url":"interfaces/FeeResponse.html#__type.drops","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type"},{"id":1200,"kind":65536,"name":"__type","url":"interfaces/FeeResponse.html#__type.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"FeeResponse.__type"},{"id":1201,"kind":1024,"name":"base_fee","url":"interfaces/FeeResponse.html#__type.__type-1.base_fee","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type.__type"},{"id":1202,"kind":1024,"name":"median_fee","url":"interfaces/FeeResponse.html#__type.__type-1.median_fee","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type.__type"},{"id":1203,"kind":1024,"name":"minimum_fee","url":"interfaces/FeeResponse.html#__type.__type-1.minimum_fee","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type.__type"},{"id":1204,"kind":1024,"name":"open_ledger_fee","url":"interfaces/FeeResponse.html#__type.__type-1.open_ledger_fee","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type.__type"},{"id":1205,"kind":1024,"name":"expected_ledger_size","url":"interfaces/FeeResponse.html#__type.expected_ledger_size","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type"},{"id":1206,"kind":1024,"name":"ledger_current_index","url":"interfaces/FeeResponse.html#__type.ledger_current_index","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type"},{"id":1207,"kind":1024,"name":"levels","url":"interfaces/FeeResponse.html#__type.levels","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type"},{"id":1208,"kind":65536,"name":"__type","url":"interfaces/FeeResponse.html#__type.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"FeeResponse.__type"},{"id":1209,"kind":1024,"name":"median_level","url":"interfaces/FeeResponse.html#__type.__type-2.median_level","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type.__type"},{"id":1210,"kind":1024,"name":"minimum_level","url":"interfaces/FeeResponse.html#__type.__type-2.minimum_level","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type.__type"},{"id":1211,"kind":1024,"name":"open_ledger_level","url":"interfaces/FeeResponse.html#__type.__type-2.open_ledger_level","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type.__type"},{"id":1212,"kind":1024,"name":"reference_level","url":"interfaces/FeeResponse.html#__type.__type-2.reference_level","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type.__type"},{"id":1213,"kind":1024,"name":"max_queue_size","url":"interfaces/FeeResponse.html#__type.max_queue_size","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"FeeResponse.__type"},{"id":1214,"kind":1024,"name":"id","url":"interfaces/FeeResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeResponse"},{"id":1215,"kind":1024,"name":"status","url":"interfaces/FeeResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeResponse"},{"id":1216,"kind":1024,"name":"type","url":"interfaces/FeeResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeResponse"},{"id":1217,"kind":1024,"name":"warning","url":"interfaces/FeeResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeResponse"},{"id":1218,"kind":1024,"name":"warnings","url":"interfaces/FeeResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeResponse"},{"id":1219,"kind":1024,"name":"forwarded","url":"interfaces/FeeResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeResponse"},{"id":1220,"kind":1024,"name":"error","url":"interfaces/FeeResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeResponse"},{"id":1221,"kind":1024,"name":"error_message","url":"interfaces/FeeResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeResponse"},{"id":1222,"kind":1024,"name":"request","url":"interfaces/FeeResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeResponse"},{"id":1223,"kind":1024,"name":"api_version","url":"interfaces/FeeResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FeeResponse"},{"id":1224,"kind":256,"name":"ManifestRequest","url":"interfaces/ManifestRequest.html","classes":"tsd-kind-interface"},{"id":1225,"kind":1024,"name":"command","url":"interfaces/ManifestRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"ManifestRequest"},{"id":1226,"kind":1024,"name":"public_key","url":"interfaces/ManifestRequest.html#public_key","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ManifestRequest"},{"id":1227,"kind":1024,"name":"id","url":"interfaces/ManifestRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestRequest"},{"id":1228,"kind":1024,"name":"api_version","url":"interfaces/ManifestRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestRequest"},{"id":1229,"kind":256,"name":"ManifestResponse","url":"interfaces/ManifestResponse.html","classes":"tsd-kind-interface"},{"id":1230,"kind":1024,"name":"result","url":"interfaces/ManifestResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"ManifestResponse"},{"id":1231,"kind":65536,"name":"__type","url":"interfaces/ManifestResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"ManifestResponse"},{"id":1232,"kind":1024,"name":"details","url":"interfaces/ManifestResponse.html#__type.details","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ManifestResponse.__type"},{"id":1233,"kind":65536,"name":"__type","url":"interfaces/ManifestResponse.html#__type.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ManifestResponse.__type"},{"id":1234,"kind":1024,"name":"domain","url":"interfaces/ManifestResponse.html#__type.__type-1.domain","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ManifestResponse.__type.__type"},{"id":1235,"kind":1024,"name":"ephemeral_key","url":"interfaces/ManifestResponse.html#__type.__type-1.ephemeral_key","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ManifestResponse.__type.__type"},{"id":1236,"kind":1024,"name":"master_key","url":"interfaces/ManifestResponse.html#__type.__type-1.master_key","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ManifestResponse.__type.__type"},{"id":1237,"kind":1024,"name":"seq","url":"interfaces/ManifestResponse.html#__type.__type-1.seq","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ManifestResponse.__type.__type"},{"id":1238,"kind":1024,"name":"manifest","url":"interfaces/ManifestResponse.html#__type.manifest","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ManifestResponse.__type"},{"id":1239,"kind":1024,"name":"requested","url":"interfaces/ManifestResponse.html#__type.requested","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ManifestResponse.__type"},{"id":1240,"kind":1024,"name":"id","url":"interfaces/ManifestResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestResponse"},{"id":1241,"kind":1024,"name":"status","url":"interfaces/ManifestResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestResponse"},{"id":1242,"kind":1024,"name":"type","url":"interfaces/ManifestResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestResponse"},{"id":1243,"kind":1024,"name":"warning","url":"interfaces/ManifestResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestResponse"},{"id":1244,"kind":1024,"name":"warnings","url":"interfaces/ManifestResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestResponse"},{"id":1245,"kind":1024,"name":"forwarded","url":"interfaces/ManifestResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestResponse"},{"id":1246,"kind":1024,"name":"error","url":"interfaces/ManifestResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestResponse"},{"id":1247,"kind":1024,"name":"error_message","url":"interfaces/ManifestResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestResponse"},{"id":1248,"kind":1024,"name":"request","url":"interfaces/ManifestResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestResponse"},{"id":1249,"kind":1024,"name":"api_version","url":"interfaces/ManifestResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ManifestResponse"},{"id":1250,"kind":256,"name":"ServerInfoRequest","url":"interfaces/ServerInfoRequest.html","classes":"tsd-kind-interface"},{"id":1251,"kind":1024,"name":"command","url":"interfaces/ServerInfoRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"ServerInfoRequest"},{"id":1252,"kind":1024,"name":"id","url":"interfaces/ServerInfoRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoRequest"},{"id":1253,"kind":1024,"name":"api_version","url":"interfaces/ServerInfoRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoRequest"},{"id":1254,"kind":256,"name":"ServerInfoResponse","url":"interfaces/ServerInfoResponse.html","classes":"tsd-kind-interface"},{"id":1255,"kind":1024,"name":"result","url":"interfaces/ServerInfoResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"ServerInfoResponse"},{"id":1256,"kind":65536,"name":"__type","url":"interfaces/ServerInfoResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"ServerInfoResponse"},{"id":1257,"kind":1024,"name":"info","url":"interfaces/ServerInfoResponse.html#__type.info","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type"},{"id":1258,"kind":65536,"name":"__type","url":"interfaces/ServerInfoResponse.html#__type.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type"},{"id":1259,"kind":1024,"name":"amendment_blocked","url":"interfaces/ServerInfoResponse.html#__type.__type-1.amendment_blocked","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1260,"kind":1024,"name":"build_version","url":"interfaces/ServerInfoResponse.html#__type.__type-1.build_version","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1261,"kind":1024,"name":"closed_ledger","url":"interfaces/ServerInfoResponse.html#__type.__type-1.closed_ledger","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1262,"kind":65536,"name":"__type","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1263,"kind":1024,"name":"age","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-2.age","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1264,"kind":1024,"name":"base_fee_xrp","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-2.base_fee_xrp","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1265,"kind":1024,"name":"hash","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-2.hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1266,"kind":1024,"name":"reserve_base_xrp","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-2.reserve_base_xrp","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1267,"kind":1024,"name":"reserve_inc_xrp","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-2.reserve_inc_xrp","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1268,"kind":1024,"name":"seq","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-2.seq","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1269,"kind":1024,"name":"complete_ledgers","url":"interfaces/ServerInfoResponse.html#__type.__type-1.complete_ledgers","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1270,"kind":1024,"name":"hostid","url":"interfaces/ServerInfoResponse.html#__type.__type-1.hostid","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1271,"kind":1024,"name":"io_latency_ms","url":"interfaces/ServerInfoResponse.html#__type.__type-1.io_latency_ms","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1272,"kind":1024,"name":"jq_trans_overflow","url":"interfaces/ServerInfoResponse.html#__type.__type-1.jq_trans_overflow","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1273,"kind":1024,"name":"last_close","url":"interfaces/ServerInfoResponse.html#__type.__type-1.last_close","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1274,"kind":65536,"name":"__type","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1275,"kind":1024,"name":"converge_time_s","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-3.converge_time_s","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1276,"kind":1024,"name":"proposers","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-3.proposers","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1277,"kind":1024,"name":"load","url":"interfaces/ServerInfoResponse.html#__type.__type-1.load","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1278,"kind":65536,"name":"__type","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1279,"kind":1024,"name":"job_types","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-4.job_types","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1280,"kind":1024,"name":"threads","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-4.threads","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1281,"kind":1024,"name":"load_factor","url":"interfaces/ServerInfoResponse.html#__type.__type-1.load_factor","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1282,"kind":1024,"name":"load_factor_local","url":"interfaces/ServerInfoResponse.html#__type.__type-1.load_factor_local","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1283,"kind":1024,"name":"load_factor_net","url":"interfaces/ServerInfoResponse.html#__type.__type-1.load_factor_net","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1284,"kind":1024,"name":"load_factor_cluster","url":"interfaces/ServerInfoResponse.html#__type.__type-1.load_factor_cluster","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1285,"kind":1024,"name":"load_factor_fee_escalation","url":"interfaces/ServerInfoResponse.html#__type.__type-1.load_factor_fee_escalation","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1286,"kind":1024,"name":"load_factor_fee_queue","url":"interfaces/ServerInfoResponse.html#__type.__type-1.load_factor_fee_queue","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1287,"kind":1024,"name":"load_factor_server","url":"interfaces/ServerInfoResponse.html#__type.__type-1.load_factor_server","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1288,"kind":1024,"name":"network_ledger","url":"interfaces/ServerInfoResponse.html#__type.__type-1.network_ledger","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1289,"kind":1024,"name":"peers","url":"interfaces/ServerInfoResponse.html#__type.__type-1.peers","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1290,"kind":1024,"name":"pubkey_node","url":"interfaces/ServerInfoResponse.html#__type.__type-1.pubkey_node","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1291,"kind":1024,"name":"pubkey_validator","url":"interfaces/ServerInfoResponse.html#__type.__type-1.pubkey_validator","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1292,"kind":1024,"name":"server_state","url":"interfaces/ServerInfoResponse.html#__type.__type-1.server_state","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1293,"kind":1024,"name":"server_state_duration_us","url":"interfaces/ServerInfoResponse.html#__type.__type-1.server_state_duration_us","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1294,"kind":1024,"name":"state_accounting","url":"interfaces/ServerInfoResponse.html#__type.__type-1.state_accounting","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1295,"kind":1024,"name":"time","url":"interfaces/ServerInfoResponse.html#__type.__type-1.time","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1296,"kind":1024,"name":"uptime","url":"interfaces/ServerInfoResponse.html#__type.__type-1.uptime","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1297,"kind":1024,"name":"validated_ledger","url":"interfaces/ServerInfoResponse.html#__type.__type-1.validated_ledger","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1298,"kind":65536,"name":"__type","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1299,"kind":1024,"name":"age","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-5.age-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1300,"kind":1024,"name":"base_fee_xrp","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-5.base_fee_xrp-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1301,"kind":1024,"name":"hash","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-5.hash-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1302,"kind":1024,"name":"reserve_base_xrp","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-5.reserve_base_xrp-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1303,"kind":1024,"name":"reserve_inc_xrp","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-5.reserve_inc_xrp-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1304,"kind":1024,"name":"seq","url":"interfaces/ServerInfoResponse.html#__type.__type-1.__type-5.seq-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type.__type"},{"id":1305,"kind":1024,"name":"validation_quorum","url":"interfaces/ServerInfoResponse.html#__type.__type-1.validation_quorum","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1306,"kind":1024,"name":"validator_list_expires","url":"interfaces/ServerInfoResponse.html#__type.__type-1.validator_list_expires","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerInfoResponse.__type.__type"},{"id":1307,"kind":1024,"name":"id","url":"interfaces/ServerInfoResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoResponse"},{"id":1308,"kind":1024,"name":"status","url":"interfaces/ServerInfoResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoResponse"},{"id":1309,"kind":1024,"name":"type","url":"interfaces/ServerInfoResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoResponse"},{"id":1310,"kind":1024,"name":"warning","url":"interfaces/ServerInfoResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoResponse"},{"id":1311,"kind":1024,"name":"warnings","url":"interfaces/ServerInfoResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoResponse"},{"id":1312,"kind":1024,"name":"forwarded","url":"interfaces/ServerInfoResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoResponse"},{"id":1313,"kind":1024,"name":"error","url":"interfaces/ServerInfoResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoResponse"},{"id":1314,"kind":1024,"name":"error_message","url":"interfaces/ServerInfoResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoResponse"},{"id":1315,"kind":1024,"name":"request","url":"interfaces/ServerInfoResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoResponse"},{"id":1316,"kind":1024,"name":"api_version","url":"interfaces/ServerInfoResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerInfoResponse"},{"id":1317,"kind":256,"name":"ServerStateRequest","url":"interfaces/ServerStateRequest.html","classes":"tsd-kind-interface"},{"id":1318,"kind":1024,"name":"command","url":"interfaces/ServerStateRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"ServerStateRequest"},{"id":1319,"kind":1024,"name":"id","url":"interfaces/ServerStateRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateRequest"},{"id":1320,"kind":1024,"name":"api_version","url":"interfaces/ServerStateRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateRequest"},{"id":1321,"kind":256,"name":"ServerStateResponse","url":"interfaces/ServerStateResponse.html","classes":"tsd-kind-interface"},{"id":1322,"kind":1024,"name":"result","url":"interfaces/ServerStateResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"ServerStateResponse"},{"id":1323,"kind":65536,"name":"__type","url":"interfaces/ServerStateResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"ServerStateResponse"},{"id":1324,"kind":1024,"name":"state","url":"interfaces/ServerStateResponse.html#__type.state","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type"},{"id":1325,"kind":65536,"name":"__type","url":"interfaces/ServerStateResponse.html#__type.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type"},{"id":1326,"kind":1024,"name":"amendment_blocked","url":"interfaces/ServerStateResponse.html#__type.__type-1.amendment_blocked","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1327,"kind":1024,"name":"build_version","url":"interfaces/ServerStateResponse.html#__type.__type-1.build_version","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1328,"kind":1024,"name":"complete_ledgers","url":"interfaces/ServerStateResponse.html#__type.__type-1.complete_ledgers","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1329,"kind":1024,"name":"closed_ledger","url":"interfaces/ServerStateResponse.html#__type.__type-1.closed_ledger","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1330,"kind":65536,"name":"__type","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1331,"kind":1024,"name":"age","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-2.age","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1332,"kind":1024,"name":"base_fee","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-2.base_fee","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1333,"kind":1024,"name":"hash","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-2.hash","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1334,"kind":1024,"name":"reserve_base","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-2.reserve_base","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1335,"kind":1024,"name":"reserve_inc","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-2.reserve_inc","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1336,"kind":1024,"name":"seq","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-2.seq","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1337,"kind":1024,"name":"io_latency_ms","url":"interfaces/ServerStateResponse.html#__type.__type-1.io_latency_ms","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1338,"kind":1024,"name":"jq_trans_overflow","url":"interfaces/ServerStateResponse.html#__type.__type-1.jq_trans_overflow","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1339,"kind":1024,"name":"last_close","url":"interfaces/ServerStateResponse.html#__type.__type-1.last_close","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1340,"kind":65536,"name":"__type","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1341,"kind":1024,"name":"converge_time_s","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-3.converge_time_s","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1342,"kind":1024,"name":"proposers","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-3.proposers","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1343,"kind":1024,"name":"load","url":"interfaces/ServerStateResponse.html#__type.__type-1.load","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1344,"kind":65536,"name":"__type","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1345,"kind":1024,"name":"job_types","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-4.job_types","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1346,"kind":1024,"name":"threads","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-4.threads","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1347,"kind":1024,"name":"load_base","url":"interfaces/ServerStateResponse.html#__type.__type-1.load_base","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1348,"kind":1024,"name":"load_factor","url":"interfaces/ServerStateResponse.html#__type.__type-1.load_factor","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1349,"kind":1024,"name":"load_factor_fee_escalation","url":"interfaces/ServerStateResponse.html#__type.__type-1.load_factor_fee_escalation","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1350,"kind":1024,"name":"load_factor_fee_queue","url":"interfaces/ServerStateResponse.html#__type.__type-1.load_factor_fee_queue","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1351,"kind":1024,"name":"load_factor_fee_reference","url":"interfaces/ServerStateResponse.html#__type.__type-1.load_factor_fee_reference","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1352,"kind":1024,"name":"load_factor_server","url":"interfaces/ServerStateResponse.html#__type.__type-1.load_factor_server","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1353,"kind":1024,"name":"peers","url":"interfaces/ServerStateResponse.html#__type.__type-1.peers","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1354,"kind":1024,"name":"pubkey_node","url":"interfaces/ServerStateResponse.html#__type.__type-1.pubkey_node","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1355,"kind":1024,"name":"pubkey_validator","url":"interfaces/ServerStateResponse.html#__type.__type-1.pubkey_validator","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1356,"kind":1024,"name":"server_state","url":"interfaces/ServerStateResponse.html#__type.__type-1.server_state","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1357,"kind":1024,"name":"server_state_duration_us","url":"interfaces/ServerStateResponse.html#__type.__type-1.server_state_duration_us","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1358,"kind":1024,"name":"state_accounting","url":"interfaces/ServerStateResponse.html#__type.__type-1.state_accounting","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1359,"kind":1024,"name":"time","url":"interfaces/ServerStateResponse.html#__type.__type-1.time","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1360,"kind":1024,"name":"uptime","url":"interfaces/ServerStateResponse.html#__type.__type-1.uptime","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1361,"kind":1024,"name":"validated_ledger","url":"interfaces/ServerStateResponse.html#__type.__type-1.validated_ledger","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1362,"kind":65536,"name":"__type","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1363,"kind":1024,"name":"age","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-5.age-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1364,"kind":1024,"name":"base_fee","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-5.base_fee-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1365,"kind":1024,"name":"hash","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-5.hash-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1366,"kind":1024,"name":"reserve_base","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-5.reserve_base-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1367,"kind":1024,"name":"reserve_inc","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-5.reserve_inc-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1368,"kind":1024,"name":"seq","url":"interfaces/ServerStateResponse.html#__type.__type-1.__type-5.seq-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type.__type"},{"id":1369,"kind":1024,"name":"validation_quorum","url":"interfaces/ServerStateResponse.html#__type.__type-1.validation_quorum","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1370,"kind":1024,"name":"validator_list_expires","url":"interfaces/ServerStateResponse.html#__type.__type-1.validator_list_expires","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"ServerStateResponse.__type.__type"},{"id":1371,"kind":1024,"name":"id","url":"interfaces/ServerStateResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateResponse"},{"id":1372,"kind":1024,"name":"status","url":"interfaces/ServerStateResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateResponse"},{"id":1373,"kind":1024,"name":"type","url":"interfaces/ServerStateResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateResponse"},{"id":1374,"kind":1024,"name":"warning","url":"interfaces/ServerStateResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateResponse"},{"id":1375,"kind":1024,"name":"warnings","url":"interfaces/ServerStateResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateResponse"},{"id":1376,"kind":1024,"name":"forwarded","url":"interfaces/ServerStateResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateResponse"},{"id":1377,"kind":1024,"name":"error","url":"interfaces/ServerStateResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateResponse"},{"id":1378,"kind":1024,"name":"error_message","url":"interfaces/ServerStateResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateResponse"},{"id":1379,"kind":1024,"name":"request","url":"interfaces/ServerStateResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateResponse"},{"id":1380,"kind":1024,"name":"api_version","url":"interfaces/ServerStateResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ServerStateResponse"},{"id":1381,"kind":256,"name":"PingRequest","url":"interfaces/PingRequest.html","classes":"tsd-kind-interface"},{"id":1382,"kind":1024,"name":"command","url":"interfaces/PingRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"PingRequest"},{"id":1383,"kind":1024,"name":"id","url":"interfaces/PingRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingRequest"},{"id":1384,"kind":1024,"name":"api_version","url":"interfaces/PingRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingRequest"},{"id":1385,"kind":256,"name":"PingResponse","url":"interfaces/PingResponse.html","classes":"tsd-kind-interface"},{"id":1386,"kind":1024,"name":"result","url":"interfaces/PingResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"PingResponse"},{"id":1387,"kind":65536,"name":"__type","url":"interfaces/PingResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"PingResponse"},{"id":1388,"kind":1024,"name":"id","url":"interfaces/PingResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingResponse"},{"id":1389,"kind":1024,"name":"status","url":"interfaces/PingResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingResponse"},{"id":1390,"kind":1024,"name":"type","url":"interfaces/PingResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingResponse"},{"id":1391,"kind":1024,"name":"warning","url":"interfaces/PingResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingResponse"},{"id":1392,"kind":1024,"name":"warnings","url":"interfaces/PingResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingResponse"},{"id":1393,"kind":1024,"name":"forwarded","url":"interfaces/PingResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingResponse"},{"id":1394,"kind":1024,"name":"error","url":"interfaces/PingResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingResponse"},{"id":1395,"kind":1024,"name":"error_message","url":"interfaces/PingResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingResponse"},{"id":1396,"kind":1024,"name":"request","url":"interfaces/PingResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingResponse"},{"id":1397,"kind":1024,"name":"api_version","url":"interfaces/PingResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"PingResponse"},{"id":1398,"kind":256,"name":"RandomRequest","url":"interfaces/RandomRequest.html","classes":"tsd-kind-interface"},{"id":1399,"kind":1024,"name":"command","url":"interfaces/RandomRequest.html#command","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"RandomRequest"},{"id":1400,"kind":1024,"name":"id","url":"interfaces/RandomRequest.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomRequest"},{"id":1401,"kind":1024,"name":"api_version","url":"interfaces/RandomRequest.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomRequest"},{"id":1402,"kind":256,"name":"RandomResponse","url":"interfaces/RandomResponse.html","classes":"tsd-kind-interface"},{"id":1403,"kind":1024,"name":"result","url":"interfaces/RandomResponse.html#result","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"RandomResponse"},{"id":1404,"kind":65536,"name":"__type","url":"interfaces/RandomResponse.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"RandomResponse"},{"id":1405,"kind":1024,"name":"random","url":"interfaces/RandomResponse.html#__type.random","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"RandomResponse.__type"},{"id":1406,"kind":1024,"name":"id","url":"interfaces/RandomResponse.html#id","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomResponse"},{"id":1407,"kind":1024,"name":"status","url":"interfaces/RandomResponse.html#status","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomResponse"},{"id":1408,"kind":1024,"name":"type","url":"interfaces/RandomResponse.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomResponse"},{"id":1409,"kind":1024,"name":"warning","url":"interfaces/RandomResponse.html#warning","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomResponse"},{"id":1410,"kind":1024,"name":"warnings","url":"interfaces/RandomResponse.html#warnings","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomResponse"},{"id":1411,"kind":1024,"name":"forwarded","url":"interfaces/RandomResponse.html#forwarded","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomResponse"},{"id":1412,"kind":1024,"name":"error","url":"interfaces/RandomResponse.html#error","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomResponse"},{"id":1413,"kind":1024,"name":"error_message","url":"interfaces/RandomResponse.html#error_message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomResponse"},{"id":1414,"kind":1024,"name":"request","url":"interfaces/RandomResponse.html#request","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomResponse"},{"id":1415,"kind":1024,"name":"api_version","url":"interfaces/RandomResponse.html#api_version","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RandomResponse"},{"id":1416,"kind":64,"name":"computeLedgerHeaderHash","url":"modules.html#computeLedgerHeaderHash","classes":"tsd-kind-function"},{"id":1417,"kind":64,"name":"dropsToXrp","url":"modules.html#dropsToXrp","classes":"tsd-kind-function"},{"id":1418,"kind":64,"name":"xrpToDrops","url":"modules.html#xrpToDrops","classes":"tsd-kind-function"},{"id":1419,"kind":64,"name":"toRippledAmount","url":"modules.html#toRippledAmount","classes":"tsd-kind-function"},{"id":1420,"kind":64,"name":"convertKeysFromSnakeCaseToCamelCase","url":"modules.html#convertKeysFromSnakeCaseToCamelCase","classes":"tsd-kind-function"},{"id":1421,"kind":64,"name":"removeUndefined","url":"modules.html#removeUndefined","classes":"tsd-kind-function tsd-has-type-parameter"},{"id":1422,"kind":64,"name":"rippleTimeToISOTime","url":"modules.html#rippleTimeToISOTime","classes":"tsd-kind-function"},{"id":1423,"kind":64,"name":"ISOTimeToRippleTime","url":"modules.html#ISOTimeToRippleTime","classes":"tsd-kind-function"},{"id":1424,"kind":64,"name":"isValidSecret","url":"modules.html#isValidSecret","classes":"tsd-kind-function"},{"id":1425,"kind":64,"name":"computeBinaryTransactionHash","url":"modules.html#computeBinaryTransactionHash","classes":"tsd-kind-function"},{"id":1426,"kind":64,"name":"computeTransactionHash","url":"modules.html#computeTransactionHash","classes":"tsd-kind-function"},{"id":1427,"kind":64,"name":"computeBinaryTransactionSigningHash","url":"modules.html#computeBinaryTransactionSigningHash","classes":"tsd-kind-function"},{"id":1428,"kind":64,"name":"computeAccountRootIndex","url":"modules.html#computeAccountRootIndex","classes":"tsd-kind-function"},{"id":1429,"kind":64,"name":"computeSignerListIndex","url":"modules.html#computeSignerListIndex","classes":"tsd-kind-function"},{"id":1430,"kind":64,"name":"computeOfferIndex","url":"modules.html#computeOfferIndex","classes":"tsd-kind-function"},{"id":1431,"kind":64,"name":"computeTrustlineHash","url":"modules.html#computeTrustlineHash","classes":"tsd-kind-function"},{"id":1432,"kind":64,"name":"computeTransactionTreeHash","url":"modules.html#computeTransactionTreeHash","classes":"tsd-kind-function"},{"id":1433,"kind":64,"name":"computeStateTreeHash","url":"modules.html#computeStateTreeHash","classes":"tsd-kind-function"},{"id":1434,"kind":64,"name":"computeLedgerHash","url":"modules.html#computeLedgerHash","classes":"tsd-kind-function"},{"id":1435,"kind":64,"name":"computeEscrowHash","url":"modules.html#computeEscrowHash","classes":"tsd-kind-function"},{"id":1436,"kind":64,"name":"computePaymentChannelHash","url":"modules.html#computePaymentChannelHash","classes":"tsd-kind-function"},{"id":1437,"kind":64,"name":"generateXAddress","url":"modules.html#generateXAddress","classes":"tsd-kind-function"},{"id":1438,"kind":65536,"name":"__type","url":"modules.html#__type","classes":"tsd-kind-type-literal"},{"id":1439,"kind":65536,"name":"__type","url":"modules.html#__type","classes":"tsd-kind-type-literal"},{"id":1440,"kind":16777216,"name":"deriveXAddress","url":"modules.html#deriveXAddress","classes":"tsd-kind-reference"},{"id":1441,"kind":64,"name":"signPaymentChannelClaim","url":"modules.html#signPaymentChannelClaim","classes":"tsd-kind-function"},{"id":1442,"kind":64,"name":"verifyPaymentChannelClaim","url":"modules.html#verifyPaymentChannelClaim","classes":"tsd-kind-function"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,26.75]],["parent/0",[]],["name/1",[1,63.589]],["parent/1",[0,2.578]],["name/2",[2,60.224]],["parent/2",[0,2.578]],["name/3",[3,22.746]],["parent/3",[0,2.578]],["name/4",[4,63.589]],["parent/4",[0,2.578]],["name/5",[3,22.746]],["parent/5",[0,2.578]],["name/6",[5,63.589]],["parent/6",[0,2.578]],["name/7",[3,22.746]],["parent/7",[0,2.578]],["name/8",[6,63.589]],["parent/8",[0,2.578]],["name/9",[3,22.746]],["parent/9",[0,2.578]],["name/10",[7,63.589]],["parent/10",[0,2.578]],["name/11",[3,22.746]],["parent/11",[0,2.578]],["name/12",[8,63.589]],["parent/12",[0,2.578]],["name/13",[3,22.746]],["parent/13",[0,2.578]],["name/14",[9,63.589]],["parent/14",[0,2.578]],["name/15",[3,22.746]],["parent/15",[0,2.578]],["name/16",[10,63.589]],["parent/16",[0,2.578]],["name/17",[3,22.746]],["parent/17",[0,2.578]],["name/18",[11,63.589]],["parent/18",[0,2.578]],["name/19",[3,22.746]],["parent/19",[0,2.578]],["name/20",[12,63.589]],["parent/20",[0,2.578]],["name/21",[3,22.746]],["parent/21",[0,2.578]],["name/22",[13,63.589]],["parent/22",[0,2.578]],["name/23",[3,22.746]],["parent/23",[0,2.578]],["name/24",[14,63.589]],["parent/24",[0,2.578]],["name/25",[3,22.746]],["parent/25",[0,2.578]],["name/26",[15,63.589]],["parent/26",[0,2.578]],["name/27",[3,22.746]],["parent/27",[0,2.578]],["name/28",[16,63.589]],["parent/28",[0,2.578]],["name/29",[3,22.746]],["parent/29",[0,2.578]],["name/30",[17,63.589]],["parent/30",[0,2.578]],["name/31",[3,22.746]],["parent/31",[0,2.578]],["name/32",[18,63.589]],["parent/32",[0,2.578]],["name/33",[3,22.746]],["parent/33",[0,2.578]],["name/34",[19,63.589]],["parent/34",[0,2.578]],["name/35",[3,22.746]],["parent/35",[0,2.578]],["name/36",[20,63.589]],["parent/36",[0,2.578]],["name/37",[3,22.746]],["parent/37",[0,2.578]],["name/38",[21,63.589]],["parent/38",[22,4.055]],["name/39",[23,63.589]],["parent/39",[22,4.055]],["name/40",[24,63.589]],["parent/40",[22,4.055]],["name/41",[25,63.589]],["parent/41",[22,4.055]],["name/42",[26,63.589]],["parent/42",[22,4.055]],["name/43",[27,63.589]],["parent/43",[22,4.055]],["name/44",[28,63.589]],["parent/44",[22,4.055]],["name/45",[29,63.589]],["parent/45",[22,4.055]],["name/46",[30,63.589]],["parent/46",[22,4.055]],["name/47",[31,60.224]],["parent/47",[0,2.578]],["name/48",[32,63.589]],["parent/48",[0,2.578]],["name/49",[33,63.589]],["parent/49",[0,2.578]],["name/50",[34,63.589]],["parent/50",[0,2.578]],["name/51",[35,37.342]],["parent/51",[0,2.578]],["name/52",[36,63.589]],["parent/52",[0,2.578]],["name/53",[37,63.589]],["parent/53",[0,2.578]],["name/54",[38,63.589]],["parent/54",[0,2.578]],["name/55",[39,63.589]],["parent/55",[0,2.578]],["name/56",[40,63.589]],["parent/56",[0,2.578]],["name/57",[41,63.589]],["parent/57",[0,2.578]],["name/58",[42,63.589]],["parent/58",[0,2.578]],["name/59",[43,63.589]],["parent/59",[0,2.578]],["name/60",[3,22.746]],["parent/60",[0,2.578]],["name/61",[44,63.589]],["parent/61",[0,2.578]],["name/62",[3,22.746]],["parent/62",[0,2.578]],["name/63",[45,63.589]],["parent/63",[0,2.578]],["name/64",[3,22.746]],["parent/64",[0,2.578]],["name/65",[46,63.589]],["parent/65",[0,2.578]],["name/66",[3,22.746]],["parent/66",[0,2.578]],["name/67",[47,63.589]],["parent/67",[0,2.578]],["name/68",[3,22.746]],["parent/68",[0,2.578]],["name/69",[48,63.589]],["parent/69",[0,2.578]],["name/70",[3,22.746]],["parent/70",[0,2.578]],["name/71",[49,63.589]],["parent/71",[0,2.578]],["name/72",[3,22.746]],["parent/72",[0,2.578]],["name/73",[50,63.589]],["parent/73",[0,2.578]],["name/74",[3,22.746]],["parent/74",[0,2.578]],["name/75",[51,63.589]],["parent/75",[0,2.578]],["name/76",[3,22.746]],["parent/76",[0,2.578]],["name/77",[52,63.589]],["parent/77",[0,2.578]],["name/78",[3,22.746]],["parent/78",[0,2.578]],["name/79",[53,63.589]],["parent/79",[0,2.578]],["name/80",[3,22.746]],["parent/80",[0,2.578]],["name/81",[54,63.589]],["parent/81",[0,2.578]],["name/82",[3,22.746]],["parent/82",[0,2.578]],["name/83",[55,63.589]],["parent/83",[0,2.578]],["name/84",[3,22.746]],["parent/84",[0,2.578]],["name/85",[56,63.589]],["parent/85",[0,2.578]],["name/86",[3,22.746]],["parent/86",[0,2.578]],["name/87",[57,63.589]],["parent/87",[0,2.578]],["name/88",[3,22.746]],["parent/88",[0,2.578]],["name/89",[58,63.589]],["parent/89",[0,2.578]],["name/90",[3,22.746]],["parent/90",[0,2.578]],["name/91",[59,63.589]],["parent/91",[0,2.578]],["name/92",[3,22.746]],["parent/92",[0,2.578]],["name/93",[60,63.589]],["parent/93",[0,2.578]],["name/94",[3,22.746]],["parent/94",[0,2.578]],["name/95",[61,63.589]],["parent/95",[0,2.578]],["name/96",[3,22.746]],["parent/96",[0,2.578]],["name/97",[62,63.589]],["parent/97",[0,2.578]],["name/98",[3,22.746]],["parent/98",[0,2.578]],["name/99",[63,63.589]],["parent/99",[0,2.578]],["name/100",[3,22.746]],["parent/100",[0,2.578]],["name/101",[64,63.589]],["parent/101",[0,2.578]],["name/102",[3,22.746]],["parent/102",[0,2.578]],["name/103",[65,63.589]],["parent/103",[0,2.578]],["name/104",[3,22.746]],["parent/104",[0,2.578]],["name/105",[66,63.589]],["parent/105",[0,2.578]],["name/106",[67,63.589]],["parent/106",[0,2.578]],["name/107",[3,22.746]],["parent/107",[0,2.578]],["name/108",[68,63.589]],["parent/108",[22,4.055]],["name/109",[3,22.746]],["parent/109",[22,4.055]],["name/110",[69,63.589]],["parent/110",[70,4.011]],["name/111",[71,63.589]],["parent/111",[22,4.055]],["name/112",[3,22.746]],["parent/112",[22,4.055]],["name/113",[72,63.589]],["parent/113",[70,4.011]],["name/114",[73,63.589]],["parent/114",[70,4.011]],["name/115",[74,63.589]],["parent/115",[70,4.011]],["name/116",[75,63.589]],["parent/116",[70,4.011]],["name/117",[76,63.589]],["parent/117",[70,4.011]],["name/118",[77,63.589]],["parent/118",[70,4.011]],["name/119",[78,63.589]],["parent/119",[22,4.055]],["name/120",[3,22.746]],["parent/120",[22,4.055]],["name/121",[79,63.589]],["parent/121",[70,4.011]],["name/122",[80,63.589]],["parent/122",[70,4.011]],["name/123",[81,63.589]],["parent/123",[70,4.011]],["name/124",[82,63.589]],["parent/124",[70,4.011]],["name/125",[83,63.589]],["parent/125",[70,4.011]],["name/126",[84,63.589]],["parent/126",[70,4.011]],["name/127",[85,63.589]],["parent/127",[22,4.055]],["name/128",[3,22.746]],["parent/128",[22,4.055]],["name/129",[86,63.589]],["parent/129",[70,4.011]],["name/130",[87,63.589]],["parent/130",[70,4.011]],["name/131",[88,63.589]],["parent/131",[70,4.011]],["name/132",[89,63.589]],["parent/132",[70,4.011]],["name/133",[90,63.589]],["parent/133",[22,4.055]],["name/134",[3,22.746]],["parent/134",[22,4.055]],["name/135",[91,63.589]],["parent/135",[70,4.011]],["name/136",[92,63.589]],["parent/136",[70,4.011]],["name/137",[93,60.224]],["parent/137",[70,4.011]],["name/138",[94,63.589]],["parent/138",[22,4.055]],["name/139",[3,22.746]],["parent/139",[22,4.055]],["name/140",[95,63.589]],["parent/140",[70,4.011]],["name/141",[96,63.589]],["parent/141",[70,4.011]],["name/142",[97,26.551]],["parent/142",[]],["name/143",[1,63.589]],["parent/143",[97,2.559]],["name/144",[2,60.224]],["parent/144",[97,2.559]],["name/145",[3,22.746]],["parent/145",[97,2.559]],["name/146",[4,63.589]],["parent/146",[97,2.559]],["name/147",[3,22.746]],["parent/147",[97,2.559]],["name/148",[5,63.589]],["parent/148",[97,2.559]],["name/149",[3,22.746]],["parent/149",[97,2.559]],["name/150",[6,63.589]],["parent/150",[97,2.559]],["name/151",[3,22.746]],["parent/151",[97,2.559]],["name/152",[7,63.589]],["parent/152",[97,2.559]],["name/153",[3,22.746]],["parent/153",[97,2.559]],["name/154",[8,63.589]],["parent/154",[97,2.559]],["name/155",[3,22.746]],["parent/155",[97,2.559]],["name/156",[9,63.589]],["parent/156",[97,2.559]],["name/157",[3,22.746]],["parent/157",[97,2.559]],["name/158",[10,63.589]],["parent/158",[97,2.559]],["name/159",[3,22.746]],["parent/159",[97,2.559]],["name/160",[11,63.589]],["parent/160",[97,2.559]],["name/161",[3,22.746]],["parent/161",[97,2.559]],["name/162",[12,63.589]],["parent/162",[97,2.559]],["name/163",[3,22.746]],["parent/163",[97,2.559]],["name/164",[13,63.589]],["parent/164",[97,2.559]],["name/165",[3,22.746]],["parent/165",[97,2.559]],["name/166",[14,63.589]],["parent/166",[97,2.559]],["name/167",[3,22.746]],["parent/167",[97,2.559]],["name/168",[15,63.589]],["parent/168",[97,2.559]],["name/169",[3,22.746]],["parent/169",[97,2.559]],["name/170",[16,63.589]],["parent/170",[97,2.559]],["name/171",[3,22.746]],["parent/171",[97,2.559]],["name/172",[17,63.589]],["parent/172",[97,2.559]],["name/173",[3,22.746]],["parent/173",[97,2.559]],["name/174",[18,63.589]],["parent/174",[97,2.559]],["name/175",[3,22.746]],["parent/175",[97,2.559]],["name/176",[19,63.589]],["parent/176",[97,2.559]],["name/177",[3,22.746]],["parent/177",[97,2.559]],["name/178",[20,63.589]],["parent/178",[97,2.559]],["name/179",[3,22.746]],["parent/179",[97,2.559]],["name/180",[21,63.589]],["parent/180",[98,4.055]],["name/181",[23,63.589]],["parent/181",[98,4.055]],["name/182",[24,63.589]],["parent/182",[98,4.055]],["name/183",[25,63.589]],["parent/183",[98,4.055]],["name/184",[26,63.589]],["parent/184",[98,4.055]],["name/185",[27,63.589]],["parent/185",[98,4.055]],["name/186",[28,63.589]],["parent/186",[98,4.055]],["name/187",[29,63.589]],["parent/187",[98,4.055]],["name/188",[30,63.589]],["parent/188",[98,4.055]],["name/189",[31,60.224]],["parent/189",[97,2.559]],["name/190",[99,68.697]],["parent/190",[97,2.559]],["name/191",[100,68.697]],["parent/191",[97,2.559]],["name/192",[32,63.589]],["parent/192",[97,2.559]],["name/193",[33,63.589]],["parent/193",[97,2.559]],["name/194",[34,63.589]],["parent/194",[97,2.559]],["name/195",[35,37.342]],["parent/195",[97,2.559]],["name/196",[36,63.589]],["parent/196",[97,2.559]],["name/197",[37,63.589]],["parent/197",[97,2.559]],["name/198",[38,63.589]],["parent/198",[97,2.559]],["name/199",[39,63.589]],["parent/199",[97,2.559]],["name/200",[40,63.589]],["parent/200",[97,2.559]],["name/201",[41,63.589]],["parent/201",[97,2.559]],["name/202",[42,63.589]],["parent/202",[97,2.559]],["name/203",[43,63.589]],["parent/203",[97,2.559]],["name/204",[3,22.746]],["parent/204",[97,2.559]],["name/205",[44,63.589]],["parent/205",[97,2.559]],["name/206",[3,22.746]],["parent/206",[97,2.559]],["name/207",[45,63.589]],["parent/207",[97,2.559]],["name/208",[3,22.746]],["parent/208",[97,2.559]],["name/209",[46,63.589]],["parent/209",[97,2.559]],["name/210",[3,22.746]],["parent/210",[97,2.559]],["name/211",[47,63.589]],["parent/211",[97,2.559]],["name/212",[3,22.746]],["parent/212",[97,2.559]],["name/213",[48,63.589]],["parent/213",[97,2.559]],["name/214",[3,22.746]],["parent/214",[97,2.559]],["name/215",[49,63.589]],["parent/215",[97,2.559]],["name/216",[3,22.746]],["parent/216",[97,2.559]],["name/217",[50,63.589]],["parent/217",[97,2.559]],["name/218",[3,22.746]],["parent/218",[97,2.559]],["name/219",[51,63.589]],["parent/219",[97,2.559]],["name/220",[3,22.746]],["parent/220",[97,2.559]],["name/221",[52,63.589]],["parent/221",[97,2.559]],["name/222",[3,22.746]],["parent/222",[97,2.559]],["name/223",[53,63.589]],["parent/223",[97,2.559]],["name/224",[3,22.746]],["parent/224",[97,2.559]],["name/225",[54,63.589]],["parent/225",[97,2.559]],["name/226",[3,22.746]],["parent/226",[97,2.559]],["name/227",[55,63.589]],["parent/227",[97,2.559]],["name/228",[3,22.746]],["parent/228",[97,2.559]],["name/229",[56,63.589]],["parent/229",[97,2.559]],["name/230",[3,22.746]],["parent/230",[97,2.559]],["name/231",[57,63.589]],["parent/231",[97,2.559]],["name/232",[3,22.746]],["parent/232",[97,2.559]],["name/233",[58,63.589]],["parent/233",[97,2.559]],["name/234",[3,22.746]],["parent/234",[97,2.559]],["name/235",[59,63.589]],["parent/235",[97,2.559]],["name/236",[3,22.746]],["parent/236",[97,2.559]],["name/237",[60,63.589]],["parent/237",[97,2.559]],["name/238",[3,22.746]],["parent/238",[97,2.559]],["name/239",[61,63.589]],["parent/239",[97,2.559]],["name/240",[3,22.746]],["parent/240",[97,2.559]],["name/241",[62,63.589]],["parent/241",[97,2.559]],["name/242",[3,22.746]],["parent/242",[97,2.559]],["name/243",[63,63.589]],["parent/243",[97,2.559]],["name/244",[3,22.746]],["parent/244",[97,2.559]],["name/245",[64,63.589]],["parent/245",[97,2.559]],["name/246",[3,22.746]],["parent/246",[97,2.559]],["name/247",[65,63.589]],["parent/247",[97,2.559]],["name/248",[3,22.746]],["parent/248",[97,2.559]],["name/249",[66,63.589]],["parent/249",[97,2.559]],["name/250",[67,63.589]],["parent/250",[97,2.559]],["name/251",[3,22.746]],["parent/251",[97,2.559]],["name/252",[68,63.589]],["parent/252",[98,4.055]],["name/253",[3,22.746]],["parent/253",[98,4.055]],["name/254",[69,63.589]],["parent/254",[101,4.011]],["name/255",[71,63.589]],["parent/255",[98,4.055]],["name/256",[3,22.746]],["parent/256",[98,4.055]],["name/257",[72,63.589]],["parent/257",[101,4.011]],["name/258",[73,63.589]],["parent/258",[101,4.011]],["name/259",[74,63.589]],["parent/259",[101,4.011]],["name/260",[75,63.589]],["parent/260",[101,4.011]],["name/261",[76,63.589]],["parent/261",[101,4.011]],["name/262",[77,63.589]],["parent/262",[101,4.011]],["name/263",[78,63.589]],["parent/263",[98,4.055]],["name/264",[3,22.746]],["parent/264",[98,4.055]],["name/265",[79,63.589]],["parent/265",[101,4.011]],["name/266",[80,63.589]],["parent/266",[101,4.011]],["name/267",[81,63.589]],["parent/267",[101,4.011]],["name/268",[82,63.589]],["parent/268",[101,4.011]],["name/269",[83,63.589]],["parent/269",[101,4.011]],["name/270",[84,63.589]],["parent/270",[101,4.011]],["name/271",[85,63.589]],["parent/271",[98,4.055]],["name/272",[3,22.746]],["parent/272",[98,4.055]],["name/273",[86,63.589]],["parent/273",[101,4.011]],["name/274",[87,63.589]],["parent/274",[101,4.011]],["name/275",[88,63.589]],["parent/275",[101,4.011]],["name/276",[89,63.589]],["parent/276",[101,4.011]],["name/277",[90,63.589]],["parent/277",[98,4.055]],["name/278",[3,22.746]],["parent/278",[98,4.055]],["name/279",[91,63.589]],["parent/279",[101,4.011]],["name/280",[92,63.589]],["parent/280",[101,4.011]],["name/281",[93,60.224]],["parent/281",[101,4.011]],["name/282",[94,63.589]],["parent/282",[98,4.055]],["name/283",[3,22.746]],["parent/283",[98,4.055]],["name/284",[95,63.589]],["parent/284",[101,4.011]],["name/285",[96,63.589]],["parent/285",[101,4.011]],["name/286",[102,44.13]],["parent/286",[]],["name/287",[103,68.697]],["parent/287",[102,4.254]],["name/288",[104,68.697]],["parent/288",[102,4.254]],["name/289",[105,68.697]],["parent/289",[102,4.254]],["name/290",[106,68.697]],["parent/290",[102,4.254]],["name/291",[107,68.697]],["parent/291",[102,4.254]],["name/292",[108,68.697]],["parent/292",[102,4.254]],["name/293",[109,68.697]],["parent/293",[102,4.254]],["name/294",[110,68.697]],["parent/294",[102,4.254]],["name/295",[31,60.224]],["parent/295",[102,4.254]],["name/296",[111,63.589]],["parent/296",[102,4.254]],["name/297",[112,63.589]],["parent/297",[102,4.254]],["name/298",[113,68.697]],["parent/298",[102,4.254]],["name/299",[114,68.697]],["parent/299",[102,4.254]],["name/300",[115,68.697]],["parent/300",[102,4.254]],["name/301",[116,68.697]],["parent/301",[102,4.254]],["name/302",[117,68.697]],["parent/302",[102,4.254]],["name/303",[118,54.034]],["parent/303",[]],["name/304",[119,43.574]],["parent/304",[118,5.208]],["name/305",[120,60.224]],["parent/305",[118,5.208]],["name/306",[121,57.711]],["parent/306",[118,5.208]],["name/307",[122,57.711]],["parent/307",[118,5.208]],["name/308",[123,60.224]],["parent/308",[118,5.208]],["name/309",[124,50.239]],["parent/309",[]],["name/310",[125,51.351]],["parent/310",[124,4.843]],["name/311",[126,63.589]],["parent/311",[124,4.843]],["name/312",[127,57.711]],["parent/312",[124,4.843]],["name/313",[128,68.697]],["parent/313",[124,4.843]],["name/314",[129,63.589]],["parent/314",[124,4.843]],["name/315",[130,68.697]],["parent/315",[124,4.843]],["name/316",[131,68.697]],["parent/316",[124,4.843]],["name/317",[132,57.711]],["parent/317",[]],["name/318",[133,63.589]],["parent/318",[132,5.563]],["name/319",[124,50.239]],["parent/319",[132,5.563]],["name/320",[3,22.746]],["parent/320",[132,5.563]],["name/321",[127,57.711]],["parent/321",[134,5.563]],["name/322",[125,51.351]],["parent/322",[134,5.563]],["name/323",[126,63.589]],["parent/323",[134,5.563]],["name/324",[129,63.589]],["parent/324",[134,5.563]],["name/325",[135,52.603]],["parent/325",[]],["name/326",[136,68.697]],["parent/326",[135,5.07]],["name/327",[137,68.697]],["parent/327",[135,5.07]],["name/328",[138,68.697]],["parent/328",[135,5.07]],["name/329",[139,68.697]],["parent/329",[135,5.07]],["name/330",[140,68.697]],["parent/330",[135,5.07]],["name/331",[133,63.589]],["parent/331",[135,5.07]],["name/332",[141,46.725]],["parent/332",[]],["name/333",[120,60.224]],["parent/333",[141,4.504]],["name/334",[119,43.574]],["parent/334",[141,4.504]],["name/335",[127,57.711]],["parent/335",[141,4.504]],["name/336",[122,57.711]],["parent/336",[141,4.504]],["name/337",[142,68.697]],["parent/337",[141,4.504]],["name/338",[125,51.351]],["parent/338",[141,4.504]],["name/339",[143,68.697]],["parent/339",[141,4.504]],["name/340",[144,68.697]],["parent/340",[141,4.504]],["name/341",[145,68.697]],["parent/341",[141,4.504]],["name/342",[146,68.697]],["parent/342",[141,4.504]],["name/343",[121,57.711]],["parent/343",[141,4.504]],["name/344",[123,60.224]],["parent/344",[141,4.504]],["name/345",[147,52.603]],["parent/345",[]],["name/346",[148,68.697]],["parent/346",[147,5.07]],["name/347",[119,43.574]],["parent/347",[147,5.07]],["name/348",[120,60.224]],["parent/348",[147,5.07]],["name/349",[121,57.711]],["parent/349",[147,5.07]],["name/350",[122,57.711]],["parent/350",[147,5.07]],["name/351",[123,60.224]],["parent/351",[147,5.07]],["name/352",[149,60.224]],["parent/352",[]],["name/353",[111,63.589]],["parent/353",[149,5.805]],["name/354",[112,63.589]],["parent/354",[149,5.805]],["name/355",[150,63.589]],["parent/355",[]],["name/356",[151,68.697]],["parent/356",[150,6.129]],["name/357",[152,44.718]],["parent/357",[]],["name/358",[153,37.939]],["parent/358",[152,4.31]],["name/359",[154,68.697]],["parent/359",[152,4.31]],["name/360",[155,68.697]],["parent/360",[152,4.31]],["name/361",[127,57.711]],["parent/361",[152,4.31]],["name/362",[156,68.697]],["parent/362",[152,4.31]],["name/363",[3,22.746]],["parent/363",[152,4.31]],["name/364",[157,68.697]],["parent/364",[152,4.31]],["name/365",[158,68.697]],["parent/365",[152,4.31]],["name/366",[3,22.746]],["parent/366",[152,4.31]],["name/367",[159,63.589]],["parent/367",[160,5.805]],["name/368",[161,68.697]],["parent/368",[160,5.805]],["name/369",[162,68.697]],["parent/369",[160,5.805]],["name/370",[163,68.697]],["parent/370",[152,4.31]],["name/371",[164,63.589]],["parent/371",[]],["name/372",[165,68.697]],["parent/372",[164,6.129]],["name/373",[166,50.239]],["parent/373",[]],["name/374",[167,68.697]],["parent/374",[166,4.843]],["name/375",[168,68.697]],["parent/375",[166,4.843]],["name/376",[169,68.697]],["parent/376",[166,4.843]],["name/377",[121,57.711]],["parent/377",[166,4.843]],["name/378",[170,68.697]],["parent/378",[166,4.843]],["name/379",[171,68.697]],["parent/379",[166,4.843]],["name/380",[172,68.697]],["parent/380",[166,4.843]],["name/381",[93,60.224]],["parent/381",[166,4.843]],["name/382",[173,52.603]],["parent/382",[]],["name/383",[174,34.575]],["parent/383",[173,5.07]],["name/384",[175,55.704]],["parent/384",[173,5.07]],["name/385",[152,44.718]],["parent/385",[173,5.07]],["name/386",[176,30.483]],["parent/386",[173,5.07]],["name/387",[177,55.704]],["parent/387",[173,5.07]],["name/388",[125,51.351]],["parent/388",[173,5.07]],["name/389",[178,52.603]],["parent/389",[]],["name/390",[174,34.575]],["parent/390",[178,5.07]],["name/391",[175,55.704]],["parent/391",[178,5.07]],["name/392",[152,44.718]],["parent/392",[178,5.07]],["name/393",[176,30.483]],["parent/393",[178,5.07]],["name/394",[177,55.704]],["parent/394",[178,5.07]],["name/395",[125,51.351]],["parent/395",[178,5.07]],["name/396",[179,52.603]],["parent/396",[]],["name/397",[174,34.575]],["parent/397",[179,5.07]],["name/398",[175,55.704]],["parent/398",[179,5.07]],["name/399",[152,44.718]],["parent/399",[179,5.07]],["name/400",[176,30.483]],["parent/400",[179,5.07]],["name/401",[177,55.704]],["parent/401",[179,5.07]],["name/402",[125,51.351]],["parent/402",[179,5.07]],["name/403",[180,52.603]],["parent/403",[]],["name/404",[174,34.575]],["parent/404",[180,5.07]],["name/405",[175,55.704]],["parent/405",[180,5.07]],["name/406",[152,44.718]],["parent/406",[180,5.07]],["name/407",[176,30.483]],["parent/407",[180,5.07]],["name/408",[177,55.704]],["parent/408",[180,5.07]],["name/409",[125,51.351]],["parent/409",[180,5.07]],["name/410",[181,52.603]],["parent/410",[]],["name/411",[174,34.575]],["parent/411",[181,5.07]],["name/412",[175,55.704]],["parent/412",[181,5.07]],["name/413",[152,44.718]],["parent/413",[181,5.07]],["name/414",[176,30.483]],["parent/414",[181,5.07]],["name/415",[177,55.704]],["parent/415",[181,5.07]],["name/416",[125,51.351]],["parent/416",[181,5.07]],["name/417",[182,68.697]],["parent/417",[]],["name/418",[183,44.13]],["parent/418",[]],["name/419",[184,68.697]],["parent/419",[183,4.254]],["name/420",[185,68.697]],["parent/420",[183,4.254]],["name/421",[186,68.697]],["parent/421",[183,4.254]],["name/422",[187,68.697]],["parent/422",[183,4.254]],["name/423",[188,63.589]],["parent/423",[183,4.254]],["name/424",[189,37.056]],["parent/424",[183,4.254]],["name/425",[190,36.508]],["parent/425",[183,4.254]],["name/426",[191,68.697]],["parent/426",[183,4.254]],["name/427",[192,68.697]],["parent/427",[183,4.254]],["name/428",[193,68.697]],["parent/428",[183,4.254]],["name/429",[194,55.704]],["parent/429",[183,4.254]],["name/430",[195,68.697]],["parent/430",[183,4.254]],["name/431",[196,68.697]],["parent/431",[183,4.254]],["name/432",[197,68.697]],["parent/432",[183,4.254]],["name/433",[198,49.238]],["parent/433",[183,4.254]],["name/434",[199,48.328]],["parent/434",[]],["name/435",[174,34.575]],["parent/435",[199,4.658]],["name/436",[200,63.589]],["parent/436",[199,4.658]],["name/437",[201,63.589]],["parent/437",[199,4.658]],["name/438",[189,37.056]],["parent/438",[199,4.658]],["name/439",[190,36.508]],["parent/439",[199,4.658]],["name/440",[202,63.589]],["parent/440",[199,4.658]],["name/441",[203,55.704]],["parent/441",[199,4.658]],["name/442",[204,55.704]],["parent/442",[199,4.658]],["name/443",[205,63.589]],["parent/443",[199,4.658]],["name/444",[206,63.589]],["parent/444",[199,4.658]],["name/445",[35,37.342]],["parent/445",[]],["name/446",[207,68.697]],["parent/446",[]],["name/447",[208,49.238]],["parent/447",[]],["name/448",[209,38.574]],["parent/448",[208,4.746]],["name/449",[119,43.574]],["parent/449",[208,4.746]],["name/450",[210,51.351]],["parent/450",[208,4.746]],["name/451",[189,37.056]],["parent/451",[208,4.746]],["name/452",[190,36.508]],["parent/452",[208,4.746]],["name/453",[211,49.238]],["parent/453",[208,4.746]],["name/454",[212,47.494]],["parent/454",[208,4.746]],["name/455",[176,30.483]],["parent/455",[208,4.746]],["name/456",[213,31.561]],["parent/456",[208,4.746]],["name/457",[214,46.725]],["parent/457",[]],["name/458",[153,37.939]],["parent/458",[214,4.504]],["name/459",[3,22.746]],["parent/459",[214,4.504]],["name/460",[119,43.574]],["parent/460",[215,5.07]],["name/461",[216,68.697]],["parent/461",[215,5.07]],["name/462",[189,37.056]],["parent/462",[215,5.07]],["name/463",[190,36.508]],["parent/463",[215,5.07]],["name/464",[198,49.238]],["parent/464",[215,5.07]],["name/465",[211,49.238]],["parent/465",[215,5.07]],["name/466",[212,47.494]],["parent/466",[215,5.07]],["name/467",[176,30.483]],["parent/467",[214,4.504]],["name/468",[217,37.342]],["parent/468",[214,4.504]],["name/469",[174,34.575]],["parent/469",[214,4.504]],["name/470",[218,38.252]],["parent/470",[214,4.504]],["name/471",[219,38.252]],["parent/471",[214,4.504]],["name/472",[220,38.252]],["parent/472",[214,4.504]],["name/473",[221,38.252]],["parent/473",[214,4.504]],["name/474",[222,38.252]],["parent/474",[214,4.504]],["name/475",[35,37.342]],["parent/475",[214,4.504]],["name/476",[213,31.561]],["parent/476",[214,4.504]],["name/477",[223,50.239]],["parent/477",[]],["name/478",[209,38.574]],["parent/478",[223,4.843]],["name/479",[119,43.574]],["parent/479",[223,4.843]],["name/480",[210,51.351]],["parent/480",[223,4.843]],["name/481",[189,37.056]],["parent/481",[223,4.843]],["name/482",[190,36.508]],["parent/482",[223,4.843]],["name/483",[224,57.711]],["parent/483",[223,4.843]],["name/484",[176,30.483]],["parent/484",[223,4.843]],["name/485",[213,31.561]],["parent/485",[223,4.843]],["name/486",[225,46.725]],["parent/486",[]],["name/487",[153,37.939]],["parent/487",[225,4.504]],["name/488",[3,22.746]],["parent/488",[225,4.504]],["name/489",[189,37.056]],["parent/489",[226,5.369]],["name/490",[190,36.508]],["parent/490",[226,5.369]],["name/491",[227,68.697]],["parent/491",[226,5.369]],["name/492",[228,68.697]],["parent/492",[226,5.369]],["name/493",[198,49.238]],["parent/493",[226,5.369]],["name/494",[176,30.483]],["parent/494",[225,4.504]],["name/495",[217,37.342]],["parent/495",[225,4.504]],["name/496",[174,34.575]],["parent/496",[225,4.504]],["name/497",[218,38.252]],["parent/497",[225,4.504]],["name/498",[219,38.252]],["parent/498",[225,4.504]],["name/499",[220,38.252]],["parent/499",[225,4.504]],["name/500",[221,38.252]],["parent/500",[225,4.504]],["name/501",[222,38.252]],["parent/501",[225,4.504]],["name/502",[35,37.342]],["parent/502",[225,4.504]],["name/503",[213,31.561]],["parent/503",[225,4.504]],["name/504",[229,49.238]],["parent/504",[]],["name/505",[209,38.574]],["parent/505",[229,4.746]],["name/506",[119,43.574]],["parent/506",[229,4.746]],["name/507",[189,37.056]],["parent/507",[229,4.746]],["name/508",[190,36.508]],["parent/508",[229,4.746]],["name/509",[230,63.589]],["parent/509",[229,4.746]],["name/510",[231,63.589]],["parent/510",[229,4.746]],["name/511",[224,57.711]],["parent/511",[229,4.746]],["name/512",[176,30.483]],["parent/512",[229,4.746]],["name/513",[213,31.561]],["parent/513",[229,4.746]],["name/514",[232,46.725]],["parent/514",[]],["name/515",[153,37.939]],["parent/515",[232,4.504]],["name/516",[3,22.746]],["parent/516",[232,4.504]],["name/517",[233,68.697]],["parent/517",[234,5.208]],["name/518",[231,63.589]],["parent/518",[234,5.208]],["name/519",[235,47.494]],["parent/519",[234,5.208]],["name/520",[190,36.508]],["parent/520",[234,5.208]],["name/521",[236,63.589]],["parent/521",[234,5.208]],["name/522",[198,49.238]],["parent/522",[234,5.208]],["name/523",[176,30.483]],["parent/523",[232,4.504]],["name/524",[217,37.342]],["parent/524",[232,4.504]],["name/525",[174,34.575]],["parent/525",[232,4.504]],["name/526",[218,38.252]],["parent/526",[232,4.504]],["name/527",[219,38.252]],["parent/527",[232,4.504]],["name/528",[220,38.252]],["parent/528",[232,4.504]],["name/529",[221,38.252]],["parent/529",[232,4.504]],["name/530",[222,38.252]],["parent/530",[232,4.504]],["name/531",[35,37.342]],["parent/531",[232,4.504]],["name/532",[213,31.561]],["parent/532",[232,4.504]],["name/533",[237,49.238]],["parent/533",[]],["name/534",[209,38.574]],["parent/534",[237,4.746]],["name/535",[119,43.574]],["parent/535",[237,4.746]],["name/536",[189,37.056]],["parent/536",[237,4.746]],["name/537",[190,36.508]],["parent/537",[237,4.746]],["name/538",[238,68.697]],["parent/538",[237,4.746]],["name/539",[211,49.238]],["parent/539",[237,4.746]],["name/540",[212,47.494]],["parent/540",[237,4.746]],["name/541",[176,30.483]],["parent/541",[237,4.746]],["name/542",[213,31.561]],["parent/542",[237,4.746]],["name/543",[239,46.725]],["parent/543",[]],["name/544",[153,37.939]],["parent/544",[239,4.504]],["name/545",[3,22.746]],["parent/545",[239,4.504]],["name/546",[119,43.574]],["parent/546",[240,5.208]],["name/547",[241,68.697]],["parent/547",[240,5.208]],["name/548",[235,47.494]],["parent/548",[240,5.208]],["name/549",[190,36.508]],["parent/549",[240,5.208]],["name/550",[189,37.056]],["parent/550",[240,5.208]],["name/551",[212,47.494]],["parent/551",[240,5.208]],["name/552",[176,30.483]],["parent/552",[239,4.504]],["name/553",[217,37.342]],["parent/553",[239,4.504]],["name/554",[174,34.575]],["parent/554",[239,4.504]],["name/555",[218,38.252]],["parent/555",[239,4.504]],["name/556",[219,38.252]],["parent/556",[239,4.504]],["name/557",[220,38.252]],["parent/557",[239,4.504]],["name/558",[221,38.252]],["parent/558",[239,4.504]],["name/559",[222,38.252]],["parent/559",[239,4.504]],["name/560",[35,37.342]],["parent/560",[239,4.504]],["name/561",[213,31.561]],["parent/561",[239,4.504]],["name/562",[242,48.328]],["parent/562",[]],["name/563",[209,38.574]],["parent/563",[242,4.658]],["name/564",[119,43.574]],["parent/564",[242,4.658]],["name/565",[174,34.575]],["parent/565",[242,4.658]],["name/566",[243,68.697]],["parent/566",[242,4.658]],["name/567",[189,37.056]],["parent/567",[242,4.658]],["name/568",[190,36.508]],["parent/568",[242,4.658]],["name/569",[211,49.238]],["parent/569",[242,4.658]],["name/570",[212,47.494]],["parent/570",[242,4.658]],["name/571",[176,30.483]],["parent/571",[242,4.658]],["name/572",[213,31.561]],["parent/572",[242,4.658]],["name/573",[244,46.725]],["parent/573",[]],["name/574",[153,37.939]],["parent/574",[244,4.504]],["name/575",[3,22.746]],["parent/575",[244,4.504]],["name/576",[119,43.574]],["parent/576",[245,4.95]],["name/577",[246,68.697]],["parent/577",[245,4.95]],["name/578",[189,37.056]],["parent/578",[245,4.95]],["name/579",[190,36.508]],["parent/579",[245,4.95]],["name/580",[235,47.494]],["parent/580",[245,4.95]],["name/581",[211,49.238]],["parent/581",[245,4.95]],["name/582",[212,47.494]],["parent/582",[245,4.95]],["name/583",[198,49.238]],["parent/583",[245,4.95]],["name/584",[176,30.483]],["parent/584",[244,4.504]],["name/585",[217,37.342]],["parent/585",[244,4.504]],["name/586",[174,34.575]],["parent/586",[244,4.504]],["name/587",[218,38.252]],["parent/587",[244,4.504]],["name/588",[219,38.252]],["parent/588",[244,4.504]],["name/589",[220,38.252]],["parent/589",[244,4.504]],["name/590",[221,38.252]],["parent/590",[244,4.504]],["name/591",[222,38.252]],["parent/591",[244,4.504]],["name/592",[35,37.342]],["parent/592",[244,4.504]],["name/593",[213,31.561]],["parent/593",[244,4.504]],["name/594",[247,49.238]],["parent/594",[]],["name/595",[209,38.574]],["parent/595",[247,4.746]],["name/596",[119,43.574]],["parent/596",[247,4.746]],["name/597",[189,37.056]],["parent/597",[247,4.746]],["name/598",[190,36.508]],["parent/598",[247,4.746]],["name/599",[211,49.238]],["parent/599",[247,4.746]],["name/600",[212,47.494]],["parent/600",[247,4.746]],["name/601",[224,57.711]],["parent/601",[247,4.746]],["name/602",[176,30.483]],["parent/602",[247,4.746]],["name/603",[213,31.561]],["parent/603",[247,4.746]],["name/604",[248,46.725]],["parent/604",[]],["name/605",[153,37.939]],["parent/605",[248,4.504]],["name/606",[3,22.746]],["parent/606",[248,4.504]],["name/607",[119,43.574]],["parent/607",[249,5.208]],["name/608",[250,63.589]],["parent/608",[249,5.208]],["name/609",[235,47.494]],["parent/609",[249,5.208]],["name/610",[190,36.508]],["parent/610",[249,5.208]],["name/611",[189,37.056]],["parent/611",[249,5.208]],["name/612",[212,47.494]],["parent/612",[249,5.208]],["name/613",[176,30.483]],["parent/613",[248,4.504]],["name/614",[217,37.342]],["parent/614",[248,4.504]],["name/615",[174,34.575]],["parent/615",[248,4.504]],["name/616",[218,38.252]],["parent/616",[248,4.504]],["name/617",[219,38.252]],["parent/617",[248,4.504]],["name/618",[220,38.252]],["parent/618",[248,4.504]],["name/619",[221,38.252]],["parent/619",[248,4.504]],["name/620",[222,38.252]],["parent/620",[248,4.504]],["name/621",[35,37.342]],["parent/621",[248,4.504]],["name/622",[213,31.561]],["parent/622",[248,4.504]],["name/623",[251,46.725]],["parent/623",[]],["name/624",[209,38.574]],["parent/624",[251,4.504]],["name/625",[119,43.574]],["parent/625",[251,4.504]],["name/626",[252,60.224]],["parent/626",[251,4.504]],["name/627",[253,60.224]],["parent/627",[251,4.504]],["name/628",[189,37.056]],["parent/628",[251,4.504]],["name/629",[190,36.508]],["parent/629",[251,4.504]],["name/630",[254,55.704]],["parent/630",[251,4.504]],["name/631",[255,68.697]],["parent/631",[251,4.504]],["name/632",[211,49.238]],["parent/632",[251,4.504]],["name/633",[212,47.494]],["parent/633",[251,4.504]],["name/634",[176,30.483]],["parent/634",[251,4.504]],["name/635",[213,31.561]],["parent/635",[251,4.504]],["name/636",[256,46.725]],["parent/636",[]],["name/637",[153,37.939]],["parent/637",[256,4.504]],["name/638",[3,22.746]],["parent/638",[256,4.504]],["name/639",[119,43.574]],["parent/639",[257,5.07]],["name/640",[252,60.224]],["parent/640",[257,5.07]],["name/641",[253,60.224]],["parent/641",[257,5.07]],["name/642",[211,49.238]],["parent/642",[257,5.07]],["name/643",[212,47.494]],["parent/643",[257,5.07]],["name/644",[194,55.704]],["parent/644",[257,5.07]],["name/645",[198,49.238]],["parent/645",[257,5.07]],["name/646",[176,30.483]],["parent/646",[256,4.504]],["name/647",[217,37.342]],["parent/647",[256,4.504]],["name/648",[174,34.575]],["parent/648",[256,4.504]],["name/649",[218,38.252]],["parent/649",[256,4.504]],["name/650",[219,38.252]],["parent/650",[256,4.504]],["name/651",[220,38.252]],["parent/651",[256,4.504]],["name/652",[221,38.252]],["parent/652",[256,4.504]],["name/653",[222,38.252]],["parent/653",[256,4.504]],["name/654",[35,37.342]],["parent/654",[256,4.504]],["name/655",[213,31.561]],["parent/655",[256,4.504]],["name/656",[258,50.239]],["parent/656",[]],["name/657",[209,38.574]],["parent/657",[258,4.843]],["name/658",[119,43.574]],["parent/658",[258,4.843]],["name/659",[224,57.711]],["parent/659",[258,4.843]],["name/660",[259,68.697]],["parent/660",[258,4.843]],["name/661",[189,37.056]],["parent/661",[258,4.843]],["name/662",[190,36.508]],["parent/662",[258,4.843]],["name/663",[176,30.483]],["parent/663",[258,4.843]],["name/664",[213,31.561]],["parent/664",[258,4.843]],["name/665",[260,46.725]],["parent/665",[]],["name/666",[153,37.939]],["parent/666",[260,4.504]],["name/667",[3,22.746]],["parent/667",[260,4.504]],["name/668",[119,43.574]],["parent/668",[261,4.746]],["name/669",[262,68.697]],["parent/669",[261,4.746]],["name/670",[3,22.746]],["parent/670",[261,4.746]],["name/671",[263,68.697]],["parent/671",[261,4.746]],["name/672",[3,22.746]],["parent/672",[261,4.746]],["name/673",[264,68.697]],["parent/673",[261,4.746]],["name/674",[3,22.746]],["parent/674",[261,4.746]],["name/675",[189,37.056]],["parent/675",[261,4.746]],["name/676",[235,47.494]],["parent/676",[261,4.746]],["name/677",[190,36.508]],["parent/677",[261,4.746]],["name/678",[176,30.483]],["parent/678",[260,4.504]],["name/679",[217,37.342]],["parent/679",[260,4.504]],["name/680",[174,34.575]],["parent/680",[260,4.504]],["name/681",[218,38.252]],["parent/681",[260,4.504]],["name/682",[219,38.252]],["parent/682",[260,4.504]],["name/683",[220,38.252]],["parent/683",[260,4.504]],["name/684",[221,38.252]],["parent/684",[260,4.504]],["name/685",[222,38.252]],["parent/685",[260,4.504]],["name/686",[35,37.342]],["parent/686",[260,4.504]],["name/687",[213,31.561]],["parent/687",[260,4.504]],["name/688",[265,50.239]],["parent/688",[]],["name/689",[209,38.574]],["parent/689",[265,4.843]],["name/690",[119,43.574]],["parent/690",[265,4.843]],["name/691",[266,68.697]],["parent/691",[265,4.843]],["name/692",[194,55.704]],["parent/692",[265,4.843]],["name/693",[189,37.056]],["parent/693",[265,4.843]],["name/694",[190,36.508]],["parent/694",[265,4.843]],["name/695",[176,30.483]],["parent/695",[265,4.843]],["name/696",[213,31.561]],["parent/696",[265,4.843]],["name/697",[267,46.725]],["parent/697",[]],["name/698",[153,37.939]],["parent/698",[267,4.504]],["name/699",[3,22.746]],["parent/699",[267,4.504]],["name/700",[235,47.494]],["parent/700",[268,5.805]],["name/701",[269,68.697]],["parent/701",[268,5.805]],["name/702",[194,55.704]],["parent/702",[268,5.805]],["name/703",[176,30.483]],["parent/703",[267,4.504]],["name/704",[217,37.342]],["parent/704",[267,4.504]],["name/705",[174,34.575]],["parent/705",[267,4.504]],["name/706",[218,38.252]],["parent/706",[267,4.504]],["name/707",[219,38.252]],["parent/707",[267,4.504]],["name/708",[220,38.252]],["parent/708",[267,4.504]],["name/709",[221,38.252]],["parent/709",[267,4.504]],["name/710",[222,38.252]],["parent/710",[267,4.504]],["name/711",[35,37.342]],["parent/711",[267,4.504]],["name/712",[213,31.561]],["parent/712",[267,4.504]],["name/713",[270,46.725]],["parent/713",[]],["name/714",[209,38.574]],["parent/714",[270,4.504]],["name/715",[189,37.056]],["parent/715",[270,4.504]],["name/716",[190,36.508]],["parent/716",[270,4.504]],["name/717",[271,63.589]],["parent/717",[270,4.504]],["name/718",[272,57.711]],["parent/718",[270,4.504]],["name/719",[194,55.704]],["parent/719",[270,4.504]],["name/720",[273,68.697]],["parent/720",[270,4.504]],["name/721",[274,68.697]],["parent/721",[270,4.504]],["name/722",[254,55.704]],["parent/722",[270,4.504]],["name/723",[230,63.589]],["parent/723",[270,4.504]],["name/724",[176,30.483]],["parent/724",[270,4.504]],["name/725",[213,31.561]],["parent/725",[270,4.504]],["name/726",[275,46.725]],["parent/726",[]],["name/727",[153,37.939]],["parent/727",[275,4.504]],["name/728",[3,22.746]],["parent/728",[275,4.504]],["name/729",[183,44.13]],["parent/729",[276,5.369]],["name/730",[189,37.056]],["parent/730",[276,5.369]],["name/731",[190,36.508]],["parent/731",[276,5.369]],["name/732",[236,63.589]],["parent/732",[276,5.369]],["name/733",[198,49.238]],["parent/733",[276,5.369]],["name/734",[176,30.483]],["parent/734",[275,4.504]],["name/735",[217,37.342]],["parent/735",[275,4.504]],["name/736",[174,34.575]],["parent/736",[275,4.504]],["name/737",[218,38.252]],["parent/737",[275,4.504]],["name/738",[219,38.252]],["parent/738",[275,4.504]],["name/739",[220,38.252]],["parent/739",[275,4.504]],["name/740",[221,38.252]],["parent/740",[275,4.504]],["name/741",[222,38.252]],["parent/741",[275,4.504]],["name/742",[35,37.342]],["parent/742",[275,4.504]],["name/743",[213,31.561]],["parent/743",[275,4.504]],["name/744",[277,57.711]],["parent/744",[]],["name/745",[209,38.574]],["parent/745",[277,5.563]],["name/746",[176,30.483]],["parent/746",[277,5.563]],["name/747",[213,31.561]],["parent/747",[277,5.563]],["name/748",[278,46.725]],["parent/748",[]],["name/749",[153,37.939]],["parent/749",[278,4.504]],["name/750",[3,22.746]],["parent/750",[278,4.504]],["name/751",[189,37.056]],["parent/751",[279,6.129]],["name/752",[190,36.508]],["parent/752",[279,6.129]],["name/753",[176,30.483]],["parent/753",[278,4.504]],["name/754",[217,37.342]],["parent/754",[278,4.504]],["name/755",[174,34.575]],["parent/755",[278,4.504]],["name/756",[218,38.252]],["parent/756",[278,4.504]],["name/757",[219,38.252]],["parent/757",[278,4.504]],["name/758",[220,38.252]],["parent/758",[278,4.504]],["name/759",[221,38.252]],["parent/759",[278,4.504]],["name/760",[222,38.252]],["parent/760",[278,4.504]],["name/761",[35,37.342]],["parent/761",[278,4.504]],["name/762",[213,31.561]],["parent/762",[278,4.504]],["name/763",[280,57.711]],["parent/763",[]],["name/764",[209,38.574]],["parent/764",[280,5.563]],["name/765",[176,30.483]],["parent/765",[280,5.563]],["name/766",[213,31.561]],["parent/766",[280,5.563]],["name/767",[281,46.725]],["parent/767",[]],["name/768",[153,37.939]],["parent/768",[281,4.504]],["name/769",[3,22.746]],["parent/769",[281,4.504]],["name/770",[235,47.494]],["parent/770",[282,6.622]],["name/771",[176,30.483]],["parent/771",[281,4.504]],["name/772",[217,37.342]],["parent/772",[281,4.504]],["name/773",[174,34.575]],["parent/773",[281,4.504]],["name/774",[218,38.252]],["parent/774",[281,4.504]],["name/775",[219,38.252]],["parent/775",[281,4.504]],["name/776",[220,38.252]],["parent/776",[281,4.504]],["name/777",[221,38.252]],["parent/777",[281,4.504]],["name/778",[222,38.252]],["parent/778",[281,4.504]],["name/779",[35,37.342]],["parent/779",[281,4.504]],["name/780",[213,31.561]],["parent/780",[281,4.504]],["name/781",[283,50.239]],["parent/781",[]],["name/782",[209,38.574]],["parent/782",[283,4.843]],["name/783",[189,37.056]],["parent/783",[283,4.843]],["name/784",[190,36.508]],["parent/784",[283,4.843]],["name/785",[254,55.704]],["parent/785",[283,4.843]],["name/786",[211,49.238]],["parent/786",[283,4.843]],["name/787",[212,47.494]],["parent/787",[283,4.843]],["name/788",[176,30.483]],["parent/788",[283,4.843]],["name/789",[213,31.561]],["parent/789",[283,4.843]],["name/790",[284,46.725]],["parent/790",[]],["name/791",[153,37.939]],["parent/791",[284,4.504]],["name/792",[3,22.746]],["parent/792",[284,4.504]],["name/793",[190,36.508]],["parent/793",[285,5.563]],["name/794",[189,37.056]],["parent/794",[285,5.563]],["name/795",[286,63.589]],["parent/795",[285,5.563]],["name/796",[212,47.494]],["parent/796",[285,5.563]],["name/797",[176,30.483]],["parent/797",[284,4.504]],["name/798",[217,37.342]],["parent/798",[284,4.504]],["name/799",[174,34.575]],["parent/799",[284,4.504]],["name/800",[218,38.252]],["parent/800",[284,4.504]],["name/801",[219,38.252]],["parent/801",[284,4.504]],["name/802",[220,38.252]],["parent/802",[284,4.504]],["name/803",[221,38.252]],["parent/803",[284,4.504]],["name/804",[222,38.252]],["parent/804",[284,4.504]],["name/805",[35,37.342]],["parent/805",[284,4.504]],["name/806",[213,31.561]],["parent/806",[284,4.504]],["name/807",[287,43.574]],["parent/807",[]],["name/808",[209,38.574]],["parent/808",[287,4.2]],["name/809",[254,55.704]],["parent/809",[287,4.2]],["name/810",[189,37.056]],["parent/810",[287,4.2]],["name/811",[190,36.508]],["parent/811",[287,4.2]],["name/812",[288,63.589]],["parent/812",[287,4.2]],["name/813",[289,68.697]],["parent/813",[287,4.2]],["name/814",[290,68.697]],["parent/814",[287,4.2]],["name/815",[291,68.697]],["parent/815",[287,4.2]],["name/816",[292,68.697]],["parent/816",[287,4.2]],["name/817",[3,22.746]],["parent/817",[287,4.2]],["name/818",[272,57.711]],["parent/818",[293,6.129]],["name/819",[159,63.589]],["parent/819",[293,6.129]],["name/820",[294,68.697]],["parent/820",[287,4.2]],["name/821",[295,68.697]],["parent/821",[287,4.2]],["name/822",[296,68.697]],["parent/822",[287,4.2]],["name/823",[297,68.697]],["parent/823",[287,4.2]],["name/824",[298,68.697]],["parent/824",[287,4.2]],["name/825",[176,30.483]],["parent/825",[287,4.2]],["name/826",[213,31.561]],["parent/826",[287,4.2]],["name/827",[299,46.725]],["parent/827",[]],["name/828",[153,37.939]],["parent/828",[299,4.504]],["name/829",[3,22.746]],["parent/829",[299,4.504]],["name/830",[288,63.589]],["parent/830",[300,5.563]],["name/831",[190,36.508]],["parent/831",[300,5.563]],["name/832",[301,68.697]],["parent/832",[300,5.563]],["name/833",[302,68.697]],["parent/833",[300,5.563]],["name/834",[176,30.483]],["parent/834",[299,4.504]],["name/835",[217,37.342]],["parent/835",[299,4.504]],["name/836",[174,34.575]],["parent/836",[299,4.504]],["name/837",[218,38.252]],["parent/837",[299,4.504]],["name/838",[219,38.252]],["parent/838",[299,4.504]],["name/839",[220,38.252]],["parent/839",[299,4.504]],["name/840",[221,38.252]],["parent/840",[299,4.504]],["name/841",[222,38.252]],["parent/841",[299,4.504]],["name/842",[35,37.342]],["parent/842",[299,4.504]],["name/843",[213,31.561]],["parent/843",[299,4.504]],["name/844",[303,54.034]],["parent/844",[]],["name/845",[209,38.574]],["parent/845",[303,5.208]],["name/846",[304,60.224]],["parent/846",[303,5.208]],["name/847",[305,63.589]],["parent/847",[303,5.208]],["name/848",[176,30.483]],["parent/848",[303,5.208]],["name/849",[213,31.561]],["parent/849",[303,5.208]],["name/850",[306,46.725]],["parent/850",[]],["name/851",[153,37.939]],["parent/851",[306,4.504]],["name/852",[3,22.746]],["parent/852",[306,4.504]],["name/853",[307,57.711]],["parent/853",[308,4.435]],["name/854",[309,57.711]],["parent/854",[308,4.435]],["name/855",[310,57.711]],["parent/855",[308,4.435]],["name/856",[304,60.224]],["parent/856",[308,4.435]],["name/857",[311,57.711]],["parent/857",[308,4.435]],["name/858",[312,68.697]],["parent/858",[308,4.435]],["name/859",[313,68.697]],["parent/859",[308,4.435]],["name/860",[314,68.697]],["parent/860",[308,4.435]],["name/861",[315,68.697]],["parent/861",[308,4.435]],["name/862",[316,68.697]],["parent/862",[308,4.435]],["name/863",[317,68.697]],["parent/863",[308,4.435]],["name/864",[318,68.697]],["parent/864",[308,4.435]],["name/865",[319,68.697]],["parent/865",[308,4.435]],["name/866",[320,68.697]],["parent/866",[308,4.435]],["name/867",[176,30.483]],["parent/867",[306,4.504]],["name/868",[217,37.342]],["parent/868",[306,4.504]],["name/869",[174,34.575]],["parent/869",[306,4.504]],["name/870",[218,38.252]],["parent/870",[306,4.504]],["name/871",[219,38.252]],["parent/871",[306,4.504]],["name/872",[220,38.252]],["parent/872",[306,4.504]],["name/873",[221,38.252]],["parent/873",[306,4.504]],["name/874",[222,38.252]],["parent/874",[306,4.504]],["name/875",[35,37.342]],["parent/875",[306,4.504]],["name/876",[213,31.561]],["parent/876",[306,4.504]],["name/877",[321,54.034]],["parent/877",[]],["name/878",[209,38.574]],["parent/878",[321,5.208]],["name/879",[311,57.711]],["parent/879",[321,5.208]],["name/880",[305,63.589]],["parent/880",[321,5.208]],["name/881",[176,30.483]],["parent/881",[321,5.208]],["name/882",[213,31.561]],["parent/882",[321,5.208]],["name/883",[322,46.725]],["parent/883",[]],["name/884",[153,37.939]],["parent/884",[322,4.504]],["name/885",[3,22.746]],["parent/885",[322,4.504]],["name/886",[307,57.711]],["parent/886",[323,5.369]],["name/887",[309,57.711]],["parent/887",[323,5.369]],["name/888",[310,57.711]],["parent/888",[323,5.369]],["name/889",[304,60.224]],["parent/889",[323,5.369]],["name/890",[311,57.711]],["parent/890",[323,5.369]],["name/891",[176,30.483]],["parent/891",[322,4.504]],["name/892",[217,37.342]],["parent/892",[322,4.504]],["name/893",[174,34.575]],["parent/893",[322,4.504]],["name/894",[218,38.252]],["parent/894",[322,4.504]],["name/895",[219,38.252]],["parent/895",[322,4.504]],["name/896",[220,38.252]],["parent/896",[322,4.504]],["name/897",[221,38.252]],["parent/897",[322,4.504]],["name/898",[222,38.252]],["parent/898",[322,4.504]],["name/899",[35,37.342]],["parent/899",[322,4.504]],["name/900",[213,31.561]],["parent/900",[322,4.504]],["name/901",[324,52.603]],["parent/901",[]],["name/902",[209,38.574]],["parent/902",[324,5.07]],["name/903",[189,37.056]],["parent/903",[324,5.07]],["name/904",[190,36.508]],["parent/904",[324,5.07]],["name/905",[325,68.697]],["parent/905",[324,5.07]],["name/906",[176,30.483]],["parent/906",[324,5.07]],["name/907",[213,31.561]],["parent/907",[324,5.07]],["name/908",[326,46.725]],["parent/908",[]],["name/909",[153,37.939]],["parent/909",[326,4.504]],["name/910",[3,22.746]],["parent/910",[326,4.504]],["name/911",[189,37.056]],["parent/911",[327,5.563]],["name/912",[190,36.508]],["parent/912",[327,5.563]],["name/913",[328,68.697]],["parent/913",[327,5.563]],["name/914",[311,57.711]],["parent/914",[327,5.563]],["name/915",[176,30.483]],["parent/915",[326,4.504]],["name/916",[217,37.342]],["parent/916",[326,4.504]],["name/917",[174,34.575]],["parent/917",[326,4.504]],["name/918",[218,38.252]],["parent/918",[326,4.504]],["name/919",[219,38.252]],["parent/919",[326,4.504]],["name/920",[220,38.252]],["parent/920",[326,4.504]],["name/921",[221,38.252]],["parent/921",[326,4.504]],["name/922",[222,38.252]],["parent/922",[326,4.504]],["name/923",[35,37.342]],["parent/923",[326,4.504]],["name/924",[213,31.561]],["parent/924",[326,4.504]],["name/925",[329,51.351]],["parent/925",[]],["name/926",[209,38.574]],["parent/926",[329,4.95]],["name/927",[330,60.224]],["parent/927",[329,4.95]],["name/928",[254,55.704]],["parent/928",[329,4.95]],["name/929",[331,68.697]],["parent/929",[329,4.95]],["name/930",[332,68.697]],["parent/930",[329,4.95]],["name/931",[176,30.483]],["parent/931",[329,4.95]],["name/932",[213,31.561]],["parent/932",[329,4.95]],["name/933",[333,46.725]],["parent/933",[]],["name/934",[153,37.939]],["parent/934",[333,4.504]],["name/935",[334,68.697]],["parent/935",[333,4.504]],["name/936",[176,30.483]],["parent/936",[333,4.504]],["name/937",[217,37.342]],["parent/937",[333,4.504]],["name/938",[174,34.575]],["parent/938",[333,4.504]],["name/939",[218,38.252]],["parent/939",[333,4.504]],["name/940",[219,38.252]],["parent/940",[333,4.504]],["name/941",[220,38.252]],["parent/941",[333,4.504]],["name/942",[221,38.252]],["parent/942",[333,4.504]],["name/943",[222,38.252]],["parent/943",[333,4.504]],["name/944",[35,37.342]],["parent/944",[333,4.504]],["name/945",[213,31.561]],["parent/945",[333,4.504]],["name/946",[335,49.238]],["parent/946",[]],["name/947",[209,38.574]],["parent/947",[335,4.746]],["name/948",[189,37.056]],["parent/948",[335,4.746]],["name/949",[190,36.508]],["parent/949",[335,4.746]],["name/950",[211,49.238]],["parent/950",[335,4.746]],["name/951",[336,68.697]],["parent/951",[335,4.746]],["name/952",[337,68.697]],["parent/952",[335,4.746]],["name/953",[338,68.697]],["parent/953",[335,4.746]],["name/954",[176,30.483]],["parent/954",[335,4.746]],["name/955",[213,31.561]],["parent/955",[335,4.746]],["name/956",[339,46.725]],["parent/956",[]],["name/957",[153,37.939]],["parent/957",[339,4.504]],["name/958",[3,22.746]],["parent/958",[339,4.504]],["name/959",[235,47.494]],["parent/959",[340,5.563]],["name/960",[190,36.508]],["parent/960",[340,5.563]],["name/961",[189,37.056]],["parent/961",[340,5.563]],["name/962",[250,63.589]],["parent/962",[340,5.563]],["name/963",[176,30.483]],["parent/963",[339,4.504]],["name/964",[217,37.342]],["parent/964",[339,4.504]],["name/965",[174,34.575]],["parent/965",[339,4.504]],["name/966",[218,38.252]],["parent/966",[339,4.504]],["name/967",[219,38.252]],["parent/967",[339,4.504]],["name/968",[220,38.252]],["parent/968",[339,4.504]],["name/969",[221,38.252]],["parent/969",[339,4.504]],["name/970",[222,38.252]],["parent/970",[339,4.504]],["name/971",[35,37.342]],["parent/971",[339,4.504]],["name/972",[213,31.561]],["parent/972",[339,4.504]],["name/973",[341,51.351]],["parent/973",[]],["name/974",[209,38.574]],["parent/974",[341,4.95]],["name/975",[342,55.704]],["parent/975",[341,4.95]],["name/976",[210,51.351]],["parent/976",[341,4.95]],["name/977",[189,37.056]],["parent/977",[341,4.95]],["name/978",[190,36.508]],["parent/978",[341,4.95]],["name/979",[176,30.483]],["parent/979",[341,4.95]],["name/980",[213,31.561]],["parent/980",[341,4.95]],["name/981",[343,46.725]],["parent/981",[]],["name/982",[153,37.939]],["parent/982",[343,4.504]],["name/983",[3,22.746]],["parent/983",[343,4.504]],["name/984",[344,68.697]],["parent/984",[345,5.07]],["name/985",[210,51.351]],["parent/985",[345,5.07]],["name/986",[189,37.056]],["parent/986",[345,5.07]],["name/987",[190,36.508]],["parent/987",[345,5.07]],["name/988",[235,47.494]],["parent/988",[345,5.07]],["name/989",[342,55.704]],["parent/989",[345,5.07]],["name/990",[198,49.238]],["parent/990",[345,5.07]],["name/991",[176,30.483]],["parent/991",[343,4.504]],["name/992",[217,37.342]],["parent/992",[343,4.504]],["name/993",[174,34.575]],["parent/993",[343,4.504]],["name/994",[218,38.252]],["parent/994",[343,4.504]],["name/995",[219,38.252]],["parent/995",[343,4.504]],["name/996",[220,38.252]],["parent/996",[343,4.504]],["name/997",[221,38.252]],["parent/997",[343,4.504]],["name/998",[222,38.252]],["parent/998",[343,4.504]],["name/999",[35,37.342]],["parent/999",[343,4.504]],["name/1000",[213,31.561]],["parent/1000",[343,4.504]],["name/1001",[346,68.697]],["parent/1001",[]],["name/1002",[347,46.725]],["parent/1002",[]],["name/1003",[153,37.939]],["parent/1003",[347,4.504]],["name/1004",[3,22.746]],["parent/1004",[347,4.504]],["name/1005",[348,60.224]],["parent/1005",[349,4.95]],["name/1006",[210,51.351]],["parent/1006",[349,4.95]],["name/1007",[350,60.224]],["parent/1007",[349,4.95]],["name/1008",[342,55.704]],["parent/1008",[349,4.95]],["name/1009",[351,63.589]],["parent/1009",[349,4.95]],["name/1010",[176,30.483]],["parent/1010",[349,4.95]],["name/1011",[188,63.589]],["parent/1011",[349,4.95]],["name/1012",[217,37.342]],["parent/1012",[349,4.95]],["name/1013",[176,30.483]],["parent/1013",[347,4.504]],["name/1014",[217,37.342]],["parent/1014",[347,4.504]],["name/1015",[174,34.575]],["parent/1015",[347,4.504]],["name/1016",[218,38.252]],["parent/1016",[347,4.504]],["name/1017",[219,38.252]],["parent/1017",[347,4.504]],["name/1018",[220,38.252]],["parent/1018",[347,4.504]],["name/1019",[221,38.252]],["parent/1019",[347,4.504]],["name/1020",[222,38.252]],["parent/1020",[347,4.504]],["name/1021",[35,37.342]],["parent/1021",[347,4.504]],["name/1022",[213,31.561]],["parent/1022",[347,4.504]],["name/1023",[352,48.328]],["parent/1023",[]],["name/1024",[209,38.574]],["parent/1024",[352,4.658]],["name/1025",[342,55.704]],["parent/1025",[352,4.658]],["name/1026",[210,51.351]],["parent/1026",[352,4.658]],["name/1027",[350,60.224]],["parent/1027",[352,4.658]],["name/1028",[353,63.589]],["parent/1028",[352,4.658]],["name/1029",[354,68.697]],["parent/1029",[352,4.658]],["name/1030",[189,37.056]],["parent/1030",[352,4.658]],["name/1031",[190,36.508]],["parent/1031",[352,4.658]],["name/1032",[176,30.483]],["parent/1032",[352,4.658]],["name/1033",[213,31.561]],["parent/1033",[352,4.658]],["name/1034",[355,46.725]],["parent/1034",[]],["name/1035",[153,37.939]],["parent/1035",[355,4.504]],["name/1036",[3,22.746]],["parent/1036",[355,4.504]],["name/1037",[348,60.224]],["parent/1037",[356,5.805]],["name/1038",[210,51.351]],["parent/1038",[356,5.805]],["name/1039",[357,68.697]],["parent/1039",[356,5.805]],["name/1040",[176,30.483]],["parent/1040",[355,4.504]],["name/1041",[217,37.342]],["parent/1041",[355,4.504]],["name/1042",[174,34.575]],["parent/1042",[355,4.504]],["name/1043",[218,38.252]],["parent/1043",[355,4.504]],["name/1044",[219,38.252]],["parent/1044",[355,4.504]],["name/1045",[220,38.252]],["parent/1045",[355,4.504]],["name/1046",[221,38.252]],["parent/1046",[355,4.504]],["name/1047",[222,38.252]],["parent/1047",[355,4.504]],["name/1048",[35,37.342]],["parent/1048",[355,4.504]],["name/1049",[213,31.561]],["parent/1049",[355,4.504]],["name/1050",[358,51.351]],["parent/1050",[]],["name/1051",[209,38.574]],["parent/1051",[358,4.95]],["name/1052",[359,68.697]],["parent/1052",[358,4.95]],["name/1053",[360,68.697]],["parent/1053",[358,4.95]],["name/1054",[361,63.589]],["parent/1054",[358,4.95]],["name/1055",[362,63.589]],["parent/1055",[358,4.95]],["name/1056",[176,30.483]],["parent/1056",[358,4.95]],["name/1057",[213,31.561]],["parent/1057",[358,4.95]],["name/1058",[363,46.725]],["parent/1058",[]],["name/1059",[153,37.939]],["parent/1059",[363,4.504]],["name/1060",[3,22.746]],["parent/1060",[363,4.504]],["name/1061",[364,68.697]],["parent/1061",[365,6.622]],["name/1062",[176,30.483]],["parent/1062",[363,4.504]],["name/1063",[217,37.342]],["parent/1063",[363,4.504]],["name/1064",[174,34.575]],["parent/1064",[363,4.504]],["name/1065",[218,38.252]],["parent/1065",[363,4.504]],["name/1066",[219,38.252]],["parent/1066",[363,4.504]],["name/1067",[220,38.252]],["parent/1067",[363,4.504]],["name/1068",[221,38.252]],["parent/1068",[363,4.504]],["name/1069",[222,38.252]],["parent/1069",[363,4.504]],["name/1070",[35,37.342]],["parent/1070",[363,4.504]],["name/1071",[213,31.561]],["parent/1071",[363,4.504]],["name/1072",[366,48.328]],["parent/1072",[]],["name/1073",[209,38.574]],["parent/1073",[366,4.658]],["name/1074",[367,63.589]],["parent/1074",[366,4.658]],["name/1075",[272,57.711]],["parent/1075",[366,4.658]],["name/1076",[368,63.589]],["parent/1076",[366,4.658]],["name/1077",[369,63.589]],["parent/1077",[366,4.658]],["name/1078",[370,68.697]],["parent/1078",[366,4.658]],["name/1079",[371,68.697]],["parent/1079",[366,4.658]],["name/1080",[372,68.697]],["parent/1080",[366,4.658]],["name/1081",[176,30.483]],["parent/1081",[366,4.658]],["name/1082",[213,31.561]],["parent/1082",[366,4.658]],["name/1083",[373,47.494]],["parent/1083",[]],["name/1084",[153,37.939]],["parent/1084",[373,4.578]],["name/1085",[176,30.483]],["parent/1085",[373,4.578]],["name/1086",[217,37.342]],["parent/1086",[373,4.578]],["name/1087",[174,34.575]],["parent/1087",[373,4.578]],["name/1088",[218,38.252]],["parent/1088",[373,4.578]],["name/1089",[219,38.252]],["parent/1089",[373,4.578]],["name/1090",[220,38.252]],["parent/1090",[373,4.578]],["name/1091",[221,38.252]],["parent/1091",[373,4.578]],["name/1092",[222,38.252]],["parent/1092",[373,4.578]],["name/1093",[35,37.342]],["parent/1093",[373,4.578]],["name/1094",[213,31.561]],["parent/1094",[373,4.578]],["name/1095",[374,68.697]],["parent/1095",[]],["name/1096",[375,48.328]],["parent/1096",[]],["name/1097",[174,34.575]],["parent/1097",[375,4.658]],["name/1098",[200,63.589]],["parent/1098",[375,4.658]],["name/1099",[201,63.589]],["parent/1099",[375,4.658]],["name/1100",[189,37.056]],["parent/1100",[375,4.658]],["name/1101",[190,36.508]],["parent/1101",[375,4.658]],["name/1102",[202,63.589]],["parent/1102",[375,4.658]],["name/1103",[203,55.704]],["parent/1103",[375,4.658]],["name/1104",[204,55.704]],["parent/1104",[375,4.658]],["name/1105",[205,63.589]],["parent/1105",[375,4.658]],["name/1106",[206,63.589]],["parent/1106",[375,4.658]],["name/1107",[376,45.343]],["parent/1107",[]],["name/1108",[174,34.575]],["parent/1108",[376,4.371]],["name/1109",[377,68.697]],["parent/1109",[376,4.371]],["name/1110",[378,57.711]],["parent/1110",[376,4.371]],["name/1111",[122,57.711]],["parent/1111",[376,4.371]],["name/1112",[271,63.589]],["parent/1112",[376,4.371]],["name/1113",[189,37.056]],["parent/1113",[376,4.371]],["name/1114",[190,36.508]],["parent/1114",[376,4.371]],["name/1115",[379,68.697]],["parent/1115",[376,4.371]],["name/1116",[380,63.589]],["parent/1116",[376,4.371]],["name/1117",[203,55.704]],["parent/1117",[376,4.371]],["name/1118",[204,55.704]],["parent/1118",[376,4.371]],["name/1119",[362,63.589]],["parent/1119",[376,4.371]],["name/1120",[381,68.697]],["parent/1120",[376,4.371]],["name/1121",[382,68.697]],["parent/1121",[376,4.371]],["name/1122",[383,47.494]],["parent/1122",[]],["name/1123",[217,37.342]],["parent/1123",[383,4.578]],["name/1124",[174,34.575]],["parent/1124",[383,4.578]],["name/1125",[307,57.711]],["parent/1125",[383,4.578]],["name/1126",[309,57.711]],["parent/1126",[383,4.578]],["name/1127",[310,57.711]],["parent/1127",[383,4.578]],["name/1128",[235,47.494]],["parent/1128",[383,4.578]],["name/1129",[189,37.056]],["parent/1129",[383,4.578]],["name/1130",[190,36.508]],["parent/1130",[383,4.578]],["name/1131",[384,63.589]],["parent/1131",[383,4.578]],["name/1132",[330,60.224]],["parent/1132",[383,4.578]],["name/1133",[198,49.238]],["parent/1133",[383,4.578]],["name/1134",[385,49.238]],["parent/1134",[]],["name/1135",[174,34.575]],["parent/1135",[385,4.746]],["name/1136",[342,55.704]],["parent/1136",[385,4.746]],["name/1137",[210,51.351]],["parent/1137",[385,4.746]],["name/1138",[350,60.224]],["parent/1138",[385,4.746]],["name/1139",[351,63.589]],["parent/1139",[385,4.746]],["name/1140",[176,30.483]],["parent/1140",[385,4.746]],["name/1141",[353,63.589]],["parent/1141",[385,4.746]],["name/1142",[348,60.224]],["parent/1142",[385,4.746]],["name/1143",[3,22.746]],["parent/1143",[385,4.746]],["name/1144",[386,68.697]],["parent/1144",[387,6.129]],["name/1145",[388,68.697]],["parent/1145",[387,6.129]],["name/1146",[389,51.351]],["parent/1146",[]],["name/1147",[174,34.575]],["parent/1147",[389,4.95]],["name/1148",[390,68.697]],["parent/1148",[389,4.95]],["name/1149",[391,68.697]],["parent/1149",[389,4.95]],["name/1150",[189,37.056]],["parent/1150",[389,4.95]],["name/1151",[190,36.508]],["parent/1151",[389,4.95]],["name/1152",[253,60.224]],["parent/1152",[389,4.95]],["name/1153",[252,60.224]],["parent/1153",[389,4.95]],["name/1154",[392,47.494]],["parent/1154",[]],["name/1155",[217,37.342]],["parent/1155",[392,4.578]],["name/1156",[174,34.575]],["parent/1156",[392,4.578]],["name/1157",[307,57.711]],["parent/1157",[392,4.578]],["name/1158",[309,57.711]],["parent/1158",[392,4.578]],["name/1159",[310,57.711]],["parent/1159",[392,4.578]],["name/1160",[235,47.494]],["parent/1160",[392,4.578]],["name/1161",[189,37.056]],["parent/1161",[392,4.578]],["name/1162",[190,36.508]],["parent/1162",[392,4.578]],["name/1163",[384,63.589]],["parent/1163",[392,4.578]],["name/1164",[330,60.224]],["parent/1164",[392,4.578]],["name/1165",[198,49.238]],["parent/1165",[392,4.578]],["name/1166",[393,60.224]],["parent/1166",[]],["name/1167",[174,34.575]],["parent/1167",[393,5.805]],["name/1168",[394,68.697]],["parent/1168",[393,5.805]],["name/1169",[395,51.351]],["parent/1169",[]],["name/1170",[209,38.574]],["parent/1170",[395,4.95]],["name/1171",[367,63.589]],["parent/1171",[395,4.95]],["name/1172",[272,57.711]],["parent/1172",[395,4.95]],["name/1173",[368,63.589]],["parent/1173",[395,4.95]],["name/1174",[369,63.589]],["parent/1174",[395,4.95]],["name/1175",[176,30.483]],["parent/1175",[395,4.95]],["name/1176",[213,31.561]],["parent/1176",[395,4.95]],["name/1177",[396,46.725]],["parent/1177",[]],["name/1178",[153,37.939]],["parent/1178",[396,4.504]],["name/1179",[3,22.746]],["parent/1179",[396,4.504]],["name/1180",[176,30.483]],["parent/1180",[396,4.504]],["name/1181",[217,37.342]],["parent/1181",[396,4.504]],["name/1182",[174,34.575]],["parent/1182",[396,4.504]],["name/1183",[218,38.252]],["parent/1183",[396,4.504]],["name/1184",[219,38.252]],["parent/1184",[396,4.504]],["name/1185",[220,38.252]],["parent/1185",[396,4.504]],["name/1186",[221,38.252]],["parent/1186",[396,4.504]],["name/1187",[222,38.252]],["parent/1187",[396,4.504]],["name/1188",[35,37.342]],["parent/1188",[396,4.504]],["name/1189",[213,31.561]],["parent/1189",[396,4.504]],["name/1190",[397,57.711]],["parent/1190",[]],["name/1191",[209,38.574]],["parent/1191",[397,5.563]],["name/1192",[176,30.483]],["parent/1192",[397,5.563]],["name/1193",[213,31.561]],["parent/1193",[397,5.563]],["name/1194",[398,46.725]],["parent/1194",[]],["name/1195",[153,37.939]],["parent/1195",[398,4.504]],["name/1196",[3,22.746]],["parent/1196",[398,4.504]],["name/1197",[399,68.697]],["parent/1197",[400,4.843]],["name/1198",[401,68.697]],["parent/1198",[400,4.843]],["name/1199",[402,68.697]],["parent/1199",[400,4.843]],["name/1200",[3,22.746]],["parent/1200",[400,4.843]],["name/1201",[378,57.711]],["parent/1201",[403,4.95]],["name/1202",[404,68.697]],["parent/1202",[403,4.95]],["name/1203",[405,68.697]],["parent/1203",[403,4.95]],["name/1204",[406,68.697]],["parent/1204",[403,4.95]],["name/1205",[407,68.697]],["parent/1205",[400,4.843]],["name/1206",[235,47.494]],["parent/1206",[400,4.843]],["name/1207",[408,68.697]],["parent/1207",[400,4.843]],["name/1208",[3,22.746]],["parent/1208",[400,4.843]],["name/1209",[409,68.697]],["parent/1209",[403,4.95]],["name/1210",[410,68.697]],["parent/1210",[403,4.95]],["name/1211",[411,68.697]],["parent/1211",[403,4.95]],["name/1212",[412,68.697]],["parent/1212",[403,4.95]],["name/1213",[413,68.697]],["parent/1213",[400,4.843]],["name/1214",[176,30.483]],["parent/1214",[398,4.504]],["name/1215",[217,37.342]],["parent/1215",[398,4.504]],["name/1216",[174,34.575]],["parent/1216",[398,4.504]],["name/1217",[218,38.252]],["parent/1217",[398,4.504]],["name/1218",[219,38.252]],["parent/1218",[398,4.504]],["name/1219",[220,38.252]],["parent/1219",[398,4.504]],["name/1220",[221,38.252]],["parent/1220",[398,4.504]],["name/1221",[222,38.252]],["parent/1221",[398,4.504]],["name/1222",[35,37.342]],["parent/1222",[398,4.504]],["name/1223",[213,31.561]],["parent/1223",[398,4.504]],["name/1224",[414,55.704]],["parent/1224",[]],["name/1225",[209,38.574]],["parent/1225",[414,5.369]],["name/1226",[361,63.589]],["parent/1226",[414,5.369]],["name/1227",[176,30.483]],["parent/1227",[414,5.369]],["name/1228",[213,31.561]],["parent/1228",[414,5.369]],["name/1229",[415,46.725]],["parent/1229",[]],["name/1230",[153,37.939]],["parent/1230",[415,4.504]],["name/1231",[3,22.746]],["parent/1231",[415,4.504]],["name/1232",[416,68.697]],["parent/1232",[417,5.563]],["name/1233",[3,22.746]],["parent/1233",[417,5.563]],["name/1234",[418,68.697]],["parent/1234",[419,5.563]],["name/1235",[420,68.697]],["parent/1235",[419,5.563]],["name/1236",[380,63.589]],["parent/1236",[419,5.563]],["name/1237",[421,55.704]],["parent/1237",[419,5.563]],["name/1238",[422,68.697]],["parent/1238",[417,5.563]],["name/1239",[423,68.697]],["parent/1239",[417,5.563]],["name/1240",[176,30.483]],["parent/1240",[415,4.504]],["name/1241",[217,37.342]],["parent/1241",[415,4.504]],["name/1242",[174,34.575]],["parent/1242",[415,4.504]],["name/1243",[218,38.252]],["parent/1243",[415,4.504]],["name/1244",[219,38.252]],["parent/1244",[415,4.504]],["name/1245",[220,38.252]],["parent/1245",[415,4.504]],["name/1246",[221,38.252]],["parent/1246",[415,4.504]],["name/1247",[222,38.252]],["parent/1247",[415,4.504]],["name/1248",[35,37.342]],["parent/1248",[415,4.504]],["name/1249",[213,31.561]],["parent/1249",[415,4.504]],["name/1250",[424,57.711]],["parent/1250",[]],["name/1251",[209,38.574]],["parent/1251",[424,5.563]],["name/1252",[176,30.483]],["parent/1252",[424,5.563]],["name/1253",[213,31.561]],["parent/1253",[424,5.563]],["name/1254",[425,46.725]],["parent/1254",[]],["name/1255",[153,37.939]],["parent/1255",[425,4.504]],["name/1256",[3,22.746]],["parent/1256",[425,4.504]],["name/1257",[426,68.697]],["parent/1257",[427,6.129]],["name/1258",[3,22.746]],["parent/1258",[427,6.129]],["name/1259",[428,63.589]],["parent/1259",[429,3.657]],["name/1260",[430,63.589]],["parent/1260",[429,3.657]],["name/1261",[431,63.589]],["parent/1261",[429,3.657]],["name/1262",[3,22.746]],["parent/1262",[429,3.657]],["name/1263",[432,57.711]],["parent/1263",[433,4.31]],["name/1264",[434,63.589]],["parent/1264",[433,4.31]],["name/1265",[435,57.711]],["parent/1265",[433,4.31]],["name/1266",[436,63.589]],["parent/1266",[433,4.31]],["name/1267",[437,63.589]],["parent/1267",[433,4.31]],["name/1268",[421,55.704]],["parent/1268",[433,4.31]],["name/1269",[438,63.589]],["parent/1269",[429,3.657]],["name/1270",[439,68.697]],["parent/1270",[429,3.657]],["name/1271",[440,63.589]],["parent/1271",[429,3.657]],["name/1272",[441,63.589]],["parent/1272",[429,3.657]],["name/1273",[442,63.589]],["parent/1273",[429,3.657]],["name/1274",[3,22.746]],["parent/1274",[429,3.657]],["name/1275",[443,63.589]],["parent/1275",[433,4.31]],["name/1276",[444,63.589]],["parent/1276",[433,4.31]],["name/1277",[445,63.589]],["parent/1277",[429,3.657]],["name/1278",[3,22.746]],["parent/1278",[429,3.657]],["name/1279",[446,63.589]],["parent/1279",[433,4.31]],["name/1280",[447,63.589]],["parent/1280",[433,4.31]],["name/1281",[448,63.589]],["parent/1281",[429,3.657]],["name/1282",[449,68.697]],["parent/1282",[429,3.657]],["name/1283",[450,68.697]],["parent/1283",[429,3.657]],["name/1284",[451,68.697]],["parent/1284",[429,3.657]],["name/1285",[452,63.589]],["parent/1285",[429,3.657]],["name/1286",[453,63.589]],["parent/1286",[429,3.657]],["name/1287",[454,63.589]],["parent/1287",[429,3.657]],["name/1288",[455,68.697]],["parent/1288",[429,3.657]],["name/1289",[456,63.589]],["parent/1289",[429,3.657]],["name/1290",[457,63.589]],["parent/1290",[429,3.657]],["name/1291",[458,63.589]],["parent/1291",[429,3.657]],["name/1292",[459,63.589]],["parent/1292",[429,3.657]],["name/1293",[460,63.589]],["parent/1293",[429,3.657]],["name/1294",[461,63.589]],["parent/1294",[429,3.657]],["name/1295",[462,63.589]],["parent/1295",[429,3.657]],["name/1296",[463,63.589]],["parent/1296",[429,3.657]],["name/1297",[464,63.589]],["parent/1297",[429,3.657]],["name/1298",[3,22.746]],["parent/1298",[429,3.657]],["name/1299",[432,57.711]],["parent/1299",[433,4.31]],["name/1300",[434,63.589]],["parent/1300",[433,4.31]],["name/1301",[435,57.711]],["parent/1301",[433,4.31]],["name/1302",[436,63.589]],["parent/1302",[433,4.31]],["name/1303",[437,63.589]],["parent/1303",[433,4.31]],["name/1304",[421,55.704]],["parent/1304",[433,4.31]],["name/1305",[465,63.589]],["parent/1305",[429,3.657]],["name/1306",[466,63.589]],["parent/1306",[429,3.657]],["name/1307",[176,30.483]],["parent/1307",[425,4.504]],["name/1308",[217,37.342]],["parent/1308",[425,4.504]],["name/1309",[174,34.575]],["parent/1309",[425,4.504]],["name/1310",[218,38.252]],["parent/1310",[425,4.504]],["name/1311",[219,38.252]],["parent/1311",[425,4.504]],["name/1312",[220,38.252]],["parent/1312",[425,4.504]],["name/1313",[221,38.252]],["parent/1313",[425,4.504]],["name/1314",[222,38.252]],["parent/1314",[425,4.504]],["name/1315",[35,37.342]],["parent/1315",[425,4.504]],["name/1316",[213,31.561]],["parent/1316",[425,4.504]],["name/1317",[467,57.711]],["parent/1317",[]],["name/1318",[209,38.574]],["parent/1318",[467,5.563]],["name/1319",[176,30.483]],["parent/1319",[467,5.563]],["name/1320",[213,31.561]],["parent/1320",[467,5.563]],["name/1321",[468,46.725]],["parent/1321",[]],["name/1322",[153,37.939]],["parent/1322",[468,4.504]],["name/1323",[3,22.746]],["parent/1323",[468,4.504]],["name/1324",[286,63.589]],["parent/1324",[469,6.129]],["name/1325",[3,22.746]],["parent/1325",[469,6.129]],["name/1326",[428,63.589]],["parent/1326",[470,3.75]],["name/1327",[430,63.589]],["parent/1327",[470,3.75]],["name/1328",[438,63.589]],["parent/1328",[470,3.75]],["name/1329",[431,63.589]],["parent/1329",[470,3.75]],["name/1330",[3,22.746]],["parent/1330",[470,3.75]],["name/1331",[432,57.711]],["parent/1331",[471,4.31]],["name/1332",[378,57.711]],["parent/1332",[471,4.31]],["name/1333",[435,57.711]],["parent/1333",[471,4.31]],["name/1334",[203,55.704]],["parent/1334",[471,4.31]],["name/1335",[204,55.704]],["parent/1335",[471,4.31]],["name/1336",[421,55.704]],["parent/1336",[471,4.31]],["name/1337",[440,63.589]],["parent/1337",[470,3.75]],["name/1338",[441,63.589]],["parent/1338",[470,3.75]],["name/1339",[442,63.589]],["parent/1339",[470,3.75]],["name/1340",[3,22.746]],["parent/1340",[470,3.75]],["name/1341",[443,63.589]],["parent/1341",[471,4.31]],["name/1342",[444,63.589]],["parent/1342",[471,4.31]],["name/1343",[445,63.589]],["parent/1343",[470,3.75]],["name/1344",[3,22.746]],["parent/1344",[470,3.75]],["name/1345",[446,63.589]],["parent/1345",[471,4.31]],["name/1346",[447,63.589]],["parent/1346",[471,4.31]],["name/1347",[472,68.697]],["parent/1347",[470,3.75]],["name/1348",[448,63.589]],["parent/1348",[470,3.75]],["name/1349",[452,63.589]],["parent/1349",[470,3.75]],["name/1350",[453,63.589]],["parent/1350",[470,3.75]],["name/1351",[473,68.697]],["parent/1351",[470,3.75]],["name/1352",[454,63.589]],["parent/1352",[470,3.75]],["name/1353",[456,63.589]],["parent/1353",[470,3.75]],["name/1354",[457,63.589]],["parent/1354",[470,3.75]],["name/1355",[458,63.589]],["parent/1355",[470,3.75]],["name/1356",[459,63.589]],["parent/1356",[470,3.75]],["name/1357",[460,63.589]],["parent/1357",[470,3.75]],["name/1358",[461,63.589]],["parent/1358",[470,3.75]],["name/1359",[462,63.589]],["parent/1359",[470,3.75]],["name/1360",[463,63.589]],["parent/1360",[470,3.75]],["name/1361",[464,63.589]],["parent/1361",[470,3.75]],["name/1362",[3,22.746]],["parent/1362",[470,3.75]],["name/1363",[432,57.711]],["parent/1363",[471,4.31]],["name/1364",[378,57.711]],["parent/1364",[471,4.31]],["name/1365",[435,57.711]],["parent/1365",[471,4.31]],["name/1366",[203,55.704]],["parent/1366",[471,4.31]],["name/1367",[204,55.704]],["parent/1367",[471,4.31]],["name/1368",[421,55.704]],["parent/1368",[471,4.31]],["name/1369",[465,63.589]],["parent/1369",[470,3.75]],["name/1370",[466,63.589]],["parent/1370",[470,3.75]],["name/1371",[176,30.483]],["parent/1371",[468,4.504]],["name/1372",[217,37.342]],["parent/1372",[468,4.504]],["name/1373",[174,34.575]],["parent/1373",[468,4.504]],["name/1374",[218,38.252]],["parent/1374",[468,4.504]],["name/1375",[219,38.252]],["parent/1375",[468,4.504]],["name/1376",[220,38.252]],["parent/1376",[468,4.504]],["name/1377",[221,38.252]],["parent/1377",[468,4.504]],["name/1378",[222,38.252]],["parent/1378",[468,4.504]],["name/1379",[35,37.342]],["parent/1379",[468,4.504]],["name/1380",[213,31.561]],["parent/1380",[468,4.504]],["name/1381",[474,57.711]],["parent/1381",[]],["name/1382",[209,38.574]],["parent/1382",[474,5.563]],["name/1383",[176,30.483]],["parent/1383",[474,5.563]],["name/1384",[213,31.561]],["parent/1384",[474,5.563]],["name/1385",[475,46.725]],["parent/1385",[]],["name/1386",[153,37.939]],["parent/1386",[475,4.504]],["name/1387",[3,22.746]],["parent/1387",[475,4.504]],["name/1388",[176,30.483]],["parent/1388",[475,4.504]],["name/1389",[217,37.342]],["parent/1389",[475,4.504]],["name/1390",[174,34.575]],["parent/1390",[475,4.504]],["name/1391",[218,38.252]],["parent/1391",[475,4.504]],["name/1392",[219,38.252]],["parent/1392",[475,4.504]],["name/1393",[220,38.252]],["parent/1393",[475,4.504]],["name/1394",[221,38.252]],["parent/1394",[475,4.504]],["name/1395",[222,38.252]],["parent/1395",[475,4.504]],["name/1396",[35,37.342]],["parent/1396",[475,4.504]],["name/1397",[213,31.561]],["parent/1397",[475,4.504]],["name/1398",[476,57.711]],["parent/1398",[]],["name/1399",[209,38.574]],["parent/1399",[476,5.563]],["name/1400",[176,30.483]],["parent/1400",[476,5.563]],["name/1401",[213,31.561]],["parent/1401",[476,5.563]],["name/1402",[477,46.725]],["parent/1402",[]],["name/1403",[153,37.939]],["parent/1403",[477,4.504]],["name/1404",[3,22.746]],["parent/1404",[477,4.504]],["name/1405",[478,68.697]],["parent/1405",[479,6.622]],["name/1406",[176,30.483]],["parent/1406",[477,4.504]],["name/1407",[217,37.342]],["parent/1407",[477,4.504]],["name/1408",[174,34.575]],["parent/1408",[477,4.504]],["name/1409",[218,38.252]],["parent/1409",[477,4.504]],["name/1410",[219,38.252]],["parent/1410",[477,4.504]],["name/1411",[220,38.252]],["parent/1411",[477,4.504]],["name/1412",[221,38.252]],["parent/1412",[477,4.504]],["name/1413",[222,38.252]],["parent/1413",[477,4.504]],["name/1414",[35,37.342]],["parent/1414",[477,4.504]],["name/1415",[213,31.561]],["parent/1415",[477,4.504]],["name/1416",[480,68.697]],["parent/1416",[]],["name/1417",[481,68.697]],["parent/1417",[]],["name/1418",[482,68.697]],["parent/1418",[]],["name/1419",[483,68.697]],["parent/1419",[]],["name/1420",[484,68.697]],["parent/1420",[]],["name/1421",[485,68.697]],["parent/1421",[]],["name/1422",[486,68.697]],["parent/1422",[]],["name/1423",[487,68.697]],["parent/1423",[]],["name/1424",[488,68.697]],["parent/1424",[]],["name/1425",[489,68.697]],["parent/1425",[]],["name/1426",[490,68.697]],["parent/1426",[]],["name/1427",[491,68.697]],["parent/1427",[]],["name/1428",[492,68.697]],["parent/1428",[]],["name/1429",[493,68.697]],["parent/1429",[]],["name/1430",[494,68.697]],["parent/1430",[]],["name/1431",[495,68.697]],["parent/1431",[]],["name/1432",[496,68.697]],["parent/1432",[]],["name/1433",[497,68.697]],["parent/1433",[]],["name/1434",[498,68.697]],["parent/1434",[]],["name/1435",[499,68.697]],["parent/1435",[]],["name/1436",[500,68.697]],["parent/1436",[]],["name/1437",[501,68.697]],["parent/1437",[]],["name/1438",[3,22.746]],["parent/1438",[]],["name/1439",[3,22.746]],["parent/1439",[]],["name/1440",[2,60.224]],["parent/1440",[]],["name/1441",[502,68.697]],["parent/1441",[]],["name/1442",[503,68.697]],["parent/1442",[]]],"invertedIndex":[["__type",{"_index":3,"name":{"3":{},"5":{},"7":{},"9":{},"11":{},"13":{},"15":{},"17":{},"19":{},"21":{},"23":{},"25":{},"27":{},"29":{},"31":{},"33":{},"35":{},"37":{},"60":{},"62":{},"64":{},"66":{},"68":{},"70":{},"72":{},"74":{},"76":{},"78":{},"80":{},"82":{},"84":{},"86":{},"88":{},"90":{},"92":{},"94":{},"96":{},"98":{},"100":{},"102":{},"104":{},"107":{},"109":{},"112":{},"120":{},"128":{},"134":{},"139":{},"145":{},"147":{},"149":{},"151":{},"153":{},"155":{},"157":{},"159":{},"161":{},"163":{},"165":{},"167":{},"169":{},"171":{},"173":{},"175":{},"177":{},"179":{},"204":{},"206":{},"208":{},"210":{},"212":{},"214":{},"216":{},"218":{},"220":{},"222":{},"224":{},"226":{},"228":{},"230":{},"232":{},"234":{},"236":{},"238":{},"240":{},"242":{},"244":{},"246":{},"248":{},"251":{},"253":{},"256":{},"264":{},"272":{},"278":{},"283":{},"320":{},"363":{},"366":{},"459":{},"488":{},"516":{},"545":{},"575":{},"606":{},"638":{},"667":{},"670":{},"672":{},"674":{},"699":{},"728":{},"750":{},"769":{},"792":{},"817":{},"829":{},"852":{},"885":{},"910":{},"958":{},"983":{},"1004":{},"1036":{},"1060":{},"1143":{},"1179":{},"1196":{},"1200":{},"1208":{},"1231":{},"1233":{},"1256":{},"1258":{},"1262":{},"1274":{},"1278":{},"1298":{},"1323":{},"1325":{},"1330":{},"1340":{},"1344":{},"1362":{},"1387":{},"1404":{},"1438":{},"1439":{}},"parent":{}}],["accepted",{"_index":312,"name":{"858":{}},"parent":{}}],["account",{"_index":119,"name":{"304":{},"334":{},"347":{},"449":{},"460":{},"479":{},"506":{},"535":{},"546":{},"564":{},"576":{},"596":{},"607":{},"625":{},"639":{},"658":{},"668":{},"690":{}},"parent":{}}],["account_data",{"_index":233,"name":{"517":{}},"parent":{}}],["account_hash",{"_index":184,"name":{"419":{}},"parent":{}}],["account_objects",{"_index":246,"name":{"577":{}},"parent":{}}],["account_root",{"_index":289,"name":{"813":{}},"parent":{}}],["account_sequence_available",{"_index":313,"name":{"859":{}},"parent":{}}],["account_sequence_next",{"_index":314,"name":{"860":{}},"parent":{}}],["accountchannelsrequest",{"_index":208,"name":{"447":{}},"parent":{"448":{},"449":{},"450":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{}}}],["accountchannelsresponse",{"_index":214,"name":{"457":{}},"parent":{"458":{},"459":{},"467":{},"468":{},"469":{},"470":{},"471":{},"472":{},"473":{},"474":{},"475":{},"476":{}}}],["accountchannelsresponse.__type",{"_index":215,"name":{},"parent":{"460":{},"461":{},"462":{},"463":{},"464":{},"465":{},"466":{}}}],["accountcurrenciesrequest",{"_index":223,"name":{"477":{}},"parent":{"478":{},"479":{},"480":{},"481":{},"482":{},"483":{},"484":{},"485":{}}}],["accountcurrenciesresponse",{"_index":225,"name":{"486":{}},"parent":{"487":{},"488":{},"494":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{}}}],["accountcurrenciesresponse.__type",{"_index":226,"name":{},"parent":{"489":{},"490":{},"491":{},"492":{},"493":{}}}],["accountinforequest",{"_index":229,"name":{"504":{}},"parent":{"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{}}}],["accountinforesponse",{"_index":232,"name":{"514":{}},"parent":{"515":{},"516":{},"523":{},"524":{},"525":{},"526":{},"527":{},"528":{},"529":{},"530":{},"531":{},"532":{}}}],["accountinforesponse.__type",{"_index":234,"name":{},"parent":{"517":{},"518":{},"519":{},"520":{},"521":{},"522":{}}}],["accountlinesrequest",{"_index":237,"name":{"533":{}},"parent":{"534":{},"535":{},"536":{},"537":{},"538":{},"539":{},"540":{},"541":{},"542":{}}}],["accountlinesresponse",{"_index":239,"name":{"543":{}},"parent":{"544":{},"545":{},"552":{},"553":{},"554":{},"555":{},"556":{},"557":{},"558":{},"559":{},"560":{},"561":{}}}],["accountlinesresponse.__type",{"_index":240,"name":{},"parent":{"546":{},"547":{},"548":{},"549":{},"550":{},"551":{}}}],["accountobjectsrequest",{"_index":242,"name":{"562":{}},"parent":{"563":{},"564":{},"565":{},"566":{},"567":{},"568":{},"569":{},"570":{},"571":{},"572":{}}}],["accountobjectsresponse",{"_index":244,"name":{"573":{}},"parent":{"574":{},"575":{},"584":{},"585":{},"586":{},"587":{},"588":{},"589":{},"590":{},"591":{},"592":{},"593":{}}}],["accountobjectsresponse.__type",{"_index":245,"name":{},"parent":{"576":{},"577":{},"578":{},"579":{},"580":{},"581":{},"582":{},"583":{}}}],["accountoffersrequest",{"_index":247,"name":{"594":{}},"parent":{"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{}}}],["accountoffersresponse",{"_index":248,"name":{"604":{}},"parent":{"605":{},"606":{},"613":{},"614":{},"615":{},"616":{},"617":{},"618":{},"619":{},"620":{},"621":{},"622":{}}}],["accountoffersresponse.__type",{"_index":249,"name":{},"parent":{"607":{},"608":{},"609":{},"610":{},"611":{},"612":{}}}],["accounts",{"_index":272,"name":{"718":{},"818":{},"1075":{},"1172":{}},"parent":{}}],["accounts_proposed",{"_index":368,"name":{"1076":{},"1173":{}},"parent":{}}],["accountset",{"_index":71,"name":{"111":{},"255":{}},"parent":{}}],["accountsetflags",{"_index":20,"name":{"36":{},"178":{}},"parent":{}}],["accountstate",{"_index":197,"name":{"432":{}},"parent":{}}],["accounttxrequest",{"_index":251,"name":{"623":{}},"parent":{"624":{},"625":{},"626":{},"627":{},"628":{},"629":{},"630":{},"631":{},"632":{},"633":{},"634":{},"635":{}}}],["accounttxresponse",{"_index":256,"name":{"636":{}},"parent":{"637":{},"638":{},"646":{},"647":{},"648":{},"649":{},"650":{},"651":{},"652":{},"653":{},"654":{},"655":{}}}],["accounttxresponse.__type",{"_index":257,"name":{},"parent":{"639":{},"640":{},"641":{},"642":{},"643":{},"644":{},"645":{}}}],["action",{"_index":390,"name":{"1148":{}},"parent":{}}],["address",{"_index":177,"name":{"387":{},"394":{},"401":{},"408":{},"415":{}},"parent":{}}],["age",{"_index":432,"name":{"1263":{},"1299":{},"1331":{},"1363":{}},"parent":{}}],["allowpartialpayment",{"_index":171,"name":{"379":{}},"parent":{}}],["allowxrp",{"_index":77,"name":{"118":{},"262":{}},"parent":{}}],["alternatives",{"_index":348,"name":{"1005":{},"1037":{},"1142":{}},"parent":{}}],["amendment_blocked",{"_index":428,"name":{"1259":{},"1326":{}},"parent":{}}],["amendments",{"_index":377,"name":{"1109":{}},"parent":{}}],["amount",{"_index":359,"name":{"1052":{}},"parent":{}}],["api_version",{"_index":213,"name":{"456":{},"476":{},"485":{},"503":{},"513":{},"532":{},"542":{},"561":{},"572":{},"593":{},"603":{},"622":{},"635":{},"655":{},"664":{},"687":{},"696":{},"712":{},"725":{},"743":{},"747":{},"762":{},"766":{},"780":{},"789":{},"806":{},"826":{},"843":{},"849":{},"876":{},"882":{},"900":{},"907":{},"924":{},"932":{},"945":{},"955":{},"972":{},"980":{},"1000":{},"1022":{},"1033":{},"1049":{},"1057":{},"1071":{},"1082":{},"1094":{},"1176":{},"1189":{},"1193":{},"1223":{},"1228":{},"1249":{},"1253":{},"1316":{},"1320":{},"1380":{},"1384":{},"1397":{},"1401":{},"1415":{}},"parent":{}}],["applied",{"_index":315,"name":{"861":{}},"parent":{}}],["assets",{"_index":264,"name":{"673":{}},"parent":{}}],["balancechanges",{"_index":156,"name":{"362":{}},"parent":{}}],["balances",{"_index":263,"name":{"671":{}},"parent":{}}],["base_fee",{"_index":378,"name":{"1110":{},"1201":{},"1332":{},"1364":{}},"parent":{}}],["base_fee_xrp",{"_index":434,"name":{"1264":{},"1300":{}},"parent":{}}],["binary",{"_index":254,"name":{"630":{},"722":{},"785":{},"809":{},"928":{}},"parent":{}}],["bookoffersrequest",{"_index":335,"name":{"946":{}},"parent":{"947":{},"948":{},"949":{},"950":{},"951":{},"952":{},"953":{},"954":{},"955":{}}}],["bookoffersresponse",{"_index":339,"name":{"956":{}},"parent":{"957":{},"958":{},"963":{},"964":{},"965":{},"966":{},"967":{},"968":{},"969":{},"970":{},"971":{},"972":{}}}],["bookoffersresponse.__type",{"_index":340,"name":{},"parent":{"959":{},"960":{},"961":{},"962":{}}}],["books",{"_index":369,"name":{"1077":{},"1174":{}},"parent":{}}],["broadcast",{"_index":316,"name":{"862":{}},"parent":{}}],["broadcastclient",{"_index":97,"name":{"142":{}},"parent":{"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"179":{},"189":{},"190":{},"191":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"202":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{},"209":{},"210":{},"211":{},"212":{},"213":{},"214":{},"215":{},"216":{},"217":{},"218":{},"219":{},"220":{},"221":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{},"250":{},"251":{}}}],["broadcastclient.__type",{"_index":98,"name":{},"parent":{"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"252":{},"253":{},"255":{},"256":{},"263":{},"264":{},"271":{},"272":{},"277":{},"278":{},"282":{},"283":{}}}],["broadcastclient.__type.__type",{"_index":101,"name":{},"parent":{"254":{},"257":{},"258":{},"259":{},"260":{},"261":{},"262":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"273":{},"274":{},"275":{},"276":{},"279":{},"280":{},"281":{},"284":{},"285":{}}}],["build_version",{"_index":430,"name":{"1260":{},"1327":{}},"parent":{}}],["channel_id",{"_index":360,"name":{"1053":{}},"parent":{}}],["channels",{"_index":216,"name":{"461":{}},"parent":{}}],["channelverifyrequest",{"_index":358,"name":{"1050":{}},"parent":{"1051":{},"1052":{},"1053":{},"1054":{},"1055":{},"1056":{},"1057":{}}}],["channelverifyresponse",{"_index":363,"name":{"1058":{}},"parent":{"1059":{},"1060":{},"1062":{},"1063":{},"1064":{},"1065":{},"1066":{},"1067":{},"1068":{},"1069":{},"1070":{},"1071":{}}}],["channelverifyresponse.__type",{"_index":365,"name":{},"parent":{"1061":{}}}],["check",{"_index":294,"name":{"820":{}},"parent":{}}],["classicaddress",{"_index":113,"name":{"298":{}},"parent":{}}],["classicaddresstoxaddress",{"_index":6,"name":{"8":{},"150":{}},"parent":{}}],["clearfreeze",{"_index":84,"name":{"126":{},"270":{}},"parent":{}}],["clearnoripple",{"_index":82,"name":{"124":{},"268":{}},"parent":{}}],["client",{"_index":0,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{}}}],["client.__type",{"_index":22,"name":{},"parent":{"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"108":{},"109":{},"111":{},"112":{},"119":{},"120":{},"127":{},"128":{},"133":{},"134":{},"138":{},"139":{}}}],["client.__type.__type",{"_index":70,"name":{},"parent":{"110":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"129":{},"130":{},"131":{},"132":{},"135":{},"136":{},"137":{},"140":{},"141":{}}}],["clients",{"_index":99,"name":{"190":{}},"parent":{}}],["close",{"_index":96,"name":{"141":{},"285":{}},"parent":{}}],["close_flags",{"_index":195,"name":{"430":{}},"parent":{}}],["close_time",{"_index":185,"name":{"420":{}},"parent":{}}],["close_time_human",{"_index":186,"name":{"421":{}},"parent":{}}],["close_time_resolution",{"_index":187,"name":{"422":{}},"parent":{}}],["closed",{"_index":188,"name":{"423":{},"1011":{}},"parent":{}}],["closed_ledger",{"_index":431,"name":{"1261":{},"1329":{}},"parent":{}}],["combine",{"_index":64,"name":{"101":{},"245":{}},"parent":{}}],["command",{"_index":209,"name":{"448":{},"478":{},"505":{},"534":{},"563":{},"595":{},"624":{},"657":{},"689":{},"714":{},"745":{},"764":{},"782":{},"808":{},"845":{},"878":{},"902":{},"926":{},"947":{},"974":{},"1024":{},"1051":{},"1073":{},"1170":{},"1191":{},"1225":{},"1251":{},"1318":{},"1382":{},"1399":{}},"parent":{}}],["complete_ledgers",{"_index":438,"name":{"1269":{},"1328":{}},"parent":{}}],["computeaccountrootindex",{"_index":492,"name":{"1428":{}},"parent":{}}],["computebinarytransactionhash",{"_index":489,"name":{"1425":{}},"parent":{}}],["computebinarytransactionsigninghash",{"_index":491,"name":{"1427":{}},"parent":{}}],["computeescrowhash",{"_index":499,"name":{"1435":{}},"parent":{}}],["computeledgerhash",{"_index":498,"name":{"1434":{}},"parent":{}}],["computeledgerheaderhash",{"_index":480,"name":{"1416":{}},"parent":{}}],["computeofferindex",{"_index":494,"name":{"1430":{}},"parent":{}}],["computepaymentchannelhash",{"_index":500,"name":{"1436":{}},"parent":{}}],["computesignerlistindex",{"_index":493,"name":{"1429":{}},"parent":{}}],["computestatetreehash",{"_index":497,"name":{"1433":{}},"parent":{}}],["computetransactionhash",{"_index":490,"name":{"1426":{}},"parent":{}}],["computetransactiontreehash",{"_index":496,"name":{"1432":{}},"parent":{}}],["computetrustlinehash",{"_index":495,"name":{"1431":{}},"parent":{}}],["connect",{"_index":40,"name":{"56":{},"200":{}},"parent":{}}],["connection",{"_index":32,"name":{"48":{},"192":{}},"parent":{}}],["consensus",{"_index":394,"name":{"1168":{}},"parent":{}}],["consensusstream",{"_index":393,"name":{"1166":{}},"parent":{"1167":{},"1168":{}}}],["constructor",{"_index":31,"name":{"47":{},"189":{},"295":{}},"parent":{}}],["converge_time_s",{"_index":443,"name":{"1275":{},"1341":{}},"parent":{}}],["convertkeysfromsnakecasetocamelcase",{"_index":484,"name":{"1420":{}},"parent":{}}],["counterparty",{"_index":161,"name":{"368":{}},"parent":{}}],["currency",{"_index":159,"name":{"367":{},"819":{}},"parent":{}}],["current_ledger_size",{"_index":399,"name":{"1197":{}},"parent":{}}],["current_queue_size",{"_index":401,"name":{"1198":{}},"parent":{}}],["date",{"_index":391,"name":{"1149":{}},"parent":{}}],["decodeaccountid",{"_index":13,"name":{"22":{},"164":{}},"parent":{}}],["decodeaccountpublic",{"_index":17,"name":{"30":{},"172":{}},"parent":{}}],["decodenodepublic",{"_index":15,"name":{"26":{},"168":{}},"parent":{}}],["decodeseed",{"_index":11,"name":{"18":{},"160":{}},"parent":{}}],["decodexaddress",{"_index":19,"name":{"34":{},"176":{}},"parent":{}}],["defaultalgorithm",{"_index":103,"name":{"287":{}},"parent":{}}],["defaultderivationpath",{"_index":104,"name":{"288":{}},"parent":{}}],["defaultripple",{"_index":30,"name":{"46":{},"188":{}},"parent":{}}],["deletion_blockers_only",{"_index":243,"name":{"566":{}},"parent":{}}],["deliveredamount",{"_index":158,"name":{"365":{}},"parent":{}}],["deposit_authorized",{"_index":344,"name":{"984":{}},"parent":{}}],["deposit_preauth",{"_index":297,"name":{"823":{}},"parent":{}}],["depositauth",{"_index":24,"name":{"40":{},"182":{}},"parent":{}}],["depositauthorizedrequest",{"_index":341,"name":{"973":{}},"parent":{"974":{},"975":{},"976":{},"977":{},"978":{},"979":{},"980":{}}}],["depositauthorizedresponse",{"_index":343,"name":{"981":{}},"parent":{"982":{},"983":{},"991":{},"992":{},"993":{},"994":{},"995":{},"996":{},"997":{},"998":{},"999":{},"1000":{}}}],["depositauthorizedresponse.__type",{"_index":345,"name":{},"parent":{"984":{},"985":{},"986":{},"987":{},"988":{},"989":{},"990":{}}}],["deriveclassicaddress",{"_index":4,"name":{"4":{},"146":{}},"parent":{}}],["derivewallet",{"_index":110,"name":{"294":{}},"parent":{}}],["derivexaddress",{"_index":2,"name":{"2":{},"144":{},"1440":{}},"parent":{}}],["destination",{"_index":168,"name":{"375":{}},"parent":{}}],["destination_account",{"_index":210,"name":{"450":{},"480":{},"976":{},"985":{},"1006":{},"1026":{},"1038":{},"1137":{}},"parent":{}}],["destination_amount",{"_index":350,"name":{"1007":{},"1027":{},"1138":{}},"parent":{}}],["destination_currencies",{"_index":357,"name":{"1039":{}},"parent":{}}],["details",{"_index":416,"name":{"1232":{}},"parent":{}}],["directory",{"_index":290,"name":{"814":{}},"parent":{}}],["disablemasterkey",{"_index":26,"name":{"42":{},"184":{}},"parent":{}}],["disallowincomingxrp",{"_index":25,"name":{"41":{},"183":{}},"parent":{}}],["disallowxrp",{"_index":76,"name":{"117":{},"261":{}},"parent":{}}],["disconnect",{"_index":41,"name":{"57":{},"201":{}},"parent":{}}],["domain",{"_index":418,"name":{"1234":{}},"parent":{}}],["drops",{"_index":402,"name":{"1199":{}},"parent":{}}],["dropstoxrp",{"_index":481,"name":{"1417":{}},"parent":{}}],["enabletransactionidtracking",{"_index":27,"name":{"43":{},"185":{}},"parent":{}}],["encodeaccountid",{"_index":12,"name":{"20":{},"162":{}},"parent":{}}],["encodeaccountpublic",{"_index":16,"name":{"28":{},"170":{}},"parent":{}}],["encodenodepublic",{"_index":14,"name":{"24":{},"166":{}},"parent":{}}],["encodeseed",{"_index":10,"name":{"16":{},"158":{}},"parent":{}}],["encodexaddress",{"_index":18,"name":{"32":{},"174":{}},"parent":{}}],["engine_result",{"_index":307,"name":{"853":{},"886":{},"1125":{},"1157":{}},"parent":{}}],["engine_result_code",{"_index":309,"name":{"854":{},"887":{},"1126":{},"1158":{}},"parent":{}}],["engine_result_message",{"_index":310,"name":{"855":{},"888":{},"1127":{},"1159":{}},"parent":{}}],["engineresult",{"_index":137,"name":{"327":{}},"parent":{}}],["engineresultcode",{"_index":138,"name":{"328":{}},"parent":{}}],["engineresultmessage",{"_index":139,"name":{"329":{}},"parent":{}}],["ephemeral_key",{"_index":420,"name":{"1235":{}},"parent":{}}],["error",{"_index":221,"name":{"473":{},"500":{},"529":{},"558":{},"590":{},"619":{},"652":{},"684":{},"709":{},"740":{},"759":{},"777":{},"803":{},"840":{},"873":{},"897":{},"921":{},"942":{},"969":{},"997":{},"1019":{},"1046":{},"1068":{},"1091":{},"1186":{},"1220":{},"1246":{},"1313":{},"1377":{},"1394":{},"1412":{}},"parent":{}}],["error_message",{"_index":222,"name":{"474":{},"501":{},"530":{},"559":{},"591":{},"620":{},"653":{},"685":{},"710":{},"741":{},"760":{},"778":{},"804":{},"841":{},"874":{},"898":{},"922":{},"943":{},"970":{},"998":{},"1020":{},"1047":{},"1069":{},"1092":{},"1187":{},"1221":{},"1247":{},"1314":{},"1378":{},"1395":{},"1413":{}},"parent":{}}],["errors",{"_index":66,"name":{"105":{},"249":{}},"parent":{}}],["escrow",{"_index":295,"name":{"821":{}},"parent":{}}],["expand",{"_index":273,"name":{"720":{}},"parent":{}}],["expected_ledger_size",{"_index":407,"name":{"1205":{}},"parent":{}}],["expiration",{"_index":145,"name":{"341":{}},"parent":{}}],["fail_hard",{"_index":305,"name":{"847":{},"880":{}},"parent":{}}],["fee",{"_index":127,"name":{"312":{},"321":{},"335":{},"361":{}},"parent":{}}],["fee_base",{"_index":200,"name":{"436":{},"1098":{}},"parent":{}}],["fee_ref",{"_index":201,"name":{"437":{},"1099":{}},"parent":{}}],["feecushion",{"_index":33,"name":{"49":{},"193":{}},"parent":{}}],["feerequest",{"_index":397,"name":{"1190":{}},"parent":{"1191":{},"1192":{},"1193":{}}}],["feeresponse",{"_index":398,"name":{"1194":{}},"parent":{"1195":{},"1196":{},"1214":{},"1215":{},"1216":{},"1217":{},"1218":{},"1219":{},"1220":{},"1221":{},"1222":{},"1223":{}}}],["feeresponse.__type",{"_index":400,"name":{},"parent":{"1197":{},"1198":{},"1199":{},"1200":{},"1205":{},"1206":{},"1207":{},"1208":{},"1213":{}}}],["feeresponse.__type.__type",{"_index":403,"name":{},"parent":{"1201":{},"1202":{},"1203":{},"1204":{},"1209":{},"1210":{},"1211":{},"1212":{}}}],["fillorkill",{"_index":88,"name":{"131":{},"275":{}},"parent":{}}],["flags",{"_index":122,"name":{"307":{},"336":{},"350":{},"1111":{}},"parent":{}}],["formatbidsandasks",{"_index":5,"name":{"6":{},"148":{}},"parent":{}}],["formattedordercancellation",{"_index":164,"name":{"371":{}},"parent":{"372":{}}}],["formattedordercancellationtransaction",{"_index":179,"name":{"396":{}},"parent":{"397":{},"398":{},"399":{},"400":{},"401":{},"402":{}}}],["formattedordertransaction",{"_index":178,"name":{"389":{}},"parent":{"390":{},"391":{},"392":{},"393":{},"394":{},"395":{}}}],["formattedpayment",{"_index":166,"name":{"373":{}},"parent":{"374":{},"375":{},"376":{},"377":{},"378":{},"379":{},"380":{},"381":{}}}],["formattedpaymenttransaction",{"_index":173,"name":{"382":{}},"parent":{"383":{},"384":{},"385":{},"386":{},"387":{},"388":{}}}],["formattedsettingstransaction",{"_index":181,"name":{"410":{}},"parent":{"411":{},"412":{},"413":{},"414":{},"415":{},"416":{}}}],["formattedtransactiontype",{"_index":182,"name":{"417":{}},"parent":{}}],["formattedtrustlinetransaction",{"_index":180,"name":{"403":{}},"parent":{"404":{},"405":{},"406":{},"407":{},"408":{},"409":{}}}],["forward",{"_index":255,"name":{"631":{}},"parent":{}}],["forwarded",{"_index":220,"name":{"472":{},"499":{},"528":{},"557":{},"589":{},"618":{},"651":{},"683":{},"708":{},"739":{},"758":{},"776":{},"802":{},"839":{},"872":{},"896":{},"920":{},"941":{},"968":{},"996":{},"1018":{},"1045":{},"1067":{},"1090":{},"1185":{},"1219":{},"1245":{},"1312":{},"1376":{},"1393":{},"1411":{}},"parent":{}}],["fromentropy",{"_index":108,"name":{"292":{}},"parent":{}}],["frommnemonic",{"_index":107,"name":{"291":{}},"parent":{}}],["fromseed",{"_index":106,"name":{"290":{}},"parent":{}}],["fulfillment",{"_index":123,"name":{"308":{},"344":{},"351":{}},"parent":{}}],["full",{"_index":271,"name":{"717":{},"1112":{}},"parent":{}}],["full_reply",{"_index":351,"name":{"1009":{},"1139":{}},"parent":{}}],["fullycanonicalsig",{"_index":69,"name":{"110":{},"254":{}},"parent":{}}],["gatewaybalancesrequest",{"_index":258,"name":{"656":{}},"parent":{"657":{},"658":{},"659":{},"660":{},"661":{},"662":{},"663":{},"664":{}}}],["gatewaybalancesresponse",{"_index":260,"name":{"665":{}},"parent":{"666":{},"667":{},"678":{},"679":{},"680":{},"681":{},"682":{},"683":{},"684":{},"685":{},"686":{},"687":{}}}],["gatewaybalancesresponse.__type",{"_index":261,"name":{},"parent":{"668":{},"669":{},"670":{},"671":{},"672":{},"673":{},"674":{},"675":{},"676":{},"677":{}}}],["generate",{"_index":105,"name":{"289":{}},"parent":{}}],["generatefaucetwallet",{"_index":65,"name":{"103":{},"247":{}},"parent":{}}],["generatexaddress",{"_index":501,"name":{"1437":{}},"parent":{}}],["getbalances",{"_index":45,"name":{"63":{},"207":{}},"parent":{}}],["getfee",{"_index":43,"name":{"59":{},"203":{}},"parent":{}}],["getmethodnames",{"_index":100,"name":{"191":{}},"parent":{}}],["getorderbook",{"_index":47,"name":{"67":{},"211":{}},"parent":{}}],["getpaths",{"_index":46,"name":{"65":{},"209":{}},"parent":{}}],["gettrustlines",{"_index":44,"name":{"61":{},"205":{}},"parent":{}}],["getxaddress",{"_index":117,"name":{"302":{}},"parent":{}}],["globalfreeze",{"_index":29,"name":{"45":{},"187":{}},"parent":{}}],["hash",{"_index":435,"name":{"1265":{},"1301":{},"1333":{},"1365":{}},"parent":{}}],["hasnextpage",{"_index":1,"name":{"1":{},"143":{}},"parent":{}}],["hexfrombuffer",{"_index":109,"name":{"293":{}},"parent":{}}],["hostid",{"_index":439,"name":{"1270":{}},"parent":{}}],["hotwallet",{"_index":259,"name":{"660":{}},"parent":{}}],["id",{"_index":176,"name":{"386":{},"393":{},"400":{},"407":{},"414":{},"455":{},"467":{},"484":{},"494":{},"512":{},"523":{},"541":{},"552":{},"571":{},"584":{},"602":{},"613":{},"634":{},"646":{},"663":{},"678":{},"695":{},"703":{},"724":{},"734":{},"746":{},"753":{},"765":{},"771":{},"788":{},"797":{},"825":{},"834":{},"848":{},"867":{},"881":{},"891":{},"906":{},"915":{},"931":{},"936":{},"954":{},"963":{},"979":{},"991":{},"1010":{},"1013":{},"1032":{},"1040":{},"1056":{},"1062":{},"1081":{},"1085":{},"1140":{},"1175":{},"1180":{},"1192":{},"1214":{},"1227":{},"1240":{},"1252":{},"1307":{},"1319":{},"1371":{},"1383":{},"1388":{},"1400":{},"1406":{}},"parent":{}}],["immediateorcancel",{"_index":87,"name":{"130":{},"274":{}},"parent":{}}],["index",{"_index":288,"name":{"812":{},"830":{}},"parent":{}}],["indexinledger",{"_index":155,"name":{"360":{}},"parent":{}}],["info",{"_index":426,"name":{"1257":{}},"parent":{}}],["instructions",{"_index":124,"name":{"309":{},"319":{}},"parent":{"310":{},"311":{},"312":{},"313":{},"314":{},"315":{},"316":{}}}],["invoiceid",{"_index":170,"name":{"378":{}},"parent":{}}],["io_latency_ms",{"_index":440,"name":{"1271":{},"1337":{}},"parent":{}}],["isconnected",{"_index":42,"name":{"58":{},"202":{}},"parent":{}}],["isotimetorippletime",{"_index":487,"name":{"1423":{}},"parent":{}}],["isvalidclassicaddress",{"_index":9,"name":{"14":{},"156":{}},"parent":{}}],["isvalidsecret",{"_index":488,"name":{"1424":{}},"parent":{}}],["isvalidxaddress",{"_index":8,"name":{"12":{},"154":{}},"parent":{}}],["job_types",{"_index":446,"name":{"1279":{},"1345":{}},"parent":{}}],["jq_trans_overflow",{"_index":441,"name":{"1272":{},"1338":{}},"parent":{}}],["kept",{"_index":317,"name":{"863":{}},"parent":{}}],["keypair",{"_index":149,"name":{"352":{}},"parent":{"353":{},"354":{}}}],["last_close",{"_index":442,"name":{"1273":{},"1339":{}},"parent":{}}],["lastledgersequence",{"_index":142,"name":{"337":{}},"parent":{}}],["ledger",{"_index":183,"name":{"418":{},"729":{}},"parent":{"419":{},"420":{},"421":{},"422":{},"423":{},"424":{},"425":{},"426":{},"427":{},"428":{},"429":{},"430":{},"431":{},"432":{},"433":{}}}],["ledger_current_index",{"_index":235,"name":{"519":{},"548":{},"580":{},"609":{},"676":{},"700":{},"770":{},"959":{},"988":{},"1128":{},"1160":{},"1206":{}},"parent":{}}],["ledger_hash",{"_index":189,"name":{"424":{},"438":{},"451":{},"462":{},"481":{},"489":{},"507":{},"536":{},"550":{},"567":{},"578":{},"597":{},"611":{},"628":{},"661":{},"675":{},"693":{},"715":{},"730":{},"751":{},"783":{},"794":{},"810":{},"903":{},"911":{},"948":{},"961":{},"977":{},"986":{},"1030":{},"1100":{},"1113":{},"1129":{},"1150":{},"1161":{}},"parent":{}}],["ledger_index",{"_index":190,"name":{"425":{},"439":{},"452":{},"463":{},"482":{},"490":{},"508":{},"520":{},"537":{},"549":{},"568":{},"579":{},"598":{},"610":{},"629":{},"662":{},"677":{},"694":{},"716":{},"731":{},"752":{},"784":{},"793":{},"811":{},"831":{},"904":{},"912":{},"949":{},"960":{},"978":{},"987":{},"1031":{},"1101":{},"1114":{},"1130":{},"1151":{},"1162":{}},"parent":{}}],["ledger_index_max",{"_index":253,"name":{"627":{},"641":{},"1152":{}},"parent":{}}],["ledger_index_min",{"_index":252,"name":{"626":{},"640":{},"1153":{}},"parent":{}}],["ledger_time",{"_index":202,"name":{"440":{},"1102":{}},"parent":{}}],["ledgerclosedevent",{"_index":199,"name":{"434":{}},"parent":{"435":{},"436":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{}}}],["ledgerclosedrequest",{"_index":277,"name":{"744":{}},"parent":{"745":{},"746":{},"747":{}}}],["ledgerclosedresponse",{"_index":278,"name":{"748":{}},"parent":{"749":{},"750":{},"753":{},"754":{},"755":{},"756":{},"757":{},"758":{},"759":{},"760":{},"761":{},"762":{}}}],["ledgerclosedresponse.__type",{"_index":279,"name":{},"parent":{"751":{},"752":{}}}],["ledgercurrentrequest",{"_index":280,"name":{"763":{}},"parent":{"764":{},"765":{},"766":{}}}],["ledgercurrentresponse",{"_index":281,"name":{"767":{}},"parent":{"768":{},"769":{},"771":{},"772":{},"773":{},"774":{},"775":{},"776":{},"777":{},"778":{},"779":{},"780":{}}}],["ledgercurrentresponse.__type",{"_index":282,"name":{},"parent":{"770":{}}}],["ledgerdatarequest",{"_index":283,"name":{"781":{}},"parent":{"782":{},"783":{},"784":{},"785":{},"786":{},"787":{},"788":{},"789":{}}}],["ledgerdataresponse",{"_index":284,"name":{"790":{}},"parent":{"791":{},"792":{},"797":{},"798":{},"799":{},"800":{},"801":{},"802":{},"803":{},"804":{},"805":{},"806":{}}}],["ledgerdataresponse.__type",{"_index":285,"name":{},"parent":{"793":{},"794":{},"795":{},"796":{}}}],["ledgerentryrequest",{"_index":287,"name":{"807":{}},"parent":{"808":{},"809":{},"810":{},"811":{},"812":{},"813":{},"814":{},"815":{},"816":{},"817":{},"820":{},"821":{},"822":{},"823":{},"824":{},"825":{},"826":{}}}],["ledgerentryrequest.__type",{"_index":293,"name":{},"parent":{"818":{},"819":{}}}],["ledgerentryresponse",{"_index":299,"name":{"827":{}},"parent":{"828":{},"829":{},"834":{},"835":{},"836":{},"837":{},"838":{},"839":{},"840":{},"841":{},"842":{},"843":{}}}],["ledgerentryresponse.__type",{"_index":300,"name":{},"parent":{"830":{},"831":{},"832":{},"833":{}}}],["ledgerrequest",{"_index":270,"name":{"713":{}},"parent":{"714":{},"715":{},"716":{},"717":{},"718":{},"719":{},"720":{},"721":{},"722":{},"723":{},"724":{},"725":{}}}],["ledgerresponse",{"_index":275,"name":{"726":{}},"parent":{"727":{},"728":{},"734":{},"735":{},"736":{},"737":{},"738":{},"739":{},"740":{},"741":{},"742":{},"743":{}}}],["ledgerresponse.__type",{"_index":276,"name":{},"parent":{"729":{},"730":{},"731":{},"732":{},"733":{}}}],["ledgerstream",{"_index":375,"name":{"1096":{}},"parent":{"1097":{},"1098":{},"1099":{},"1100":{},"1101":{},"1102":{},"1103":{},"1104":{},"1105":{},"1106":{}}}],["ledgerversion",{"_index":154,"name":{"359":{}},"parent":{}}],["levels",{"_index":408,"name":{"1207":{}},"parent":{}}],["limit",{"_index":211,"name":{"453":{},"465":{},"539":{},"569":{},"581":{},"599":{},"632":{},"642":{},"786":{},"950":{}},"parent":{}}],["limitquality",{"_index":93,"name":{"137":{},"281":{},"381":{}},"parent":{}}],["lines",{"_index":241,"name":{"547":{}},"parent":{}}],["load",{"_index":445,"name":{"1277":{},"1343":{}},"parent":{}}],["load_base",{"_index":472,"name":{"1347":{}},"parent":{}}],["load_factor",{"_index":448,"name":{"1281":{},"1348":{}},"parent":{}}],["load_factor_cluster",{"_index":451,"name":{"1284":{}},"parent":{}}],["load_factor_fee_escalation",{"_index":452,"name":{"1285":{},"1349":{}},"parent":{}}],["load_factor_fee_queue",{"_index":453,"name":{"1286":{},"1350":{}},"parent":{}}],["load_factor_fee_reference",{"_index":473,"name":{"1351":{}},"parent":{}}],["load_factor_local",{"_index":449,"name":{"1282":{}},"parent":{}}],["load_factor_net",{"_index":450,"name":{"1283":{}},"parent":{}}],["load_factor_server",{"_index":454,"name":{"1287":{},"1352":{}},"parent":{}}],["load_fee",{"_index":379,"name":{"1115":{}},"parent":{}}],["manifest",{"_index":422,"name":{"1238":{}},"parent":{}}],["manifestrequest",{"_index":414,"name":{"1224":{}},"parent":{"1225":{},"1226":{},"1227":{},"1228":{}}}],["manifestresponse",{"_index":415,"name":{"1229":{}},"parent":{"1230":{},"1231":{},"1240":{},"1241":{},"1242":{},"1243":{},"1244":{},"1245":{},"1246":{},"1247":{},"1248":{},"1249":{}}}],["manifestresponse.__type",{"_index":417,"name":{},"parent":{"1232":{},"1233":{},"1238":{},"1239":{}}}],["manifestresponse.__type.__type",{"_index":419,"name":{},"parent":{"1234":{},"1235":{},"1236":{},"1237":{}}}],["marker",{"_index":212,"name":{"454":{},"466":{},"540":{},"551":{},"570":{},"582":{},"600":{},"612":{},"633":{},"643":{},"787":{},"796":{}},"parent":{}}],["master_key",{"_index":380,"name":{"1116":{},"1236":{}},"parent":{}}],["max_ledger",{"_index":332,"name":{"930":{}},"parent":{}}],["max_queue_size",{"_index":413,"name":{"1213":{}},"parent":{}}],["maxfee",{"_index":128,"name":{"313":{}},"parent":{}}],["maxfeexrp",{"_index":34,"name":{"50":{},"194":{}},"parent":{}}],["maxledgerversion",{"_index":129,"name":{"314":{},"324":{}},"parent":{}}],["maxledgerversionoffset",{"_index":130,"name":{"315":{}},"parent":{}}],["median_fee",{"_index":404,"name":{"1202":{}},"parent":{}}],["median_level",{"_index":409,"name":{"1209":{}},"parent":{}}],["memos",{"_index":121,"name":{"306":{},"343":{},"349":{},"377":{}},"parent":{}}],["meta",{"_index":384,"name":{"1131":{},"1163":{}},"parent":{}}],["metadata",{"_index":328,"name":{"913":{}},"parent":{}}],["min_ledger",{"_index":331,"name":{"929":{}},"parent":{}}],["minimum_fee",{"_index":405,"name":{"1203":{}},"parent":{}}],["minimum_level",{"_index":410,"name":{"1210":{}},"parent":{}}],["network_ledger",{"_index":455,"name":{"1288":{}},"parent":{}}],["node",{"_index":301,"name":{"832":{}},"parent":{}}],["node_binary",{"_index":302,"name":{"833":{}},"parent":{}}],["nodirectripple",{"_index":172,"name":{"380":{}},"parent":{}}],["nofreeze",{"_index":28,"name":{"44":{},"186":{}},"parent":{}}],["noripple",{"_index":80,"name":{"122":{},"266":{}},"parent":{}}],["noripplecheckrequest",{"_index":265,"name":{"688":{}},"parent":{"689":{},"690":{},"691":{},"692":{},"693":{},"694":{},"695":{},"696":{}}}],["noripplecheckresponse",{"_index":267,"name":{"697":{}},"parent":{"698":{},"699":{},"703":{},"704":{},"705":{},"706":{},"707":{},"708":{},"709":{},"710":{},"711":{},"712":{}}}],["noripplecheckresponse.__type",{"_index":268,"name":{},"parent":{"700":{},"701":{},"702":{}}}],["norippledirect",{"_index":91,"name":{"135":{},"279":{}},"parent":{}}],["obligations",{"_index":262,"name":{"669":{}},"parent":{}}],["offer",{"_index":291,"name":{"815":{}},"parent":{}}],["offercreate",{"_index":85,"name":{"127":{},"271":{}},"parent":{}}],["offercreatetransaction",{"_index":141,"name":{"332":{}},"parent":{"333":{},"334":{},"335":{},"336":{},"337":{},"338":{},"339":{},"340":{},"341":{},"342":{},"343":{},"344":{}}}],["offers",{"_index":250,"name":{"608":{},"962":{}},"parent":{}}],["offersequence",{"_index":146,"name":{"342":{}},"parent":{}}],["on",{"_index":37,"name":{"53":{},"197":{}},"parent":{}}],["open_ledger_cost",{"_index":319,"name":{"865":{}},"parent":{}}],["open_ledger_fee",{"_index":406,"name":{"1204":{}},"parent":{}}],["open_ledger_level",{"_index":411,"name":{"1211":{}},"parent":{}}],["optionalauth",{"_index":75,"name":{"116":{},"260":{}},"parent":{}}],["optionaldesttag",{"_index":73,"name":{"114":{},"258":{}},"parent":{}}],["orderbookchanges",{"_index":157,"name":{"364":{}},"parent":{}}],["orderbookstream",{"_index":392,"name":{"1154":{}},"parent":{"1155":{},"1156":{},"1157":{},"1158":{},"1159":{},"1160":{},"1161":{},"1162":{},"1163":{},"1164":{},"1165":{}}}],["ordersequence",{"_index":165,"name":{"372":{}},"parent":{}}],["outcome",{"_index":152,"name":{"357":{},"385":{},"392":{},"399":{},"406":{},"413":{}},"parent":{"358":{},"359":{},"360":{},"361":{},"362":{},"363":{},"364":{},"365":{},"366":{},"370":{}}}],["outcome.__type",{"_index":160,"name":{},"parent":{"367":{},"368":{},"369":{}}}],["owner_funds",{"_index":274,"name":{"721":{}},"parent":{}}],["parent_close_time",{"_index":196,"name":{"431":{}},"parent":{}}],["parent_hash",{"_index":191,"name":{"426":{}},"parent":{}}],["partialpayment",{"_index":92,"name":{"136":{},"280":{}},"parent":{}}],["passive",{"_index":86,"name":{"129":{},"273":{}},"parent":{}}],["pathfindrequest",{"_index":346,"name":{"1001":{}},"parent":{}}],["pathfindresponse",{"_index":347,"name":{"1002":{}},"parent":{"1003":{},"1004":{},"1013":{},"1014":{},"1015":{},"1016":{},"1017":{},"1018":{},"1019":{},"1020":{},"1021":{},"1022":{}}}],["pathfindresponse.__type",{"_index":349,"name":{},"parent":{"1005":{},"1006":{},"1007":{},"1008":{},"1009":{},"1010":{},"1011":{},"1012":{}}}],["pathfindstream",{"_index":385,"name":{"1134":{}},"parent":{"1135":{},"1136":{},"1137":{},"1138":{},"1139":{},"1140":{},"1141":{},"1142":{},"1143":{}}}],["pathfindstream.__type",{"_index":387,"name":{},"parent":{"1144":{},"1145":{}}}],["paths",{"_index":169,"name":{"376":{}},"parent":{}}],["paths_computed",{"_index":386,"name":{"1144":{}},"parent":{}}],["payment",{"_index":90,"name":{"133":{},"277":{}},"parent":{}}],["payment_channel",{"_index":296,"name":{"822":{}},"parent":{}}],["paymentchannelclaim",{"_index":94,"name":{"138":{},"282":{}},"parent":{}}],["peer",{"_index":238,"name":{"538":{}},"parent":{}}],["peers",{"_index":456,"name":{"1289":{},"1353":{}},"parent":{}}],["peerstatusstream",{"_index":389,"name":{"1146":{}},"parent":{"1147":{},"1148":{},"1149":{},"1150":{},"1151":{},"1152":{},"1153":{}}}],["pingrequest",{"_index":474,"name":{"1381":{}},"parent":{"1382":{},"1383":{},"1384":{}}}],["pingresponse",{"_index":475,"name":{"1385":{}},"parent":{"1386":{},"1387":{},"1388":{},"1389":{},"1390":{},"1391":{},"1392":{},"1393":{},"1394":{},"1395":{},"1396":{},"1397":{}}}],["prepare",{"_index":132,"name":{"317":{}},"parent":{"318":{},"319":{},"320":{}}}],["prepare.__type",{"_index":134,"name":{},"parent":{"321":{},"322":{},"323":{},"324":{}}}],["preparecheckcancel",{"_index":60,"name":{"93":{},"237":{}},"parent":{}}],["preparecheckcash",{"_index":59,"name":{"91":{},"235":{}},"parent":{}}],["preparecheckcreate",{"_index":58,"name":{"89":{},"233":{}},"parent":{}}],["prepareescrowcancellation",{"_index":54,"name":{"81":{},"225":{}},"parent":{}}],["prepareescrowcreation",{"_index":52,"name":{"77":{},"221":{}},"parent":{}}],["prepareescrowexecution",{"_index":53,"name":{"79":{},"223":{}},"parent":{}}],["prepareorder",{"_index":50,"name":{"73":{},"217":{}},"parent":{}}],["prepareordercancellation",{"_index":51,"name":{"75":{},"219":{}},"parent":{}}],["preparepayment",{"_index":48,"name":{"69":{},"213":{}},"parent":{}}],["preparepaymentchannelclaim",{"_index":57,"name":{"87":{},"231":{}},"parent":{}}],["preparepaymentchannelcreate",{"_index":55,"name":{"83":{},"227":{}},"parent":{}}],["preparepaymentchannelfund",{"_index":56,"name":{"85":{},"229":{}},"parent":{}}],["preparesettings",{"_index":62,"name":{"97":{},"241":{}},"parent":{}}],["prepareticketcreate",{"_index":61,"name":{"95":{},"239":{}},"parent":{}}],["preparetransaction",{"_index":38,"name":{"54":{},"198":{}},"parent":{}}],["preparetrustline",{"_index":49,"name":{"71":{},"215":{}},"parent":{}}],["privatekey",{"_index":112,"name":{"297":{},"354":{}},"parent":{}}],["problems",{"_index":269,"name":{"701":{}},"parent":{}}],["proposers",{"_index":444,"name":{"1276":{},"1342":{}},"parent":{}}],["pubkey_node",{"_index":457,"name":{"1290":{},"1354":{}},"parent":{}}],["pubkey_validator",{"_index":458,"name":{"1291":{},"1355":{}},"parent":{}}],["public_key",{"_index":361,"name":{"1054":{},"1226":{}},"parent":{}}],["publickey",{"_index":111,"name":{"296":{},"353":{}},"parent":{}}],["queue",{"_index":230,"name":{"509":{},"723":{}},"parent":{}}],["queue_data",{"_index":236,"name":{"521":{},"732":{}},"parent":{}}],["queued",{"_index":318,"name":{"864":{}},"parent":{}}],["random",{"_index":478,"name":{"1405":{}},"parent":{}}],["randomrequest",{"_index":476,"name":{"1398":{}},"parent":{"1399":{},"1400":{},"1401":{}}}],["randomresponse",{"_index":477,"name":{"1402":{}},"parent":{"1403":{},"1404":{},"1406":{},"1407":{},"1408":{},"1409":{},"1410":{},"1411":{},"1412":{},"1413":{},"1414":{},"1415":{}}}],["randomresponse.__type",{"_index":479,"name":{},"parent":{"1405":{}}}],["receive_currencies",{"_index":227,"name":{"491":{}},"parent":{}}],["reference_level",{"_index":412,"name":{"1212":{}},"parent":{}}],["removeundefined",{"_index":485,"name":{"1421":{}},"parent":{}}],["renew",{"_index":95,"name":{"140":{},"284":{}},"parent":{}}],["request",{"_index":35,"name":{"51":{},"195":{},"445":{},"475":{},"502":{},"531":{},"560":{},"592":{},"621":{},"654":{},"686":{},"711":{},"742":{},"761":{},"779":{},"805":{},"842":{},"875":{},"899":{},"923":{},"944":{},"971":{},"999":{},"1021":{},"1048":{},"1070":{},"1093":{},"1188":{},"1222":{},"1248":{},"1315":{},"1379":{},"1396":{},"1414":{}},"parent":{}}],["requestall",{"_index":39,"name":{"55":{},"199":{}},"parent":{}}],["requested",{"_index":423,"name":{"1239":{}},"parent":{}}],["requestnextpage",{"_index":36,"name":{"52":{},"196":{}},"parent":{}}],["requireauth",{"_index":74,"name":{"115":{},"259":{}},"parent":{}}],["requireauthorization",{"_index":23,"name":{"39":{},"181":{}},"parent":{}}],["requiredestinationtag",{"_index":21,"name":{"38":{},"180":{}},"parent":{}}],["requiredesttag",{"_index":72,"name":{"113":{},"257":{}},"parent":{}}],["reserve_base",{"_index":203,"name":{"441":{},"1103":{},"1117":{},"1334":{},"1366":{}},"parent":{}}],["reserve_base_xrp",{"_index":436,"name":{"1266":{},"1302":{}},"parent":{}}],["reserve_inc",{"_index":204,"name":{"442":{},"1104":{},"1118":{},"1335":{},"1367":{}},"parent":{}}],["reserve_inc_xrp",{"_index":437,"name":{"1267":{},"1303":{}},"parent":{}}],["response",{"_index":207,"name":{"446":{}},"parent":{}}],["result",{"_index":153,"name":{"358":{},"458":{},"487":{},"515":{},"544":{},"574":{},"605":{},"637":{},"666":{},"698":{},"727":{},"749":{},"768":{},"791":{},"828":{},"851":{},"884":{},"909":{},"934":{},"957":{},"982":{},"1003":{},"1035":{},"1059":{},"1084":{},"1178":{},"1195":{},"1230":{},"1255":{},"1322":{},"1386":{},"1403":{}},"parent":{}}],["ripple_state",{"_index":292,"name":{"816":{}},"parent":{}}],["ripplepathfindrequest",{"_index":352,"name":{"1023":{}},"parent":{"1024":{},"1025":{},"1026":{},"1027":{},"1028":{},"1029":{},"1030":{},"1031":{},"1032":{},"1033":{}}}],["ripplepathfindresponse",{"_index":355,"name":{"1034":{}},"parent":{"1035":{},"1036":{},"1040":{},"1041":{},"1042":{},"1043":{},"1044":{},"1045":{},"1046":{},"1047":{},"1048":{},"1049":{}}}],["ripplepathfindresponse.__type",{"_index":356,"name":{},"parent":{"1037":{},"1038":{},"1039":{}}}],["rippletimetoisotime",{"_index":486,"name":{"1422":{}},"parent":{}}],["role",{"_index":266,"name":{"691":{}},"parent":{}}],["searched_all",{"_index":334,"name":{"935":{}},"parent":{}}],["seed",{"_index":114,"name":{"299":{}},"parent":{}}],["sell",{"_index":89,"name":{"132":{},"276":{}},"parent":{}}],["send_currencies",{"_index":228,"name":{"492":{}},"parent":{}}],["send_max",{"_index":353,"name":{"1028":{},"1141":{}},"parent":{}}],["seq",{"_index":421,"name":{"1237":{},"1268":{},"1304":{},"1336":{},"1368":{}},"parent":{}}],["sequence",{"_index":125,"name":{"310":{},"322":{},"338":{},"388":{},"395":{},"402":{},"409":{},"416":{}},"parent":{}}],["server_state",{"_index":459,"name":{"1292":{},"1356":{}},"parent":{}}],["server_state_duration_us",{"_index":460,"name":{"1293":{},"1357":{}},"parent":{}}],["serverinforequest",{"_index":424,"name":{"1250":{}},"parent":{"1251":{},"1252":{},"1253":{}}}],["serverinforesponse",{"_index":425,"name":{"1254":{}},"parent":{"1255":{},"1256":{},"1307":{},"1308":{},"1309":{},"1310":{},"1311":{},"1312":{},"1313":{},"1314":{},"1315":{},"1316":{}}}],["serverinforesponse.__type",{"_index":427,"name":{},"parent":{"1257":{},"1258":{}}}],["serverinforesponse.__type.__type",{"_index":429,"name":{},"parent":{"1259":{},"1260":{},"1261":{},"1262":{},"1269":{},"1270":{},"1271":{},"1272":{},"1273":{},"1274":{},"1277":{},"1278":{},"1281":{},"1282":{},"1283":{},"1284":{},"1285":{},"1286":{},"1287":{},"1288":{},"1289":{},"1290":{},"1291":{},"1292":{},"1293":{},"1294":{},"1295":{},"1296":{},"1297":{},"1298":{},"1305":{},"1306":{}}}],["serverinforesponse.__type.__type.__type",{"_index":433,"name":{},"parent":{"1263":{},"1264":{},"1265":{},"1266":{},"1267":{},"1268":{},"1275":{},"1276":{},"1279":{},"1280":{},"1299":{},"1300":{},"1301":{},"1302":{},"1303":{},"1304":{}}}],["serverstaterequest",{"_index":467,"name":{"1317":{}},"parent":{"1318":{},"1319":{},"1320":{}}}],["serverstateresponse",{"_index":468,"name":{"1321":{}},"parent":{"1322":{},"1323":{},"1371":{},"1372":{},"1373":{},"1374":{},"1375":{},"1376":{},"1377":{},"1378":{},"1379":{},"1380":{}}}],["serverstateresponse.__type",{"_index":469,"name":{},"parent":{"1324":{},"1325":{}}}],["serverstateresponse.__type.__type",{"_index":470,"name":{},"parent":{"1326":{},"1327":{},"1328":{},"1329":{},"1330":{},"1337":{},"1338":{},"1339":{},"1340":{},"1343":{},"1344":{},"1347":{},"1348":{},"1349":{},"1350":{},"1351":{},"1352":{},"1353":{},"1354":{},"1355":{},"1356":{},"1357":{},"1358":{},"1359":{},"1360":{},"1361":{},"1362":{},"1369":{},"1370":{}}}],["serverstateresponse.__type.__type.__type",{"_index":471,"name":{},"parent":{"1331":{},"1332":{},"1333":{},"1334":{},"1335":{},"1336":{},"1341":{},"1342":{},"1345":{},"1346":{},"1363":{},"1364":{},"1365":{},"1366":{},"1367":{},"1368":{}}}],["setauth",{"_index":79,"name":{"121":{},"265":{}},"parent":{}}],["setfreeze",{"_index":83,"name":{"125":{},"269":{}},"parent":{}}],["setnoripple",{"_index":81,"name":{"123":{},"267":{}},"parent":{}}],["settingstransaction",{"_index":147,"name":{"345":{}},"parent":{"346":{},"347":{},"348":{},"349":{},"350":{},"351":{}}}],["sign",{"_index":63,"name":{"99":{},"243":{}},"parent":{}}],["signas",{"_index":151,"name":{"356":{}},"parent":{}}],["signature",{"_index":362,"name":{"1055":{},"1119":{}},"parent":{}}],["signature_verified",{"_index":364,"name":{"1061":{}},"parent":{}}],["signer_lists",{"_index":231,"name":{"510":{},"518":{}},"parent":{}}],["signerscount",{"_index":131,"name":{"316":{}},"parent":{}}],["signing_time",{"_index":381,"name":{"1120":{}},"parent":{}}],["signoptions",{"_index":150,"name":{"355":{}},"parent":{"356":{}}}],["signpaymentchannelclaim",{"_index":502,"name":{"1441":{}},"parent":{}}],["signtransaction",{"_index":115,"name":{"300":{}},"parent":{}}],["source",{"_index":167,"name":{"374":{}},"parent":{}}],["source_account",{"_index":342,"name":{"975":{},"989":{},"1008":{},"1025":{},"1136":{}},"parent":{}}],["source_amount",{"_index":388,"name":{"1145":{}},"parent":{}}],["source_currencies",{"_index":354,"name":{"1029":{}},"parent":{}}],["specification",{"_index":175,"name":{"384":{},"391":{},"398":{},"405":{},"412":{}},"parent":{}}],["state",{"_index":286,"name":{"795":{},"1324":{}},"parent":{}}],["state_accounting",{"_index":461,"name":{"1294":{},"1358":{}},"parent":{}}],["status",{"_index":217,"name":{"468":{},"495":{},"524":{},"553":{},"585":{},"614":{},"647":{},"679":{},"704":{},"735":{},"754":{},"772":{},"798":{},"835":{},"868":{},"892":{},"916":{},"937":{},"964":{},"992":{},"1012":{},"1014":{},"1041":{},"1063":{},"1086":{},"1123":{},"1155":{},"1181":{},"1215":{},"1241":{},"1308":{},"1372":{},"1389":{},"1407":{}},"parent":{}}],["stream",{"_index":374,"name":{"1095":{}},"parent":{}}],["streams",{"_index":367,"name":{"1074":{},"1171":{}},"parent":{}}],["strict",{"_index":224,"name":{"483":{},"511":{},"601":{},"659":{}},"parent":{}}],["submit",{"_index":135,"name":{"325":{}},"parent":{"326":{},"327":{},"328":{},"329":{},"330":{},"331":{}}}],["submitmultisignedrequest",{"_index":321,"name":{"877":{}},"parent":{"878":{},"879":{},"880":{},"881":{},"882":{}}}],["submitmultisignedresponse",{"_index":322,"name":{"883":{}},"parent":{"884":{},"885":{},"891":{},"892":{},"893":{},"894":{},"895":{},"896":{},"897":{},"898":{},"899":{},"900":{}}}],["submitmultisignedresponse.__type",{"_index":323,"name":{},"parent":{"886":{},"887":{},"888":{},"889":{},"890":{}}}],["submitrequest",{"_index":303,"name":{"844":{}},"parent":{"845":{},"846":{},"847":{},"848":{},"849":{}}}],["submitresponse",{"_index":306,"name":{"850":{}},"parent":{"851":{},"852":{},"867":{},"868":{},"869":{},"870":{},"871":{},"872":{},"873":{},"874":{},"875":{},"876":{}}}],["submitresponse.__type",{"_index":308,"name":{},"parent":{"853":{},"854":{},"855":{},"856":{},"857":{},"858":{},"859":{},"860":{},"861":{},"862":{},"863":{},"864":{},"865":{},"866":{}}}],["subscriberequest",{"_index":366,"name":{"1072":{}},"parent":{"1073":{},"1074":{},"1075":{},"1076":{},"1077":{},"1078":{},"1079":{},"1080":{},"1081":{},"1082":{}}}],["subscriberesponse",{"_index":373,"name":{"1083":{}},"parent":{"1084":{},"1085":{},"1086":{},"1087":{},"1088":{},"1089":{},"1090":{},"1091":{},"1092":{},"1093":{},"1094":{}}}],["success",{"_index":136,"name":{"326":{}},"parent":{}}],["taker",{"_index":336,"name":{"951":{}},"parent":{}}],["taker_gets",{"_index":337,"name":{"952":{}},"parent":{}}],["taker_pays",{"_index":338,"name":{"953":{}},"parent":{}}],["takergets",{"_index":143,"name":{"339":{}},"parent":{}}],["takerpays",{"_index":144,"name":{"340":{}},"parent":{}}],["threads",{"_index":447,"name":{"1280":{},"1346":{}},"parent":{}}],["ticket",{"_index":298,"name":{"824":{}},"parent":{}}],["ticketsequence",{"_index":126,"name":{"311":{},"323":{}},"parent":{}}],["time",{"_index":462,"name":{"1295":{},"1359":{}},"parent":{}}],["timestamp",{"_index":163,"name":{"370":{}},"parent":{}}],["torippledamount",{"_index":483,"name":{"1419":{}},"parent":{}}],["total_coins",{"_index":192,"name":{"427":{}},"parent":{}}],["transaction",{"_index":330,"name":{"927":{},"1132":{},"1164":{}},"parent":{}}],["transaction_hash",{"_index":193,"name":{"428":{}},"parent":{}}],["transactionentryrequest",{"_index":324,"name":{"901":{}},"parent":{"902":{},"903":{},"904":{},"905":{},"906":{},"907":{}}}],["transactionentryresponse",{"_index":326,"name":{"908":{}},"parent":{"909":{},"910":{},"915":{},"916":{},"917":{},"918":{},"919":{},"920":{},"921":{},"922":{},"923":{},"924":{}}}],["transactionentryresponse.__type",{"_index":327,"name":{},"parent":{"911":{},"912":{},"913":{},"914":{}}}],["transactionjson",{"_index":118,"name":{"303":{}},"parent":{"304":{},"305":{},"306":{},"307":{},"308":{}}}],["transactions",{"_index":194,"name":{"429":{},"644":{},"692":{},"702":{},"719":{}},"parent":{}}],["transactionstream",{"_index":383,"name":{"1122":{}},"parent":{"1123":{},"1124":{},"1125":{},"1126":{},"1127":{},"1128":{},"1129":{},"1130":{},"1131":{},"1132":{},"1133":{}}}],["transactiontype",{"_index":120,"name":{"305":{},"333":{},"348":{}},"parent":{}}],["transferrate",{"_index":148,"name":{"346":{}},"parent":{}}],["trustset",{"_index":78,"name":{"119":{},"263":{}},"parent":{}}],["tx_blob",{"_index":304,"name":{"846":{},"856":{},"889":{}},"parent":{}}],["tx_hash",{"_index":325,"name":{"905":{}},"parent":{}}],["tx_json",{"_index":311,"name":{"857":{},"879":{},"890":{},"914":{}},"parent":{}}],["txblob",{"_index":140,"name":{"330":{}},"parent":{}}],["txflags",{"_index":67,"name":{"106":{},"250":{}},"parent":{}}],["txjson",{"_index":133,"name":{"318":{},"331":{}},"parent":{}}],["txn_count",{"_index":205,"name":{"443":{},"1105":{}},"parent":{}}],["txrequest",{"_index":329,"name":{"925":{}},"parent":{"926":{},"927":{},"928":{},"929":{},"930":{},"931":{},"932":{}}}],["txresponse",{"_index":333,"name":{"933":{}},"parent":{"934":{},"935":{},"936":{},"937":{},"938":{},"939":{},"940":{},"941":{},"942":{},"943":{},"944":{},"945":{}}}],["type",{"_index":174,"name":{"383":{},"390":{},"397":{},"404":{},"411":{},"435":{},"469":{},"496":{},"525":{},"554":{},"565":{},"586":{},"615":{},"648":{},"680":{},"705":{},"736":{},"755":{},"773":{},"799":{},"836":{},"869":{},"893":{},"917":{},"938":{},"965":{},"993":{},"1015":{},"1042":{},"1064":{},"1087":{},"1097":{},"1108":{},"1124":{},"1135":{},"1147":{},"1156":{},"1167":{},"1182":{},"1216":{},"1242":{},"1309":{},"1373":{},"1390":{},"1408":{}},"parent":{}}],["universal",{"_index":68,"name":{"108":{},"252":{}},"parent":{}}],["unsubscriberequest",{"_index":395,"name":{"1169":{}},"parent":{"1170":{},"1171":{},"1172":{},"1173":{},"1174":{},"1175":{},"1176":{}}}],["unsubscriberesponse",{"_index":396,"name":{"1177":{}},"parent":{"1178":{},"1179":{},"1180":{},"1181":{},"1182":{},"1183":{},"1184":{},"1185":{},"1186":{},"1187":{},"1188":{},"1189":{}}}],["uptime",{"_index":463,"name":{"1296":{},"1360":{}},"parent":{}}],["url",{"_index":370,"name":{"1078":{}},"parent":{}}],["url_password",{"_index":372,"name":{"1080":{}},"parent":{}}],["url_username",{"_index":371,"name":{"1079":{}},"parent":{}}],["validated",{"_index":198,"name":{"433":{},"464":{},"493":{},"522":{},"583":{},"645":{},"733":{},"990":{},"1133":{},"1165":{}},"parent":{}}],["validated_ledger",{"_index":464,"name":{"1297":{},"1361":{}},"parent":{}}],["validated_ledger_index",{"_index":320,"name":{"866":{}},"parent":{}}],["validated_ledgers",{"_index":206,"name":{"444":{},"1106":{}},"parent":{}}],["validation_public_key",{"_index":382,"name":{"1121":{}},"parent":{}}],["validation_quorum",{"_index":465,"name":{"1305":{},"1369":{}},"parent":{}}],["validationstream",{"_index":376,"name":{"1107":{}},"parent":{"1108":{},"1109":{},"1110":{},"1111":{},"1112":{},"1113":{},"1114":{},"1115":{},"1116":{},"1117":{},"1118":{},"1119":{},"1120":{},"1121":{}}}],["validator_list_expires",{"_index":466,"name":{"1306":{},"1370":{}},"parent":{}}],["value",{"_index":162,"name":{"369":{}},"parent":{}}],["verifypaymentchannelclaim",{"_index":503,"name":{"1442":{}},"parent":{}}],["verifytransaction",{"_index":116,"name":{"301":{}},"parent":{}}],["wallet",{"_index":102,"name":{"286":{}},"parent":{"287":{},"288":{},"289":{},"290":{},"291":{},"292":{},"293":{},"294":{},"295":{},"296":{},"297":{},"298":{},"299":{},"300":{},"301":{},"302":{}}}],["warning",{"_index":218,"name":{"470":{},"497":{},"526":{},"555":{},"587":{},"616":{},"649":{},"681":{},"706":{},"737":{},"756":{},"774":{},"800":{},"837":{},"870":{},"894":{},"918":{},"939":{},"966":{},"994":{},"1016":{},"1043":{},"1065":{},"1088":{},"1183":{},"1217":{},"1243":{},"1310":{},"1374":{},"1391":{},"1409":{}},"parent":{}}],["warnings",{"_index":219,"name":{"471":{},"498":{},"527":{},"556":{},"588":{},"617":{},"650":{},"682":{},"707":{},"738":{},"757":{},"775":{},"801":{},"838":{},"871":{},"895":{},"919":{},"940":{},"967":{},"995":{},"1017":{},"1044":{},"1066":{},"1089":{},"1184":{},"1218":{},"1244":{},"1311":{},"1375":{},"1392":{},"1410":{}},"parent":{}}],["xaddresstoclassicaddress",{"_index":7,"name":{"10":{},"152":{}},"parent":{}}],["xrptodrops",{"_index":482,"name":{"1418":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/docs/classes/BroadcastClient.html b/docs/classes/BroadcastClient.html new file mode 100644 index 00000000..335cfff0 --- /dev/null +++ b/docs/classes/BroadcastClient.html @@ -0,0 +1,4614 @@ + + + + + + BroadcastClient | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class BroadcastClient

+
+
+
+
+
+
+
+
+
+

Client that can rely on multiple different servers.

+
+
+
+
+

Hierarchy

+
    +
  • + Client +
      +
    • + BroadcastClient +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new BroadcastClient(servers: string[], options?: ClientOptions): BroadcastClient
  • +
+ +
+
+
+

Properties

+
+ +

Private Readonly clients

+
clients: Client[]
+ +
+
+ +

combine

+
combine: (signedTransactions: string[]) => object = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (signedTransactions: string[]): object
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        signedTransactions: string[]
        +
        +

        A collection of the same transaction signed by different signers. The only difference + between the elements of signedTransactions should be the Signers field.

        +
        +
      • +
      +

      Returns object

      +

      An object with the combined transaction (now having a sorted list of all signers) which is encoded, along + with a transaction id based on the combined transaction.

      +
    • +
    +
  • +
+
+
+
+ +

Readonly connection

+
connection: Connection
+ +
+
+ +

errors

+
errors: __module = ...
+ +
+
+ +

Readonly feeCushion

+
feeCushion: number
+ +
+
+ +

generateFaucetWallet

+
generateFaucetWallet: (client: Client, wallet?: Wallet) => Promise<Wallet | void> = ...
+ +
+

Type declaration

+
    +
  • + +
      +
    • +

      Parameters

      + +

      Returns Promise<Wallet | void>

      +
    • +
    +
  • +
+
+
+
+ +

getBalances

+
getBalances: (address: string, options: GetTrustlinesOptions) => Promise<GetBalances> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, options: GetTrustlinesOptions): Promise<GetBalances>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        options: GetTrustlinesOptions
        +
      • +
      +

      Returns Promise<GetBalances>

      +
    • +
    +
  • +
+
+
+
+ +

getFee

+
getFee: (cushion: number | null) => Promise<string> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (cushion: number | null): Promise<string>
    • +
    +
      +
    • +
      +
      +

      Calculates the current transaction fee for the ledger. + Note: This is a public API that can be called directly. + This is not used by the prepare* methods. See src/transaction/utils.ts.

      +
      +
      +

      Parameters

      +
        +
      • +
        cushion: number | null
        +
        +

        The fee cushion to use.

        +
        +
      • +
      +

      Returns Promise<string>

      +

      The transaction fee.

      +
    • +
    +
  • +
+
+
+
+ +

getOrderbook

+
getOrderbook: (address: string, orderbook: OrderbookInfo, options: GetOrderbookOptions) => Promise<FormattedOrderbook> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, orderbook: OrderbookInfo, options: GetOrderbookOptions): Promise<FormattedOrderbook>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        orderbook: OrderbookInfo
        +
      • +
      • +
        options: GetOrderbookOptions
        +
      • +
      +

      Returns Promise<FormattedOrderbook>

      +
    • +
    +
  • +
+
+
+
+ +

getPaths

+
getPaths: (pathfind: PathFind) => Promise<GetPaths> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (pathfind: PathFind): Promise<GetPaths>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        pathfind: PathFind
        +
      • +
      +

      Returns Promise<GetPaths>

      +
    • +
    +
  • +
+
+
+
+ +

getTrustlines

+
getTrustlines: (address: string, options: GetTrustlinesOptions) => Promise<FormattedTrustline[]> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, options: GetTrustlinesOptions): Promise<FormattedTrustline[]>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        options: GetTrustlinesOptions
        +
      • +
      +

      Returns Promise<FormattedTrustline[]>

      +
    • +
    +
  • +
+
+
+
+ +

Readonly maxFeeXRP

+
maxFeeXRP: string
+ +
+
+ +

prepareCheckCancel

+
prepareCheckCancel: (address: string, checkCancel: CheckCancelParameters, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, checkCancel: CheckCancelParameters, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        checkCancel: CheckCancelParameters
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareCheckCash

+
prepareCheckCash: (address: string, checkCash: CheckCashParameters, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, checkCash: CheckCashParameters, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        checkCash: CheckCashParameters
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareCheckCreate

+
prepareCheckCreate: (address: string, checkCreate: CheckCreateParameters, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, checkCreate: CheckCreateParameters, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        checkCreate: CheckCreateParameters
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareEscrowCancellation

+
prepareEscrowCancellation: (address: string, escrowCancellation: EscrowCancellation, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, escrowCancellation: EscrowCancellation, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        escrowCancellation: EscrowCancellation
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareEscrowCreation

+
prepareEscrowCreation: (address: string, escrowCreation: EscrowCreation, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, escrowCreation: EscrowCreation, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        escrowCreation: EscrowCreation
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareEscrowExecution

+
prepareEscrowExecution: (address: string, escrowExecution: EscrowExecution, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, escrowExecution: EscrowExecution, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        escrowExecution: EscrowExecution
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareOrder

+
prepareOrder: (address: string, order: FormattedOrderSpecification, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, order: FormattedOrderSpecification, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        order: FormattedOrderSpecification
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareOrderCancellation

+
prepareOrderCancellation: (address: string, orderCancellation: object, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, orderCancellation: object, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        orderCancellation: object
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

preparePayment

+
preparePayment: (address: string, payment: Payment, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • + +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        payment: Payment
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

preparePaymentChannelClaim

+
preparePaymentChannelClaim: (address: string, paymentChannelClaim: PaymentChannelClaim, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, paymentChannelClaim: PaymentChannelClaim, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        paymentChannelClaim: PaymentChannelClaim
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

preparePaymentChannelCreate

+
preparePaymentChannelCreate: (address: string, paymentChannelCreate: PaymentChannelCreate, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, paymentChannelCreate: PaymentChannelCreate, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        paymentChannelCreate: PaymentChannelCreate
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

preparePaymentChannelFund

+
preparePaymentChannelFund: (address: string, paymentChannelFund: PaymentChannelFund, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, paymentChannelFund: PaymentChannelFund, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        paymentChannelFund: PaymentChannelFund
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareSettings

+
prepareSettings: (address: string, settings: FormattedSettings, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, settings: FormattedSettings, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        settings: FormattedSettings
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareTicketCreate

+
prepareTicketCreate: (address: string, ticketCount: number, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • + +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        ticketCount: number
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareTrustline

+
prepareTrustline: (address: string, trustline: FormattedTrustlineSpecification, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, trustline: FormattedTrustlineSpecification, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        trustline: FormattedTrustlineSpecification
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

sign

+
sign: (txJSON: string, secret?: any, options?: SignOptions, keypair?: KeyPair) => SignedTransaction = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (txJSON: string, secret?: any, options?: SignOptions, keypair?: KeyPair): SignedTransaction
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        txJSON: string
        +
      • +
      • +
        Optional secret: any
        +
      • +
      • +
        Optional options: SignOptions
        +
      • +
      • +
        Optional keypair: KeyPair
        +
      • +
      +

      Returns SignedTransaction

      +
    • +
    +
  • +
+
+
+
+ +

txFlags

+
txFlags: { AccountSet: { AllowXRP: number; DisallowXRP: number; OptionalAuth: number; OptionalDestTag: number; RequireAuth: number; RequireDestTag: number }; OfferCreate: { FillOrKill: number; ImmediateOrCancel: number; Passive: number; Sell: number }; Payment: { LimitQuality: number; NoRippleDirect: number; PartialPayment: number }; PaymentChannelClaim: { Close: number; Renew: number }; TrustSet: { ClearFreeze: number; ClearNoRipple: number; NoRipple: number; SetAuth: number; SetFreeze: number; SetNoRipple: number }; Universal: { FullyCanonicalSig: number } } = ...
+ +
+

Type declaration

+
    +
  • +
    AccountSet: { AllowXRP: number; DisallowXRP: number; OptionalAuth: number; OptionalDestTag: number; RequireAuth: number; RequireDestTag: number }
    +
      +
    • +
      AllowXRP: number
      +
    • +
    • +
      DisallowXRP: number
      +
    • +
    • +
      OptionalAuth: number
      +
    • +
    • +
      OptionalDestTag: number
      +
    • +
    • +
      RequireAuth: number
      +
    • +
    • +
      RequireDestTag: number
      +
    • +
    +
  • +
  • +
    OfferCreate: { FillOrKill: number; ImmediateOrCancel: number; Passive: number; Sell: number }
    +
      +
    • +
      FillOrKill: number
      +
    • +
    • +
      ImmediateOrCancel: number
      +
    • +
    • +
      Passive: number
      +
    • +
    • +
      Sell: number
      +
    • +
    +
  • +
  • +
    Payment: { LimitQuality: number; NoRippleDirect: number; PartialPayment: number }
    +
      +
    • +
      LimitQuality: number
      +
    • +
    • +
      NoRippleDirect: number
      +
    • +
    • +
      PartialPayment: number
      +
    • +
    +
  • +
  • +
    PaymentChannelClaim: { Close: number; Renew: number }
    +
      +
    • +
      Close: number
      +
    • +
    • +
      Renew: number
      +
    • +
    +
  • +
  • +
    TrustSet: { ClearFreeze: number; ClearNoRipple: number; NoRipple: number; SetAuth: number; SetFreeze: number; SetNoRipple: number }
    +
      +
    • +
      ClearFreeze: number
      +
    • +
    • +
      ClearNoRipple: number
      +
    • +
    • +
      NoRipple: number
      +
    • +
    • +
      SetAuth: number
      +
    • +
    • +
      SetFreeze: number
      +
    • +
    • +
      SetNoRipple: number
      +
    • +
    +
  • +
  • +
    Universal: { FullyCanonicalSig: number }
    +
      +
    • +
      FullyCanonicalSig: number
      +
    • +
    +
  • +
+
+
+
+ +

Static accountSetFlags

+
accountSetFlags: { defaultRipple: number; depositAuth: number; disableMasterKey: number; disallowIncomingXRP: number; enableTransactionIDTracking: number; globalFreeze: number; noFreeze: number; requireAuthorization: number; requireDestinationTag: number } = ...
+ +
+

Type declaration

+
    +
  • +
    defaultRipple: number
    +
  • +
  • +
    depositAuth: number
    +
  • +
  • +
    disableMasterKey: number
    +
  • +
  • +
    disallowIncomingXRP: number
    +
  • +
  • +
    enableTransactionIDTracking: number
    +
  • +
  • +
    globalFreeze: number
    +
  • +
  • +
    noFreeze: number
    +
  • +
  • +
    requireAuthorization: number
    +
  • +
  • +
    requireDestinationTag: number
    +
  • +
+
+
+
+ +

Static Readonly captureRejectionSymbol

+
captureRejectionSymbol: typeof captureRejectionSymbol
+ +
+
+ +

Static captureRejections

+
captureRejections: boolean
+ +
+
+

Sets or gets the default captureRejection value for all emitters.

+
+
+
+
+ +

Static classicAddressToXAddress

+
classicAddressToXAddress: (classicAddress: string, tag: number | false, test: boolean) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (classicAddress: string, tag: number | false, test: boolean): string
    • +
    +
      +
    • +
      +
      +

      Static methods to expose ripple-address-codec methods.

      +
      +
      +

      Parameters

      +
        +
      • +
        classicAddress: string
        +
      • +
      • +
        tag: number | false
        +
      • +
      • +
        test: boolean
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static decodeAccountID

+
decodeAccountID: (accountId: string) => Buffer = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (accountId: string): Buffer
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        accountId: string
        +
      • +
      +

      Returns Buffer

      +
    • +
    +
  • +
+
+
+
+ +

Static decodeAccountPublic

+
decodeAccountPublic: (base58string: string) => Buffer = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (base58string: string): Buffer
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        base58string: string
        +
      • +
      +

      Returns Buffer

      +
    • +
    +
  • +
+
+
+
+ +

Static decodeNodePublic

+
decodeNodePublic: (base58string: string) => Buffer = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (base58string: string): Buffer
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        base58string: string
        +
      • +
      +

      Returns Buffer

      +
    • +
    +
  • +
+
+
+
+ +

Static decodeSeed

+
decodeSeed: (seed: string, opts?: { expectedLength: number; versionTypes: ["ed25519", "secp256k1"]; versions: (number | number[])[] }) => { bytes: Buffer; type: string | null; version: number[] } = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (seed: string, opts?: { expectedLength: number; versionTypes: ["ed25519", "secp256k1"]; versions: (number | number[])[] }): { bytes: Buffer; type: string | null; version: number[] }
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        seed: string
        +
      • +
      • +
        Optional opts: { expectedLength: number; versionTypes: ["ed25519", "secp256k1"]; versions: (number | number[])[] }
        +
          +
        • +
          expectedLength: number
          +
        • +
        • +
          versionTypes: ["ed25519", "secp256k1"]
          +
        • +
        • +
          versions: (number | number[])[]
          +
        • +
        +
      • +
      +

      Returns { bytes: Buffer; type: string | null; version: number[] }

      +
        +
      • +
        bytes: Buffer
        +
      • +
      • +
        type: string | null
        +
      • +
      • +
        version: number[]
        +
      • +
      +
    • +
    +
  • +
+
+
+
+ +

Static decodeXAddress

+
decodeXAddress: (xAddress: string) => { accountId: Buffer; tag: number | false; test: boolean } = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (xAddress: string): { accountId: Buffer; tag: number | false; test: boolean }
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        xAddress: string
        +
      • +
      +

      Returns { accountId: Buffer; tag: number | false; test: boolean }

      +
        +
      • +
        accountId: Buffer
        +
      • +
      • +
        tag: number | false
        +
      • +
      • +
        test: boolean
        +
      • +
      +
    • +
    +
  • +
+
+
+
+ +

Static defaultMaxListeners

+
defaultMaxListeners: number
+ +
+
+ +

Static deriveClassicAddress

+
deriveClassicAddress: (publicKey: any) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (publicKey: any): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        publicKey: any
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static deriveXAddress

+
deriveXAddress: (options: { publicKey: string; tag: number | false; test: boolean }) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (options: { publicKey: string; tag: number | false; test: boolean }): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        options: { publicKey: string; tag: number | false; test: boolean }
        +
          +
        • +
          publicKey: string
          +
        • +
        • +
          tag: number | false
          +
        • +
        • +
          test: boolean
          +
        • +
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static encodeAccountID

+
encodeAccountID: (bytes: Buffer) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (bytes: Buffer): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        bytes: Buffer
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static encodeAccountPublic

+
encodeAccountPublic: (bytes: Buffer) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (bytes: Buffer): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        bytes: Buffer
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static encodeNodePublic

+
encodeNodePublic: (bytes: Buffer) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (bytes: Buffer): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        bytes: Buffer
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static encodeSeed

+
encodeSeed: (entropy: Buffer, type: "ed25519" | "secp256k1") => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (entropy: Buffer, type: "ed25519" | "secp256k1"): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        entropy: Buffer
        +
      • +
      • +
        type: "ed25519" | "secp256k1"
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static encodeXAddress

+
encodeXAddress: (accountId: Buffer, tag: number | false, test: boolean) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (accountId: Buffer, tag: number | false, test: boolean): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        accountId: Buffer
        +
      • +
      • +
        tag: number | false
        +
      • +
      • +
        test: boolean
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static Readonly errorMonitor

+
errorMonitor: typeof errorMonitor
+ +
+
+

This symbol shall be used to install a listener for only monitoring 'error' + events. Listeners installed using this symbol are called before the regular + 'error' listeners are called.

+
+

Installing a listener using this symbol does not change the behavior once an + 'error' event is emitted, therefore the process will still crash if no + regular 'error' listener is installed.

+
+
+
+ +

Static formatBidsAndAsks

+
formatBidsAndAsks: (orderbook: OrderbookInfo, offers: BookOffer[]) => { asks: FormattedOrderbookOrder[]; bids: FormattedOrderbookOrder[] } = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (orderbook: OrderbookInfo, offers: BookOffer[]): { asks: FormattedOrderbookOrder[]; bids: FormattedOrderbookOrder[] }
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        orderbook: OrderbookInfo
        +
      • +
      • +
        offers: BookOffer[]
        +
      • +
      +

      Returns { asks: FormattedOrderbookOrder[]; bids: FormattedOrderbookOrder[] }

      +
        +
      • +
        asks: FormattedOrderbookOrder[]
        +
      • +
      • +
        bids: FormattedOrderbookOrder[]
        +
      • +
      +
    • +
    +
  • +
+
+
+
+ +

Static isValidClassicAddress

+
isValidClassicAddress: (address: string) => boolean = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string): boolean
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      +

      Returns boolean

      +
    • +
    +
  • +
+
+
+
+ +

Static isValidXAddress

+
isValidXAddress: (xAddress: string) => boolean = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (xAddress: string): boolean
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        xAddress: string
        +
      • +
      +

      Returns boolean

      +
    • +
    +
  • +
+
+
+
+ +

Static xAddressToClassicAddress

+
xAddressToClassicAddress: (xAddress: string) => { classicAddress: string; tag: number | false; test: boolean } = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (xAddress: string): { classicAddress: string; tag: number | false; test: boolean }
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        xAddress: string
        +
      • +
      +

      Returns { classicAddress: string; tag: number | false; test: boolean }

      +
        +
      • +
        classicAddress: string
        +
      • +
      • +
        tag: number | false
        +
      • +
      • +
        test: boolean
        +
      • +
      +
    • +
    +
  • +
+
+
+
+
+

Methods

+
+ +

addListener

+
    +
  • addListener(eventName: string | symbol, listener: (...args: any[]) => void): BroadcastClient
  • +
+
    +
  • + +
    +
    +

    Alias for emitter.on(eventName, listener).

    +
    +
    +
    since
    +

    v0.1.26

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns BroadcastClient

    +
  • +
+
+
+ +

connect

+
    +
  • connect(): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Tells the Client instance to connect to its rippled server.

    +
    +
    +

    Returns Promise<void>

    +

    A promise that resolves with a void value when a connection is established.

    +
  • +
+
+
+ +

disconnect

+
    +
  • disconnect(): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Tells the Client instance to disconnect from it's rippled server.

    +
    +
    +

    Returns Promise<void>

    +

    A promise that resolves with a void value when a connection is destroyed.

    +
  • +
+
+
+ +

emit

+
    +
  • emit(eventName: string | symbol, ...args: any[]): boolean
  • +
+
    +
  • + +
    +
    +

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments + to each.

    +
    +

    Returns true if the event had listeners, false otherwise.

    +
    const EventEmitter = require('events');
    +const myEmitter = new EventEmitter();
    +
    +// First listener
    +myEmitter.on('event', function firstListener() {
    +  console.log('Helloooo! first listener');
    +});
    +// Second listener
    +myEmitter.on('event', function secondListener(arg1, arg2) {
    +  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    +});
    +// Third listener
    +myEmitter.on('event', function thirdListener(...args) {
    +  const parameters = args.join(', ');
    +  console.log(`event with parameters ${parameters} in third listener`);
    +});
    +
    +console.log(myEmitter.listeners('event'));
    +
    +myEmitter.emit('event', 1, 2, 3, 4, 5);
    +
    +// Prints:
    +// [
    +//   [Function: firstListener],
    +//   [Function: secondListener],
    +//   [Function: thirdListener]
    +// ]
    +// Helloooo! first listener
    +// event with parameters 1, 2 in second listener
    +// event with parameters 1, 2, 3, 4, 5 in third listener
    +
    +
    +
    since
    +

    v0.1.26

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    • +
      Rest ...args: any[]
      +
    • +
    +

    Returns boolean

    +
  • +
+
+
+ +

eventNames

+
    +
  • eventNames(): (string | symbol)[]
  • +
+
    +
  • + +
    +
    +

    Returns an array listing the events for which the emitter has registered + listeners. The values in the array are strings or Symbols.

    +
    +
    const EventEmitter = require('events');
    +const myEE = new EventEmitter();
    +myEE.on('foo', () => {});
    +myEE.on('bar', () => {});
    +
    +const sym = Symbol('symbol');
    +myEE.on(sym, () => {});
    +
    +console.log(myEE.eventNames());
    +// Prints: [ 'foo', 'bar', Symbol(symbol) ]
    +
    +
    +
    since
    +

    v6.0.0

    +
    +
    +
    +

    Returns (string | symbol)[]

    +
  • +
+
+
+ +

getMaxListeners

+
    +
  • getMaxListeners(): number
  • +
+
    +
  • + +
    +
    +

    Returns the current max listener value for the EventEmitter which is either + set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    +
    +
    +
    since
    +

    v1.0.0

    +
    +
    +
    +

    Returns number

    +
  • +
+
+
+ +

Private getMethodNames

+
    +
  • getMethodNames(): string[]
  • +
+
    +
  • + +
    +
    +

    Gets the method names of all the methods of the client.

    +
    +
    +

    Returns string[]

    +

    A list of the names of all the methods of the client.

    +
  • +
+
+
+ +

isConnected

+
    +
  • isConnected(): boolean
  • +
+
    +
  • + +
    +
    +

    Checks if the Client instance is connected to its rippled server.

    +
    +
    +

    Returns boolean

    +

    Whether the client instance is connected.

    +
  • +
+
+
+ +

listenerCount

+
    +
  • listenerCount(eventName: string | symbol): number
  • +
+
    +
  • + +
    +
    +

    Returns the number of listeners listening to the event named eventName.

    +
    +
    +
    since
    +

    v3.2.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
      +

      The name of the event being listened for

      +
      +
    • +
    +

    Returns number

    +
  • +
+
+
+ +

listeners

+
    +
  • listeners(eventName: string | symbol): Function[]
  • +
+
    +
  • + +
    +
    +

    Returns a copy of the array of listeners for the event named eventName.

    +
    +
    server.on('connection', (stream) => {
    +  console.log('someone connected!');
    +});
    +console.log(util.inspect(server.listeners('connection')));
    +// Prints: [ [Function] ]
    +
    +
    +
    since
    +

    v0.1.26

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    +

    Returns Function[]

    +
  • +
+
+
+ +

off

+
    +
  • off(eventName: string | symbol, listener: (...args: any[]) => void): BroadcastClient
  • +
+
    +
  • + +
    +
    +

    Alias for emitter.removeListener().

    +
    +
    +
    since
    +

    v10.0.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns BroadcastClient

    +
  • +
+
+
+ +

on

+
    +
  • on(event: "ledgerClosed", listener: (ledger: LedgerStream) => void): any
  • +
  • on(event: "validationReceived", listener: (validation: ValidationStream) => void): any
  • +
  • on(event: "transaction", listener: (tx: TransactionStream) => void): any
  • +
  • on(event: "peerStatusChange", listener: (status: PeerStatusStream) => void): any
  • +
  • on(event: "consensusPhase", listener: (phase: ConsensusStream) => void): any
  • +
  • on(event: "path_find", listener: (path: PathFindStream) => void): any
  • +
  • on(event: string, listener: (...args: any[]) => void): any
  • +
+ +
+
+ +

once

+
    +
  • once(eventName: string | symbol, listener: (...args: any[]) => void): BroadcastClient
  • +
+
    +
  • + +
    +
    +

    Adds a one-timelistener function for the event named eventName. The + next time eventName is triggered, this listener is removed and then invoked.

    +
    +
    server.once('connection', (stream) => {
    +  console.log('Ah, we have our first user!');
    +});
    +
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the + event listener to the beginning of the listeners array.

    +
    const myEE = new EventEmitter();
    +myEE.once('foo', () => console.log('a'));
    +myEE.prependOnceListener('foo', () => console.log('b'));
    +myEE.emit('foo');
    +// Prints:
    +//   b
    +//   a
    +
    +
    +
    since
    +

    v0.3.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
      +

      The name of the event.

      +
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns BroadcastClient

    +
  • +
+
+
+ +

prepareTransaction

+ + +
+
+ +

prependListener

+
    +
  • prependListener(eventName: string | symbol, listener: (...args: any[]) => void): BroadcastClient
  • +
+
    +
  • + +
    +
    +

    Adds the listener function to the beginning of the listeners array for the + event named eventName. No checks are made to see if the listener has + already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple + times.

    +
    +
    server.prependListener('connection', (stream) => {
    +  console.log('someone connected!');
    +});
    +
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    since
    +

    v6.0.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
      +

      The name of the event.

      +
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns BroadcastClient

    +
  • +
+
+
+ +

prependOnceListener

+
    +
  • prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): BroadcastClient
  • +
+
    +
  • + +
    +
    +

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this + listener is removed, and then invoked.

    +
    +
    server.prependOnceListener('connection', (stream) => {
    +  console.log('Ah, we have our first user!');
    +});
    +
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    since
    +

    v6.0.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
      +

      The name of the event.

      +
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns BroadcastClient

    +
  • +
+
+
+ +

rawListeners

+
    +
  • rawListeners(eventName: string | symbol): Function[]
  • +
+
    +
  • + +
    +
    +

    Returns a copy of the array of listeners for the event named eventName, + including any wrappers (such as those created by .once()).

    +
    +
    const emitter = new EventEmitter();
    +emitter.once('log', () => console.log('log once'));
    +
    +// Returns a new Array with a function `onceWrapper` which has a property
    +// `listener` which contains the original listener bound above
    +const listeners = emitter.rawListeners('log');
    +const logFnWrapper = listeners[0];
    +
    +// Logs "log once" to the console and does not unbind the `once` event
    +logFnWrapper.listener();
    +
    +// Logs "log once" to the console and removes the listener
    +logFnWrapper();
    +
    +emitter.on('log', () => console.log('log persistently'));
    +// Will return a new Array with a single function bound by `.on()` above
    +const newListeners = emitter.rawListeners('log');
    +
    +// Logs "log persistently" twice
    +newListeners[0]();
    +emitter.emit('log');
    +
    +
    +
    since
    +

    v9.4.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    +

    Returns Function[]

    +
  • +
+
+
+ +

removeAllListeners

+ +
    +
  • + +
    +
    +

    Removes all listeners, or those of the specified eventName.

    +
    +

    It is bad practice to remove listeners added elsewhere in the code, + particularly when the EventEmitter instance was created by some other + component or module (e.g. sockets or file streams).

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    since
    +

    v0.1.26

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional event: string | symbol
      +
    • +
    +

    Returns BroadcastClient

    +
  • +
+
+
+ +

removeListener

+
    +
  • removeListener(eventName: string | symbol, listener: (...args: any[]) => void): BroadcastClient
  • +
+
    +
  • + +
    +
    +

    Removes the specified listener from the listener array for the event namedeventName.

    +
    +
    const callback = (stream) => {
    +  console.log('someone connected!');
    +};
    +server.on('connection', callback);
    +// ...
    +server.removeListener('connection', callback);
    +
    +

    removeListener() will remove, at most, one instance of a listener from the + listener array. If any single listener has been added multiple times to the + listener array for the specified eventName, then removeListener() must be + called multiple times to remove each instance.

    +

    Once an event is emitted, all listeners attached to it at the + time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will + not remove them fromemit() in progress. Subsequent events behave as expected.

    +
    const myEmitter = new MyEmitter();
    +
    +const callbackA = () => {
    +  console.log('A');
    +  myEmitter.removeListener('event', callbackB);
    +};
    +
    +const callbackB = () => {
    +  console.log('B');
    +};
    +
    +myEmitter.on('event', callbackA);
    +
    +myEmitter.on('event', callbackB);
    +
    +// callbackA removes listener callbackB but it will still be called.
    +// Internal listener array at time of emit [callbackA, callbackB]
    +myEmitter.emit('event');
    +// Prints:
    +//   A
    +//   B
    +
    +// callbackB is now removed.
    +// Internal listener array [callbackA]
    +myEmitter.emit('event');
    +// Prints:
    +//   A
    +
    +

    Because listeners are managed using an internal array, calling this will + change the position indices of any listener registered after the listener + being removed. This will not impact the order in which listeners are called, + but it means that any copies of the listener array as returned by + the emitter.listeners() method will need to be recreated.

    +

    When a single function has been added as a handler multiple times for a single + event (as in the example below), removeListener() will remove the most + recently added instance. In the example the once('ping')listener is removed:

    +
    const ee = new EventEmitter();
    +
    +function pong() {
    +  console.log('pong');
    +}
    +
    +ee.on('ping', pong);
    +ee.once('ping', pong);
    +ee.removeListener('ping', pong);
    +
    +ee.emit('ping');
    +ee.emit('ping');
    +
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    since
    +

    v0.1.26

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns BroadcastClient

    +
  • +
+
+
+ +

request

+ + +
+
+ +

requestAll

+ + +
+
+ +

requestNextPage

+ + +
+
+ +

setMaxListeners

+ +
    +
  • + +
    +
    +

    By default EventEmitters will print a warning if more than 10 listeners are + added for a particular event. This is a useful default that helps finding + memory leaks. The emitter.setMaxListeners() method allows the limit to be + modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    +
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    since
    +

    v0.3.5

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
      +
    • +
    +

    Returns BroadcastClient

    +
  • +
+
+
+ +

Static getEventListeners

+
    +
  • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
  • +
+
    +
  • + +
    +
    +

    Returns a copy of the array of listeners for the event named eventName.

    +
    +

    For EventEmitters this behaves exactly the same as calling .listeners on + the emitter.

    +

    For EventTargets this is the only way to get the event listeners for the + event target. This is useful for debugging and diagnostic purposes.

    +
    const { getEventListeners, EventEmitter } = require('events');
    +
    +{
    +  const ee = new EventEmitter();
    +  const listener = () => console.log('Events are fun');
    +  ee.on('foo', listener);
    +  getEventListeners(ee, 'foo'); // [listener]
    +}
    +{
    +  const et = new EventTarget();
    +  const listener = () => console.log('Events are fun');
    +  et.addEventListener('foo', listener);
    +  getEventListeners(et, 'foo'); // [listener]
    +}
    +
    +
    +
    since
    +

    v15.2.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: DOMEventTarget | EventEmitter
      +
    • +
    • +
      name: string | symbol
      +
    • +
    +

    Returns Function[]

    +
  • +
+
+
+ +

Static hasNextPage

+
    +
  • hasNextPage(response: MarkerResponse): boolean
  • +
+ +
+
+ +

Static listenerCount

+
    +
  • listenerCount(emitter: EventEmitter, eventName: string | symbol): number
  • +
+
    +
  • + +
    +
    +

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    +
    +
    const { EventEmitter, listenerCount } = require('events');
    +const myEmitter = new EventEmitter();
    +myEmitter.on('event', () => {});
    +myEmitter.on('event', () => {});
    +console.log(listenerCount(myEmitter, 'event'));
    +// Prints: 2
    +
    +
    +
    since
    +

    v0.9.12

    +
    +
    deprecated
    +

    Since v3.2.0 - Use listenerCount instead.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      +
      +

      The emitter to query

      +
      +
    • +
    • +
      eventName: string | symbol
      +
      +

      The event name

      +
      +
    • +
    +

    Returns number

    +
  • +
+
+
+ +

Static on

+
    +
  • on(emitter: EventEmitter, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • +
+
    +
  • + +
    +
    +

    ```js + const { on, EventEmitter } = require('events');

    +
    +

    (async () => { + const ee = new EventEmitter();

    +

    // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + });

    +

    for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here + })();

    +
    
    +Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    +if the `EventEmitter` emits `'error'`. It removes all listeners when
    +exiting the loop. The `value` returned by each iteration is an array
    +composed of the emitted event arguments.
    +
    +An `AbortSignal` can be used to cancel waiting on events:
    +
    +```js
    +const { on, EventEmitter } = require('events');
    +const ac = new AbortController();
    +
    +(async () => {
    +  const ee = new EventEmitter();
    +
    +  // Emit later on
    +  process.nextTick(() => {
    +    ee.emit('foo', 'bar');
    +    ee.emit('foo', 42);
    +  });
    +
    +  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    +    // The execution of this inner block is synchronous and it
    +    // processes one event at a time (even with await). Do not use
    +    // if concurrent execution is required.
    +    console.log(event); // prints ['bar'] [42]
    +  }
    +  // Unreachable here
    +})();
    +
    +process.nextTick(() => ac.abort());
    +
    +
    +
    since
    +

    v13.6.0, v12.16.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      +
    • +
    • +
      eventName: string
      +
      +

      The name of the event being listened for

      +
      +
    • +
    • +
      Optional options: StaticEventEmitterOptions
      +
    • +
    +

    Returns AsyncIterableIterator<any>

    +

    that iterates eventName events emitted by the emitter

    +
  • +
+
+
+ +

Static once

+
    +
  • once(emitter: NodeEventTarget, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • +
  • once(emitter: DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • +
+
    +
  • + +
    +
    +

    Creates a Promise that is fulfilled when the EventEmitter emits the given + event or that is rejected if the EventEmitter emits 'error' while waiting. + The Promise will resolve with an array of all the arguments emitted to the + given event.

    +
    +

    This method is intentionally generic and works with the web platformEventTarget interface, which has no special'error' event + semantics and does not listen to the 'error' event.

    +
    const { once, EventEmitter } = require('events');
    +
    +async function run() {
    +  const ee = new EventEmitter();
    +
    +  process.nextTick(() => {
    +    ee.emit('myevent', 42);
    +  });
    +
    +  const [value] = await once(ee, 'myevent');
    +  console.log(value);
    +
    +  const err = new Error('kaboom');
    +  process.nextTick(() => {
    +    ee.emit('error', err);
    +  });
    +
    +  try {
    +    await once(ee, 'myevent');
    +  } catch (err) {
    +    console.log('error happened', err);
    +  }
    +}
    +
    +run();
    +
    +

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the + 'error' event itself, then it is treated as any other kind of event without + special handling:

    +
    const { EventEmitter, once } = require('events');
    +
    +const ee = new EventEmitter();
    +
    +once(ee, 'error')
    +  .then(([err]) => console.log('ok', err.message))
    +  .catch((err) => console.log('error', err.message));
    +
    +ee.emit('error', new Error('boom'));
    +
    +// Prints: ok boom
    +
    +

    An AbortSignal can be used to cancel waiting for the event:

    +
    const { EventEmitter, once } = require('events');
    +
    +const ee = new EventEmitter();
    +const ac = new AbortController();
    +
    +async function foo(emitter, event, signal) {
    +  try {
    +    await once(emitter, event, { signal });
    +    console.log('event emitted!');
    +  } catch (error) {
    +    if (error.name === 'AbortError') {
    +      console.error('Waiting for the event was canceled!');
    +    } else {
    +      console.error('There was an error', error.message);
    +    }
    +  }
    +}
    +
    +foo(ee, 'foo', ac.signal);
    +ac.abort(); // Abort waiting for the event
    +ee.emit('foo'); // Prints: Waiting for the event was canceled!
    +
    +
    +
    since
    +

    v11.13.0, v10.16.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: NodeEventTarget
      +
    • +
    • +
      eventName: string | symbol
      +
    • +
    • +
      Optional options: StaticEventEmitterOptions
      +
    • +
    +

    Returns Promise<any[]>

    +
  • +
  • + +

    Parameters

    +
      +
    • +
      emitter: DOMEventTarget
      +
    • +
    • +
      eventName: string
      +
    • +
    • +
      Optional options: StaticEventEmitterOptions
      +
    • +
    +

    Returns Promise<any[]>

    +
  • +
+
+
+
+ +
+
+ +
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/classes/Client.html b/docs/classes/Client.html new file mode 100644 index 00000000..9edc40b0 --- /dev/null +++ b/docs/classes/Client.html @@ -0,0 +1,4476 @@ + + + + + + Client | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Client

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new Client(server: string, options?: ClientOptions): Client
  • +
+
    +
  • + +
    +
    +

    Creates a new Client with a websocket connection to a rippled server.

    +
    +
    +

    Parameters

    +
      +
    • +
      server: string
      +
      +
      +

      URL of the server to connect to.

      +
      +
      +
    • +
    • +
      options: ClientOptions = {}
      +
      +
      +

      Options for client settings.

      +
      +
      +
    • +
    +

    Returns Client

    +
  • +
+
+
+
+

Properties

+
+ +

combine

+
combine: (signedTransactions: string[]) => object = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (signedTransactions: string[]): object
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        signedTransactions: string[]
        +
        +

        A collection of the same transaction signed by different signers. The only difference + between the elements of signedTransactions should be the Signers field.

        +
        +
      • +
      +

      Returns object

      +

      An object with the combined transaction (now having a sorted list of all signers) which is encoded, along + with a transaction id based on the combined transaction.

      +
    • +
    +
  • +
+
+
+
+ +

Readonly connection

+
connection: Connection
+ +
+
+ +

errors

+
errors: __module = ...
+ +
+
+ +

Readonly feeCushion

+
feeCushion: number
+ +
+
+ +

generateFaucetWallet

+
generateFaucetWallet: (client: Client, wallet?: Wallet) => Promise<Wallet | void> = ...
+ +
+

Type declaration

+
    +
  • + +
      +
    • +

      Parameters

      + +

      Returns Promise<Wallet | void>

      +
    • +
    +
  • +
+
+
+
+ +

getBalances

+
getBalances: (address: string, options: GetTrustlinesOptions) => Promise<GetBalances> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, options: GetTrustlinesOptions): Promise<GetBalances>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        options: GetTrustlinesOptions
        +
      • +
      +

      Returns Promise<GetBalances>

      +
    • +
    +
  • +
+
+
+
+ +

getFee

+
getFee: (cushion: number | null) => Promise<string> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (cushion: number | null): Promise<string>
    • +
    +
      +
    • +
      +
      +

      Calculates the current transaction fee for the ledger. + Note: This is a public API that can be called directly. + This is not used by the prepare* methods. See src/transaction/utils.ts.

      +
      +
      +

      Parameters

      +
        +
      • +
        cushion: number | null
        +
        +

        The fee cushion to use.

        +
        +
      • +
      +

      Returns Promise<string>

      +

      The transaction fee.

      +
    • +
    +
  • +
+
+
+
+ +

getOrderbook

+
getOrderbook: (address: string, orderbook: OrderbookInfo, options: GetOrderbookOptions) => Promise<FormattedOrderbook> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, orderbook: OrderbookInfo, options: GetOrderbookOptions): Promise<FormattedOrderbook>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        orderbook: OrderbookInfo
        +
      • +
      • +
        options: GetOrderbookOptions
        +
      • +
      +

      Returns Promise<FormattedOrderbook>

      +
    • +
    +
  • +
+
+
+
+ +

getPaths

+
getPaths: (pathfind: PathFind) => Promise<GetPaths> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (pathfind: PathFind): Promise<GetPaths>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        pathfind: PathFind
        +
      • +
      +

      Returns Promise<GetPaths>

      +
    • +
    +
  • +
+
+
+
+ +

getTrustlines

+
getTrustlines: (address: string, options: GetTrustlinesOptions) => Promise<FormattedTrustline[]> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, options: GetTrustlinesOptions): Promise<FormattedTrustline[]>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        options: GetTrustlinesOptions
        +
      • +
      +

      Returns Promise<FormattedTrustline[]>

      +
    • +
    +
  • +
+
+
+
+ +

Readonly maxFeeXRP

+
maxFeeXRP: string
+ +
+
+ +

prepareCheckCancel

+
prepareCheckCancel: (address: string, checkCancel: CheckCancelParameters, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, checkCancel: CheckCancelParameters, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        checkCancel: CheckCancelParameters
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareCheckCash

+
prepareCheckCash: (address: string, checkCash: CheckCashParameters, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, checkCash: CheckCashParameters, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        checkCash: CheckCashParameters
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareCheckCreate

+
prepareCheckCreate: (address: string, checkCreate: CheckCreateParameters, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, checkCreate: CheckCreateParameters, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        checkCreate: CheckCreateParameters
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareEscrowCancellation

+
prepareEscrowCancellation: (address: string, escrowCancellation: EscrowCancellation, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, escrowCancellation: EscrowCancellation, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        escrowCancellation: EscrowCancellation
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareEscrowCreation

+
prepareEscrowCreation: (address: string, escrowCreation: EscrowCreation, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, escrowCreation: EscrowCreation, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        escrowCreation: EscrowCreation
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareEscrowExecution

+
prepareEscrowExecution: (address: string, escrowExecution: EscrowExecution, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, escrowExecution: EscrowExecution, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        escrowExecution: EscrowExecution
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareOrder

+
prepareOrder: (address: string, order: FormattedOrderSpecification, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, order: FormattedOrderSpecification, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        order: FormattedOrderSpecification
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareOrderCancellation

+
prepareOrderCancellation: (address: string, orderCancellation: object, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, orderCancellation: object, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        orderCancellation: object
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

preparePayment

+
preparePayment: (address: string, payment: Payment, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • + +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        payment: Payment
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

preparePaymentChannelClaim

+
preparePaymentChannelClaim: (address: string, paymentChannelClaim: PaymentChannelClaim, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, paymentChannelClaim: PaymentChannelClaim, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        paymentChannelClaim: PaymentChannelClaim
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

preparePaymentChannelCreate

+
preparePaymentChannelCreate: (address: string, paymentChannelCreate: PaymentChannelCreate, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, paymentChannelCreate: PaymentChannelCreate, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        paymentChannelCreate: PaymentChannelCreate
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

preparePaymentChannelFund

+
preparePaymentChannelFund: (address: string, paymentChannelFund: PaymentChannelFund, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, paymentChannelFund: PaymentChannelFund, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        paymentChannelFund: PaymentChannelFund
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareSettings

+
prepareSettings: (address: string, settings: FormattedSettings, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, settings: FormattedSettings, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        settings: FormattedSettings
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareTicketCreate

+
prepareTicketCreate: (address: string, ticketCount: number, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • + +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        ticketCount: number
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

prepareTrustline

+
prepareTrustline: (address: string, trustline: FormattedTrustlineSpecification, instructions: Instructions) => Promise<Prepare> = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string, trustline: FormattedTrustlineSpecification, instructions: Instructions): Promise<Prepare>
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      • +
        trustline: FormattedTrustlineSpecification
        +
      • +
      • +
        instructions: Instructions
        +
      • +
      +

      Returns Promise<Prepare>

      +
    • +
    +
  • +
+
+
+
+ +

sign

+
sign: (txJSON: string, secret?: any, options?: SignOptions, keypair?: KeyPair) => SignedTransaction = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (txJSON: string, secret?: any, options?: SignOptions, keypair?: KeyPair): SignedTransaction
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        txJSON: string
        +
      • +
      • +
        Optional secret: any
        +
      • +
      • +
        Optional options: SignOptions
        +
      • +
      • +
        Optional keypair: KeyPair
        +
      • +
      +

      Returns SignedTransaction

      +
    • +
    +
  • +
+
+
+
+ +

txFlags

+
txFlags: { AccountSet: { AllowXRP: number; DisallowXRP: number; OptionalAuth: number; OptionalDestTag: number; RequireAuth: number; RequireDestTag: number }; OfferCreate: { FillOrKill: number; ImmediateOrCancel: number; Passive: number; Sell: number }; Payment: { LimitQuality: number; NoRippleDirect: number; PartialPayment: number }; PaymentChannelClaim: { Close: number; Renew: number }; TrustSet: { ClearFreeze: number; ClearNoRipple: number; NoRipple: number; SetAuth: number; SetFreeze: number; SetNoRipple: number }; Universal: { FullyCanonicalSig: number } } = ...
+ +
+

Type declaration

+
    +
  • +
    AccountSet: { AllowXRP: number; DisallowXRP: number; OptionalAuth: number; OptionalDestTag: number; RequireAuth: number; RequireDestTag: number }
    +
      +
    • +
      AllowXRP: number
      +
    • +
    • +
      DisallowXRP: number
      +
    • +
    • +
      OptionalAuth: number
      +
    • +
    • +
      OptionalDestTag: number
      +
    • +
    • +
      RequireAuth: number
      +
    • +
    • +
      RequireDestTag: number
      +
    • +
    +
  • +
  • +
    OfferCreate: { FillOrKill: number; ImmediateOrCancel: number; Passive: number; Sell: number }
    +
      +
    • +
      FillOrKill: number
      +
    • +
    • +
      ImmediateOrCancel: number
      +
    • +
    • +
      Passive: number
      +
    • +
    • +
      Sell: number
      +
    • +
    +
  • +
  • +
    Payment: { LimitQuality: number; NoRippleDirect: number; PartialPayment: number }
    +
      +
    • +
      LimitQuality: number
      +
    • +
    • +
      NoRippleDirect: number
      +
    • +
    • +
      PartialPayment: number
      +
    • +
    +
  • +
  • +
    PaymentChannelClaim: { Close: number; Renew: number }
    +
      +
    • +
      Close: number
      +
    • +
    • +
      Renew: number
      +
    • +
    +
  • +
  • +
    TrustSet: { ClearFreeze: number; ClearNoRipple: number; NoRipple: number; SetAuth: number; SetFreeze: number; SetNoRipple: number }
    +
      +
    • +
      ClearFreeze: number
      +
    • +
    • +
      ClearNoRipple: number
      +
    • +
    • +
      NoRipple: number
      +
    • +
    • +
      SetAuth: number
      +
    • +
    • +
      SetFreeze: number
      +
    • +
    • +
      SetNoRipple: number
      +
    • +
    +
  • +
  • +
    Universal: { FullyCanonicalSig: number }
    +
      +
    • +
      FullyCanonicalSig: number
      +
    • +
    +
  • +
+
+
+
+ +

Static accountSetFlags

+
accountSetFlags: { defaultRipple: number; depositAuth: number; disableMasterKey: number; disallowIncomingXRP: number; enableTransactionIDTracking: number; globalFreeze: number; noFreeze: number; requireAuthorization: number; requireDestinationTag: number } = ...
+ +
+

Type declaration

+
    +
  • +
    defaultRipple: number
    +
  • +
  • +
    depositAuth: number
    +
  • +
  • +
    disableMasterKey: number
    +
  • +
  • +
    disallowIncomingXRP: number
    +
  • +
  • +
    enableTransactionIDTracking: number
    +
  • +
  • +
    globalFreeze: number
    +
  • +
  • +
    noFreeze: number
    +
  • +
  • +
    requireAuthorization: number
    +
  • +
  • +
    requireDestinationTag: number
    +
  • +
+
+
+
+ +

Static Readonly captureRejectionSymbol

+
captureRejectionSymbol: typeof captureRejectionSymbol
+ +
+
+ +

Static captureRejections

+
captureRejections: boolean
+ +
+
+

Sets or gets the default captureRejection value for all emitters.

+
+
+
+
+ +

Static classicAddressToXAddress

+
classicAddressToXAddress: (classicAddress: string, tag: number | false, test: boolean) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (classicAddress: string, tag: number | false, test: boolean): string
    • +
    +
      +
    • +
      +
      +

      Static methods to expose ripple-address-codec methods.

      +
      +
      +

      Parameters

      +
        +
      • +
        classicAddress: string
        +
      • +
      • +
        tag: number | false
        +
      • +
      • +
        test: boolean
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static decodeAccountID

+
decodeAccountID: (accountId: string) => Buffer = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (accountId: string): Buffer
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        accountId: string
        +
      • +
      +

      Returns Buffer

      +
    • +
    +
  • +
+
+
+
+ +

Static decodeAccountPublic

+
decodeAccountPublic: (base58string: string) => Buffer = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (base58string: string): Buffer
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        base58string: string
        +
      • +
      +

      Returns Buffer

      +
    • +
    +
  • +
+
+
+
+ +

Static decodeNodePublic

+
decodeNodePublic: (base58string: string) => Buffer = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (base58string: string): Buffer
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        base58string: string
        +
      • +
      +

      Returns Buffer

      +
    • +
    +
  • +
+
+
+
+ +

Static decodeSeed

+
decodeSeed: (seed: string, opts?: { expectedLength: number; versionTypes: ["ed25519", "secp256k1"]; versions: (number | number[])[] }) => { bytes: Buffer; type: string | null; version: number[] } = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (seed: string, opts?: { expectedLength: number; versionTypes: ["ed25519", "secp256k1"]; versions: (number | number[])[] }): { bytes: Buffer; type: string | null; version: number[] }
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        seed: string
        +
      • +
      • +
        Optional opts: { expectedLength: number; versionTypes: ["ed25519", "secp256k1"]; versions: (number | number[])[] }
        +
          +
        • +
          expectedLength: number
          +
        • +
        • +
          versionTypes: ["ed25519", "secp256k1"]
          +
        • +
        • +
          versions: (number | number[])[]
          +
        • +
        +
      • +
      +

      Returns { bytes: Buffer; type: string | null; version: number[] }

      +
        +
      • +
        bytes: Buffer
        +
      • +
      • +
        type: string | null
        +
      • +
      • +
        version: number[]
        +
      • +
      +
    • +
    +
  • +
+
+
+
+ +

Static decodeXAddress

+
decodeXAddress: (xAddress: string) => { accountId: Buffer; tag: number | false; test: boolean } = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (xAddress: string): { accountId: Buffer; tag: number | false; test: boolean }
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        xAddress: string
        +
      • +
      +

      Returns { accountId: Buffer; tag: number | false; test: boolean }

      +
        +
      • +
        accountId: Buffer
        +
      • +
      • +
        tag: number | false
        +
      • +
      • +
        test: boolean
        +
      • +
      +
    • +
    +
  • +
+
+
+
+ +

Static defaultMaxListeners

+
defaultMaxListeners: number
+ +
+
+ +

Static deriveClassicAddress

+
deriveClassicAddress: (publicKey: any) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (publicKey: any): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        publicKey: any
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static deriveXAddress

+
deriveXAddress: (options: { publicKey: string; tag: number | false; test: boolean }) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (options: { publicKey: string; tag: number | false; test: boolean }): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        options: { publicKey: string; tag: number | false; test: boolean }
        +
          +
        • +
          publicKey: string
          +
        • +
        • +
          tag: number | false
          +
        • +
        • +
          test: boolean
          +
        • +
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static encodeAccountID

+
encodeAccountID: (bytes: Buffer) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (bytes: Buffer): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        bytes: Buffer
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static encodeAccountPublic

+
encodeAccountPublic: (bytes: Buffer) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (bytes: Buffer): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        bytes: Buffer
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static encodeNodePublic

+
encodeNodePublic: (bytes: Buffer) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (bytes: Buffer): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        bytes: Buffer
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static encodeSeed

+
encodeSeed: (entropy: Buffer, type: "ed25519" | "secp256k1") => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (entropy: Buffer, type: "ed25519" | "secp256k1"): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        entropy: Buffer
        +
      • +
      • +
        type: "ed25519" | "secp256k1"
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static encodeXAddress

+
encodeXAddress: (accountId: Buffer, tag: number | false, test: boolean) => string = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (accountId: Buffer, tag: number | false, test: boolean): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        accountId: Buffer
        +
      • +
      • +
        tag: number | false
        +
      • +
      • +
        test: boolean
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

Static Readonly errorMonitor

+
errorMonitor: typeof errorMonitor
+ +
+
+

This symbol shall be used to install a listener for only monitoring 'error' + events. Listeners installed using this symbol are called before the regular + 'error' listeners are called.

+
+

Installing a listener using this symbol does not change the behavior once an + 'error' event is emitted, therefore the process will still crash if no + regular 'error' listener is installed.

+
+
+
+ +

Static formatBidsAndAsks

+
formatBidsAndAsks: (orderbook: OrderbookInfo, offers: BookOffer[]) => { asks: FormattedOrderbookOrder[]; bids: FormattedOrderbookOrder[] } = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (orderbook: OrderbookInfo, offers: BookOffer[]): { asks: FormattedOrderbookOrder[]; bids: FormattedOrderbookOrder[] }
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        orderbook: OrderbookInfo
        +
      • +
      • +
        offers: BookOffer[]
        +
      • +
      +

      Returns { asks: FormattedOrderbookOrder[]; bids: FormattedOrderbookOrder[] }

      +
        +
      • +
        asks: FormattedOrderbookOrder[]
        +
      • +
      • +
        bids: FormattedOrderbookOrder[]
        +
      • +
      +
    • +
    +
  • +
+
+
+
+ +

Static isValidClassicAddress

+
isValidClassicAddress: (address: string) => boolean = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (address: string): boolean
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        address: string
        +
      • +
      +

      Returns boolean

      +
    • +
    +
  • +
+
+
+
+ +

Static isValidXAddress

+
isValidXAddress: (xAddress: string) => boolean = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (xAddress: string): boolean
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        xAddress: string
        +
      • +
      +

      Returns boolean

      +
    • +
    +
  • +
+
+
+
+ +

Static xAddressToClassicAddress

+
xAddressToClassicAddress: (xAddress: string) => { classicAddress: string; tag: number | false; test: boolean } = ...
+ +
+

Type declaration

+
    +
  • +
      +
    • (xAddress: string): { classicAddress: string; tag: number | false; test: boolean }
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        xAddress: string
        +
      • +
      +

      Returns { classicAddress: string; tag: number | false; test: boolean }

      +
        +
      • +
        classicAddress: string
        +
      • +
      • +
        tag: number | false
        +
      • +
      • +
        test: boolean
        +
      • +
      +
    • +
    +
  • +
+
+
+
+
+

Methods

+
+ +

addListener

+
    +
  • addListener(eventName: string | symbol, listener: (...args: any[]) => void): Client
  • +
+
    +
  • + +
    +
    +

    Alias for emitter.on(eventName, listener).

    +
    +
    +
    since
    +

    v0.1.26

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns Client

    +
  • +
+
+
+ +

connect

+
    +
  • connect(): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Tells the Client instance to connect to its rippled server.

    +
    +
    +

    Returns Promise<void>

    +

    A promise that resolves with a void value when a connection is established.

    +
  • +
+
+
+ +

disconnect

+
    +
  • disconnect(): Promise<void>
  • +
+
    +
  • + +
    +
    +

    Tells the Client instance to disconnect from it's rippled server.

    +
    +
    +

    Returns Promise<void>

    +

    A promise that resolves with a void value when a connection is destroyed.

    +
  • +
+
+
+ +

emit

+
    +
  • emit(eventName: string | symbol, ...args: any[]): boolean
  • +
+
    +
  • + +
    +
    +

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments + to each.

    +
    +

    Returns true if the event had listeners, false otherwise.

    +
    const EventEmitter = require('events');
    +const myEmitter = new EventEmitter();
    +
    +// First listener
    +myEmitter.on('event', function firstListener() {
    +  console.log('Helloooo! first listener');
    +});
    +// Second listener
    +myEmitter.on('event', function secondListener(arg1, arg2) {
    +  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    +});
    +// Third listener
    +myEmitter.on('event', function thirdListener(...args) {
    +  const parameters = args.join(', ');
    +  console.log(`event with parameters ${parameters} in third listener`);
    +});
    +
    +console.log(myEmitter.listeners('event'));
    +
    +myEmitter.emit('event', 1, 2, 3, 4, 5);
    +
    +// Prints:
    +// [
    +//   [Function: firstListener],
    +//   [Function: secondListener],
    +//   [Function: thirdListener]
    +// ]
    +// Helloooo! first listener
    +// event with parameters 1, 2 in second listener
    +// event with parameters 1, 2, 3, 4, 5 in third listener
    +
    +
    +
    since
    +

    v0.1.26

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    • +
      Rest ...args: any[]
      +
    • +
    +

    Returns boolean

    +
  • +
+
+
+ +

eventNames

+
    +
  • eventNames(): (string | symbol)[]
  • +
+
    +
  • + +
    +
    +

    Returns an array listing the events for which the emitter has registered + listeners. The values in the array are strings or Symbols.

    +
    +
    const EventEmitter = require('events');
    +const myEE = new EventEmitter();
    +myEE.on('foo', () => {});
    +myEE.on('bar', () => {});
    +
    +const sym = Symbol('symbol');
    +myEE.on(sym, () => {});
    +
    +console.log(myEE.eventNames());
    +// Prints: [ 'foo', 'bar', Symbol(symbol) ]
    +
    +
    +
    since
    +

    v6.0.0

    +
    +
    +
    +

    Returns (string | symbol)[]

    +
  • +
+
+
+ +

getMaxListeners

+
    +
  • getMaxListeners(): number
  • +
+
    +
  • + +
    +
    +

    Returns the current max listener value for the EventEmitter which is either + set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    +
    +
    +
    since
    +

    v1.0.0

    +
    +
    +
    +

    Returns number

    +
  • +
+
+
+ +

isConnected

+
    +
  • isConnected(): boolean
  • +
+
    +
  • + +
    +
    +

    Checks if the Client instance is connected to its rippled server.

    +
    +
    +

    Returns boolean

    +

    Whether the client instance is connected.

    +
  • +
+
+
+ +

listenerCount

+
    +
  • listenerCount(eventName: string | symbol): number
  • +
+
    +
  • + +
    +
    +

    Returns the number of listeners listening to the event named eventName.

    +
    +
    +
    since
    +

    v3.2.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
      +

      The name of the event being listened for

      +
      +
    • +
    +

    Returns number

    +
  • +
+
+
+ +

listeners

+
    +
  • listeners(eventName: string | symbol): Function[]
  • +
+
    +
  • + +
    +
    +

    Returns a copy of the array of listeners for the event named eventName.

    +
    +
    server.on('connection', (stream) => {
    +  console.log('someone connected!');
    +});
    +console.log(util.inspect(server.listeners('connection')));
    +// Prints: [ [Function] ]
    +
    +
    +
    since
    +

    v0.1.26

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    +

    Returns Function[]

    +
  • +
+
+
+ +

off

+
    +
  • off(eventName: string | symbol, listener: (...args: any[]) => void): Client
  • +
+
    +
  • + +
    +
    +

    Alias for emitter.removeListener().

    +
    +
    +
    since
    +

    v10.0.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns Client

    +
  • +
+
+
+ +

on

+
    +
  • on(event: "ledgerClosed", listener: (ledger: LedgerStream) => void): any
  • +
  • on(event: "validationReceived", listener: (validation: ValidationStream) => void): any
  • +
  • on(event: "transaction", listener: (tx: TransactionStream) => void): any
  • +
  • on(event: "peerStatusChange", listener: (status: PeerStatusStream) => void): any
  • +
  • on(event: "consensusPhase", listener: (phase: ConsensusStream) => void): any
  • +
  • on(event: "path_find", listener: (path: PathFindStream) => void): any
  • +
  • on(event: string, listener: (...args: any[]) => void): any
  • +
+ +
+
+ +

once

+
    +
  • once(eventName: string | symbol, listener: (...args: any[]) => void): Client
  • +
+
    +
  • + +
    +
    +

    Adds a one-timelistener function for the event named eventName. The + next time eventName is triggered, this listener is removed and then invoked.

    +
    +
    server.once('connection', (stream) => {
    +  console.log('Ah, we have our first user!');
    +});
    +
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the + event listener to the beginning of the listeners array.

    +
    const myEE = new EventEmitter();
    +myEE.once('foo', () => console.log('a'));
    +myEE.prependOnceListener('foo', () => console.log('b'));
    +myEE.emit('foo');
    +// Prints:
    +//   b
    +//   a
    +
    +
    +
    since
    +

    v0.3.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
      +

      The name of the event.

      +
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns Client

    +
  • +
+
+
+ +

prepareTransaction

+ +
    +
  • + +
    +
    +

    Prepare a transaction.

    +
    +

    You can later submit the transaction with a submit request.

    +
    +

    Parameters

    + +

    Returns Promise<Prepare>

    +

    TODO: will be deleted.

    +
  • +
+
+
+ +

prependListener

+
    +
  • prependListener(eventName: string | symbol, listener: (...args: any[]) => void): Client
  • +
+
    +
  • + +
    +
    +

    Adds the listener function to the beginning of the listeners array for the + event named eventName. No checks are made to see if the listener has + already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple + times.

    +
    +
    server.prependListener('connection', (stream) => {
    +  console.log('someone connected!');
    +});
    +
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    since
    +

    v6.0.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
      +

      The name of the event.

      +
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns Client

    +
  • +
+
+
+ +

prependOnceListener

+
    +
  • prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): Client
  • +
+
    +
  • + +
    +
    +

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this + listener is removed, and then invoked.

    +
    +
    server.prependOnceListener('connection', (stream) => {
    +  console.log('Ah, we have our first user!');
    +});
    +
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    since
    +

    v6.0.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
      +

      The name of the event.

      +
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns Client

    +
  • +
+
+
+ +

rawListeners

+
    +
  • rawListeners(eventName: string | symbol): Function[]
  • +
+
    +
  • + +
    +
    +

    Returns a copy of the array of listeners for the event named eventName, + including any wrappers (such as those created by .once()).

    +
    +
    const emitter = new EventEmitter();
    +emitter.once('log', () => console.log('log once'));
    +
    +// Returns a new Array with a function `onceWrapper` which has a property
    +// `listener` which contains the original listener bound above
    +const listeners = emitter.rawListeners('log');
    +const logFnWrapper = listeners[0];
    +
    +// Logs "log once" to the console and does not unbind the `once` event
    +logFnWrapper.listener();
    +
    +// Logs "log once" to the console and removes the listener
    +logFnWrapper();
    +
    +emitter.on('log', () => console.log('log persistently'));
    +// Will return a new Array with a single function bound by `.on()` above
    +const newListeners = emitter.rawListeners('log');
    +
    +// Logs "log persistently" twice
    +newListeners[0]();
    +emitter.emit('log');
    +
    +
    +
    since
    +

    v9.4.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    +

    Returns Function[]

    +
  • +
+
+
+ +

removeAllListeners

+
    +
  • removeAllListeners(event?: string | symbol): Client
  • +
+
    +
  • + +
    +
    +

    Removes all listeners, or those of the specified eventName.

    +
    +

    It is bad practice to remove listeners added elsewhere in the code, + particularly when the EventEmitter instance was created by some other + component or module (e.g. sockets or file streams).

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    since
    +

    v0.1.26

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional event: string | symbol
      +
    • +
    +

    Returns Client

    +
  • +
+
+
+ +

removeListener

+
    +
  • removeListener(eventName: string | symbol, listener: (...args: any[]) => void): Client
  • +
+
    +
  • + +
    +
    +

    Removes the specified listener from the listener array for the event namedeventName.

    +
    +
    const callback = (stream) => {
    +  console.log('someone connected!');
    +};
    +server.on('connection', callback);
    +// ...
    +server.removeListener('connection', callback);
    +
    +

    removeListener() will remove, at most, one instance of a listener from the + listener array. If any single listener has been added multiple times to the + listener array for the specified eventName, then removeListener() must be + called multiple times to remove each instance.

    +

    Once an event is emitted, all listeners attached to it at the + time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will + not remove them fromemit() in progress. Subsequent events behave as expected.

    +
    const myEmitter = new MyEmitter();
    +
    +const callbackA = () => {
    +  console.log('A');
    +  myEmitter.removeListener('event', callbackB);
    +};
    +
    +const callbackB = () => {
    +  console.log('B');
    +};
    +
    +myEmitter.on('event', callbackA);
    +
    +myEmitter.on('event', callbackB);
    +
    +// callbackA removes listener callbackB but it will still be called.
    +// Internal listener array at time of emit [callbackA, callbackB]
    +myEmitter.emit('event');
    +// Prints:
    +//   A
    +//   B
    +
    +// callbackB is now removed.
    +// Internal listener array [callbackA]
    +myEmitter.emit('event');
    +// Prints:
    +//   A
    +
    +

    Because listeners are managed using an internal array, calling this will + change the position indices of any listener registered after the listener + being removed. This will not impact the order in which listeners are called, + but it means that any copies of the listener array as returned by + the emitter.listeners() method will need to be recreated.

    +

    When a single function has been added as a handler multiple times for a single + event (as in the example below), removeListener() will remove the most + recently added instance. In the example the once('ping')listener is removed:

    +
    const ee = new EventEmitter();
    +
    +function pong() {
    +  console.log('pong');
    +}
    +
    +ee.on('ping', pong);
    +ee.once('ping', pong);
    +ee.removeListener('ping', pong);
    +
    +ee.emit('ping');
    +ee.emit('ping');
    +
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    since
    +

    v0.1.26

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +
    • +
    • +
      listener: (...args: any[]) => void
      +
        +
      • +
          +
        • (...args: any[]): void
        • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
            +
          • +
          +

          Returns void

          +
        • +
        +
      • +
      +
    • +
    +

    Returns Client

    +
  • +
+
+
+ +

request

+ + +
+
+ +

requestAll

+ + +
+
+ +

requestNextPage

+ + +
+
+ +

setMaxListeners

+
    +
  • setMaxListeners(n: number): Client
  • +
+
    +
  • + +
    +
    +

    By default EventEmitters will print a warning if more than 10 listeners are + added for a particular event. This is a useful default that helps finding + memory leaks. The emitter.setMaxListeners() method allows the limit to be + modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    +
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    since
    +

    v0.3.5

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
      +
    • +
    +

    Returns Client

    +
  • +
+
+
+ +

Static getEventListeners

+
    +
  • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
  • +
+
    +
  • + +
    +
    +

    Returns a copy of the array of listeners for the event named eventName.

    +
    +

    For EventEmitters this behaves exactly the same as calling .listeners on + the emitter.

    +

    For EventTargets this is the only way to get the event listeners for the + event target. This is useful for debugging and diagnostic purposes.

    +
    const { getEventListeners, EventEmitter } = require('events');
    +
    +{
    +  const ee = new EventEmitter();
    +  const listener = () => console.log('Events are fun');
    +  ee.on('foo', listener);
    +  getEventListeners(ee, 'foo'); // [listener]
    +}
    +{
    +  const et = new EventTarget();
    +  const listener = () => console.log('Events are fun');
    +  et.addEventListener('foo', listener);
    +  getEventListeners(et, 'foo'); // [listener]
    +}
    +
    +
    +
    since
    +

    v15.2.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: DOMEventTarget | EventEmitter
      +
    • +
    • +
      name: string | symbol
      +
    • +
    +

    Returns Function[]

    +
  • +
+
+
+ +

Static hasNextPage

+
    +
  • hasNextPage(response: MarkerResponse): boolean
  • +
+
    +
  • + +
    +
    +

    Returns true if there are more pages of data.

    +
    +

    When there are more results than contained in the response, the response + includes a marker field.

    +

    See https://ripple.com/build/rippled-apis/#markers-and-pagination.

    +
    +

    Parameters

    +
      +
    • +
      response: MarkerResponse
      +
      +

      Response to check for more pages on.

      +
      +
    • +
    +

    Returns boolean

    +

    Whether the response has more pages of data.

    +
  • +
+
+
+ +

Static listenerCount

+
    +
  • listenerCount(emitter: EventEmitter, eventName: string | symbol): number
  • +
+
    +
  • + +
    +
    +

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    +
    +
    const { EventEmitter, listenerCount } = require('events');
    +const myEmitter = new EventEmitter();
    +myEmitter.on('event', () => {});
    +myEmitter.on('event', () => {});
    +console.log(listenerCount(myEmitter, 'event'));
    +// Prints: 2
    +
    +
    +
    since
    +

    v0.9.12

    +
    +
    deprecated
    +

    Since v3.2.0 - Use listenerCount instead.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      +
      +

      The emitter to query

      +
      +
    • +
    • +
      eventName: string | symbol
      +
      +

      The event name

      +
      +
    • +
    +

    Returns number

    +
  • +
+
+
+ +

Static on

+
    +
  • on(emitter: EventEmitter, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • +
+
    +
  • + +
    +
    +

    ```js + const { on, EventEmitter } = require('events');

    +
    +

    (async () => { + const ee = new EventEmitter();

    +

    // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + });

    +

    for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here + })();

    +
    
    +Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    +if the `EventEmitter` emits `'error'`. It removes all listeners when
    +exiting the loop. The `value` returned by each iteration is an array
    +composed of the emitted event arguments.
    +
    +An `AbortSignal` can be used to cancel waiting on events:
    +
    +```js
    +const { on, EventEmitter } = require('events');
    +const ac = new AbortController();
    +
    +(async () => {
    +  const ee = new EventEmitter();
    +
    +  // Emit later on
    +  process.nextTick(() => {
    +    ee.emit('foo', 'bar');
    +    ee.emit('foo', 42);
    +  });
    +
    +  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    +    // The execution of this inner block is synchronous and it
    +    // processes one event at a time (even with await). Do not use
    +    // if concurrent execution is required.
    +    console.log(event); // prints ['bar'] [42]
    +  }
    +  // Unreachable here
    +})();
    +
    +process.nextTick(() => ac.abort());
    +
    +
    +
    since
    +

    v13.6.0, v12.16.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      +
    • +
    • +
      eventName: string
      +
      +

      The name of the event being listened for

      +
      +
    • +
    • +
      Optional options: StaticEventEmitterOptions
      +
    • +
    +

    Returns AsyncIterableIterator<any>

    +

    that iterates eventName events emitted by the emitter

    +
  • +
+
+
+ +

Static once

+
    +
  • once(emitter: NodeEventTarget, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • +
  • once(emitter: DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • +
+
    +
  • + +
    +
    +

    Creates a Promise that is fulfilled when the EventEmitter emits the given + event or that is rejected if the EventEmitter emits 'error' while waiting. + The Promise will resolve with an array of all the arguments emitted to the + given event.

    +
    +

    This method is intentionally generic and works with the web platformEventTarget interface, which has no special'error' event + semantics and does not listen to the 'error' event.

    +
    const { once, EventEmitter } = require('events');
    +
    +async function run() {
    +  const ee = new EventEmitter();
    +
    +  process.nextTick(() => {
    +    ee.emit('myevent', 42);
    +  });
    +
    +  const [value] = await once(ee, 'myevent');
    +  console.log(value);
    +
    +  const err = new Error('kaboom');
    +  process.nextTick(() => {
    +    ee.emit('error', err);
    +  });
    +
    +  try {
    +    await once(ee, 'myevent');
    +  } catch (err) {
    +    console.log('error happened', err);
    +  }
    +}
    +
    +run();
    +
    +

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the + 'error' event itself, then it is treated as any other kind of event without + special handling:

    +
    const { EventEmitter, once } = require('events');
    +
    +const ee = new EventEmitter();
    +
    +once(ee, 'error')
    +  .then(([err]) => console.log('ok', err.message))
    +  .catch((err) => console.log('error', err.message));
    +
    +ee.emit('error', new Error('boom'));
    +
    +// Prints: ok boom
    +
    +

    An AbortSignal can be used to cancel waiting for the event:

    +
    const { EventEmitter, once } = require('events');
    +
    +const ee = new EventEmitter();
    +const ac = new AbortController();
    +
    +async function foo(emitter, event, signal) {
    +  try {
    +    await once(emitter, event, { signal });
    +    console.log('event emitted!');
    +  } catch (error) {
    +    if (error.name === 'AbortError') {
    +      console.error('Waiting for the event was canceled!');
    +    } else {
    +      console.error('There was an error', error.message);
    +    }
    +  }
    +}
    +
    +foo(ee, 'foo', ac.signal);
    +ac.abort(); // Abort waiting for the event
    +ee.emit('foo'); // Prints: Waiting for the event was canceled!
    +
    +
    +
    since
    +

    v11.13.0, v10.16.0

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: NodeEventTarget
      +
    • +
    • +
      eventName: string | symbol
      +
    • +
    • +
      Optional options: StaticEventEmitterOptions
      +
    • +
    +

    Returns Promise<any[]>

    +
  • +
  • + +

    Parameters

    +
      +
    • +
      emitter: DOMEventTarget
      +
    • +
    • +
      eventName: string
      +
    • +
    • +
      Optional options: StaticEventEmitterOptions
      +
    • +
    +

    Returns Promise<any[]>

    +
  • +
+
+
+
+ +
+
+ +
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/classes/Wallet.html b/docs/classes/Wallet.html new file mode 100644 index 00000000..1d8a5652 --- /dev/null +++ b/docs/classes/Wallet.html @@ -0,0 +1,630 @@ + + + + + + Wallet | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Wallet

+
+
+
+
+
+
+
+
+
+

A utility for deriving a wallet composed of a keypair (publicKey/privateKey). + A wallet can be derived from either a seed, mnemnoic, or entropy (array of random numbers). + It provides functionality to sign/verify transactions offline.

+
+
+
+
+

Hierarchy

+
    +
  • + Wallet +
  • +
+
+
+

Index

+
+ +
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new Wallet(publicKey: string, privateKey: string, seed?: string): Wallet
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      publicKey: string
      +
    • +
    • +
      privateKey: string
      +
    • +
    • +
      Optional seed: string
      +
    • +
    +

    Returns Wallet

    +
  • +
+
+
+
+

Properties

+
+ +

Readonly classicAddress

+
classicAddress: string
+ +
+
+ +

Readonly privateKey

+
privateKey: string
+ +
+
+ +

Readonly publicKey

+
publicKey: string
+ +
+
+ +

Optional Readonly seed

+
seed: string
+ +
+
+ +

Static Private Readonly defaultAlgorithm

+
defaultAlgorithm: ECDSA = ...
+ +
+
+ +

Static Private Readonly defaultDerivationPath

+
defaultDerivationPath: string = "m/44'/144'/0'/0/0"
+ +
+
+
+

Methods

+
+ +

getXAddress

+
    +
  • getXAddress(tag: number, test?: boolean): string
  • +
+
    +
  • + +
    +
    +

    Gets an X-address in Testnet/Mainnet format.

    +
    +
    +

    Parameters

    +
      +
    • +
      tag: number
      +
      +

      A tag to be included within the X-address.

      +
      +
    • +
    • +
      test: boolean = false
      +
      +

      A boolean to indicate if X-address should be in Testnet (true) or Mainnet (false) format.

      +
      +
    • +
    +

    Returns string

    +

    An X-address.

    +
  • +
+
+
+ +

signTransaction

+
    +
  • signTransaction(transaction: any, options?: SignOptions): SignedTransaction
  • +
+
    +
  • + +
    +
    +

    Signs a transaction offline.

    +
    +
    +

    Parameters

    +
      +
    • +
      transaction: any
      +
      +

      A transaction to be signed offline.

      +
      +
    • +
    • +
      options: SignOptions = ...
      +
      +

      Options to include for signing.

      +
      +
    • +
    +

    Returns SignedTransaction

    +

    A signed transaction.

    +
  • +
+
+
+ +

verifyTransaction

+
    +
  • verifyTransaction(signedTransaction: string): boolean
  • +
+
    +
  • + +
    +
    +

    Verifies a signed transaction offline.

    +
    +
    +

    Parameters

    +
      +
    • +
      signedTransaction: string
      +
      +

      A signed transaction (hex string of signTransaction result) to be verified offline.

      +
      +
    • +
    +

    Returns boolean

    +

    Returns true if a signedTransaction is valid.

    +
  • +
+
+
+ +

Static Private deriveWallet

+
    +
  • deriveWallet(seed: string, algorithm?: ECDSA): Wallet
  • +
+ +
+
+ +

Static fromEntropy

+
    +
  • fromEntropy(entropy: number[] | Uint8Array, algorithm?: ECDSA): Wallet
  • +
+
    +
  • + +
    +
    +

    Derives a wallet from an entropy (array of random numbers).

    +
    +
    +

    Parameters

    +
      +
    • +
      entropy: number[] | Uint8Array
      +
      +

      An array of random numbers to generate a seed used to derive a wallet.

      +
      +
    • +
    • +
      algorithm: ECDSA = ...
      +
      +

      The digital signature algorithm to generate an address for.

      +
      +
    • +
    +

    Returns Wallet

    +

    A Wallet derived from an entropy.

    +
  • +
+
+
+ +

Static fromMnemonic

+
    +
  • fromMnemonic(mnemonic: string, derivationPath?: string): Wallet
  • +
+
    +
  • + +
    +
    +

    Derives a wallet from a mnemonic.

    +
    +
    +

    Parameters

    +
      +
    • +
      mnemonic: string
      +
      +

      A string consisting of words (whitespace delimited) used to derive a wallet.

      +
      +
    • +
    • +
      derivationPath: string = ...
      +
      +

      The path to derive a keypair (publicKey/privateKey) from a seed (that was converted from a mnemonic).

      +
      +
    • +
    +

    Returns Wallet

    +

    A Wallet derived from a mnemonic.

    +
  • +
+
+
+ +

Static fromSeed

+
    +
  • fromSeed(seed: string, algorithm?: ECDSA): Wallet
  • +
+
    +
  • + +
    +
    +

    Derives a wallet from a seed.

    +
    +
    +

    Parameters

    +
      +
    • +
      seed: string
      +
      +

      A string used to generate a keypair (publicKey/privateKey) to derive a wallet.

      +
      +
    • +
    • +
      algorithm: ECDSA = ...
      +
      +

      The digital signature algorithm to generate an address for.

      +
      +
    • +
    +

    Returns Wallet

    +

    A Wallet derived from a seed.

    +
  • +
+
+
+ +

Static generate

+
    +
  • generate(algorithm?: ECDSA): Wallet
  • +
+
    +
  • + +
    +
    +

    Generates a new Wallet using a generated seed.

    +
    +
    +

    Parameters

    +
      +
    • +
      algorithm: ECDSA = ...
      +
      +

      The digital signature algorithm to generate an address for.

      +
      +
    • +
    +

    Returns Wallet

    +

    A new Wallet derived from a generated seed.

    +
  • +
+
+
+ +

Static Private hexFromBuffer

+
    +
  • hexFromBuffer(buffer: Buffer): string
  • +
+ +
+
+
+ +
+
+ +
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..821b4928 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,622 @@ + + + + + + ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+

ripple-lib

+
+
+
+
+
+
+
+ +

ripple-lib (RippleAPI)

+
+

A JavaScript/TypeScript API for interacting with the XRP Ledger

+

NPM

+

This is the recommended library for integrating a JavaScript/TypeScript app with the XRP Ledger, especially if you intend to use advanced functionality such as IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more.

+ +

➡️ Reference Documentation

+ +

See the full reference documentation on the XRP Ledger Dev Portal.

+ +

➡️ Applications and Projects

+ +

What is ripple-lib used for? The applications on the list linked above use ripple-lib. Open a PR to add your app or project to the list!

+ +

Features

+
+
    +
  • Connect to a rippled server from Node.js or a web browser
  • +
  • Helpers for creating requests and parsing responses for the rippled API
  • +
  • Listen to events on the XRP Ledger (transactions, ledger, validations, etc.)
  • +
  • Sign and submit transactions to the XRP Ledger
  • +
  • Type definitions for TypeScript
  • +
+ +

Requirements

+
+
    +
  • Node.js v14 is recommended. Other versions may work but are not frequently tested.
  • +
  • npm is recommended. yarn may work but we use package-lock.json.
  • +
+ +

Getting Started

+
+

See also: RippleAPI Beginners Guide

+

In an existing project (with package.json), install ripple-lib:

+
$ npm install ripple-lib
+
+

Then see the documentation.

+ +

Using ripple-lib with React Native

+
+

If you want to use ripple-lib with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like rn-nodeify.

+
    +
  1. Install dependencies (you can use npm as well):

    +
    npm install react-native-crypto
    +npm install ripple-lib
    +# install peer deps
    +npm install react-native-randombytes
    +# install latest rn-nodeify
    +npm install rn-nodeify@latest --dev
    +
    +
  2. +
  3. After that, run the following command:

    +
    # install node core shims and recursively hack package.json files
    +# in ./node_modules to add/update the "browser"/"react-native" field with relevant mappings
    +./node_modules/.bin/rn-nodeify --hack --install
    +
    +
  4. +
  5. Enable crypto:

    +

    rn-nodeify will create a shim.js file in the project root directory. + Open it and uncomment the line that requires the crypto module:

    +
    // If using the crypto shim, uncomment the following line to ensure
    +// crypto is loaded first, so it can populate global.crypto
    +require('crypto')
    +
    +
  6. +
  7. Import shim in your project (it must be the first line):

    +
  8. +
+
import './shim'
+...
+
+ +

Using ripple-lib with Deno

+
+

Until official support for Deno is added, you can use the following work-around to use ripple-lib with Deno:

+
import ripple from 'https://dev.jspm.io/npm:ripple-lib';
+
+(async () => {
+  const api = new (ripple as any).RippleAPI({ server: 'wss://s.altnet.rippletest.net:51233' });
+  const address = 'rH8NxV12EuV...khfJ5uw9kT';
+
+  api.connect().then(() => {
+    api.getBalances(address).then((balances: any) => {
+      console.log(JSON.stringify(balances, null, 2));
+    });
+  });
+})();
+
+ +

Documentation

+
+ + +

Mailing Lists

+
+

We have a low-traffic mailing list for announcements of new ripple-lib releases. (About 1 email per week)

+ +

If you're using the XRP Ledger in production, you should run a rippled server and subscribe to the ripple-server mailing list as well.

+ + +

Development

+
+

To build the library for Node.js and the browser:

+
$ npm run build
+
+

The TypeScript compiler will output the resulting JS files in ./dist/npm/.

+

webpack will output the resulting JS files in ./build/.

+

For details, see the scripts in package.json.

+ +

Running Tests

+
+ +

Unit Tests

+
+
    +
  1. Clone the repository
  2. +
  3. cd into the repository and install dependencies with npm install
  4. +
  5. npm test
  6. +
+ +

Linting

+
+

Run npm run lint to lint the code with eslint.

+ +

Generating Documentation

+
+

Do not edit ./docs/index.md directly because it is a generated file.

+

Instead, edit the appropriate .md.ejs files in ./docs/src/.

+

If you make changes to the JSON schemas, fixtures, or documentation sources, update the documentation by running npm run docgen.

+ +

More Information

+
+ +

Build Status

+
+
+ +
+
+ +
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index e6d320d7..00000000 --- a/docs/index.md +++ /dev/null @@ -1,6612 +0,0 @@ - - -# RippleAPI Reference - -- [Introduction](#introduction) - - [Boilerplate](#boilerplate) - - [Offline functionality](#offline-functionality) -- [Basic Types](#basic-types) - - [Address](#address) - - [Account Sequence Number](#account-sequence-number) - - [Currency](#currency) - - [Value](#value) - - [Amount](#amount) -- [Transaction Overview](#transaction-overview) - - [Transaction Types](#transaction-types) - - [Transaction Flow](#transaction-flow) - - [Transaction Fees](#transaction-fees) - - [Transaction Instructions](#transaction-instructions) - - [Transaction ID](#transaction-id) - - [Transaction Memos](#transaction-memos) -- [Transaction Specifications](#transaction-specifications) - - [Account Delete](#account-delete) - - [Check Cancel](#check-cancel) - - [Check Cash](#check-cash) - - [Check Create](#check-create) - - [Deposit Preauth](#deposit-preauth) - - [Escrow Cancellation](#escrow-cancellation) - - [Escrow Creation](#escrow-creation) - - [Escrow Execution](#escrow-execution) - - [Order](#order) - - [Order Cancellation](#order-cancellation) - - [Payment](#payment) - - [Payment Channel Claim](#payment-channel-claim) - - [Payment Channel Create](#payment-channel-create) - - [Payment Channel Fund](#payment-channel-fund) - - [Settings](#settings) - - [Ticket Create](#ticket-create) - - [Trustline](#trustline) -- [rippled APIs](#rippled-apis) - - [Listening to streams](#listening-to-streams) - - [request](#request) - - [hasNextPage](#hasnextpage) - - [requestNextPage](#requestnextpage) -- [Static Methods](#static-methods) - - [computeBinaryTransactionHash](#computebinarytransactionhash) - - [classicAddressToXAddress](#classicaddresstoxaddress) - - [xAddressToClassicAddress](#xaddresstoclassicaddress) - - [renameCounterpartyToIssuer](#renamecounterpartytoissuer) - - [formatBidsAndAsks](#formatbidsandasks) -- [API Methods](#api-methods) - - [connect](#connect) - - [disconnect](#disconnect) - - [isConnected](#isconnected) - - [getServerInfo](#getserverinfo) - - [getFee](#getfee) - - [getLedgerVersion](#getledgerversion) - - [getTransaction](#gettransaction) - - [getTransactions](#gettransactions) - - [getTrustlines](#gettrustlines) - - [getBalances](#getbalances) - - [getBalanceSheet](#getbalancesheet) - - [getPaths](#getpaths) - - [getOrders](#getorders) - - [getOrderbook](#getorderbook) - - [getSettings](#getsettings) - - [getAccountInfo](#getaccountinfo) - - [getAccountObjects](#getaccountobjects) - - [getPaymentChannel](#getpaymentchannel) - - [getLedger](#getledger) - - [parseAccountFlags](#parseaccountflags) - - [prepareTransaction](#preparetransaction) - - [preparePayment](#preparepayment) - - [prepareTrustline](#preparetrustline) - - [prepareOrder](#prepareorder) - - [prepareOrderCancellation](#prepareordercancellation) - - [prepareSettings](#preparesettings) - - [prepareEscrowCreation](#prepareescrowcreation) - - [prepareEscrowCancellation](#prepareescrowcancellation) - - [prepareEscrowExecution](#prepareescrowexecution) - - [preparePaymentChannelCreate](#preparepaymentchannelcreate) - - [preparePaymentChannelClaim](#preparepaymentchannelclaim) - - [preparePaymentChannelFund](#preparepaymentchannelfund) - - [prepareCheckCreate](#preparecheckcreate) - - [prepareCheckCancel](#preparecheckcancel) - - [prepareCheckCash](#preparecheckcash) - - [prepareTicketCreate](#prepareticketcreate) - - [sign](#sign) - - [combine](#combine) - - [submit](#submit) - - [generateXAddress](#generatexaddress) - - [generateAddress](#generateaddress) - - [isValidAddress](#isvalidaddress) - - [isValidSecret](#isvalidsecret) - - [deriveKeypair](#derivekeypair) - - [deriveAddress](#deriveaddress) - - [generateFaucetWallet](#generatefaucetwallet) - - [signPaymentChannelClaim](#signpaymentchannelclaim) - - [verifyPaymentChannelClaim](#verifypaymentchannelclaim) - - [computeLedgerHash](#computeledgerhash) - - [xrpToDrops](#xrptodrops) - - [dropsToXrp](#dropstoxrp) - - [iso8601ToRippleTime](#iso8601torippletime) - - [rippleTimeToISO8601](#rippletimetoiso8601) - - [txFlags](#txflags) - - [AccountSet Flags](#accountset-flags) - - [schemaValidator](#schemavalidator) - - [schemaValidate](#schemavalidate) -- [API Events](#api-events) - - [ledger](#ledger) - - [error](#error) - - [connected](#connected) - - [disconnected](#disconnected) - - - -# Introduction - -RippleAPI (ripple-lib) is the official client library to the XRP Ledger. Currently, RippleAPI is only available in JavaScript/TypeScript. - -Using RippleAPI, you can: - -* [Query transactions from the XRP Ledger history](#gettransaction) -* [Sign](#sign) transactions securely without connecting to any server -* [Submit](#submit) transactions to the XRP Ledger, including [Payments](#payment), [Orders](#order), [Settings changes](#settings), and [other types](#transaction-types) -* [Generate a new XRP Ledger Address](#generateaddress) -* ... and [much more](#api-methods). - -This page contains documentation for ripple-lib. To use ripple-lib with npm/yarn, begin with the [Getting Started](https://github.com/ripple/ripple-lib#getting-started) steps. - -**What is ripple-lib used for?** Here's a [list of applications that use `ripple-lib`](https://github.com/ripple/ripple-lib/blob/develop/APPLICATIONS.md). Open a PR to add your app or project to the list! - -## Boilerplate - -Use the following [boilerplate code](https://en.wikipedia.org/wiki/Boilerplate_code) to wrap your custom code using RippleAPI. - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI; - -const api = new RippleAPI({ - server: 'wss://xrplcluster.com' // Public cluster -}); -api.on('error', (errorCode, errorMessage) => { - console.log(errorCode + ': ' + errorMessage); -}); -api.on('connected', () => { - console.log('connected'); -}); -api.on('disconnected', (code) => { - // code - [close code](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) sent by the server - // the code is 1000 for a normal closure - console.log('disconnected, code:', code); -}); -api.connect().then(() => { - /* insert code here */ -}).then(() => { - return api.disconnect(); -}).catch(console.error); -``` - -[Node.js v14](https://nodejs.org/) is recommended. Other versions may work but are not frequently tested. - - - - - - - -### Parameters - -The RippleAPI constructor optionally takes one argument, an object with the following options: - -Name | Type | Description ----- | ---- | ----------- -authorization | string | *Optional* Username and password for HTTP basic authentication to the rippled server in the format **username:password**. -certificate | string | *Optional* A string containing the certificate key of the client in PEM format. (Can be an array of certificates). -connectionTimeout | integer | *Optional* Connection timeout, in milliseconds, before considering connect() to have failed. -feeCushion | number | *Optional* Factor to multiply estimated fee by to provide a cushion in case the required fee rises during submission of a transaction. Defaults to `1.2`. -key | string | *Optional* A string containing the private key of the client in PEM format. (Can be an array of keys). -maxFeeXRP | string | *Optional* Maximum fee to use with transactions, in XRP. Must be a string-encoded number. Defaults to `'2'`. -passphrase | string | *Optional* The passphrase for the private key of the client. -proxy | uri string | *Optional* URI for HTTP/HTTPS proxy to use to connect to the rippled server. -proxyAuthorization | string | *Optional* Username and password for HTTP basic authentication to the proxy in the format **username:password**. -server | uri string | *Optional* URI for rippled websocket port to connect to. Must start with `wss://`, `ws://`, `wss+unix://`, or `ws+unix://`. -timeout | integer | *Optional* Request timeout in milliseconds before considering a request to have failed. See also: connectionTimeout. -trace | boolean | *Optional* If true, log rippled requests and responses to stdout. -trustedCertificates | array\ | *Optional* Array of PEM-formatted SSL certificates to trust when connecting to a proxy. This is useful if you want to use a self-signed certificate on the proxy server. Note: Each element must contain a single certificate; concatenated certificates are not valid. - -If you omit the `server` parameter, RippleAPI operates [offline](#offline-functionality). - - -### Installation ### - -1. Install [Node.js](https://nodejs.org) and [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). Most Linux distros have a package for Node.js; check that it's the version you want. -2. Use npm to install RippleAPI: - `npm install ripple-lib` - -After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using the Node.js executable, typically named `node`: - - `node script.js` - -## Offline functionality - -RippleAPI can also function without internet connectivity, so you can generate secrets and sign transactions from a secure, isolated machine. - -To instantiate RippleAPI in offline mode, use the following code: - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI; - -const api = new RippleAPI(); -/* insert code here */ -``` - -Methods that depend on the state of the XRP Ledger are unavailable in offline mode. To prepare transactions offline, you **must** specify the `fee`, `sequence`, and `maxLedgerVersion` parameters in the [transaction instructions](#transaction-instructions). You can use the following methods while offline: - -* [preparePayment](#preparepayment) -* [prepareTrustline](#preparetrustline) -* [prepareOrder](#prepareorder) -* [prepareOrderCancellation](#prepareordercancellation) -* [prepareSettings](#preparesettings) -* [prepareEscrowCreation](#prepareescrowcreation) -* [prepareEscrowCancellation](#prepareescrowcancellation) -* [prepareEscrowExecution](#prepareescrowexecution) -* [sign](#sign) -* [generateAddress](#generateaddress) -* [generateXAddress](#generatexaddress) -* [computeLedgerHash](#computeledgerhash) - -# Basic Types - -## Address - -```json -"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" -``` - -```json -"X7AcgcsBL6XDcUb289X4mJ8djcdyKaB5hJDWMArnXr61cqZ" -``` - -An *address* refers to a specific XRP Ledger account. It is a base-58 encoding of a hash of the account's public key. There are two kinds of addresses in common use: - -### Classic Address - -A *classic address* encodes a hash of the account's public key and a checksum. It has no other data. This kind of address always starts with the lowercase letter `r`. - -### X-address - -An *X-address* encodes a hash of the account's public key, a tag, and a checksum. This kind of address starts with the uppercase letter `X` if it is intended for use on the production XRP Ledger (mainnet). It starts with the uppercase letter `T` if it is intended for use on a test network such as Testnet or Devnet. - -## Account Sequence Number - -Every XRP Ledger account has a *sequence number* that is used to keep transactions in order. Every transaction must have a sequence or a ticketSequence number. A transaction can only be executed if it has the next sequence number in order, of the account sending it, or uses a previously generated ticketSequence number. This prevents one transaction from executing twice and transactions executing out of order. The sequence number starts at `1` and increments for each transaction that the account makes. - -## Currency - -Currencies are represented as either 3-character currency codes or 40-character uppercase hexadecimal strings. We recommend using uppercase [ISO 4217 Currency Codes](http://www.xe.com/iso4217.php) only. The string "XRP" is disallowed on trustlines because it is reserved for the XRP Ledger's native currency. The following characters are permitted: all uppercase and lowercase letters, digits, as well as the symbols `?`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `<`, `>`, `(`, `)`, `{`, `}`, `[`, `]`, and `|`. - -## Value -A *value* is a quantity of a currency represented as a decimal string. Be careful: JavaScript's native number format does not have sufficient precision to represent all values. XRP has different precision from other currencies. - -**XRP** has 6 significant digits past the decimal point. In other words, XRP cannot be divided into positive values smaller than `0.000001` (1e-6). This smallest unit is called a "drop". XRP has a maximum value of `100000000000` (1e11). Some RippleAPI methods accept XRP to maintain compatibility with older versions of the API. For consistency with the `rippled` APIs, we recommend formally specifying XRP values in *drops* in all API requests, and converting them to XRP for display. This is like Bitcoin's *satoshis* and Ethereum's *wei*. 1 XRP = 1,000,000 drops. - -**Non-XRP values** have 16 decimal digits of precision, with a maximum value of `9999999999999999e80`. The smallest positive non-XRP value is `1e-81`. - -## Amount - -Example 100.00 USD amount: - -```json -{ - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "value": "100" -} -``` - -Example 3.0 XRP amount, in drops: -```json -{ - "currency": "drops", - "value": "3000000" -} -``` -(Requires `ripple-lib` version 1.0.0 or higher.) - -An *amount* is an object specifying a currency, a quantity of that currency, and the counterparty (issuer) on the trustline that holds the value. For XRP, there is no counterparty. - -A *lax amount* allows the counterparty to be omitted for all currencies. If the counterparty is not specified in an amount within a transaction specification, then any counterparty may be used for that amount. - -A *lax lax amount* allows either or both the counterparty and value to be omitted. - -A *balance* is an amount than can have a negative value. - -Name | Type | Description ----- | ---- | ----------- -currency | [currency](#currency) | The three-character code or hexadecimal string used to denote currencies, or "drops" for the smallest unit of XRP. -counterparty | [address](#address) | *Optional* The XRP Ledger address of the account that owes or is owed the funds (omitted if `currency` is "XRP" or "drops") -value | [value](#value) | *Optional* The quantity of the currency, denoted as a string so that it does not lose precision - -# Transaction Overview - -## Transaction Types - -A transaction type is specified by the strings in the first column in the table below. - -Type | Description ----- | ----------- -[payment](#payment) | A `payment` transaction represents a transfer of value from one account to another. Depending on the [path](https://xrpl.org/paths.html) taken, additional exchanges of value may occur atomically to enable the payment. -[order](#order) | An `order` transaction creates a limit order. It defines an intent to exchange currencies, and creates an order in the XRP Ledger's order book if not completely fulfilled when placed. Orders can be partially fulfilled. -[orderCancellation](#order-cancellation) | An `orderCancellation` transaction cancels an order in the XRP Ledger's order book. -[trustline](#trustline) | A `trustline` transaction creates or modifies a trust line between two accounts. -[settings](#settings) | A `settings` transaction modifies the settings of an account in the XRP Ledger. -[escrowCreation](#escrow-creation) | An `escrowCreation` transaction creates an escrow on the ledger, which locks XRP until a cryptographic condition is met or it expires. It is like an escrow service where the XRP Ledger acts as the escrow agent. -[escrowCancellation](#escrow-cancellation) | An `escrowCancellation` transaction unlocks the funds in an escrow and sends them back to the creator of the escrow, if the escrow has expired. -[escrowExecution](#escrow-execution) | An `escrowExecution` transaction unlocks the funds in an escrow and sends them to the destination of the escrow, if the conditions for the escrow are met. -[checkCreate](#check-create) | A `checkCreate` transaction creates a check on the ledger, which is a deferred payment that can be cashed by its intended destination. -[checkCancel](#check-cancel) | A `checkCancel` transaction cancels an unredeemed Check, removing it from the ledger without sending any money. -[checkCash](#check-cash) | A `checkCash` transaction redeems a Check to receive up to the amount authorized by the corresponding `checkCreate` transaction. Only the `destination` address of a Check can cash it. -[paymentChannelCreate](#payment-channel-create) | A `paymentChannelCreate` transaction opens a payment channel between two addresses with XRP set aside for asynchronous payments. -[paymentChannelFund](#payment-channel-fund) | A `paymentChannelFund` transaction adds XRP to a payment channel and optionally sets a new expiration for the channel. -[paymentChannelClaim](#payment-channel-claim) | A `paymentChannelClaim` transaction withdraws XRP from a channel and optionally requests to close it. -[ticketCreate](#ticket-create) | A successful `ticketCreate` transaction adds a Ticket in the directory of the owning account. - -## Transaction Flow - -Executing a transaction with `RippleAPI` requires the following four steps: - -1. Prepare - Create an unsigned transaction based on a [specification](#transaction-specifications) and [instructions](#transaction-instructions). There is a method to prepare each type of transaction: - * [preparePayment](#preparepayment) - * [prepareTrustline](#preparetrustline) - * [prepareOrder](#prepareorder) - * [prepareOrderCancellation](#prepareordercancellation) - * [prepareSettings](#preparesettings) - * [prepareEscrowCreation](#prepareescrowcreation) - * [prepareEscrowCancellation](#prepareescrowcancellation) - * [prepareEscrowExecution](#prepareescrowexecution) - * [prepareCheckCreate](#preparecheckcreate) - * [prepareCheckCancel](#preparecheckcancel) - * [prepareCheckCash](#preparecheckcash) - * [prepareTicketCreate](#prepareticketcreate) -2. [Sign](#sign) - Cryptographically sign the transaction locally and save the [transaction ID](#transaction-id). Signing is how the owner of an account authorizes a transaction to take place. For multisignature transactions, the `signedTransaction` fields returned by `sign` must be collected and passed to the [combine](#combine) method. -3. [Submit](#submit) - Submit the transaction to the connected server. -4. Verify - Verify that the transaction got validated by querying with [getTransaction](#gettransaction). This is necessary because transactions may fail even if they were successfully submitted. - -## Transaction Fees - -Every transaction must destroy a small amount of XRP as a cost to apply the transaction to the ledger. This is also called a *transaction fee*. The transaction cost is designed to increase along with the load on the XRP Ledger, making it very expensive to deliberately or inadvertently overload the peer-to-peer network that powers the XRP Ledger. - -You can choose the size of the fee you want to pay or let a default be used. You can get an estimate of the fee required to be included in the next ledger closing with the [getFee](#getfee) method. - -For a multi-signed transaction, ripple-lib automatically multiplies the `fee` by (1 + Number of Signatures Provided). For example, if you set `instructions.fee = '0.000020'` and `instructions.signersCount = 2`, the prepared transaction's `Fee` is 20 drops × (1 + 2 Signatures) = 60 drops. See [Transaction Cost](https://xrpl.org/transaction-cost.html). - -## Transaction Instructions - -Transaction instructions indicate how to execute a transaction, complementary with the [transaction specification](#transaction-specifications). - -Name | Type | Description ----- | ---- | ----------- -fee | [value](#value) | *Optional* An exact fee to pay for the transaction, before multiplying for multi-signed transactions. See [Transaction Fees](#transaction-fees) for more information. -maxFee | [value](#value) | *Optional* Deprecated: Use `maxFeeXRP` in the Client constructor instead. The maximum fee to pay for this transaction. If this exceeds `maxFeeXRP`, use `maxFeeXRP` instead. See [Transaction Fees](#transaction-fees) for more information. -maxLedgerVersion | integer,null | *Optional* The highest ledger version that the transaction can be included in. If this option and `maxLedgerVersionOffset` are both omitted, the default is 3 greater than the current validated ledger version (equivalent to `maxLedgerVersionOffset=3`). Use `null` to not set a maximum ledger version. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -maxLedgerVersion | string,null | *Optional* The highest ledger version that the transaction can be included in. If this option and `maxLedgerVersionOffset` are both omitted, the default is 3 greater than the current validated ledger version (equivalent to `maxLedgerVersionOffset=3`). Use `null` to not set a maximum ledger version. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -maxLedgerVersionOffset | integer | *Optional* Offset from current validated ledger version to highest ledger version that the transaction can be included in. -sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -signersCount | integer | *Optional* Number of signers that can multi-sign this transaction. -ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The ticket sequence to be used for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -We recommend that you specify a `maxLedgerVersion` so that you can quickly determine that a failed transaction can never succeed in the future. It is impossible for a transaction to succeed after the XRP Ledger's consensus-validated ledger version exceeds the transaction's `maxLedgerVersion`. If you omit `maxLedgerVersion`, the "prepare\*" method automatically supplies a `maxLedgerVersion` equal to the current ledger plus 3, which it includes in the return value from the "prepare\*" method. - -## Transaction ID - -```json -"F4AB442A6D4CBB935D66E1DA7309A5FC71C7143ED4049053EC14E3875B0CF9BF" -``` - -A transaction ID is a 64-bit hexadecimal string that uniquely identifies the transaction. The transaction ID is derived from the transaction instruction and specifications, using a strong hash function. - -You can look up a transaction by ID using the [getTransaction](#gettransaction) method. - -## Transaction Memos - -Every transaction can optionally have an array of memos for user applications. The `memos` field in each [transaction specification](#transaction-specifications) is an array of objects with the following structure: - -Name | Type | Description ----- | ---- | ----------- -data | string | *Optional* Arbitrary string, conventionally containing the content of the memo. -format | string | *Optional* Conventionally containing information on how the memo is encoded, for example as a [MIME type](http://www.iana.org/assignments/media-types/media-types.xhtml). Only characters allowed in URLs are permitted. -type | string | *Optional* Conventionally, a unique relation (according to [RFC 5988](http://tools.ietf.org/html/rfc5988#section-4)) that defines the format of this memo. Only characters allowed in URLs are permitted. - -# Transaction Specifications - -A *transaction specification* specifies what a transaction should do. Each [Transaction Type](#transaction-types) has its own type of specification, which corresponds to the [native XRP Ledger transaction types](https://xrpl.org/transaction-types.html). - -## Account Delete - -Delete your account and send the remaining XRP elsewhere. (Native transaction type: [AccountDelete](https://xrpl.org/accountdelete.html)) - -Name | Type | Description ----- | ---- | ----------- -destination | [address](#address) | *Optional* Address of an account to receive any leftover XRP after deleting the sending account. Must be a funded account in the ledger, and must not be the sending account. -destinationTag | integer | *Optional* (Optional) Arbitrary destination tag that identifies a hosted recipient or other information for the recipient of the deleted account's leftover XRP. -destinationXAddress | [address](#address) | *Optional* X-address of an account to receive any leftover XRP after deleting the sending account. Must be a funded account in the ledger, and must not be the sending account. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. - -> **Note:** To prepare an Account Delete transaction, use [`prepareTransaction()`](#preparetransaction) with the [native transaction format](https://xrpl.org/accountdelete.html). - -## Check Cancel - -Cancel a Check that has not been redeemed. (Native transaction type: [CheckCancel](https://xrpl.org/checkcancel.html)) - -Name | Type | Description ----- | ---- | ----------- -checkID | string | The ID of the Check ledger object to cancel, as a 64-character hexadecimal string. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. - -#### Example - - -```json -{ - "checkID": "49647F0D748DC3FE26BDACBC57F251AADEFFF391403EC9BF87C97F67E9977FB0" -} -``` - - - -## Check Cash - -Redeem a Check for up to its stated value. (Native transaction type: [CheckCash](https://xrpl.org/checkcash.html)) - -Name | Type | Description ----- | ---- | ----------- -checkID | string | The ID of the Check ledger object to cash, as a 64-character hexadecimal string. -amount | [laxAmount](#amount) | *Optional* Redeem the Check for exactly this amount, if possible. The currency must match that of the sendMax of the corresponding CheckCreate transaction. You must provide either this field or deliverMin. -deliverMin | [laxAmount](#amount) | *Optional* Redeem the Check for at least this amount and for as much as possible. The currency must match that of the sendMax of the corresponding CheckCreate transaction. You must provide either this field or amount. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. - -#### Example - - -```json -{ - "amount": { - "currency": "drops", - "value": "1000000" - }, - "checkID": "838766BA2B995C00744175F69A1B11E32C3DBC40E64801A4056FCBD657F57334" -} -``` - - - -## Check Create - -Create a Check, a deferred payment that can be redeemed by the destination. (Native transaction type: [CheckCreate](https://xrpl.org/checkcreate.html)) - -Name | Type | Description ----- | ---- | ----------- -destination | [address](#address) | Address of the account that can cash the check. -sendMax | [laxAmount](#amount) | Amount of source currency the check is allowed to debit the sender, including transfer fees on non-XRP currencies. -destinationTag | integer | *Optional* Destination tag that identifies the reason for the check, or a hosted recipient to pay. -expiration | date-time string | *Optional* Time after which the check is no longer valid. -invoiceID | string | *Optional* 256-bit hash, as a 64-character hexadecimal string, representing a specific reason or identifier for this check. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. - -#### Example - - -```json -{ - "destination": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW", - "sendMax": { - "currency": "drops", - "value": "1000000" - } -} -``` - - - -## Deposit Preauth - -Preauthorize an sender to deposit money at an account using [Deposit Authorization](https://xrpl.org/depositauth.html). (Native transaction type: [DepositPreauth](https://xrpl.org/depositpreauth.html)) - -Name | Type | Description ----- | ---- | ----------- -authorize | [address](#address) | *Optional* Address of the account that can cash the check. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. -unauthorize | [address](#address) | *Optional* Address of the account that can cash the check. - -> **Note:** To prepare a Deposit Preauth transaction, use [`prepareTransaction()`](#preparetransaction) with the [native transaction format](https://xrpl.org/depositpreauth.html). - - -## Escrow Cancellation - -Cancel an Escrow that has passed its expiration. (Native transaction type: [EscrowCancel](https://xrpl.org/escrowcancel.html)) - -Name | Type | Description ----- | ---- | ----------- -owner | [address](#address) | The address of the owner of the escrow to cancel. -escrowSequence | [sequence](#account-sequence-number) | The [account sequence number](#account-sequence-number) of the [Escrow Creation](#escrow-creation) transaction for the escrow to cancel. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. - -#### Example - - -```json -{ - "owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "escrowSequence": 1234 -} -``` - - - -## Escrow Creation - -Create an Escrow that locks up XRP until a given time or condition is met. (Native transaction type: [EscrowCreate](https://xrpl.org/escrowcreate.html)) - -Name | Type | Description ----- | ---- | ----------- -amount | [value](#value) | Amount of XRP for sender to escrow. -destination | [address](#address) | Address to receive escrowed XRP. -allowCancelAfter | date-time string | *Optional* If present, the escrow may be cancelled after this time. -allowExecuteAfter | date-time string | *Optional* If present, the escrow can not be executed before this time. -condition | string | *Optional* A hex value representing a [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1). If present, `fulfillment` is required upon execution. -destinationTag | integer | *Optional* Destination tag. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. -sourceTag | integer | *Optional* Source tag. - -#### Example - - -```json -{ - "destination": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "amount": "0.01", - "allowExecuteAfter": "2014-09-24T21:21:50.000Z", - "allowCancelAfter": "2017-01-01T00:00:00.000Z" -} -``` - - - -## Escrow Execution - -Deliver XRP from an Escrow after its conditions have been met. (Native transaction type: [EscrowFinish](https://xrpl.org/escrowfinish.html)) - -Name | Type | Description ----- | ---- | ----------- -owner | [address](#address) | The address of the owner of the escrow to execute. -escrowSequence | [sequence](#account-sequence-number) | The [account sequence number](#account-sequence-number) of the [Escrow Creation](#escrow-creation) transaction for the escrow to execute. -condition | string | *Optional* A hex value representing a [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1). This must match the original `condition` from the escrow creation transaction. -fulfillment | string | *Optional* A hex value representing the [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1) fulfillment for `condition`. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. - -#### Example - - -```json -{ - "owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "escrowSequence": 1234, - "condition": "A0258020E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855810100", - "fulfillment": "A0028000" -} -``` - - - -## Order - -Create and execute a limit order in the decentralized exchange. (Native transaction type: [OfferCreate](https://xrpl.org/offercreate.html)) - -Name | Type | Description ----- | ---- | ----------- -direction | string | Equal to "buy" for buy orders and "sell" for sell orders. -quantity | [amount](#amount) | The amount of currency to buy or sell. -totalPrice | [amount](#amount) | The total price to be paid for the `quantity` to be bought or sold. -expirationTime | date-time string | *Optional* Time after which the offer is no longer active, as an [ISO 8601 date-time](https://en.wikipedia.org/wiki/ISO_8601). -fillOrKill | boolean | *Optional* Treat the offer as a [Fill or Kill order](http://en.wikipedia.org/wiki/Fill_or_kill). Only attempt to match existing offers in the ledger, and only do so if the entire quantity can be exchanged. This cannot be used with `immediateOrCancel`. -immediateOrCancel | boolean | *Optional* Treat the offer as an [Immediate or Cancel order](http://en.wikipedia.org/wiki/Immediate_or_cancel). If enabled, do not create an object in the ledger that can be matched later: instead, only execute as much as can be fulfilled immediately. This cannot be used with `fillOrKill`. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. -orderToReplace | [sequence](#account-sequence-number) | *Optional* The [account sequence number](#account-sequence-number) of an order to cancel before the new order is created, effectively replacing the old order. -passive | boolean | *Optional* If enabled, the offer does not consume offers that exactly match it, and instead becomes an Offer node in the ledger. It still consumes offers that cross it. - -The following invalid flag combination causes a `ValidationError`: `immediateOrCancel` and `fillOrKill`. These fields are mutually exclusive, and cannot both be set at the same time. - -#### Example - - -```json -{ - "direction": "buy", - "quantity": { - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "value": "10.1" - }, - "totalPrice": { - "currency": "drops", - "value": "2000000" - }, - "passive": false, - "fillOrKill": true -} -``` - - - -## Order Cancellation - -Cancel an order in the decentralized exchange. (Native transaction type: [OfferCancel](https://xrpl.org/offercancel.html)) - -Name | Type | Description ----- | ---- | ----------- -orderSequence | [sequence](#account-sequence-number) | The [account sequence number](#account-sequence-number) of the order to cancel. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. - -#### Example - - -```json -{ - "orderSequence": 23 -} -``` - - - -## Payment - -Send value from one account to another. (Native transaction type: [Payment](https://xrpl.org/payment.html)) - -Name | Type | Description ----- | ---- | ----------- -source | object | The source of the funds to be sent. -*source.* address | [address](#address) | The address to send from. -*source.* amount | [laxAmount](#amount) | An exact amount to send. If the counterparty is not specified, amounts with any counterparty may be used. (This field cannot be used with source.maxAmount) -*source.* tag | integer | *Optional* An arbitrary 32-bit unsigned integer. It typically maps to an off-ledger account; for example, a hosted wallet or exchange account. -*source.* maxAmount | [laxAmount](#amount) | The maximum amount to send. (This field cannot be used with source.amount) -destination | object | The destination of the funds to be sent. -*destination.* address | [address](#address) | An address representing the destination of the transaction. -*destination.* amount | [laxAmount](#amount) | An exact amount to deliver to the recipient. If the counterparty is not specified, amounts with any counterparty may be used. (This field cannot be used with `destination.minAmount`.) -*destination.* tag | integer | *Optional* An arbitrary 32-bit unsigned integer. It typically maps to an off-ledger account; for example, a hosted wallet or exchange account. -*destination.* minAmount | [laxAmount](#amount) | The minimum amount to be delivered. (This field cannot be used with destination.amount) -allowPartialPayment | boolean | *Optional* If true, this payment can deliver less than the full amount. -invoiceID | string | *Optional* A 256-bit hash that can be used to identify a particular payment. -limitQuality | boolean | *Optional* Only take paths where all the conversions have an input:output ratio that is equal or better than the ratio of destination.amount:source.maxAmount. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. -noDirectRipple | boolean | *Optional* If true and paths are specified, the sender would like the XRP Ledger to disregard any direct paths from the source account to the destination account. This may be used to take advantage of an arbitrage opportunity or by gateways wishing to issue balances from a hot wallet to a user who has mistakenly set a trustline directly to the hot wallet. -paths | string | *Optional* The paths of trustlines and orders to use in executing the payment. - -#### Example - - -```json -{ - "source": { - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "maxAmount": { - "value": "0.01", - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM" - } - }, - "destination": { - "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "amount": { - "value": "0.01", - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM" - } - } -} -``` - - - -## Payment Channel Claim - -Redeem XRP from a Payment Channel. (Native transaction type: [PaymentChannelClaim](https://xrpl.org/paymentchannelclaim.html)) - -Name | Type | Description ----- | ---- | ----------- -channel | string | 256-bit hexadecimal channel identifier. -amount | [value](#value) | *Optional* Amount of XRP authorized by this signature. -balance | [value](#value) | *Optional* Total XRP balance delivered by this channel after claim is processed. -close | boolean | *Optional* Request to close the channel. If the channel has no XRP remaining or the destination address requests it, closes the channel immediately (returning unclaimed XRP to the source address). Otherwise, sets the channel to expire after settleDelay seconds have passed. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. -publicKey | string | *Optional* Public key of the channel. (For verifying the signature.) -renew | boolean | *Optional* Clear the channel's expiration time. -signature | string | *Optional* Signed claim authorizing withdrawal of XRP from the channel. (Required except from the channel's source address.) - -#### Example - - -```json -{ - "channel": "C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198" -} -``` - - - -## Payment Channel Create - -Create a Payment Channel with XRP set aside for asynchronous payments. (Native transaction type: [PaymentChannelCreate](https://xrpl.org/paymentchannelcreate.html)) - -Name | Type | Description ----- | ---- | ----------- -amount | [value](#value) | Amount of XRP for sender to set aside in this channel. -destination | [address](#address) | Address to receive XRP claims against this channel. -settleDelay | number | Amount of seconds the source address must wait before closing the channel if it has unclaimed XRP. -publicKey | string | Public key of the key pair the source may use to sign claims against this channel. -cancelAfter | date-time string | *Optional* Time when this channel expires. This expiration cannot be changed after creating the channel. -destinationTag | integer | *Optional* Destination tag. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. -sourceTag | integer | *Optional* Source tag. - -#### Example - - -```json -{ - "amount": "1", - "destination": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW", - "settleDelay": 86400, - "publicKey": "32D2471DB72B27E3310F355BB33E339BF26F8392D5A93D3BC0FC3B566612DA0F0A" -} -``` - - - -## Payment Channel Fund - -Add XRP to a Payment Channel. (Native transaction type: [PaymentChannelFund](https://xrpl.org/paymentchannelfund.html)) - -Name | Type | Description ----- | ---- | ----------- -amount | [value](#value) | Amount of XRP to fund the channel with. -channel | string | 256-bit hexadecimal channel identifier. -expiration | date-time string | *Optional* New expiration for this channel. (This does not change the cancelAfter expiration, if the channel has one.) Cannot move the expiration sooner than settleDelay seconds from time of the request. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. - -#### Example - - -```json -{ - "channel": "C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198", - "amount": "1" -} -``` - - - - -## Settings - -Change account settings. (Native transaction types: [AccountSet](https://xrpl.org/accountset.html), [SetRegularKey](https://xrpl.org/setregularkey.html), [SignerListSet](https://xrpl.org/signerlistset.html)) - -Name | Type | Description ----- | ---- | ----------- -defaultRipple | boolean | *Optional* Enable [rippling](https://xrpl.org/rippling.html) on this account’s trust lines by default. Currency issuers should enable this setting; most others should not. -depositAuth | boolean | *Optional* Enable [Deposit Authorization](https://xrpl.org/depositauth.html) on this account. If set, transactions cannot send value of any kind to this account unless the sender of those transactions is the account itself. (Requires the [DepositAuth amendment](https://xrpl.org/known-amendments.html#depositauth)) -disableMasterKey | boolean | *Optional* Disallows use of the master key to sign transactions for this account. To disable the master key, you must authorize the transaction by signing it with the master key pair. You cannot use a regular key pair or a multi-signature. You can re-enable the master key pair using a regular key pair or multi-signature. See [AccountSet](https://xrpl.org/accountset.html). -disallowIncomingXRP | boolean | *Optional* Indicates that client applications should not send XRP to this account. Not enforced by rippled. -domain | string | *Optional* The domain that owns this account, as a hexadecimal string representing the ASCII for the domain in lowercase. -emailHash | string,null | *Optional* Hash of an email address to be used for generating an avatar image. Conventionally, clients use Gravatar to display this image. Use `null` to clear. -enableTransactionIDTracking | boolean | *Optional* Track the ID of this account’s most recent transaction. -globalFreeze | boolean | *Optional* Freeze all assets issued by this account. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. -messageKey | string | *Optional* Public key for sending encrypted messages to this account. Conventionally, it should be a secp256k1 key, the same encryption that is used by the rest of Ripple. -noFreeze | boolean | *Optional* Permanently give up the ability to freeze individual trust lines. This flag can never be disabled after being enabled. -passwordSpent | boolean | *Optional* Indicates that the account has used its free SetRegularKey transaction. -regularKey | [address](#address),null | *Optional* The public key of a new keypair, to use as the regular key to this account, as a base-58-encoded string in the same format as an account address. Use `null` to remove the regular key. -requireAuthorization | boolean | *Optional* If set, this account must individually give other users permission to hold this account’s issued tokens. -requireDestinationTag | boolean | *Optional* Requires incoming payments to specify a destination tag. -signers | object | *Optional* Settings that determine what sets of accounts can be used to sign a transaction on behalf of this account using multisigning. -*signers.* threshold | integer | A target number for the signer weights. A multi-signature from this list is valid only if the sum weights of the signatures provided is equal or greater than this value. To delete the signers setting, use the value `0`. -*signers.* weights | array | *Optional* Weights of signatures for each signer. -*signers.* weights[] | object | An association of an address and a weight. -*signers.weights[].* address | [address](#address) | An account address on the XRP Ledger -*signers.weights[].* weight | integer | The weight that the signature of this account counts as towards the threshold. -tickSize | string | *Optional* Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are 3 to 15 inclusive, or 0 to disable. -transferRate | number,null | *Optional* The fee to charge when users transfer this account’s issuances, as the decimal amount that must be sent to deliver 1 unit. Has precision up to 9 digits beyond the decimal point. Use `null` to set no fee. -walletLocator | string,null | *Optional* Transaction hash or any other 64 character hexadecimal string, that may or may not represent the result of a hash operation. Use `null` to clear. - -#### Example - - -```json -{ - "domain": "example.com", - "memos": [ - { - "type": "test", - "format": "text/plain", - "data": "texted data" - } - ] -} -``` - - - -## Ticket Create - -Set aside account Sequence numbers as Tickets to be used by later transactions. - -> **Caution:** As of 2021-01-22, Tickets are not yet available on the XRP Ledger. - -> **Note:** To prepare a Ticket Create transaction, use [`prepareTransaction()`](#preparetransaction) with the native transaction format. - - -## Trustline - -Create or modify a trust line between two accounts, for an issued currency. (Native transaction type: [TrustSet](https://xrpl.org/trustset.html)) - -Name | Type | Description ----- | ---- | ----------- -currency | [currency](#currency) | The currency this trustline applies to. -counterparty | [address](#address) | The address of the account this trustline extends trust to. -limit | [value](#value) | The maximum amount that the owner of the trustline can be owed through the trustline. -authorized | boolean | *Optional* If true, authorize the counterparty to hold issuances from this account. -frozen | boolean | *Optional* If true, the trustline is frozen, which means that funds can only be sent to the owner. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. -qualityIn | number | *Optional* Incoming balances on this trustline are valued at this ratio. -qualityOut | number | *Optional* Outgoing balances on this trustline are valued at this ratio. -ripplingDisabled | boolean | *Optional* If true, payments cannot ripple through this trustline. - -#### Example - - -```json -{ - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "limit": "10000", - "qualityIn": 0.91, - "qualityOut": 0.87, - "ripplingDisabled": true, - "frozen": false, - "memos": [ - { - "type": "test", - "format": "text/plain", - "data": "texted data" - } - ] -} -``` - - -# rippled APIs - -ripple-lib uses the XRP Ledger's [WebSocket API](https://xrpl.org/rippled-api.html) for online functionality. You can use ripple-lib to call these APIs directly. Use the `request()`, `hasNextPage()`, and `requestNextPage()` methods: - -* Use `request()` to issue any `rippled` command, including `account_currencies`, `subscribe`, and `unsubscribe`. [Full list of API Methods](https://xrpl.org/public-rippled-methods.html). -* Use `hasNextPage()` to determine whether a response has more pages. This is true when the response includes a [`marker` field](https://xrpl.org/markers-and-pagination.html). -* Use `requestNextPage()` to request the next page of data. - -When using rippled APIs: - -* [Specify XRP amounts in drops](https://xrpl.org/basic-data-types.html#specifying-currency-amounts). -* [Specify timestamps as the number of seconds since the "Ripple Epoch"](https://xrpl.org/basic-data-types.html#specifying-time). -* Instead of `counterparty`, use `issuer`. - -## Listening to streams - -The `rippled` server can push updates to your client when various events happen. -Refer to [Subscriptions in the `rippled` API docs](https://xrpl.org/subscribe.html) for details. - -Note that the `streams` parameter for generic streams takes an array. For example, to subscribe to the `validations` stream, use `{ streams: [ 'validations' ] }`. - -The string names of some generic streams to subscribe to are in the table below. (Refer to `rippled` for an up-to-date list of streams.) - -Type | Description ----- | ----------- -`server` | Sends a message whenever the status of the `rippled` server (for example, network connectivity) changes. -`ledger` | Sends a message whenever the consensus process declares a new validated ledger. -`transactions` | Sends a message whenever a transaction is included in a closed ledger. -`transactions_proposed` | Sends a message whenever a transaction is included in a closed ledger, as well as some transactions that have not yet been included in a validated ledger and may never be. Not all proposed transactions appear before validation. Even some transactions that don't succeed are included in validated ledgers because they take the anti-spam transaction fee. -`validations` | Sends a message whenever the server receives a validation message, also called a validation vote, regardless of whether the server trusts the validator. -`manifests` | Sends a message whenever the server receives a manifest. -`peer_status` | (Admin-only) Information about connected peer `rippled` servers, especially with regards to the consensus process. - -When you subscribe to a stream, you must also listen to the relevant message type(s). Some of the available message types are in the table below. (Refer to `rippled` for an up-to-date list of message types.) - -Type | Description ----- | ----------- -`ledgerClosed` | Sent by the `ledger` stream when the consensus process declares a new fully validated ledger. The message identifies the ledger and provides some information about its contents. -`validationReceived` | Sent by the `validations` stream when the server receives a validation message, also called a validation vote, regardless of whether the server trusts the validator. -`manifestReceived` | Sent by the `manifests` stream when the server receives a manifest. -`transaction` | Sent by many subscriptions including `transactions`, `transactions_proposed`, `accounts`, `accounts_proposed`, and `book` (Order Book). See [Transaction Streams](https://xrpl.org/subscribe.html#transaction-streams) for details. -`peerStatusChange` | (Admin-only) Reports a large amount of information on the activities of other `rippled` servers to which the server is connected. -`path_find` | Asynchronous follow-up response to the currently open path\_find request. See [rippled path\_find method](https://xrpl.org/path_find.html) for details. - -To register your listener function, use `connection.on(type, handler)`. - -Here is an example of listening for transactions on given account(s): -``` -const account = 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn' // Replace with the account you want notifications for -api.connect().then(() => { - - // 'transaction' can be replaced with the relevant `type` from the table above - api.connection.on('transaction', (event) => { - - // Do something useful with `event` - console.log(JSON.stringify(event, null, 2)) - }) - - api.request('subscribe', { - accounts: [ account ] - }).then(response => { - console.log('Successfully subscribed') - }).catch(error => { - // Handle `error` - }) -}) -``` - -The subscription ends when you unsubscribe or the WebSocket connection is closed. - -For full details, see the [subscribe method](https://xrpl.org/subscribe.html). - -## request - -`request(command: string, options: object): Promise` - -Returns the response from invoking the specified command, with the specified options, on the connected rippled server. - -Refer to [HTTP / WebSocket APIs](https://xrpl.org/rippled-api.html) for commands and options. All XRP amounts must be specified in drops. One drop is equal to 0.000001 XRP. See [Specifying Currency Amounts](https://xrpl.org/basic-data-types.html#specifying-currency-amounts). - -Most commands return data for the `current` (in-progress, open) ledger by default. Do not rely on this. Always specify a ledger version in your request. In the example below, the 'validated' ledger is requested, which is the most recent ledger that has been validated by the whole network. See [Specifying Ledgers](https://xrpl.org/basic-data-types.html#specifying-ledgers). - -### Return Value - -This method returns a promise that resolves with the response from rippled. - -### Example - -```javascript -// Replace 'ledger' with your desired rippled command -return api.request('ledger', { - ledger_index: 'validated' -}).then(response => { - /* Do something useful with response */ - console.log(JSON.stringify(response, null, 2)) -}).catch(console.error); -``` - - -```json -{ - "ledger": { - "account_hash": "F9E9653EA76EA0AEA58AC98A8E19EDCEC8299C2940519A190674FFAED3639A1F", - "close_flags": 0, - "close_time": 577999430, - "close_time_human": "2018-Apr-25 19:23:50", - "close_time_resolution": 10, - "closed": true, - "ledger_hash": "450E5CB0A39495839DA9CD9A0FED74BD71CBB929423A907ADC00F14FC7E7F920", - "ledger_index": "38217406", - "parent_close_time": 577999422, - "parent_hash": "B8B364C63EB9E13FDB89CB729FEF833089B8438CBEB8FC41744CB667209221B3", - "total_coins": "99992286058637091", - "transaction_hash": "5BDD3D2780C28FB2C91C3404BD8ED04786B764B1E18CF319888EDE2C09834726" - }, - "ledger_hash": "450E5CB0A39495839DA9CD9A0FED74BD71CBB929423A907ADC00F14FC7E7F920", - "ledger_index": 38217406, - "validated": true -} -``` - - -## hasNextPage - -`hasNextPage(currentResponse): boolean` - -Returns `true` when there are more pages available. - -When there are more results than contained in the response, the response includes a `marker` field. You can use this convenience method, or check for `marker` yourself. - -See [Markers and Pagination](https://xrpl.org/markers-and-pagination.html). - -### Return Value - -This method returns `true` if `currentResponse` includes a `marker`. - -### Example - -```javascript -return api.request('ledger_data', { - ledger_index: 'validated' -}).then(response => { - /* Do something useful with response */ - - if (api.hasNextPage(response)) { - /* There are more pages available */ - } -}).catch(console.error); -``` - -## requestNextPage - -`requestNextPage(command: string, params: object = {}, currentResponse: object): Promise` - -Requests the next page of data. - -You can use this convenience method, or include `currentResponse.marker` in `params` yourself, when using `request`. - -See [Markers and Pagination](https://xrpl.org/markers-and-pagination.html). - -### Return Value - -This method returns a promise that resolves with the next page of data from rippled. - -If the response does not have a next page, the promise rejects with `new errors.NotFoundError('response does not have a next page')`. - -### Example - -```javascript -const command = 'ledger_data' -const params = { - ledger_index: 'validated' -} -return api.request(command, params).then(response => { - return api.requestNextPage(command, params, response) -}).then(response_page_2 => { - /* Do something useful with second page of response */ -}).catch(console.error); -``` - - -# Static Methods - -You can access static methods directly on the `RippleAPI` class. For example, `RippleAPI.computeBinaryTransactionHash(...)`. - -A few of the most commonly-used methods are documented below. - -For a full list, refer to these docs: - -- [XRP Ledger Hashes](https://github.com/ripple/ripple-lib/blob/develop/src/common/hashes/README.md) -- [ripple-address-codec API](https://github.com/ripple/ripple-address-codec/blob/master/README.md#api) - -## computeBinaryTransactionHash - -`computeBinaryTransactionHash(txBlobHex: string): string` - -Returns the hash (id) of a binary transaction blob. - -This is a static method on the `RippleAPI` class. - -### Parameters - -This method takes one parameter, a string containing a binary transaction in hex. - -### Return Value - -This method returns a string representing the transaction's id (hash). - -### Example - -```javascript -const signed_blob = '120000228000000024000B2E5A201B0066374B61400000003B9ACA0068400000000000000C732102356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC74473045022100B3721EEB1ED6DFF29FB8B209E2DE6B54A0A6E44D52D926342F3D334BE98F08640220367A74107AD5DEAEFA3AB2984C161FC23F30B2704BB5CC984358BA262177A4568114F667B0CA50CC7709A220B0561B85E53A48461FA883142B71D8B09B4EE8DAA68FB936C23E3A974713BDAC' -if (typeof signed_blob === 'string' && signed_blob.match(/^[A-F0-9]+$/)) { - const id = RippleAPI.computeBinaryTransactionHash(signed_blob) - console.log('Transaction hash:', id') -} -``` - -``` -Transaction hash: 80C5E11E1A21A626759D6CB944B33DBAAC66BD704A289C86E330B847904F5C13 -``` - -[RunKit Example: computeBinaryTransactionHash](https://runkit.com/intelliot/computebinarytransactionhash-example) - -## classicAddressToXAddress - -`classicAddressToXAddress(classicAddress: string, tag: number | false[, test: boolean]): string` - -Convert a classic address and tag to an X-address. - -If `test` is `true`, the address starts with `T` to show that the address is intended for use on a test network. - -### Example: Encode an X-address with tag 4294967295 - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI -const xAddress = RippleAPI.classicAddressToXAddress('rGWrZyQqhTp9Xu7G5Pkayo7bXjH4k4QYpf', 4294967295) -console.log(xAddress) -``` - -``` -XVLhHMPHU98es4dbozjVtdWzVrDjtV18pX8yuPT7y4xaEHi -``` - -### Example: Encode a test address for use with Testnet or Devnet - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI -const address = RippleAPI.classicAddressToXAddress('r3SVzk8ApofDJuVBPKdmbbLjWGCCXpBQ2g', 123, true) -console.log(address) -``` - -``` -T7oKJ3q7s94kDH6tpkBowhetT1JKfcfdSCmAXbS75iATyLD -``` - -## xAddressToClassicAddress - -`xAddressToClassicAddress(xAddress: string): {classicAddress: string, tag: number | false, test: boolean}` - -Convert an X-address to a classic address and tag. - -Since `0` is a valid tag, use `if (tag !== false)` to you want to check for a tag. - -If the address is intended for use on a test network, `test === true`. Otherwise, `test === false`. - -### Example - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI -const address = RippleAPI.xAddressToClassicAddress('XVLhHMPHU98es4dbozjVtdWzVrDjtV18pX8yuPT7y4xaEHi') -console.log(address) -``` - -``` -{ - classicAddress: 'rGWrZyQqhTp9Xu7G5Pkayo7bXjH4k4QYpf', - tag: 4294967295, - test: false -} -``` - -## renameCounterpartyToIssuer - -`renameCounterpartyToIssuer(issue: {currency: string, counterparty: address}): {currency: string, issuer: address}` - -Returns an object with the `counterparty` field renamed to `issuer`. This is useful because RippleAPI generally uses the name `counterparty` while the rippled API generally uses the name `issuer`. - -This is a static method on the `RippleAPI` class. - -### Parameters - -This method takes one parameter, an object with a `counterparty` field. - -### Return Value - -This method returns a new object based on the source object, but with `issuer` instead of `counterparty`. - -### Example - -```javascript -const orderbookInfo = { - "base": { - "currency": "USD", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "counter": { - "currency": "BTC", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } -}; -console.log(RippleAPI.renameCounterpartyToIssuer(orderbookInfo.base)) -console.log(RippleAPI.renameCounterpartyToIssuer(orderbookInfo.counter)) -``` - -``` -{ currency: 'USD', issuer: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' } -{ currency: 'BTC', issuer: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' } -``` - -## formatBidsAndAsks - -`formatBidsAndAsks(orderbookInfo: {base: Issue, counter: Issue}, offers: BookOffer[]): orderbook` - -Returns formatted bids and asks, which make up an orderbook. - -This is a static method on the `RippleAPI` class. - -### Parameters - -This method takes two parameters. - -1. An `OrderbookInfo` object: `{ base: Issue, counter: Issue }`. -2. An array of `BookOffer` objects. - -### Return Value - -This method returns an object with two properties: `bids` and `asks`, each of which is an array of bids (buy orders) or asks (sell orders), respectively. Both `bids` and `asks` are formatted the same way. - -Object structure: - -Name | Type | Description ----- | ---- | ----------- -bids | array | The buy orders in the order book. -bids[] | object | An order in the order book. -*bids[].* specification | [order](#order) | An order specification that would create an order equivalent to the current state of this order. -*bids[].* properties | object | Properties of the order not in the specification. -*bids[].properties.* maker | [address](#address) | The address of the account that submitted the order. -*bids[].properties.* sequence | [sequence](#account-sequence-number) | The account sequence number of the transaction that created this order. -*bids[].properties.* makerExchangeRate | [value](#value) | The exchange rate from the point of view of the account that submitted the order (also known as "quality"). -*bids[].data.* \* | object | -*bids[].* state | object | *Optional* The state of the order. -*bids[].state.* fundedAmount | [amount](#amount) | How much of the amount the maker would have to pay that the maker currently holds. -*bids[].state.* priceOfFundedAmount | [amount](#amount) | How much the `fundedAmount` would convert to through the exchange rate of this order. -asks | array | The sell orders in the order book. -asks[] | object | An order in the order book. -*asks[].* specification | [order](#order) | An order specification that would create an order equivalent to the current state of this order. -*asks[].* properties | object | Properties of the order not in the specification. -*asks[].properties.* maker | [address](#address) | The address of the account that submitted the order. -*asks[].properties.* sequence | [sequence](#account-sequence-number) | The account sequence number of the transaction that created this order. -*asks[].properties.* makerExchangeRate | [value](#value) | The exchange rate from the point of view of the account that submitted the order (also known as "quality"). -*asks[].data.* \* | object | -*asks[].* state | object | *Optional* The state of the order. -*asks[].state.* fundedAmount | [amount](#amount) | How much of the amount the maker would have to pay that the maker currently holds. -*asks[].state.* priceOfFundedAmount | [amount](#amount) | How much the `fundedAmount` would convert to through the exchange rate of this order. - -**Raw order data:** The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields. - -For details, see the `rippled` [book_offers method](https://xrpl.org/book_offers.html). - -### Example - -```javascript -const orderbookInfo = { - "base": { - "currency": "USD", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "counter": { - "currency": "BTC", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } -}; - -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; - -return Promise.all( - [ - this.api.request('book_offers', { - taker_gets: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.base), - taker_pays: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.counter), - ledger_index: 'validated', - limit: 20, - taker: address - }), - this.api.request('book_offers', { - taker_gets: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.counter), - taker_pays: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.base), - ledger_index: 'validated', - limit: 20, - taker: address - }) - ] -).then((directOfferResults, reverseOfferResults) => { - const directOffers = (directOfferResults ? directOfferResults : []).reduce((acc, res) => acc.concat(res.offers), []) - const reverseOffers = (reverseOfferResults ? reverseOfferResults : []).reduce((acc, res) => acc.concat(res.offers), []) - const orderbook = RippleAPI.formatBidsAndAsks(orderbookInfo, [...directOffers, ...reverseOffers]); - console.log(JSON.stringify(orderbook, null, 2)); -}); -``` - -``` -{ - "bids": [ - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "0.71800168", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.00016708342", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq", - "sequence": 262660, - "makerExchangeRate": "4297.264683713081" - }, - "data": { - "Account": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98580F4456E6FA8239", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "000000000000001D", - "PreviousTxnID": "16D75506C6317723FC03543130B5E0AAB13E8AD22514C1DB098BE05771C90447", - "PreviousTxnLgrSeq": 43127860, - "Sequence": 262660, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.00016708342" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.71800168" - }, - "index": "DE877FB94EF892A4BCC58DB8CDE063D97AB5133201905DE6C8650B5DEA19E11B", - "owner_funds": "0.03358376764081196", - "quality": "4297.264683713081" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "1.6770875", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.00038681218", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM", - "sequence": 231459, - "makerExchangeRate": "4335.663628792661" - }, - "data": { - "Account": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98580F67435A75B355", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000001", - "PreviousTxnID": "F049EAFDDDA7B99970F77533743D95C9E12A16FE6C56215A0B09C32C4D23163F", - "PreviousTxnLgrSeq": 43127094, - "Sequence": 231459, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.00038681218" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1.6770875" - }, - "index": "3B314A51BD57601CA1509834DF9462037BF4B05AFCC1E1EFD334DB4E2D7B2AA6", - "owner_funds": "0.03906802968738533", - "quality": "4335.663628792661" - } - }, - // ... trimmed for brevity ... - ], - "asks": [ - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "0.71085738", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.00016876265", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq", - "sequence": 262664, - "makerExchangeRate": "0.0002374071856720401" - }, - "data": { - "Account": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A451086F34ADB0EA11", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "000000000000001D", - "PreviousTxnID": "54CE0B2783AF973718FAFA35E864A3C172BE488EBBB6F2852611C6DAC8893BDF", - "PreviousTxnLgrSeq": 43127875, - "Sequence": 262664, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.71085738" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.00016876265" - }, - "index": "2D4ED103D6B3FEFA21BC385C53B63359F5678E5AA5429DDE6E1D8FE8B41CD6A8", - "owner_funds": "142.8821425048244", - "quality": "0.0002374071856720401" - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "1.6438778", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.00039462656", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM", - "sequence": 231483, - "makerExchangeRate": "0.0002400583303698121" - }, - "data": { - "Account": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4510887515B1216C9", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000001", - "PreviousTxnID": "6FA370F52C45F6149482156FF7B4226713AECE991FB7D053F74172CB0B8F24E9", - "PreviousTxnLgrSeq": 43127158, - "Sequence": 231483, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1.6438778" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.00039462656" - }, - "index": "735F9661AD006BA0776859BE371D445555FC0815604603AC056469C16AC84AE3", - "owner_funds": "166.0316626329364", - "quality": "0.0002400583303698121" - } - }, - // ... trimmed for brevity ... - ] -} -``` - - -# API Methods - -## connect - -`connect(): Promise` - -Tells the RippleAPI instance to connect to its rippled server. - -### Parameters - -This method has no parameters. - -### Return Value - -This method returns a promise that resolves with a void value when a connection is established. - -### Example - -See [Boilerplate](#boilerplate) for code sample. - -## disconnect - -`disconnect(): Promise` - -Tells the RippleAPI instance to disconnect from its rippled server. - -### Parameters - -This method has no parameters. - -### Return Value - -This method returns a promise that resolves with a void value when a connection is destroyed. - -### Example - -See [Boilerplate](#boilerplate) for code sample - -## isConnected - -`isConnected(): boolean` - -Checks if the RippleAPI instance is connected to its rippled server. - -### Parameters - -This method has no parameters. - -### Return Value - -This method returns `true` if connected and `false` if not connected. - -### Example - -```javascript -return api.isConnected(); -``` - -```json -true -``` - -## getServerInfo - -`getServerInfo(): Promise` - -Get status information about the server that the RippleAPI instance is connected to. - -### Parameters - -This method has no parameters. - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -Name | Type | Description ----- | ---- | ----------- -buildVersion | string | The version number of the running rippled version. -completeLedgers | string | Range expression indicating the sequence numbers of the ledger versions the local rippled has in its database. It is possible to be a disjoint sequence, e.g. “2500-5000,32570-7695432”. -hostID | string | On an admin request, returns the hostname of the server running the rippled instance; otherwise, returns a unique four letter word. -ioLatencyMs | number | 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. -lastClose | object | Information about the last time the server closed a ledger. -*lastClose.* convergeTimeS | number | The time it took to reach a consensus for the last ledger closing, in seconds. -*lastClose.* proposers | integer | Number of trusted validators participating in the ledger closing. -loadFactor | number | The load factor the server is currently enforcing, as a multiplier on the base transaction fee. The load factor is determined by the highest of the individual server’s load factor, cluster’s load factor, and the overall network’s load factor. -peers | integer | How many other rippled servers the node is currently connected to. -pubkeyNode | string | Public key used to verify this node for internal communications; this key is automatically generated by the server the first time it starts up. -serverState | string | A string indicating to what extent the server is participating in the network. See [Possible Server States](https://xrpl.org/rippled-server-states.html) for more details. -validatedLedger | object | Information about the fully-validated ledger with the highest sequence number (the most recent). -*validatedLedger.* age | integer | The time since the ledger was closed, in seconds. -*validatedLedger.* baseFeeXRP | [value](#value) | Base fee, in XRP. This may be represented in scientific notation such as 1e-05 for 0.00005. -*validatedLedger.* hash | string | Unique hash for the ledger, as an uppercase hexadecimal string. -*validatedLedger.* reserveBaseXRP | [value](#value) | Minimum amount of XRP necessary for every account to keep in reserve. -*validatedLedger.* reserveIncrementXRP | [value](#value) | Amount of XRP added to the account reserve for each object an account owns in the ledger. -*validatedLedger.* ledgerVersion | integer | Identifying ledger index of this ledger version. -validationQuorum | number | Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. -load | object | *Optional* *(Admin only)* Detailed information about the current load state of the server. -*load.* jobTypes | array\ | *(Admin only)* Information about the rate of different types of jobs the server is doing and how much time it spends on each. -*load.* threads | number | *(Admin only)* The number of threads in the server’s main job pool, performing various operations. -pubkeyValidator | string | *Optional* *(Admin only)* Public key used by this node to sign ledger validations. - -### Example - -```javascript -return api.getServerInfo().then(info => {/* ... */}); -``` - - -```json -{ - "build_version": "0.24.0-rc1", - "complete_ledgers": "32570-6595042", - "hostid": "ARTS", - "io_latency_ms": 1, - "last_close": { - "converge_time_s": 2.007, - "proposers": 4 - }, - "load_factor": 1, - "peers": 53, - "pubkey_node": "n94wWvFUmaKGYrKUGgpv1DyYgDeXRGdACkNQaSe7zJiy5Znio7UC", - "server_state": "full", - "validated_ledger": { - "age": 5, - "base_fee_xrp": 0.00001, - "hash": "4482DEE5362332F54A4036ED57EE1767C9F33CF7CE5A6670355C16CECE381D46", - "reserve_base_xrp": 20, - "reserve_inc_xrp": 5, - "seq": 6595042 - }, - "validation_quorum": 3 -} -``` - - -## getFee - -`getFee(): Promise` - -Returns the estimated transaction fee for the rippled server the RippleAPI instance is connected to. - -This uses the [feeCushion parameter](#parameters) provided to the RippleAPI constructor, or the default value of `1.2`. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -cushion | number | *Optional* The fee is the product of the base fee, the `load_factor`, and this cushion. Default is provided by the `Client` constructor's `feeCushion`. - -### Return Value - -This method returns a promise that resolves with a string-encoded floating point value representing the estimated fee to submit a transaction, expressed in XRP. - -### Example - -```javascript -return api.getFee().then(fee => {/* ... */}); -``` - -```json -"0.000012" -``` - -## getLedgerVersion - -`getLedgerVersion(): Promise` - -Returns the most recent validated ledger version number known to the connected server. - -### Parameters - -This method has no parameters. - -### Return Value - -This method returns a promise that resolves with a positive integer representing the most recent validated ledger version number known to the connected server. - -### Example - -```javascript -return api.getLedgerVersion().then(ledgerVersion => { - /* ... */ -}); -``` - -```json -16869039 -``` - - -## getTransaction - -`getTransaction(id: string, options: object): Promise` - -Retrieves a transaction by its [Transaction ID](#transaction-id). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -id | [transactionHash](#transaction-id) | A hash of a transaction used to identify the transaction, represented in hexadecimal. -options | object | *Optional* Options to limit the ledger versions to search or include raw transaction data. -*options.* includeRawTransaction | object | *Optional* Include raw transaction data. For advanced users; exercise caution when interpreting this data. -*options.* maxLedgerVersion | integer | *Optional* The highest ledger version to search. This must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*options.* maxLedgerVersion | string | *Optional* The highest ledger version to search. This must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*options.* minLedgerVersion | integer | *Optional* The lowest ledger version to search. This must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*options.* minLedgerVersion | string | *Optional* The lowest ledger version to search. This must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. - -### Return Value - -This method returns a promise that resolves with a transaction object containing the following fields. - -Name | Type | Description ----- | ---- | ----------- -id | [transactionHash](#transaction-id) | A hash of the transaction that can be used to identify it. -address | [address](#address) | The address of the account that initiated the transaction. -sequence | [sequence](#account-sequence-number) | The account sequence number of the transaction for the account that initiated it. -type | [transactionType](#transaction-types) | The type of the transaction. -specification | object | A specification that would produce the same outcome as this transaction. *Exception:* For payment transactions, this omits the `destination.amount` field, to prevent misunderstanding. The structure of the specification depends on the value of the `type` field (see [Transaction Types](#transaction-types) for details). *Note:* This is **not** necessarily the same as the original specification. -outcome | object | The outcome of the transaction (what effects it had). -*outcome.* result | string | Result code returned by rippled. See [Transaction Results](https://xrpl.org/transaction-results.html) for a complete list. -*outcome.* fee | [value](#value) | The XRP fee that was charged for the transaction. -*outcome.balanceChanges.* \* | array\<[balance](#amount)\> | Key is the XRP Ledger address; value is an array of signed amounts representing changes of balances for that address. -*outcome.orderbookChanges.* \* | array | Key is the maker's XRP Ledger address; value is an array of changes -*outcome.orderbookChanges.* \*[] | object | A change to an order. -*outcome.orderbookChanges.\*[].* direction | string | Equal to "buy" for buy orders and "sell" for sell orders. -*outcome.orderbookChanges.\*[].* quantity | [amount](#amount) | The amount to be bought or sold by the maker. -*outcome.orderbookChanges.\*[].* totalPrice | [amount](#amount) | The total amount to be paid or received by the taker. -*outcome.orderbookChanges.\*[].* sequence | [sequence](#account-sequence-number) | The order sequence number, used to identify the order for cancellation -*outcome.orderbookChanges.\*[].* status | string | The status of the order. One of "created", "filled", "partially-filled", "cancelled". -*outcome.orderbookChanges.\*[].* expirationTime | date-time string | *Optional* The time after which the order expires, if any. -*outcome.orderbookChanges.\*[].* makerExchangeRate | [value](#value) | *Optional* The exchange rate between the `quantity` currency and the `totalPrice` currency from the point of view of the maker. -*outcome.* ledgerVersion | integer | The ledger version that the transaction was validated in. -*outcome.* ledgerVersion | string | The ledger version that the transaction was validated in. -*outcome.* indexInLedger | integer | The ordering index of the transaction in the ledger. -*outcome.* channelChanges | object | *Optional* Properties reflecting the details of the payment channel. -*outcome.* deliveredAmount | [amount](#amount) | *Optional* For payment transactions, it is impossible to reliably compute the actual delivered amount from the balanceChanges due to fixed precision. If the payment is not a partial payment and the transaction succeeded, the deliveredAmount should always be considered to be the amount specified in the transaction. -*outcome.* timestamp | date-time string | *Optional* The timestamp when the transaction was validated. (May be missing when requesting transactions in binary mode.) -rawTransaction | string | *Optional* The raw transaction data as a JSON string. For advanced users only; exercise caution when interpreting this data. - -### Example - -```javascript -const id = '01CDEAA89BF99D97DFD47F79A0477E1DCC0989D39F70E8AACBFE68CC83BD1E94'; -return api.getTransaction(id).then(transaction => { - /* ... */ -}); -``` - - -```json -{ - "type": "payment", - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 4, - "id": "F4AB442A6D4CBB935D66E1DA7309A5FC71C7143ED4049053EC14E3875B0CF9BF", - "specification": { - "source": { - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "maxAmount": { - "currency": "XRP", - "value": "1.112209" - } - }, - "destination": { - "address": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM" - }, - "paths": "[[{\"currency\":\"USD\",\"issuer\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"type\":48,\"type_hex\":\"0000000000000030\"},{\"account\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"currency\":\"USD\",\"issuer\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"type\":49,\"type_hex\":\"0000000000000031\"}]]" - }, - "outcome": { - "result": "tesSUCCESS", - "timestamp": "2013-03-12T23:56:50.000Z", - "fee": "0.00001", - "deliveredAmount": { - "currency": "USD", - "value": "0.001", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM" - }, - "balanceChanges": { - "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo": [ - { - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "currency": "USD", - "value": "-0.001" - }, - { - "counterparty": "r9tGqzZgKxVFvzKFdUqXAqTzazWBUia8Qr", - "currency": "USD", - "value": "0.001002" - } - ], - "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM": [ - { - "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "currency": "USD", - "value": "0.001" - } - ], - "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59": [ - { - "currency": "XRP", - "value": "-1.101208" - } - ], - "r9tGqzZgKxVFvzKFdUqXAqTzazWBUia8Qr": [ - { - "currency": "XRP", - "value": "1.101198" - }, - { - "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "currency": "USD", - "value": "-0.001002" - } - ] - }, - "orderbookChanges": { - "r9tGqzZgKxVFvzKFdUqXAqTzazWBUia8Qr": [ - { - "direction": "buy", - "quantity": { - "currency": "XRP", - "value": "1.101198" - }, - "totalPrice": { - "currency": "USD", - "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "value": "0.001002" - }, - "makerExchangeRate": "1099", - "sequence": 58, - "status": "partially-filled" - } - ] - }, - "ledgerVersion": 348860, - "indexInLedger": 0 - } -} -``` - - -## getTransactions - -`getTransactions(address: string, options: object): Promise>` - -Retrieves historical transactions of an account. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account to get transactions for. -options | object | *Optional* Options to filter the resulting transactions. -*options.* binary | boolean | *Optional* If true, return transactions in binary format rather than JSON. -*options.* counterparty | [address](#address) | *Optional* If provided, only return transactions with this account as a counterparty to the transaction. -*options.* earliestFirst | boolean | *Optional* If true, sort transactions so that the earliest ones come first. By default, the newest transactions come first. -*options.* excludeFailures | boolean | *Optional* If true, the result omits transactions that did not succeed. -*options.* includeRawTransactions | object | *Optional* Include raw transaction data. For advanced users; exercise caution when interpreting this data. -*options.* initiated | boolean | *Optional* If true, return only transactions initiated by the account specified by `address`. If false, return only transactions not initiated by the account specified by `address`. -*options.* limit | integer | *Optional* If specified, return at most this many transactions. -*options.* maxLedgerVersion | integer | *Optional* Return only transactions in this ledger version or lower. -*options.* maxLedgerVersion | string | *Optional* Return only transactions in this ledger version or lower. -*options.* minLedgerVersion | integer | *Optional* Return only transactions in this ledger version or higher. -*options.* minLedgerVersion | string | *Optional* Return only transactions in this ledger version or higher. -*options.* start | string | *Optional* If specified, start the results from this transaction. You cannot use `start` with `minLedgerVersion` or `maxLedgerVersion`. When `start` is specified, these ledger versions are determined internally. -*options.* types | array\<[transactionType](#transaction-types)\> | *Optional* Only return transactions of the specified [Transaction Types](#transaction-types). - -### Return Value - -This method returns a promise that resolves with an array of transaction object in the same format as [getTransaction](#gettransaction). - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getTransactions(address).then(transaction => { - /* ... */ -}); -``` - - -```json -[ - { - "type": "payment", - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 4, - "id": "99404A34E8170319521223A6C604AF48B9F1E3000C377E6141F9A1BF60B0B865", - "specification": { - "memos": [ - { - "type": "client", - "format": "rt1.5.2" - } - ], - "source": { - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "maxAmount": { - "currency": "XRP", - "value": "1.112209" - } - }, - "destination": { - "address": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM" - }, - "paths": "[[{\"issuer\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"currency\":\"USD\"},{\"account\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"issuer\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"currency\":\"USD\"}]]" - }, - "outcome": { - "result": "tesSUCCESS", - "timestamp": "2019-04-01T07:39:01.000Z", - "fee": "0.00001", - "deliveredAmount": { - "currency": "USD", - "value": "0.001", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM" - }, - "balanceChanges": { - "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo": [ - { - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "currency": "USD", - "value": "-0.001" - }, - { - "counterparty": "r9tGqzZgKxVFvzKFdUqXAqTzazWBUia8Qr", - "currency": "USD", - "value": "0.001002" - } - ], - "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM": [ - { - "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "currency": "USD", - "value": "0.001" - } - ], - "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59": [ - { - "currency": "XRP", - "value": "-1.101208" - } - ], - "r9tGqzZgKxVFvzKFdUqXAqTzazWBUia8Qr": [ - { - "currency": "XRP", - "value": "1.101198" - }, - { - "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "currency": "USD", - "value": "-0.001002" - } - ] - }, - "orderbookChanges": { - "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59": [ - { - "direction": "buy", - "quantity": { - "currency": "XRP", - "value": "1.101198" - }, - "totalPrice": { - "currency": "USD", - "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "value": "0.001002" - }, - "makerExchangeRate": "1099", - "sequence": 58, - "status": "partially-filled" - } - ] - }, - "ledgerVersion": 348859, - "indexInLedger": 0 - } - }, - { - "type": "payment", - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "id": "99404A34E8170319521223A6C604AF48B9F1E3000C377E6141F9A1BF60B0B865", - "sequence": 4, - "specification": { - "memos": [ - { - "type": "client", - "format": "rt1.5.2" - } - ], - "source": { - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "maxAmount": { - "currency": "XRP", - "value": "1.112209" - } - }, - "destination": { - "address": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM" - }, - "paths": "[[{\"issuer\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"currency\":\"USD\"},{\"account\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"issuer\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"currency\":\"USD\"}]]" - }, - "outcome": { - "result": "tesSUCCESS", - "timestamp": "2019-04-01T07:39:01.000Z", - "fee": "0.00001", - "deliveredAmount": { - "currency": "USD", - "value": "0.001", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM" - }, - "balanceChanges": { - "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo": [ - { - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "currency": "USD", - "value": "-0.001" - }, - { - "counterparty": "r9tGqzZgKxVFvzKFdUqXAqTzazWBUia8Qr", - "currency": "USD", - "value": "0.001002" - } - ], - "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM": [ - { - "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "currency": "USD", - "value": "0.001" - } - ], - "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59": [ - { - "currency": "XRP", - "value": "-1.101208" - } - ], - "r9tGqzZgKxVFvzKFdUqXAqTzazWBUia8Qr": [ - { - "currency": "XRP", - "value": "1.101198" - }, - { - "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "currency": "USD", - "value": "-0.001002" - } - ] - }, - "orderbookChanges": { - "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59": [ - { - "direction": "buy", - "quantity": { - "currency": "XRP", - "value": "1.101198" - }, - "totalPrice": { - "currency": "USD", - "counterparty": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "value": "0.001002" - }, - "makerExchangeRate": "1099", - "sequence": 58, - "status": "partially-filled" - } - ] - }, - "ledgerVersion": 348858, - "indexInLedger": 0 - } - } -] -``` - - -## getTrustlines - -`getTrustlines(address: string, options: object): Promise>` - -Returns trustlines for a specified account. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account to get trustlines for. -options | object | *Optional* Options to filter and determine which trustlines to return. -*options.* counterparty | [address](#address) | *Optional* Only return trustlines with this counterparty. -*options.* currency | [currency](#currency) | *Optional* Only return trustlines for this currency. -*options.* ledgerVersion | integer | *Optional* Return trustlines as they were in this historical ledger version. -*options.* ledgerVersion | string | *Optional* Return trustlines as they were in this historical ledger version. -*options.* limit | integer | *Optional* Return at most this many trustlines. - -### Return Value - -This method returns a promise that resolves with an array of objects with the following structure. - -Name | Type | Description ----- | ---- | ----------- -specification | [trustline](#trustline) | A trust line specification that would produce this trust line in its current state. -counterparty | object | Properties of the trustline from the perspective of the counterparty. -*counterparty.* limit | [value](#value) | The maximum amount that the counterparty can be owed through the trust line. -*counterparty.* authorized | boolean | *Optional* If true, the counterparty authorizes this party to hold issuances from the counterparty. -*counterparty.* frozen | boolean | *Optional* If true, the trust line is frozen, which means that funds can only be sent directly to the counterparty. -*counterparty.* ripplingDisabled | boolean | *Optional* If true, payments cannot ripple through this trustline. -state | object | Non-settings details of the trust line's state. -*state.* balance | [signedValue](#value) | The balance on the trust line, representing which party owes the other and by how much. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getTrustlines(address).then(trustlines => - {/* ... */}); -``` - - -```json -[ - { - "specification": { - "limit": "5", - "currency": "USD", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "ripplingDisabled": true, - "frozen": true - }, - "counterparty": { - "limit": "0" - }, - "state": { - "balance": "2.497605752725159" - } - }, - { - "specification": { - "limit": "5000", - "currency": "USD", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "counterparty": { - "limit": "0" - }, - "state": { - "balance": "0" - } - }, - { - "specification": { - "limit": "1", - "currency": "USD", - "counterparty": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun" - }, - "counterparty": { - "limit": "0" - }, - "state": { - "balance": "1" - } - }, - { - "specification": { - "limit": "1", - "currency": "USD", - "counterparty": "r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X", - "ripplingDisabled": true - }, - "counterparty": { - "limit": "0" - }, - "state": { - "balance": "0" - } - }, - { - "specification": { - "limit": "500", - "currency": "USD", - "counterparty": "rfF3PNkwkq1DygW2wum2HK3RGfgkJjdPVD", - "ripplingDisabled": true - }, - "counterparty": { - "limit": "0" - }, - "state": { - "balance": "35" - } - }, - { - "specification": { - "limit": "0", - "currency": "USD", - "counterparty": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2" - }, - "counterparty": { - "limit": "100", - "ripplingDisabled": true - }, - "state": { - "balance": "0" - } - }, - { - "specification": { - "limit": "0", - "currency": "USD", - "counterparty": "rEhDDUUNxpXgEHVJtC2cjXAgyx5VCFxdMF", - "frozen": true - }, - "counterparty": { - "limit": "1" - }, - "state": { - "balance": "0" - } - } -] -``` - - -## getBalances - -`getBalances(address: string, options: object): Promise>` - -Returns balances for a specified account. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account to get balances for. -options | object | *Optional* Options to filter and determine which balances to return. -*options.* counterparty | [address](#address) | *Optional* Only return balances with this counterparty. -*options.* currency | [currency](#currency) | *Optional* Only return balances for this currency. -*options.* ledgerVersion | integer | *Optional* Return balances as they were in this historical ledger version. -*options.* ledgerVersion | string | *Optional* Return balances as they were in this historical ledger version. -*options.* limit | integer | *Optional* Return at most this many balances. - -### Return Value - -This method returns a promise that resolves with an array of objects with the following structure: - -Name | Type | Description ----- | ---- | ----------- -currency | [currency](#currency) | The three-character code or hexadecimal string used to denote currencies -value | [signedValue](#value) | The balance on the trustline -counterparty | [address](#address) | *Optional* The XRP Ledger address of the account that owes or is owed the funds. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getBalances(address).then(balances => - {/* ... */}); -``` - - -```json -[ - { - "value": "922.913243", - "currency": "XRP" - }, - { - "value": "0", - "currency": "ASP", - "counterparty": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z" - }, - { - "value": "0", - "currency": "XAU", - "counterparty": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z" - }, - { - "value": "2.497605752725159", - "currency": "USD", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - { - "value": "481.992867407479", - "currency": "MXN", - "counterparty": "rHpXfibHgSb64n8kK9QWDpdbfqSpYbM9a4" - }, - { - "value": "0.793598266778297", - "currency": "EUR", - "counterparty": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun" - }, - { - "value": "0", - "currency": "CNY", - "counterparty": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK" - }, - { - "value": "1.294889190631542", - "currency": "DYM", - "counterparty": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E" - }, - { - "value": "0.3488146605801446", - "currency": "CHF", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - { - "value": "2.114103174931847", - "currency": "BTC", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - { - "value": "0", - "currency": "USD", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - { - "value": "-0.00111", - "currency": "BTC", - "counterparty": "rpgKWEmNqSDAGFhy5WDnsyPqfQxbWxKeVd" - }, - { - "value": "-0.1010780000080207", - "currency": "BTC", - "counterparty": "rBJ3YjwXi2MGbg7GVLuTXUWQ8DjL7tDXh4" - }, - { - "value": "1", - "currency": "USD", - "counterparty": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun" - }, - { - "value": "8.07619790068559", - "currency": "CNY", - "counterparty": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA" - }, - { - "value": "7.292695098901099", - "currency": "JPY", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - { - "value": "0", - "currency": "AUX", - "counterparty": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z" - }, - { - "value": "0", - "currency": "USD", - "counterparty": "r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X" - }, - { - "value": "12.41688780720394", - "currency": "EUR", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - { - "value": "35", - "currency": "USD", - "counterparty": "rfF3PNkwkq1DygW2wum2HK3RGfgkJjdPVD" - }, - { - "value": "-5", - "currency": "JOE", - "counterparty": "rwUVoVMSURqNyvocPCcvLu3ygJzZyw8qwp" - }, - { - "value": "0", - "currency": "USD", - "counterparty": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2" - }, - { - "value": "0", - "currency": "JOE", - "counterparty": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2" - }, - { - "value": "0", - "currency": "015841551A748AD2C1F76FF6ECB0CCCD00000000", - "counterparty": "rs9M85karFkCRjvc6KMWn8Coigm9cbcgcx" - }, - { - "value": "0", - "currency": "USD", - "counterparty": "rEhDDUUNxpXgEHVJtC2cjXAgyx5VCFxdMF" - } -] -``` - - -## getBalanceSheet - -`getBalanceSheet(address: string, options: object): Promise` - -Returns aggregate balances by currency plus a breakdown of assets and obligations for a specified account. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The XRP Ledger address of the account to get the balance sheet of. -options | object | *Optional* Options to determine how the balances are calculated. -*options.* excludeAddresses | array\<[address](#address)\> | *Optional* Addresses to exclude from the balance totals. -*options.* ledgerVersion | integer | *Optional* Get the balance sheet as of this historical ledger version. -*options.* ledgerVersion | string | *Optional* Get the balance sheet as of this historical ledger version. - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -Name | Type | Description ----- | ---- | ----------- -assets | array\<[amount](#amount)\> | *Optional* Total amounts held that are issued by others. For the recommended gateway configuration, there should be none. -balances | array\<[amount](#amount)\> | *Optional* Amounts issued to the "hotwallet" accounts from the request. The keys are the accounts' addresses, and the values are arrays of currency amounts they hold. The issuer (omitted from the currency amounts) is the account from the request. -obligations | array | *Optional* Total amounts issued to accounts that are not hot wallets, as a map of currencies to the total value issued. -obligations[] | object | An amount that is owed. -*obligations[].* currency | [currency](#currency) | The three-character code or hexadecimal string used to denote currencies -*obligations[].* value | [value](#value) | A string representation of a non-negative floating point number - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getBalanceSheet(address).then(balanceSheet => - {/* ... */}); -``` - - -```json -{ - "balances": [ - { - "counterparty": "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ", - "currency": "EUR", - "value": "29826.1965999999" - }, - { - "counterparty": "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ", - "currency": "USD", - "value": "10.0" - }, - { - "counterparty": "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt", - "currency": "USD", - "value": "13857.70416" - } - ], - "assets": [ - { - "counterparty": "r9F6wk8HkXrgYWoJ7fsv4VrUBVoqDVtzkH", - "currency": "BTC", - "value": "5444166510000000e-26" - }, - { - "counterparty": "r9F6wk8HkXrgYWoJ7fsv4VrUBVoqDVtzkH", - "currency": "USD", - "value": "100.0" - }, - { - "counterparty": "rwmUaXsWtXU4Z843xSYwgt1is97bgY8yj6", - "currency": "BTC", - "value": "8700000000000000e-30" - } - ], - "obligations": [ - { - "currency": "BTC", - "value": "5908.324927635318" - }, - { - "currency": "EUR", - "value": "992471.7419793958" - }, - { - "currency": "GBP", - "value": "4991.38706013193" - }, - { - "currency": "USD", - "value": "1997134.20229482" - } - ] -} -``` - - -## getPaths - -`getPaths(pathfind: object): Promise>` - -Finds paths to send a payment. Paths are options for how to route a payment. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -pathfind | object | Specification of a pathfind request. -*pathfind.* source | object | Properties of the source of funds. -*pathfind.source.* address | [address](#address) | The XRP Ledger address of the planned sender. -*pathfind.source.* amount | [laxAmount](#amount) | *Optional* The amount of funds to send. -*pathfind.source.* currencies | array | *Optional* An array of currencies (with optional counterparty) that may be used in the payment paths. -*pathfind.source.* currencies[] | object | A currency with optional counterparty. -*pathfind.source.currencies[].* currency | [currency](#currency) | The three-character code or hexadecimal string used to denote currencies -*pathfind.source.currencies[].* counterparty | [address](#address) | *Optional* The counterparty for the currency; if omitted any counterparty may be used. -*pathfind.* destination | object | Properties of the destination of funds. -*pathfind.destination.* address | [address](#address) | An address representing the destination of the transaction. -*pathfind.destination.* amount | [laxLaxAmount](#amount) | The amount to be received by the receiver (`value` may be ommitted if a source amount is specified). - -### Return Value - -This method returns a promise that resolves with an array of objects with the following structure: - -Name | Type | Description ----- | ---- | ----------- -source | object | Properties of the source of the payment. -*source.* address | [address](#address) | The address to send from. -*source.* amount | [laxAmount](#amount) | An exact amount to send. If the counterparty is not specified, amounts with any counterparty may be used. (This field cannot be used with source.maxAmount) -*source.* tag | integer | *Optional* An arbitrary 32-bit unsigned integer. It typically maps to an off-ledger account; for example, a hosted wallet or exchange account. -*source.* maxAmount | [laxAmount](#amount) | The maximum amount to send. (This field cannot be used with source.amount) -destination | object | Properties of the destination of the payment. -*destination.* address | [address](#address) | An address representing the destination of the transaction. -*destination.* amount | [laxAmount](#amount) | An exact amount to deliver to the recipient. If the counterparty is not specified, amounts with any counterparty may be used. (This field cannot be used with `destination.minAmount`.) -*destination.* tag | integer | *Optional* An arbitrary 32-bit unsigned integer. It typically maps to an off-ledger account; for example, a hosted wallet or exchange account. -*destination.* minAmount | [laxAmount](#amount) | The minimum amount to be delivered. (This field cannot be used with destination.amount) -paths | string | The paths of trustlines and orders to use in executing the payment. - -### Example - -```javascript -const pathfind = { - "source": { - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" - }, - "destination": { - "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "amount": { - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "value": "100" - } - } -}; -return api.getPaths(pathfind) - .then(paths => {/* ... */}); -``` - - -```json -[ - { - "source": { - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "maxAmount": { - "currency": "JPY", - "value": "0.1117218827811721" - } - }, - "destination": { - "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "amount": { - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "value": "100" - } - }, - "paths": "[[{\"account\":\"rMAz5ZnK73nyNUL4foAvaxdreczCkG3vA6\"},{\"currency\":\"USD\",\"issuer\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}],[{\"account\":\"rMAz5ZnK73nyNUL4foAvaxdreczCkG3vA6\"},{\"currency\":\"XRP\"},{\"currency\":\"USD\",\"issuer\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}],[{\"account\":\"rMAz5ZnK73nyNUL4foAvaxdreczCkG3vA6\"},{\"currency\":\"XRP\"},{\"currency\":\"USD\",\"issuer\":\"rpHgehzdpfWRXKvSv6duKvVuo1aZVimdaT\"},{\"account\":\"rpHgehzdpfWRXKvSv6duKvVuo1aZVimdaT\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}],[{\"account\":\"rMAz5ZnK73nyNUL4foAvaxdreczCkG3vA6\"},{\"currency\":\"XRP\"},{\"currency\":\"USD\",\"issuer\":\"rHHa9t2kLQyXRbdLkSzEgkzwf9unmFgZs9\"},{\"account\":\"rHHa9t2kLQyXRbdLkSzEgkzwf9unmFgZs9\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}]]" - }, - { - "source": { - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "maxAmount": { - "currency": "USD", - "value": "0.001002" - } - }, - "destination": { - "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "amount": { - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "value": "100" - } - }, - "paths": "[[{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}],[{\"account\":\"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q\"},{\"currency\":\"USD\",\"issuer\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}],[{\"account\":\"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q\"},{\"currency\":\"XRP\"},{\"currency\":\"USD\",\"issuer\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}],[{\"account\":\"rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q\"},{\"currency\":\"XRP\"},{\"currency\":\"USD\",\"issuer\":\"rpHgehzdpfWRXKvSv6duKvVuo1aZVimdaT\"},{\"account\":\"rpHgehzdpfWRXKvSv6duKvVuo1aZVimdaT\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}]]" - }, - { - "source": { - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "maxAmount": { - "currency": "XRP", - "value": "0.207669" - } - }, - "destination": { - "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "amount": { - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "value": "100" - } - }, - "paths": "[[{\"currency\":\"USD\",\"issuer\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}],[{\"currency\":\"USD\",\"issuer\":\"rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc\"},{\"account\":\"rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc\"},{\"account\":\"rf9X8QoYnWLHMHuDfjkmRcD2UE5qX5aYV\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}],[{\"currency\":\"USD\",\"issuer\":\"rDVdJ62foD1sn7ZpxtXyptdkBSyhsQGviT\"},{\"account\":\"rDVdJ62foD1sn7ZpxtXyptdkBSyhsQGviT\"},{\"account\":\"rfQPFZ3eLcaSUKjUy7A3LAmDNM4F9Hz9j1\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}],[{\"currency\":\"USD\",\"issuer\":\"rpHgehzdpfWRXKvSv6duKvVuo1aZVimdaT\"},{\"account\":\"rpHgehzdpfWRXKvSv6duKvVuo1aZVimdaT\"},{\"account\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"}]]" - } -] -``` - - -## getOrders - -`getOrders(address: string, options: object): Promise>` - -Returns open orders for the specified account. Open orders are orders that have not yet been fully executed and are still in the order book. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The XRP Ledger address of the account to get open orders for. -options | object | *Optional* Options that determine what orders to return. -*options.* ledgerVersion | integer | *Optional* Return orders as of this historical ledger version. -*options.* ledgerVersion | string | *Optional* Return orders as of this historical ledger version. -*options.* limit | integer | *Optional* Return at most this many orders. - -### Return Value - -This method returns a promise that resolves with an array of objects with the following structure: - -Name | Type | Description ----- | ---- | ----------- -specification | [order](#order) | An order specification that would create an order equivalent to the current state of this order. -properties | object | Properties of the order not in the specification. -*properties.* maker | [address](#address) | The address of the account that submitted the order. -*properties.* sequence | [sequence](#account-sequence-number) | The account sequence number of the transaction that created this order. -*properties.* makerExchangeRate | [value](#value) | The exchange rate from the point of view of the account that submitted the order (also known as "quality"). - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getOrders(address).then(orders => - {/* ... */}); -``` - - -```json -[ - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "EUR", - "value": "17.70155237781915", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "totalPrice": { - "currency": "USD", - "value": "1122.990930900328", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 719930, - "makerExchangeRate": "63.44025128030504" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "EUR", - "value": "750", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "totalPrice": { - "currency": "USD", - "value": "19.11697137482289", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 756999, - "makerExchangeRate": "39.23215583132338" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "19.50899530491766", - "counterparty": "rpDMez6pm6dBve2TJsmDpv7Yae6V5Pyvy2" - }, - "totalPrice": { - "currency": "USD", - "value": "18.46856867857617", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 757002, - "makerExchangeRate": "1.056334989703257" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "1445.796633544794", - "counterparty": "rpDMez6pm6dBve2TJsmDpv7Yae6V5Pyvy2" - }, - "totalPrice": { - "currency": "USD", - "value": "14.40727807030772", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 757003, - "makerExchangeRate": "100.3518240218094" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "750", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "totalPrice": { - "currency": "NZD", - "value": "9.178557969538755", - "counterparty": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 782148, - "makerExchangeRate": "81.7121820757743" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "500", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "USD", - "value": "9.94768291869523", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 787368, - "makerExchangeRate": "50.26296114247091" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "10000", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "USD", - "value": "9.994805759894176", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 787408, - "makerExchangeRate": "1000.519693952099" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "MXN", - "value": "15834.53653918684", - "counterparty": "rG6FZ31hDHN1K5Dkbma3PSB5uVCuVVRzfn" - }, - "totalPrice": { - "currency": "USD", - "value": "11.67691646304319", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 803438, - "makerExchangeRate": "1356.054621894598" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "3968.240250979598", - "counterparty": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH" - }, - "totalPrice": { - "currency": "XAU", - "value": "0.03206299605333101", - "counterparty": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 807858, - "makerExchangeRate": "123763.8630020459" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "4139.022125516302", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "XAU", - "value": "0.03347459066593226", - "counterparty": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 807896, - "makerExchangeRate": "123646.6837435794" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "XRP", - "value": "115760.19" - }, - "totalPrice": { - "currency": "NZD", - "value": "6.840555705", - "counterparty": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 814018, - "makerExchangeRate": "16922.62953364839" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "902.4050961259154", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "EUR", - "value": "14.40843766044656", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 827522, - "makerExchangeRate": "62.63032241192674" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "181.4887131319798", - "counterparty": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH" - }, - "totalPrice": { - "currency": "XAG", - "value": "1.128432823485989", - "counterparty": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 833591, - "makerExchangeRate": "160.8325363767064" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "1814.887131319799", - "counterparty": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH" - }, - "totalPrice": { - "currency": "XAG", - "value": "1.128432823485991", - "counterparty": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 833592, - "makerExchangeRate": "1608.325363767062" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "118.6872603846736", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "XAG", - "value": "0.7283371225235964", - "counterparty": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 838954, - "makerExchangeRate": "162.9564891233845" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "XAU", - "value": "1", - "counterparty": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH" - }, - "totalPrice": { - "currency": "XRP", - "value": "2229.229447" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 843730, - "makerExchangeRate": "0.0004485854972648762" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "EUR", - "value": "750", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "totalPrice": { - "currency": "USD", - "value": "17.77537376072202", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "sequence": 844068, - "makerExchangeRate": "42.19320561670911" - } - } -] -``` - - -## getOrderbook - -`getOrderbook(address: string, orderbook: object, options: object): Promise` - -Returns open orders for the specified account. Open orders are orders that have not yet been fully executed and are still in the order book. - -**Breaking change:** In ripple-lib 1.1.0 and earlier, orders returned by this method were not sorted correctly. Orders are now sorted correctly, from best to worst. - -**See also:** An alternative way to get orderbooks is with `request` and [`formatBidsAndAsks`](#formatbidsandasks). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | Address of an account to use as point-of-view. (This affects which unfunded offers are returned.) -orderbook | object | The order book to get. -*orderbook.* base | object | The currency code, and the counterparty if it's not XRP. -*orderbook.* counter | object | The currency code, and the counterparty if it's not XRP. -options | object | *Optional* Options to determine what to return. -*options.* ledgerVersion | integer | *Optional* Return the order book as of this historical ledger version. -*options.* ledgerVersion | string | *Optional* Return the order book as of this historical ledger version. -*options.* limit | integer | *Optional* Return at most this many orders from the order book. - -### Return Value - -This method returns a promise that resolves with an object with the following structure Both `bids` and `asks` have the same format: - -Name | Type | Description ----- | ---- | ----------- -bids | array | The buy orders in the order book. -bids[] | object | An order in the order book. -*bids[].* specification | [order](#order) | An order specification that would create an order equivalent to the current state of this order. -*bids[].* properties | object | Properties of the order not in the specification. -*bids[].properties.* maker | [address](#address) | The address of the account that submitted the order. -*bids[].properties.* sequence | [sequence](#account-sequence-number) | The account sequence number of the transaction that created this order. -*bids[].properties.* makerExchangeRate | [value](#value) | The exchange rate from the point of view of the account that submitted the order (also known as "quality"). -*bids[].data.* \* | object | -*bids[].* state | object | *Optional* The state of the order. -*bids[].state.* fundedAmount | [amount](#amount) | How much of the amount the maker would have to pay that the maker currently holds. -*bids[].state.* priceOfFundedAmount | [amount](#amount) | How much the `fundedAmount` would convert to through the exchange rate of this order. -asks | array | The sell orders in the order book. -asks[] | object | An order in the order book. -*asks[].* specification | [order](#order) | An order specification that would create an order equivalent to the current state of this order. -*asks[].* properties | object | Properties of the order not in the specification. -*asks[].properties.* maker | [address](#address) | The address of the account that submitted the order. -*asks[].properties.* sequence | [sequence](#account-sequence-number) | The account sequence number of the transaction that created this order. -*asks[].properties.* makerExchangeRate | [value](#value) | The exchange rate from the point of view of the account that submitted the order (also known as "quality"). -*asks[].data.* \* | object | -*asks[].* state | object | *Optional* The state of the order. -*asks[].state.* fundedAmount | [amount](#amount) | How much of the amount the maker would have to pay that the maker currently holds. -*asks[].state.* priceOfFundedAmount | [amount](#amount) | How much the `fundedAmount` would convert to through the exchange rate of this order. - -**Raw order data:** The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields. - -For details, see the `rippled` [book_offers method](https://xrpl.org/book_offers.html). - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const orderbook = { - "base": { - "currency": "USD", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "counter": { - "currency": "BTC", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } -}; -return api.getOrderbook(address, orderbook) - .then(orderbook => {/* ... */}); -``` - - -```json -{ - "bids": [ - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "93.030522464522", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.2849323720855092", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rwBYyfufTzk77zUSKEu4MvixfarC35av1J", - "sequence": 386940, - "makerExchangeRate": "326.5003614141928" - }, - "data": { - "Account": "rwBYyfufTzk77zUSKEu4MvixfarC35av1J", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98570B9980E49C7DE8", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000008", - "PreviousTxnID": "92DBA0BE18B331AC61FB277211477A255D3B5EA9C5FE689171DE689FB45FE18A", - "PreviousTxnLgrSeq": 10714030, - "Sequence": 386940, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.2849323720855092" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "93.030522464522" - }, - "index": "8092033091034D94219BC1131AF7A6B469D790D81831CB479AB6F67A32BE4E13", - "owner_funds": "31.77682120227525", - "quality": "326.5003614141928" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "1", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.00302447007930511", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rwjsRktX1eguUr1pHTffyHnC4uyrvX58V1", - "sequence": 207855, - "makerExchangeRate": "330.6364334177034" - }, - "data": { - "Account": "rwjsRktX1eguUr1pHTffyHnC4uyrvX58V1", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98570BBF1EEFA2FB0A", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000000", - "PreviousTxnID": "C6BDA152363E3CFE18688A6830B49F3DB2B05976110B5908EA4EB66D93DEEB1F", - "PreviousTxnLgrSeq": 10714031, - "Sequence": 207855, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.00302447007930511" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1" - }, - "index": "8DB3520FF9CB16A0EA955056C49115F8CFB03A587D0A4AFC844F1D220EFCE0B9", - "owner_funds": "0.0670537912615556", - "quality": "330.6364334177034" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "99.34014894048333", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.3", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "expirationTime": "2014-12-25T01:14:43.000Z" - }, - "properties": { - "maker": "raudnGKfTK23YKfnS7ixejHrqGERTYNFXk", - "sequence": 110103, - "makerExchangeRate": "331.1338298016111" - }, - "data": { - "Account": "raudnGKfTK23YKfnS7ixejHrqGERTYNFXk", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98570BC3A506FC016F", - "BookNode": "0000000000000000", - "Expiration": 472785283, - "Flags": 131072, - "LedgerEntryType": "Offer", - "OwnerNode": "00000000000008F0", - "PreviousTxnID": "77E763F1D02F58965CD1AD94F557B37A582FAC7760B71F391B856959836C2F7B", - "PreviousTxnLgrSeq": 10713576, - "Sequence": 110103, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.3" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "99.34014894048333" - }, - "index": "9ECDFD31B28643FD3A54658398C5715D6DAD574F83F04529CB24765770F9084D", - "owner_funds": "4.021116654525635", - "quality": "331.1338298016111" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "268.754", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.8095", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rPyYxUGK8L4dgEvjPs3aRc1B1jEiLr3Hx5", - "sequence": 392, - "makerExchangeRate": "332" - }, - "state": { - "fundedAmount": { - "currency": "BTC", - "value": "0.8078974385735969", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "priceOfFundedAmount": { - "currency": "USD", - "value": "268.2219496064341", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "data": { - "Account": "rPyYxUGK8L4dgEvjPs3aRc1B1jEiLr3Hx5", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98570BCB85BCA78000", - "BookNode": "0000000000000000", - "Flags": 131072, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000000", - "PreviousTxnID": "D22993C68C94ACE3F2FCE4A334EBEA98CC46DCA92886C12B5E5B4780B5E17D4E", - "PreviousTxnLgrSeq": 10711938, - "Sequence": 392, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.8095" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "268.754" - }, - "index": "18B136E08EF50F0DEE8521EA22D16A950CD8B6DDF5F6E07C35F7FDDBBB09718D", - "owner_funds": "0.8095132334507441", - "quality": "332", - "taker_gets_funded": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.8078974385735969" - }, - "taker_pays_funded": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "268.2219496064341" - } - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "152.0098333185607", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.4499999999999999", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "expirationTime": "2014-12-25T01:14:44.000Z" - }, - "properties": { - "maker": "raudnGKfTK23YKfnS7ixejHrqGERTYNFXk", - "sequence": 110105, - "makerExchangeRate": "337.7996295968016" - }, - "data": { - "Account": "raudnGKfTK23YKfnS7ixejHrqGERTYNFXk", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98570C00450D461510", - "BookNode": "0000000000000000", - "Expiration": 472785284, - "Flags": 131072, - "LedgerEntryType": "Offer", - "OwnerNode": "00000000000008F0", - "PreviousTxnID": "1F4D9D859D9AABA888C0708A572B38919A3AEF2C8C1F5A13F58F44C92E5FF3FB", - "PreviousTxnLgrSeq": 10713576, - "Sequence": 110105, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.4499999999999999" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "152.0098333185607" - }, - "index": "9F380E0B39E2AF8AA9608C3E39A5A8628E6D0F44385C6D12BE06F4FEC8D83351", - "quality": "337.7996295968016" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "1.308365894430151", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.003768001830745216", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rDbsCJr5m8gHDCNEHCZtFxcXHsD4S9jH83", - "sequence": 110061, - "makerExchangeRate": "347.2306949944844" - }, - "data": { - "Account": "rDbsCJr5m8gHDCNEHCZtFxcXHsD4S9jH83", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98570C560B764D760C", - "BookNode": "0000000000000000", - "Flags": 131072, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000001", - "PreviousTxnID": "9A0B6B76F0D86614F965A2FFCC8859D8607F4E424351D4CFE2FBE24510F93F25", - "PreviousTxnLgrSeq": 10708382, - "Sequence": 110061, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.003768001830745216" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1.308365894430151" - }, - "index": "B971769686CE1B9139502770158A4E7C011CFF8E865E5AAE5428E23AAA0E146D", - "owner_funds": "0.2229210189326514", - "quality": "347.2306949944844" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "176.3546101589987", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.5", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "expirationTime": "2014-12-25T00:41:38.000Z" - }, - "properties": { - "maker": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE", - "sequence": 35788, - "makerExchangeRate": "352.7092203179974" - }, - "data": { - "Account": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98570C87DF25DC4FC6", - "BookNode": "0000000000000000", - "Expiration": 472783298, - "Flags": 131072, - "LedgerEntryType": "Offer", - "OwnerNode": "00000000000003D2", - "PreviousTxnID": "E5F9A10F29A4BB3634D5A84FC96931E17267B58E0D2D5ADE24FFB751E52ADB9E", - "PreviousTxnLgrSeq": 10713533, - "Sequence": 35788, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.5" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "176.3546101589987" - }, - "index": "D2CB71038AD0ECAF4B5FF0A953AD1257225D0071E6F3AF9ADE67F05590B45C6E", - "owner_funds": "6.617688680663627", - "quality": "352.7092203179974" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "179.48", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.5", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rN6jbxx4H6NxcnmkzBxQnbCWLECNKrgSSf", - "sequence": 491, - "makerExchangeRate": "358.96" - }, - "state": { - "fundedAmount": { - "currency": "BTC", - "value": "0.499001996007984", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "priceOfFundedAmount": { - "currency": "USD", - "value": "179.1217564870259", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "data": { - "Account": "rN6jbxx4H6NxcnmkzBxQnbCWLECNKrgSSf", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98570CC0B8E0E2C000", - "BookNode": "0000000000000000", - "Flags": 131072, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000000", - "PreviousTxnID": "2E16ACFEAC2306E3B3483D445787F3496FACF9504F7A5E909620C1A73E2EDE54", - "PreviousTxnLgrSeq": 10558020, - "Sequence": 491, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.5" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "179.48" - }, - "index": "DA853913C8013C9471957349EDAEE4DF4846833B8CCB92008E2A8994E37BEF0D", - "owner_funds": "0.5", - "quality": "358.96", - "taker_gets_funded": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.499001996007984" - }, - "taker_pays_funded": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "179.1217564870259" - } - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "288.7710263794967", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.8", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "expirationTime": "2014-12-25T00:41:39.000Z" - }, - "properties": { - "maker": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE", - "sequence": 35789, - "makerExchangeRate": "360.9637829743709" - }, - "data": { - "Account": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98570CD2F24C9C145D", - "BookNode": "0000000000000000", - "Expiration": 472783299, - "Flags": 131072, - "LedgerEntryType": "Offer", - "OwnerNode": "00000000000003D2", - "PreviousTxnID": "B1B12E47043B4260223A2C4240D19E93526B55B1DB38DEED335DACE7C04FEB23", - "PreviousTxnLgrSeq": 10713534, - "Sequence": 35789, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.8" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "288.7710263794967" - }, - "index": "B89AD580E908F7337CCBB47A0BAAC6417EF13AC3465E34E8B7DD3BED016EA833", - "quality": "360.9637829743709" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "182.9814890090516", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.5", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rUeCeioKJkbYhv4mRGuAbZpPcqkMCoYq6N", - "sequence": 5255, - "makerExchangeRate": "365.9629780181032" - }, - "state": { - "fundedAmount": { - "currency": "BTC", - "value": "0.2254411038203033", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "priceOfFundedAmount": { - "currency": "USD", - "value": "82.50309772176658", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "data": { - "Account": "rUeCeioKJkbYhv4mRGuAbZpPcqkMCoYq6N", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98570D0069F50EA028", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000012", - "PreviousTxnID": "F0E8ABF07F83DF0B5EF5B417E8E29A45A5503BA8F26FBC86447CC6B1FAD6A1C4", - "PreviousTxnLgrSeq": 10447672, - "Sequence": 5255, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.5" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "182.9814890090516" - }, - "index": "D652DCE4B19C6CB43912651D3A975371D3B2A16A034EDF07BC11BF721AEF94A4", - "owner_funds": "0.225891986027944", - "quality": "365.9629780181032", - "taker_gets_funded": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.2254411038203033" - }, - "taker_pays_funded": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "82.50309772176658" - } - } - } - ], - "asks": [ - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "3205.1", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "10", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "r49y2xKuKVG2dPkNHgWQAV61cjxk8gryjQ", - "sequence": 434, - "makerExchangeRate": "0.003120027456241615" - }, - "data": { - "Account": "r49y2xKuKVG2dPkNHgWQAV61cjxk8gryjQ", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4520B15A60037FFCF", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000000", - "PreviousTxnID": "544932DC56D72E845AF2B738821FE07865E32EC196270678AB0D947F54E9F49F", - "PreviousTxnLgrSeq": 10679000, - "Sequence": 434, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "3205.1" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "10" - }, - "index": "CE457115A4ADCC8CB351B3E35A0851E48DE16605C23E305017A9B697B156DE5A", - "owner_funds": "41952.95917199965", - "quality": "0.003120027456241615" - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "1599.063669386278", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "4.99707396683212", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rDYCRhpahKEhCFV25xScg67Bwf4W9sTYAm", - "sequence": 233, - "makerExchangeRate": "0.003125" - }, - "data": { - "Account": "rDYCRhpahKEhCFV25xScg67Bwf4W9sTYAm", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4520B1A2BC2EC5000", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000000", - "PreviousTxnID": "F68F9658AB3D462FEB027E6C380F054BC6D2514B43EC3C6AD46EE19C59BF1CC3", - "PreviousTxnLgrSeq": 10704238, - "Sequence": 233, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1599.063669386278" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "4.99707396683212" - }, - "index": "BF14FBB305159DBCAEA91B7E848408F5B559A91B160EBCB6D244958A6A16EA6B", - "owner_funds": "3169.910902910102", - "quality": "0.003125" - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "143.1050962074379", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.4499999999999999", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "expirationTime": "2014-12-25T01:14:44.000Z" - }, - "properties": { - "maker": "raudnGKfTK23YKfnS7ixejHrqGERTYNFXk", - "sequence": 110104, - "makerExchangeRate": "0.003144542101755081" - }, - "state": { - "fundedAmount": { - "currency": "USD", - "value": "0", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "priceOfFundedAmount": { - "currency": "BTC", - "value": "0", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "data": { - "Account": "raudnGKfTK23YKfnS7ixejHrqGERTYNFXk", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4520B2BF1C2F4D4C9", - "BookNode": "0000000000000000", - "Expiration": 472785284, - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "00000000000008F0", - "PreviousTxnID": "446410E1CD718AC01929DD16B558FCF6B3A7B8BF208C420E67A280C089C5C59B", - "PreviousTxnLgrSeq": 10713576, - "Sequence": 110104, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "143.1050962074379" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.4499999999999999" - }, - "index": "67924B0EAA15784CC00CCD5FDD655EE2D6D2AE40341776B5F14E52341E7FC73E", - "owner_funds": "0", - "quality": "0.003144542101755081", - "taker_gets_funded": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "taker_pays_funded": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - } - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "254.329207354604", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.8", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "expirationTime": "2014-12-24T21:44:11.000Z" - }, - "properties": { - "maker": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE", - "sequence": 35625, - "makerExchangeRate": "0.003145529403882357" - }, - "state": { - "fundedAmount": { - "currency": "USD", - "value": "0", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "priceOfFundedAmount": { - "currency": "BTC", - "value": "0", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "data": { - "Account": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4520B2CD7A2BFBB75", - "BookNode": "0000000000000000", - "Expiration": 472772651, - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "00000000000003CD", - "PreviousTxnID": "D49164AB68DDA3AEC9DFCC69A35685C4F532B5C231D3C1D25FEA7D5D0224FB84", - "PreviousTxnLgrSeq": 10711128, - "Sequence": 35625, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "254.329207354604" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.8" - }, - "index": "567BF2825173E3FB28FC94E436B6EB30D9A415FC2335E6D25CDE1BE47B25D120", - "owner_funds": "0", - "quality": "0.003145529403882357", - "taker_gets_funded": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "taker_pays_funded": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - } - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "390.4979", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "1.23231134568807", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rwBYyfufTzk77zUSKEu4MvixfarC35av1J", - "sequence": 387756, - "makerExchangeRate": "0.003155743848271834" - }, - "data": { - "Account": "rwBYyfufTzk77zUSKEu4MvixfarC35av1J", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4520B3621DF140FDA", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000008", - "PreviousTxnID": "2E371E2B287C8A9FBB3424E4204B17AD9FA1BAA9F3B33C7D2261E3B038AFF083", - "PreviousTxnLgrSeq": 10716291, - "Sequence": 387756, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "390.4979" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1.23231134568807" - }, - "index": "8CA23E55BF9F46AC7E803D3DB40FD03225EFCA66650D4CF0CBDD28A7CCDC8400", - "owner_funds": "5704.824764087842", - "quality": "0.003155743848271834" - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "1", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.003160328237957649", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rwjsRktX1eguUr1pHTffyHnC4uyrvX58V1", - "sequence": 208927, - "makerExchangeRate": "0.003160328237957649" - }, - "data": { - "Account": "rwjsRktX1eguUr1pHTffyHnC4uyrvX58V1", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4520B3A4D41FF4211", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000000", - "PreviousTxnID": "91763FA7089C63CC4D5D14CBA6A5A5BF7ECE949B0D34F00FD35E733AF9F05AF1", - "PreviousTxnLgrSeq": 10716292, - "Sequence": 208927, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.003160328237957649" - }, - "index": "7206866E39D9843623EE79E570242753DEE3C597F3856AEFB4631DD5AD8B0557", - "owner_funds": "45.55665106096075", - "quality": "0.003160328237957649" - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "4725", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "15", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "r49y2xKuKVG2dPkNHgWQAV61cjxk8gryjQ", - "sequence": 429, - "makerExchangeRate": "0.003174603174603175" - }, - "data": { - "Account": "r49y2xKuKVG2dPkNHgWQAV61cjxk8gryjQ", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4520B4748E68669A7", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000000", - "PreviousTxnID": "3B3CF6FF1A336335E78513CF77AFD3A784ACDD7B1B4D3F1F16E22957A060BFAE", - "PreviousTxnLgrSeq": 10639969, - "Sequence": 429, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "4725" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "15" - }, - "index": "42894809370C7E6B23498EF8E22AD4B05F02B94F08E6983357A51EA96A95FF7F", - "quality": "0.003174603174603175" - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "1.24252537879871", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.003967400879423823", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rDbsCJr5m8gHDCNEHCZtFxcXHsD4S9jH83", - "sequence": 110099, - "makerExchangeRate": "0.003193013959408667" - }, - "data": { - "Account": "rDbsCJr5m8gHDCNEHCZtFxcXHsD4S9jH83", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4520B58077ED03C1B", - "BookNode": "0000000000000000", - "Flags": 131072, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000001", - "PreviousTxnID": "98F3F2D02D3BB0AEAC09EECCF2F24BBE5E1AB2C71C40D7BD0A5199E12541B6E2", - "PreviousTxnLgrSeq": 10715839, - "Sequence": 110099, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1.24252537879871" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.003967400879423823" - }, - "index": "F4404D6547149419D3607F81D7080979FBB3AFE2661F9A933E2F6C07AC1D1F6D", - "owner_funds": "73.52163803897041", - "quality": "0.003193013959408667" - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "496.5429474010489", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "1.6", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "expirationTime": "2014-12-24T21:44:12.000Z" - }, - "properties": { - "maker": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE", - "sequence": 35627, - "makerExchangeRate": "0.003222279177208227" - }, - "state": { - "fundedAmount": { - "currency": "USD", - "value": "0", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "priceOfFundedAmount": { - "currency": "BTC", - "value": "0", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "data": { - "Account": "rDVBvAQScXrGRGnzrxRrcJPeNLeLeUTAqE", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4520B72A555B981A3", - "BookNode": "0000000000000000", - "Expiration": 472772652, - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "00000000000003CD", - "PreviousTxnID": "146C8DBB047BAAFAE5B8C8DECCCDACD9DFCD7A464E5AB273230FF975E9B83CF7", - "PreviousTxnLgrSeq": 10711128, - "Sequence": 35627, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "496.5429474010489" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1.6" - }, - "index": "50CAA04E81D0009115B61C132FC9887FA9E5336E0CB8A2E7D3280ADBF6ABC043", - "quality": "0.003222279177208227", - "taker_gets_funded": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "taker_pays_funded": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - } - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "3103", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "10", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "r49y2xKuKVG2dPkNHgWQAV61cjxk8gryjQ", - "sequence": 431, - "makerExchangeRate": "0.003222687721559781" - }, - "data": { - "Account": "r49y2xKuKVG2dPkNHgWQAV61cjxk8gryjQ", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4520B730474DD96E5", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000000", - "PreviousTxnID": "624F9ADA85EC3BE845EAC075B47E01E4F89288EAF27823C715777B3DFFB21F24", - "PreviousTxnLgrSeq": 10639989, - "Sequence": 431, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "3103" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "10" - }, - "index": "8A319A496288228AD9CAD74375E32FA81805C56A9AD84798A26756A8B3F9EE23", - "quality": "0.003222687721559781" - } - } - ] -} -``` - - -## getSettings - -`getSettings(address: string, options: object): Promise` - -Returns settings for the specified account. Note: For account data that is not modifiable by the user, see [getAccountInfo](#getaccountinfo). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account to get the settings of. -options | object | *Optional* Options that affect what to return. -*options.* ledgerVersion | integer | *Optional* Get the settings as of this historical ledger version. -*options.* ledgerVersion | string | *Optional* Get the settings as of this historical ledger version. - -### Return Value - -This method returns a promise that resolves with an array of objects with the following structure. All fields are optional, and are omitted if they are set to their default value. - -Name | Type | Description ----- | ---- | ----------- -defaultRipple | boolean | *Optional* Enable [rippling](https://xrpl.org/rippling.html) on this account’s trust lines by default. Currency issuers should enable this setting; most others should not. -depositAuth | boolean | *Optional* Enable [Deposit Authorization](https://xrpl.org/depositauth.html) on this account. If set, transactions cannot send value of any kind to this account unless the sender of those transactions is the account itself. (Requires the [DepositAuth amendment](https://xrpl.org/known-amendments.html#depositauth)) -disableMasterKey | boolean | *Optional* Disallows use of the master key to sign transactions for this account. To disable the master key, you must authorize the transaction by signing it with the master key pair. You cannot use a regular key pair or a multi-signature. You can re-enable the master key pair using a regular key pair or multi-signature. See [AccountSet](https://xrpl.org/accountset.html). -disallowIncomingXRP | boolean | *Optional* Indicates that client applications should not send XRP to this account. Not enforced by rippled. -domain | string | *Optional* The domain that owns this account, as a hexadecimal string representing the ASCII for the domain in lowercase. -emailHash | string,null | *Optional* Hash of an email address to be used for generating an avatar image. Conventionally, clients use Gravatar to display this image. Use `null` to clear. -enableTransactionIDTracking | boolean | *Optional* Track the ID of this account’s most recent transaction. -globalFreeze | boolean | *Optional* Freeze all assets issued by this account. -memos | [memos](#transaction-memos) | *Optional* Array of memos to attach to the transaction. -messageKey | string | *Optional* Public key for sending encrypted messages to this account. Conventionally, it should be a secp256k1 key, the same encryption that is used by the rest of Ripple. -noFreeze | boolean | *Optional* Permanently give up the ability to freeze individual trust lines. This flag can never be disabled after being enabled. -passwordSpent | boolean | *Optional* Indicates that the account has used its free SetRegularKey transaction. -regularKey | [address](#address),null | *Optional* The public key of a new keypair, to use as the regular key to this account, as a base-58-encoded string in the same format as an account address. Use `null` to remove the regular key. -requireAuthorization | boolean | *Optional* If set, this account must individually give other users permission to hold this account’s issued tokens. -requireDestinationTag | boolean | *Optional* Requires incoming payments to specify a destination tag. -signers | object | *Optional* Settings that determine what sets of accounts can be used to sign a transaction on behalf of this account using multisigning. -*signers.* threshold | integer | A target number for the signer weights. A multi-signature from this list is valid only if the sum weights of the signatures provided is equal or greater than this value. To delete the signers setting, use the value `0`. -*signers.* weights | array | *Optional* Weights of signatures for each signer. -*signers.* weights[] | object | An association of an address and a weight. -*signers.weights[].* address | [address](#address) | An account address on the XRP Ledger -*signers.weights[].* weight | integer | The weight that the signature of this account counts as towards the threshold. -tickSize | string | *Optional* Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are 3 to 15 inclusive, or 0 to disable. -transferRate | number,null | *Optional* The fee to charge when users transfer this account’s issuances, as the decimal amount that must be sent to deliver 1 unit. Has precision up to 9 digits beyond the decimal point. Use `null` to set no fee. -walletLocator | string,null | *Optional* Transaction hash or any other 64 character hexadecimal string, that may or may not represent the result of a hash operation. Use `null` to clear. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getSettings(address).then(settings => - {/* ... */}); -``` - - -```json -{ - "requireDestinationTag": true, - "disallowIncomingXRP": true, - "emailHash": "23463B99B62A72F26ED677CC556C44E8", - "walletLocator": "00000000000000000000000000000000000000000000000000000000DEADBEEF", - "domain": "example.com", - "transferRate": 1.002, - "tickSize": 5, - "signers": { - "threshold": 3, - "weights": [ - { - "address": "rpHit3GvUR1VSGh2PXcaaZKEEUnCVxWU2i", - "weight": 1 - }, { - "address": "rN4oCm1c6BQz6nru83H52FBSpNbC9VQcRc", - "weight": 1 - }, { - "address": "rJ8KhCi67VgbapiKCQN3r1ZA6BMUxUvvnD", - "weight": 1 - } - ] - } -} -``` - - -## getAccountInfo - -`getAccountInfo(address: string, options: object): Promise` - -Returns information for the specified account. Note: For account data that is modifiable by the user, see [getSettings](#getsettings). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account to get the account info of. -options | object | *Optional* Options that affect what to return. -*options.* ledgerVersion | integer | *Optional* Get the account info as of this historical ledger version. -*options.* ledgerVersion | string | *Optional* Get the account info as of this historical ledger version. - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -Name | Type | Description ----- | ---- | ----------- -sequence | [sequence](#account-sequence-number) | The next (smallest unused) sequence number for this account. -xrpBalance | [value](#value) | The XRP balance owned by the account. -ownerCount | integer | Number of other ledger entries (specifically, trust lines and offers) attributed to this account. This is used to calculate the total reserve required to use the account. -previousAffectingTransactionID | string | Hash value representing the most recent transaction that affected this account node directly. **Note:** This does not include changes to the account’s trust lines and offers. -previousAffectingTransactionLedgerVersion | integer | The ledger version that the transaction identified by the `previousAffectingTransactionID` was validated in. -previousAffectingTransactionLedgerVersion | string | The ledger version that the transaction identified by the `previousAffectingTransactionID` was validated in. -previousInitiatedTransactionID | string | *Optional* Hash value representing the most recent transaction that was initiated by this account. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getAccountInfo(address).then(info => - {/* ... */}); -``` - - -```json -{ - "sequence": 23, - "xrpBalance": "922.913243", - "ownerCount": 1, - "previousAffectingTransactionID": "19899273706A9E040FDB5885EE991A1DC2BAD878A0D6E7DBCFB714E63BF737F7", - "previousAffectingTransactionLedgerVersion": 6614625 -} -``` - - -## getAccountObjects - -`getAccountObjects(address: string, options: object): Promise` - -Returns objects owned by an account. For an account's trust lines and balances, see `getTrustlines` and `getBalances`. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account to get the account objects of. -options | object | *Optional* Options that affect what to return. -*options.* ledgerHash | string | *Optional* (Optional) A 20-byte hex string for the ledger version to use. -*options.* ledgerIndex | integer | *Optional* (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. -*options.* ledgerIndex | string | *Optional* (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. -*options.* limit | integer | *Optional* (Optional) The maximum number of objects to include in the results. -*options.* type | string | *Optional* (Optional) Filter results to include only this type of ledger object. The valid types are: `check`, `escrow`, `offer`, `payment_channel`, `signer_list`, and `state` (trust line). - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -Name | Type | Description ----- | ---- | ----------- -account | [address](#address) | Unique address of the account this request corresponds to. -account_objects | array\ | Array of objects owned by this account. Each object is in its raw ledger format. -ledger_current_index | integer | *Optional* (May be omitted) The sequence number of the ledger that was used to generate this response. -ledger_current_index | string | *Optional* (May be omitted) The sequence number of the ledger that was used to generate this response. -ledger_hash | string | *Optional* (May be omitted) The identifying hash of the ledger that was used to generate this response. -ledger_index | integer | *Optional* (May be omitted) The sequence number of the ledger that was used to generate this response. -ledger_index | string | *Optional* (May be omitted) The sequence number of the ledger that was used to generate this response. -limit | integer | *Optional* (May be omitted) The limit that was used in this request, if any. -validated | boolean | *Optional* If included and set to true, the information in this request comes from a validated ledger version. Otherwise, the information is subject to change. - -The types of objects that may be returned include: - -* `Offer` objects for orders that are currently live, unfunded, or expired but not yet removed. -* `RippleState` objects for trust lines where this account's side is not in the default state. -* A `SignerList` object if the account has multi-signing enabled. -* `Escrow` objects for held payments that have not yet been executed or canceled. -* `PayChannel` objects for open payment channels. -* `Check` objects for pending checks. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getAccountObjects(address: address).then(objects => - {/* ... */}); -``` - - -```json -{ - "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "account_objects": [ - { - "Balance": { - "currency": "ASP", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 65536, - "HighLimit": { - "currency": "ASP", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "ASP", - "issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", - "value": "10" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": - "BF7555B0F018E3C5E2A3FF9437A1A5092F32903BE246202F988181B9CED0D862", - "PreviousTxnLgrSeq": 1438879, - "index": - "2243B0B630EA6F7330B654EFA53E27A7609D9484E535AB11B7F946DF3D247CE9" - }, - { - "Balance": { - "currency": "XAU", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 3342336, - "HighLimit": { - "currency": "XAU", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "XAU", - "issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", - "value": "0" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": - "79B26D7D34B950AC2C2F91A299A6888FABB376DD76CFF79D56E805BF439F6942", - "PreviousTxnLgrSeq": 5982530, - "index": - "9ED4406351B7A511A012A9B5E7FE4059FA2F7650621379C0013492C315E25B97" - }, - { - "Balance": { - "currency": "USD", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 1114112, - "HighLimit": { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "USD", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "5" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": - "6FE8C824364FB1195BCFEDCB368DFEE3980F7F78D3BF4DC4174BB4C86CF8C5CE", - "PreviousTxnLgrSeq": 10555014, - "index": - "2DECFAC23B77D5AEA6116C15F5C6D4669EBAEE9E7EE050A40FE2B1E47B6A9419" - }, - { - "Balance": { - "currency": "MXN", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "481.992867407479" - }, - "Flags": 65536, - "HighLimit": { - "currency": "MXN", - "issuer": "rHpXfibHgSb64n8kK9QWDpdbfqSpYbM9a4", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "MXN", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "1000" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": - "A467BACE5F183CDE1F075F72435FE86BAD8626ED1048EDEFF7562A4CC76FD1C5", - "PreviousTxnLgrSeq": 3316170, - "index": - "EC8B9B6B364AF6CB6393A423FDD2DDBA96375EC772E6B50A3581E53BFBDFDD9A" - }, - { - "Balance": { - "currency": "EUR", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0.793598266778297" - }, - "Flags": 1114112, - "HighLimit": { - "currency": "EUR", - "issuer": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "EUR", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "1" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": - "E9345D44433EA368CFE1E00D84809C8E695C87FED18859248E13662D46A0EC46", - "PreviousTxnLgrSeq": 5447146, - "index": - "4513749B30F4AF8DA11F077C448128D6486BF12854B760E4E5808714588AA915" - }, - { - "Balance": { - "currency": "CNY", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 2228224, - "HighLimit": { - "currency": "CNY", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "3" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "CNY", - "issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK", - "value": "0" - }, - "LowNode": "0000000000000008", - "PreviousTxnID": - "2FDDC81F4394695B01A47913BEC4281AC9A283CC8F903C14ADEA970F60E57FCF", - "PreviousTxnLgrSeq": 5949673, - "index": - "578C327DA8944BDE2E10C9BA36AFA2F43E06C8D1E8819FB225D266CBBCFDE5CE" - }, - { - "Balance": { - "currency": "DYM", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "1.336889190631542" - }, - "Flags": 65536, - "HighLimit": { - "currency": "DYM", - "issuer": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "DYM", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "3" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": - "6DA2BD02DFB83FA4DAFC2651860B60071156171E9C021D9E0372A61A477FFBB1", - "PreviousTxnLgrSeq": 8818732, - "index": - "5A2A5FF12E71AEE57564E624117BBA68DEF78CD564EF6259F92A011693E027C7" - }, - { - "Balance": { - "currency": "CHF", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "-0.3488146605801446" - }, - "Flags": 131072, - "HighLimit": { - "currency": "CHF", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "CHF", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "LowNode": "000000000000008C", - "PreviousTxnID": - "722394372525A13D1EAAB005642F50F05A93CF63F7F472E0F91CDD6D38EB5869", - "PreviousTxnLgrSeq": 2687590, - "index": - "F2DBAD20072527F6AD02CE7F5A450DBC72BE2ABB91741A8A3ADD30D5AD7A99FB" - }, - { - "Balance": { - "currency": "BTC", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 131072, - "HighLimit": { - "currency": "BTC", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "3" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "LowNode": "0000000000000043", - "PreviousTxnID": - "03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A", - "PreviousTxnLgrSeq": 8317037, - "index": - "767C12AF647CDF5FEB9019B37018748A79C50EDAF87E8D4C7F39F78AA7CA9765" - }, - { - "Balance": { - "currency": "USD", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "-16.00534471983042" - }, - "Flags": 131072, - "HighLimit": { - "currency": "USD", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "5000" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "LowNode": "000000000000004A", - "PreviousTxnID": - "CFFF5CFE623C9543308C6529782B6A6532207D819795AAFE85555DB8BF390FE7", - "PreviousTxnLgrSeq": 14365854, - "index": - "826CF5BFD28F3934B518D0BDF3231259CBD3FD0946E3C3CA0C97D2C75D2D1A09" - } - ], - "ledger_hash": - "053DF17D2289D1C4971C22F235BC1FCA7D4B3AE966F842E5819D0749E0B8ECD3", - "ledger_index": 14378733, - "validated": true -} -``` - - -## getPaymentChannel - -`getPaymentChannel(id: string): Promise` - -Returns specified payment channel. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -id | string | 256-bit hexadecimal channel identifier. - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -Name | Type | Description ----- | ---- | ----------- -account | [address](#address) | Address that created the payment channel. -destination | [address](#address) | Address to receive XRP claims against this channel. -amount | [value](#value) | The total amount of XRP funded in this channel. -balance | [value](#value) | The total amount of XRP delivered by this channel. -settleDelay | number | Amount of seconds the source address must wait before closing the channel if it has unclaimed XRP. -previousAffectingTransactionID | string | Hash value representing the most recent transaction that affected this payment channel. -previousAffectingTransactionLedgerVersion | integer | The ledger version that the transaction identified by the `previousAffectingTransactionID` was validated in. -previousAffectingTransactionLedgerVersion | string | The ledger version that the transaction identified by the `previousAffectingTransactionID` was validated in. -cancelAfter | date-time string | *Optional* Time when this channel expires as specified at creation. -destinationTag | integer | *Optional* Destination tag. -expiration | date-time string | *Optional* Time when this channel expires. -publicKey | string | *Optional* Public key of the key pair the source uses to sign claims against this channel. -sourceTag | integer | *Optional* Source tag. - -### Example - -```javascript -const channelId = - 'E30E709CF009A1F26E0E5C48F7AA1BFB79393764F15FB108BDC6E06D3CBD8415'; -return api.getPaymentChannel(channelId).then(channel => - {/* ... */}); -``` - - -```json -{ - "account": "r6ZtfQFWbCkp4XqaUygzHaXsQXBT67xLj", - "amount": "10", - "balance": "0", - "destination": "rQf9vCwQtzQQwtnGvr6zc1fqzqg7QBuj7G", - "publicKey": "02A05282CB6197E34490BACCD9405E81D9DFBE123B0969F9F40EC3F9987AD9A97D", - "settleDelay": 10000, - "previousAffectingTransactionID": "F939A0BEF139465403C56CCDC49F59A77C868C78C5AEC184E29D15E9CD1FF675", - "previousAffectingTransactionLedgerVersion": 151322 -} -``` - - -## getLedger - -`getLedger(options: object): Promise` - -Returns header information for the specified ledger (or the most recent validated ledger if no ledger is specified). Optionally, all the transactions that were validated in the ledger or the account state information can be returned with the ledger header. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -options | object | *Optional* Options affecting what ledger and how much data to return. -*options.* includeAllData | boolean | *Optional* Include the details of the transactions or state information if `includeTransactions` or `includeState` is set. -*options.* includeState | boolean | *Optional* Return an array of state data in this ledger. By default, provides the identifying hashes of state data. If `includeAllData` is true, return the state data in JSON form instead. **Admin required:** This is a very large amount of data. -*options.* includeTransactions | boolean | *Optional* Return an array of transactions in this ledger. By default, provides the identifying hashes for each transaction. If `includeAllData` is true, include the entire transaction JSON for each transaction instead. -*options.* ledgerHash | string | *Optional* Get ledger data for this historical ledger hash. -*options.* ledgerVersion | integer | *Optional* Get ledger data for this historical ledger version. -*options.* ledgerVersion | string | *Optional* Get ledger data for this historical ledger version. - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -Name | Type | Description ----- | ---- | ----------- -stateHash | string | Hash of all state information in this ledger. -closeTime | date-time string | The approximate time when this ledger was closed. This number is rounded based on the `closeTimeResolution`. If it would have been rounded to the same time as a previous ledger, the close time is recorded as 1 second later instead. -closeTimeResolution | integer | A number of seconds, indicating how much the `closeTime` could be rounded. Ledger close times are approximate so that small differences in servers clocks don't hinder consensus. -closeFlags | integer | A bit-map of flags relating to the closing of this ledger. Currently, the ledger has only one flag defined for `closeFlags`: **sLCF_NoConsensusTime** (value 1). If this flag is enabled, it means that validators disagreed on the correct close time for the ledger, but built otherwise the same ledger, so they declared consensus while "agreeing to disagree" on the close time. In this case, the consensus ledger contains a `closeTime` value that is 1 second after that of the previous ledger. (In this case, there is no official close time, but the actual real-world close time is probably 3-6 seconds later than the specified `closeTime`.) -ledgerHash | string | Unique identifying hash of the entire ledger. -ledgerVersion | integer | The ledger version of this ledger. -ledgerVersion | string | The ledger version of this ledger. -parentLedgerHash | string | Unique identifying hash of the ledger that came immediately before this one. -parentCloseTime | date-time string | The previous ledger's recorded close time. -totalDrops | [value](#value) | Total number of drops (1/1,000,000th of an XRP) in the network, as a quoted integer. (This decreases as transaction fees cause XRP to be destroyed.) -transactionHash | string | Hash of the transaction information included in this ledger. -rawState | string | *Optional* A JSON string containing all state data for this ledger in rippled JSON format. -stateHashes | array\ | *Optional* An array of hashes of all state data in this ledger. -transactionHashes | array\<[transactionHash](#transaction-id)\> | *Optional* An array of hashes of all transactions that were validated in this ledger. -transactions | array\<[getTransaction](#gettransaction)\> | *Optional* Array of all transactions that were validated in this ledger. Transactions are represented in the same format as the return value of [getTransaction](#gettransaction). - -### Example - -```javascript -return api.getLedger() - .then(ledger => {/* ... */}); -``` - - -```json -{ - "stateHash": "EC028EC32896D537ECCA18D18BEBE6AE99709FEFF9EF72DBD3A7819E918D8B96", - "closeTime": "2014-09-24T21:21:50.000Z", - "closeTimeResolution": 10, - "closeFlags": 0, - "ledgerHash": "0F7ED9F40742D8A513AE86029462B7A6768325583DF8EE21B7EC663019DD6A0F", - "ledgerVersion": 9038214, - "parentLedgerHash": "4BB9CBE44C39DC67A1BE849C7467FE1A6D1F73949EA163C38A0121A15E04FFDE", - "parentCloseTime": "2014-09-24T21:21:40.000Z", - "totalDrops": "99999973964317514", - "transactionHash": "ECB730839EB55B1B114D5D1AD2CD9A932C35BA9AB6D3A8C2F08935EAC2BAC239" -} -``` - - -## parseAccountFlags - -`parseAccountFlags(Flags: number): object` - -Parse an `AccountRoot` object's [`Flags`](https://xrpl.org/accountroot.html#accountroot-flags). - -### Parameters - -This method takes one parameter, the AccountRoot `Flags` number to parse. Note that flags have different mappings on other types of objects or in transactions such as AccountSet. - -### Return Value - -This method returns an object with containing a key for each AccountRoot flag known to this version of RippleAPI. Each flag has a boolean value of `true` or `false`. - -### Example - -```javascript -const account_info = await api.request('account_info', {account: 'rKsdkGhyZH6b2Zzd5hNnEqSv2wpznn4n6N'}) -const flags = api.parseAccountFlags(account_info.account_data.Flags) -console.log(JSON.stringify(flags, null, 2)) -``` - -```json -{ - "passwordSpent": false, - "requireDestinationTag": false, - "requireAuthorization": false, - "depositAuth": true, - "disallowIncomingXRP": false, - "disableMasterKey": false, - "noFreeze": false, - "globalFreeze": false, - "defaultRipple": false -} -``` - -## prepareTransaction - -`prepareTransaction(transaction: object, instructions: object): Promise` - -Prepare a transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -This method works with any of [the transaction types supported by rippled](https://xrpl.org/transaction-types.html). - -Notably, this is the preferred method for preparing `DepositPreauth` or `AccountDelete` transactions. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -transaction | [Transaction](https://xrpl.org/transaction-formats.html) | The specification (JSON) of the transaction to prepare. Set `Account` to the address of the account that is creating the transaction. You may omit auto-fillable fields like `Fee`, `Flags`, and `Sequence` to have them set automatically. -instructions | [Instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction. - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -async function preparedPreauth() { - const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; - return api.prepareTransaction({ - TransactionType: 'DepositPreauth', - Account: address, - Authorize: 'rMyVso4p83khNyHdV1m1PggV9QNadCj8wM' - }); -} -``` - -```javascript -{ - txJSON: '{"TransactionType":"DepositPreauth","Account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","Authorize":"rMyVso4p83khNyHdV1m1PggV9QNadCj8wM","Flags":2147483648,"LastLedgerSequence":13561714,"Fee":"12","Sequence":1}', - instructions: { - fee: '0.000012', - sequence: 1, - maxLedgerVersion: 13561714 - } -} -``` - -## preparePayment - -`preparePayment(address: string, payment: object, instructions: object): Promise` - -Prepare a payment transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -payment | [payment](#payment) | The specification of the payment to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const payment = { - "source": { - "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "maxAmount": { - "value": "0.01", - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM" - } - }, - "destination": { - "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "amount": { - "value": "0.01", - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM" - } - } -}; -return api.preparePayment(address, payment).then(prepared => { - /* ... */ - }).catch(error => { - /* ... as with all prepare* methods, use a Promise catch block to handle errors ... */ - }) -``` - - -```json -{ - "txJSON": "{\"Flags\":2147483648,\"TransactionType\":\"Payment\",\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"Destination\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"Amount\":{\"value\":\"0.01\",\"currency\":\"USD\",\"issuer\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"},\"SendMax\":{\"value\":\"0.01\",\"currency\":\"USD\",\"issuer\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"},\"LastLedgerSequence\":8820051,\"Fee\":\"12\",\"Sequence\":23}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8820051 - } -} -``` - - -## prepareTrustline - -`prepareTrustline(address: string, trustline: object, instructions: object): Promise` - -Prepare a trustline transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -trustline | [trustline](#trustline) | The specification of the trustline to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const trustline = { - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "limit": "10000", - "qualityIn": 0.91, - "qualityOut": 0.87, - "ripplingDisabled": true, - "frozen": false, - "memos": [ - { - "type": "test", - "format": "text/plain", - "data": "texted data" - } - ] -}; -return api.prepareTrustline(address, trustline).then(prepared => - {/* ... */}); -``` - - -```json -{ - "txJSON": "{\"TransactionType\":\"TrustSet\",\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"LimitAmount\":{\"currency\":\"USD\",\"issuer\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\",\"value\":\"10000\"},\"Flags\":2149711872,\"QualityIn\":910000000,\"QualityOut\":870000000,\"Memos\":[{\"Memo\":{\"MemoData\":\"7465787465642064617461\",\"MemoType\":\"74657374\",\"MemoFormat\":\"746578742F706C61696E\"}}],\"LastLedgerSequence\":8820051,\"Fee\":\"12\",\"Sequence\":23}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8820051 - } -} -``` - - -## prepareOrder - -`prepareOrder(address: string, order: object, instructions: object): Promise` - -Prepare an order transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -order | [order](#order) | The specification of the order to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; - -// Buy 10.10 USD (of the specified issuer) for 2.0 XRP (2000000 drops), fill or kill. -const order = { - "direction": "buy", - "quantity": { - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "value": "10.1" - }, - "totalPrice": { - "currency": "drops", - "value": "2000000" - }, - "passive": false, - "fillOrKill": true -}; -return api.prepareOrder(address, order) - .then(prepared => {/* ... */}); -``` - - -```json -{ - "txJSON": "{\"Flags\":2147745792,\"TransactionType\":\"OfferCreate\",\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"TakerGets\":\"2000000\",\"TakerPays\":{\"value\":\"10.1\",\"currency\":\"USD\",\"issuer\":\"rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM\"},\"LastLedgerSequence\":8819954,\"Fee\":\"12\",\"Sequence\":23}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8819954 - } -} -``` - - -## prepareOrderCancellation - -`prepareOrderCancellation(address: string, orderCancellation: object, instructions: object): Promise` - -Prepare an order cancellation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -orderCancellation | [orderCancellation](#order-cancellation) | The specification of the order cancellation to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const orderCancellation = {orderSequence: 123}; -return api.prepareOrderCancellation(address, orderCancellation) - .then(prepared => {/* ... */}); -``` - - -```json -{ - "txJSON": "{\"Flags\":2147483648,\"TransactionType\":\"OfferCancel\",\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"OfferSequence\":23,\"LastLedgerSequence\":8820051,\"Fee\":\"12\",\"Sequence\":23}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8820051 - } -} -``` - - -## prepareSettings - -`prepareSettings(address: string, settings: object, instructions: object): Promise` - -Prepare a settings transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -settings | [settings](#settings) | The specification of the settings to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const settings = { - "domain": "example.com", - "memos": [ - { - "type": "test", - "format": "text/plain", - "data": "texted data" - } - ] -}; -return api.prepareSettings(address, settings) - .then(prepared => {/* ... */}); -``` - - -```json -{ - "domain": "example.com", - "memos": [ - { - "type": "test", - "format": "text/plain", - "data": "texted data" - } - ] -} -``` - - -## prepareEscrowCreation - -`prepareEscrowCreation(address: string, escrowCreation: object, instructions: object): Promise` - -Prepare an escrow creation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -escrowCreation | [escrowCreation](#escrow-creation) | The specification of the escrow creation to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -This is a convenience method for generating the EscrowCreate JSON used by rippled, so the same restrictions apply. - -Field mapping: `allowCancelAfter` is equivalent to rippled's `CancelAfter`; `allowExecuteAfter` is equivalent to `FinishAfter`. At the `allowCancelAfter` time, the escrow is considered expired. This means that the funds can only be returned to the sender. At the `allowExecuteAfter` time, the escrow is permitted to be released to the recipient (if the `condition` is fulfilled). - -Note that `allowCancelAfter` must be chronologically later than `allowExecuteAfter`. - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const escrowCreation = { - "destination": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo", - "amount": "0.01", - "allowExecuteAfter": "2014-09-24T21:21:50.000Z", - "allowCancelAfter": "2017-01-01T00:00:00.000Z" -}; -return api.prepareEscrowCreation(address, escrowCreation).then(prepared => - {/* ... */}); -``` - - -```json -{ - "txJSON": "{\"Flags\":2147483648,\"TransactionType\":\"EscrowCreate\",\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"Destination\":\"rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo\",\"Amount\":\"10000\",\"CancelAfter\":536544000,\"FinishAfter\":464908910,\"LastLedgerSequence\":8820051,\"Fee\":\"12\",\"Sequence\":23}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8820051 - } -} -``` - - -## prepareEscrowCancellation - -`prepareEscrowCancellation(address: string, escrowCancellation: object, instructions: object): Promise` - -Prepare an escrow cancellation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -escrowCancellation | [escrowCancellation](#escrow-cancellation) | The specification of the escrow cancellation to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const escrowCancellation = { - "owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "escrowSequence": 1234 -}; -return api.prepareEscrowCancellation(address, escrowCancellation).then(prepared => - {/* ... */}); -``` - - -```json -{ - "txJSON": "{\"Flags\":2147483648,\"TransactionType\":\"EscrowCancel\",\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"Owner\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"OfferSequence\":1234,\"LastLedgerSequence\":8820051,\"Fee\":\"12\",\"Sequence\":23}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8820051 - } -} -``` - - -## prepareEscrowExecution - -`prepareEscrowExecution(address: string, escrowExecution: object, instructions: object): Promise` - -Prepare an escrow execution transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -escrowExecution | [escrowExecution](#escrow-execution) | The specification of the escrow execution to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const escrowExecution = { - "owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "escrowSequence": 1234, - "condition": "A0258020E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855810100", - "fulfillment": "A0028000" -}; -return api.prepareEscrowExecution(address, escrowExecution).then(prepared => - {/* ... */}); -``` - - -```json -{ - "txJSON": "{\"Flags\":2147483648,\"TransactionType\":\"EscrowFinish\",\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"Owner\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"OfferSequence\":1234,\"Condition\":\"A0258020E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855810100\",\"Fulfillment\":\"A0028000\",\"LastLedgerSequence\":8820051,\"Fee\":\"396\",\"Sequence\":23}", - "instructions": { - "fee": "0.000396", - "sequence": 23, - "maxLedgerVersion": 8820051 - } -} -``` - - -## preparePaymentChannelCreate - -`preparePaymentChannelCreate(address: string, paymentChannelCreate: object, instructions: object): Promise` - -Prepare a payment channel creation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -paymentChannelCreate | [paymentChannelCreate](#payment-channel-create) | The specification of the payment channel to create. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const paymentChannelCreate = { - "amount": "1", - "destination": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW", - "settleDelay": 86400, - "publicKey": "32D2471DB72B27E3310F355BB33E339BF26F8392D5A93D3BC0FC3B566612DA0F0A" -}; -return api.preparePaymentChannelCreate(address, paymentChannelCreate).then(prepared => - {/* ... */}); -``` - - -```json -{ - "txJSON":"{\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"TransactionType\":\"PaymentChannelCreate\",\"Amount\":\"1000000\",\"Destination\":\"rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW\",\"SettleDelay\":86400,\"PublicKey\":\"32D2471DB72B27E3310F355BB33E339BF26F8392D5A93D3BC0FC3B566612DA0F0A\",\"Flags\":2147483648,\"LastLedgerSequence\":8820051,\"Fee\":\"12\",\"Sequence\":23}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8820051 - } -} -``` - - -## preparePaymentChannelClaim - -`preparePaymentChannelClaim(address: string, paymentChannelClaim: object, instructions: object): Promise` - -Prepare a payment channel claim transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -paymentChannelClaim | [paymentChannelClaim](#payment-channel-claim) | Details of the channel and claim. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const paymentChannelClaim = { - "channel": "C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198" -}; -return api.preparePaymentChannelClaim(address, paymentChannelClaim).then(prepared => - {/* ... */}); -``` - - -```json -{ - "txJSON": "{\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"TransactionType\":\"PaymentChannelClaim\",\"Channel\":\"C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198\",\"Flags\":2147483648,\"LastLedgerSequence\":8820051,\"Fee\":\"12\",\"Sequence\":23}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8820051 - } -} -``` - - -## preparePaymentChannelFund - -`preparePaymentChannelFund(address: string, paymentChannelFund: object, instructions: object): Promise` - -Prepare a payment channel fund transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -paymentChannelFund | [paymentChannelFund](#payment-channel-fund) | The channel to fund, and the details of how to fund it. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const paymentChannelFund = { - "channel": "C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198", - "amount": "1" -}; -return api.preparePaymentChannelFund(address, paymentChannelFund).then(prepared => - {/* ... */}); -``` - - -```json -{ - "txJSON":"{\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"TransactionType\":\"PaymentChannelFund\",\"Channel\":\"C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198\",\"Amount\":\"1000000\",\"Flags\":2147483648,\"LastLedgerSequence\":8820051,\"Fee\":\"12\",\"Sequence\":23}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8820051 - } -} -``` - - -## prepareCheckCreate - -`prepareCheckCreate(address: string, checkCreate: object, instructions: object): Promise` - -Prepare a Check creation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -checkCreate | [checkCreate](#check-create) | The specification of the Check create creation to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const checkCreate = { - "destination": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW", - "sendMax": { - "currency": "drops", - "value": "1000000" - } -}; -return api.prepareCheckCreate(address, checkCreate).then(prepared => - {/* ... */}); -``` - - -```json -{ - "txJSON": "{\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"TransactionType\":\"CheckCreate\",\"Destination\":\"rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW\",\"SendMax\":\"1000000\",\"Flags\":2147483648,\"LastLedgerSequence\":8820051,\"Sequence\":23,\"Fee\":\"12\"}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8820051 - } -} -``` - - -## prepareCheckCancel - -`prepareCheckCancel(address: string, checkCancel: object, instructions: object): Promise` - -Prepare a Check cancellation transaction. This type of transaction cancels an unredeemed Check, removing it from the ledger without sending any money. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -checkCancel | [checkCancel](#check-cancel) | The specification of the Check cancellation to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const checkCancel = { - "checkID": "49647F0D748DC3FE26BDACBC57F251AADEFFF391403EC9BF87C97F67E9977FB0" -}; -return api.prepareCheckCancel(address, checkCancel).then(prepared => - {/* ... */}); -``` - - -```json -{ - "txJSON": "{\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"TransactionType\":\"CheckCancel\",\"CheckID\":\"49647F0D748DC3FE26BDACBC57F251AADEFFF391403EC9BF87C97F67E9977FB0\",\"Flags\":2147483648,\"LastLedgerSequence\":8819954,\"Fee\":\"12\",\"Sequence\":23}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8819954 - } -} -``` - - -## prepareCheckCash - -`prepareCheckCash(address: string, checkCash: object, instructions: object): Promise` - -Prepare a Check cashing transaction. This redeems a Check to receive up to the amount authorized by the corresponding CheckCreate transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -checkCash | [checkCash](#check-cash) | The specification of the Check cash to prepare. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const checkCash = { - "amount": { - "currency": "drops", - "value": "1000000" - }, - "checkID": "838766BA2B995C00744175F69A1B11E32C3DBC40E64801A4056FCBD657F57334" -}; -return api.prepareCheckCash(address, checkCash).then(prepared => - {/* ... */}); -``` - - -```json -{ - "txJSON": "{\"Account\":\"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59\",\"TransactionType\":\"CheckCash\",\"CheckID\":\"838766BA2B995C00744175F69A1B11E32C3DBC40E64801A4056FCBD657F57334\",\"Amount\":\"1000000\",\"Flags\":2147483648,\"LastLedgerSequence\":8819954,\"Sequence\":23,\"Fee\":\"12\"}", - "instructions": { - "fee": "0.000012", - "sequence": 23, - "maxLedgerVersion": 8819954 - } -} -``` - - -## prepareTicketCreate - -`prepareTicketCreate(address: string, ticketCount: number, instructions: object): Promise` - -Prepare a ticket transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -Ticket functionality requires the [TicketBatch amendment](https://github.com/ripple/xrpl-dev-portal/issues/898). As of 2020-11-24, this amendment is not activated on the Mainnet, Testnet, or Devnet. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -address | [address](#address) | The address of the account that is creating the transaction. -ticketCount | number | The number of tickets to be created. -instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | The prepared transaction in rippled JSON format. -instructions | object | The instructions for how to execute the transaction after adding automatic defaults. -*instructions.* fee | [value](#value) | The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide. -*instructions.* maxLedgerVersion | integer,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* maxLedgerVersion | string,null | The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'. -*instructions.* sequence | [sequence](#account-sequence-number) | *Optional* The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. -*instructions.* ticketSequence | [ticket-sequence](#account-sequence-number) | *Optional* The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.prepareTicketCreate(address, 2).then(prepared => { - /* ... */ - }).catch(error => { - /* ... as with all prepare* methods, use a Promise catch block to handle errors ... */ - }) -``` - - -```json -{ - "TransactionType": "TicketCreate", - "Account": "r4SDqUD1ZcfoZrhnsZ94XNFKxYL4oHYJyA", - "TicketCount": 2, - "LastLedgerSequence": 13, - "Fee": "12", - "Sequence": 25 -} -``` - - -## sign - -``` -sign(txJSON: string, secret: string, options: object): {signedTransaction: string, id: string} -sign(txJSON: string, keypair: object, options: object): {signedTransaction: string, id: string} -``` - -Sign a prepared transaction. The signed transaction can then be [submitted](#submit). - -This method can sign any of [the transaction types supported by ripple-binary-codec](https://github.com/ripple/ripple-binary-codec/blob/cfcde79c19c359e9a0466d7bc3dc9a3aef47bb99/src/enums/definitions.json#L1637). When a new transaction type is added to the XRP Ledger, it is unrecognized until `ripple-binary-codec` is updated. If you try to sign an unrecognized transaction type, this method throws an error like the following: - -`Error: [TRANSACTION_TYPE] is not a valid name or ordinal for TransactionType` - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -txJSON | string | Transaction represented as a JSON string in rippled format. -keypair | object | *Optional* The private and public key of the account that is initiating the transaction. (This field cannot be used with secret). -*keypair.* privateKey | privateKey | The uppercase hexadecimal representation of the secp256k1 or Ed25519 private key. Ed25519 keys are prefixed with 0xED. You can read about how keys are derived [here](https://xrpl.org/cryptographic-keys.html). -*keypair.* publicKey | publicKey | The uppercase hexadecimal representation of the secp256k1 or Ed25519 public key. Ed25519 keys are prefixed with 0xED. You can read about how keys are derived [here](https://xrpl.org/cryptographic-keys.html). -options | object | *Optional* Options that control the type of signature to create. -*options.* signAs | [address](#address) | *Optional* The account that the signature should count for in multisigning. -secret | secret string | *Optional* The secret of the account that is initiating the transaction. (This field cannot be used with keypair). - -When this method is used for multi-signing, the `options` parameter is required. See the multi-signing example in this section for more details. - -### Return Value - -This method returns an object with the following structure: - -Name | Type | Description ----- | ---- | ----------- -signedTransaction | string | The signed transaction represented as an uppercase hexadecimal string. -id | [transactionHash](#transaction-id) | The [Transaction ID](#transaction-id) of the signed transaction. - -### Example - -```javascript -// AccountSet transaction that sets Domain to example.com: -const txJSON = '{"Flags":2147483648,"TransactionType":"AccountSet","Account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","Domain":"6578616D706C652E636F6D","LastLedgerSequence":8820051,"Fee":"12","Sequence":23}'; -const secret = 'shsWGZcmZz6YsWWmcnpfr6fLTdtFV'; -const keypair = { privateKey: '00ACCD3309DB14D1A4FC9B1DAE608031F4408C85C73EE05E035B7DC8B25840107A', publicKey: '02F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8' }; -return api.sign(txJSON, secret); // or: api.sign(txJSON, keypair); -``` - - -```json -{ - "signedTransaction": "12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8744630440220680070A157682D9EB510E8AD58C35DC9C8346B155077D73792E88120B7A3B6B1022079537D3300C9B4D2D3D62ACCE1E66CDA893F9612CB2577ADEC8154B933765336770B6578616D706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304", - "id": "10B54D31384A49336C36A5907E3C28227139E282D3C7F734FEA351DE446F3674" -} -``` - - -### Example Keypairs - -To learn how keypairs are derived read [here](https://xrpl.org/cryptographic-keys.html#generating-keys). -```javascript -// secp25519 (33 bytes) -const privateKey = "002512BBDFDBB77510883B7DCCBEF270B86DEAC8B64AC762873D75A1BEE6298665" -const publicKey = "0390A196799EE412284A5D80BF78C3E84CBB80E1437A0AECD9ADF94D7FEAAFA284" - -// ed25519 (Note the 0xED prefixes a 32 byte value for a total of 33 bytes) -const privateKey = "ED0B6CBAC838DFE7F47EA1BD0DF00EC282FDF45510C92161072CCFB84035390C4D" -const publicKey = "ED1A7C082846CFF58FF9A892BA4BA2593151CCF1DBA59F37714CC9ED39824AF85F" -``` - -### Example (multi-signing) - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI; - -// jon's address will have a multi-signing setup with a quorum of 2 -const jon = { - account: 'rJKpme4m2zBQceBuU89d7vLMzgoUw2Ptj', - secret: 'sh4Va7b1wQof8knHFV2sxwX12fSgK' -}; -const aya = { - account: 'rnrPdBjs98fFFfmRpL6hM7exT788SWQPFN', - secret: 'snaMuMrXeVc2Vd4NYvHofeGNjgYoe' -}; -const bran = { - account: 'rJ93RLnT1t5A8fCr7HTScw7WtfKJMRXodH', - secret: 'shQtQ8Um5MS218yvEU3Ehy1eZQKqH' -}; - -// Setup the signers list with a quorum of 2 -const multiSignSetupTransaction = { - "Flags": 0, - "TransactionType": "SignerListSet", - "Account": "rJKpme4m2zBQceBuU89d7vLMzgoUw2Ptj", - "Fee": "120", - "SignerQuorum": 2, - "SignerEntries": [ - { - "SignerEntry": { - "Account": "rnrPdBjs98fFFfmRpL6hM7exT788SWQPFN", - "SignerWeight": 2 - } - }, - { - "SignerEntry": { - "Account": "rJ93RLnT1t5A8fCr7HTScw7WtfKJMRXodH", - "SignerWeight": 1 - } - }, - ] -}; - -// a transaction which requires multi signing -const multiSignPaymentTransaction = { - TransactionType: 'Payment', - Account: 'rJKpme4m2zBQceBuU89d7vLMzgoUw2Ptj', - Destination: 'rJ93RLnT1t5A8fCr7HTScw7WtfKJMRXodH', - Amount: '88000000' -}; - -const multiSignPaymentInstruction = { - signersCount: 2 -}; - -const api = new RippleAPI({ - server: 'wss://s.altnet.rippletest.net:51233' -}); - -api.connect().then(() => { - // adding the multi signing feature to jon's account - api.prepareTransaction(multiSignSetupTransaction).then((prepared) => { - console.log(prepared); - jonSign = api.sign(prepared.txJSON, jon.secret).signedTransaction; - api.submit(jonSign).then( response => { - console.log(response.resultCode, response.resultMessage); - - // multi sign a transaction - api.prepareTransaction(multiSignPaymentTransaction, multiSignPaymentInstruction).then(prepared => { - console.log(prepared); - - // Aya and Bran sign it too but with 'signAs' set to their own account - let ayaSign = api.sign(prepared.txJSON, aya.secret, {'signAs': aya.account}).signedTransaction; - let branSign = api.sign(prepared.txJSON, bran.secret, {'signAs': bran.account}).signedTransaction; - - // signatures are combined and submitted - let combinedTx = api.combine([ayaSign, branSign]); - api.submit(combinedTx.signedTransaction).then(response => { - console.log(response.tx_json.hash); - return api.disconnect(); - }).catch(console.error); - }).catch(console.error); - }).catch(console.error) - }).catch(console.error); -}).catch(console.error); -``` - -If the multi-signing account was setup properly, the above example logs `resultCode: 'tesSUCCESS'` and the hash for the transaction. If any of `{signAs: some_address}` options were missing, the code returns a validation error such as: - -``` -[ValidationError(txJSON is not the same for all signedTransactions)] -``` - -## combine - -`combine(signedTransactions: Array): {signedTransaction: string, id: string}` - -Combines signed transactions from multiple accounts for a multisignature transaction into a form that can be [submitted](#submit). - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -signedTransactions | array\ | An array of signed transactions (from the output of [sign](#sign)) to combine. - -### Return Value - -This method returns an object with the following structure: - -Name | Type | Description ----- | ---- | ----------- -signedTransaction | string | The signed transaction represented as an uppercase hexadecimal string. -id | [transactionHash](#transaction-id) | The [Transaction ID](#transaction-id) of the signed transaction. - -### Example - -```javascript -const signedTransactions = [ "12000322800000002400000004201B000000116840000000000F42407300770B6578616D706C652E636F6D811407C532442A675C881BA1235354D4AB9D023243A6F3E0107321026C784C1987F83BACBF02CD3E484AFC84ADE5CA6B36ED4DCA06D5BA233B9D382774473045022100E484F54FF909469FA2033E22EFF3DF8EDFE62217062680BB2F3EDF2F185074FE0220350DB29001C710F0450DAF466C5D819DC6D6A3340602DE9B6CB7DA8E17C90F798114FE9337B0574213FA5BCC0A319DBB4A7AC0CCA894E1F1", - "12000322800000002400000004201B000000116840000000000F42407300770B6578616D706C652E636F6D811407C532442A675C881BA1235354D4AB9D023243A6F3E01073210287AAAB8FBE8C4C4A47F6F1228C6E5123A7ED844BFE88A9B22C2F7CC34279EEAA74473045022100B09DDF23144595B5A9523B20E605E138DC6549F5CA7B5984D7C32B0E3469DF6B022018845CA6C203D4B6288C87DDA439134C83E7ADF8358BD41A8A9141A9B631419F8114517D9B9609229E0CDFE2428B586738C5B2E84D45E1F1" ]; -return api.combine(signedTransactions); -``` - - -```json -{ - "signedTransaction": "12000322800000002400000004201B000000116840000000000F42407300770B6578616D706C652E636F6D811407C532442A675C881BA1235354D4AB9D023243A6F3E01073210287AAAB8FBE8C4C4A47F6F1228C6E5123A7ED844BFE88A9B22C2F7CC34279EEAA74473045022100B09DDF23144595B5A9523B20E605E138DC6549F5CA7B5984D7C32B0E3469DF6B022018845CA6C203D4B6288C87DDA439134C83E7ADF8358BD41A8A9141A9B631419F8114517D9B9609229E0CDFE2428B586738C5B2E84D45E1E0107321026C784C1987F83BACBF02CD3E484AFC84ADE5CA6B36ED4DCA06D5BA233B9D382774473045022100E484F54FF909469FA2033E22EFF3DF8EDFE62217062680BB2F3EDF2F185074FE0220350DB29001C710F0450DAF466C5D819DC6D6A3340602DE9B6CB7DA8E17C90F798114FE9337B0574213FA5BCC0A319DBB4A7AC0CCA894E1F1", - "id": "8A3BFD2214B4C8271ED62648FCE9ADE4EE82EF01827CF7D1F7ED497549A368CC" -} -``` - - -## submit - -`request('submit', {tx_blob: string, fail_hard: boolean}): Promise` - -The `submit` method applies a transaction and sends it to the network to be confirmed and included in future ledgers. - -This method takes a signed, serialized transaction as a binary blob, and submits it to the network as-is. Since signed transaction objects are immutable, no part of the transaction can be modified or automatically filled in after submission. - -To send a transaction as robustly as possible, you should construct and sign it in advance, persist it somewhere that you can access even after a power outage, then `submit` it as a `tx_blob`. After submission, monitor the network with the `tx` method to see if the transaction was successfully applied; if a restart or other problem occurs, you can safely re-submit the `tx_blob` transaction: it won't be applied twice since it has the same sequence number as the old transaction. - -### Parameters - -| `Field` | Type | Description | -|:------------|:--------|:-----------------------------------------------------| -| `tx_blob` | String | Hex representation of the signed transaction to submit. This can be a multi-signed transaction. | -| `fail_hard` | Boolean | (Optional, defaults to false) If true, and the transaction fails locally, do not retry or relay the transaction to other servers | - -### Return Value - -When successful, this method returns an object containing the following fields: - -| `Field` | Type | Description | -|:------------------------|:--------|:-----------------------------------------| -| `engine_result` | String | Text [result code](https://xrpl.org/transaction-results.html) indicating the preliminary result of the transaction, for example `tesSUCCESS` | -| `engine_result_code` | Integer | Numeric version of the [result code](https://xrpl.org/transaction-results.html). **Not recommended.** | -| `engine_result_message` | String | Human-readable explanation of the transaction's preliminary result | -| `tx_blob` | String | The complete transaction in hex string format | -| `tx_json` | Object | The complete transaction in JSON format | -| `accepted` | Boolean | The value `true` indicates that the transaction was applied, queued, broadcast, or kept for later. The value `false` indicates that none of those happened, so the transaction cannot possibly succeed as long as you do not submit it again and have not already submitted it another time. [New in: rippled 1.5.0] | -| `account_sequence_available` | Number | The next [Sequence Number](https://xrpl.org/basic-data-types.html#account-sequence) available for the sending account after all pending and [queued](https://xrpl.org/transaction-queue.html) transactions. [New in: rippled 1.5.0] | -| `account_sequence_next` | number | The next [Sequence Number](https://xrpl.org/basic-data-types.html#account-sequence) for the sending account after all transactions that have been provisionally applied, but not transactions in the [queue](https://xrpl.org/transaction-queue.html). [New in: rippled 1.5.0] | -| `applied` | Boolean | The value `true` indicates that this transaction was applied to the open ledger. In this case, the transaction is likely, but not guaranteed, to be validated in the next ledger version. [New in: rippled 1.5.0] | -| `broadcast` | Boolean | The value `true` indicates this transaction was broadcast to peer servers in the peer-to-peer XRP Ledger network. (Note: if the server has no peers, such as in [stand-alone mode](https://xrpl.org/rippled-server-modes.html#reasons-to-run-a-rippled-server-in-stand-alone-mode), the server uses the value `true` for cases where it _would_ have broadcast the transaction.) The value `false` indicates the transaction was not broadcast to any other servers. [New in: rippled 1.5.0] | -| `kept` | Boolean | The value `true` indicates that the transaction was kept to be retried later. [New in: rippled 1.5.0] | -| `queued` | Boolean | The value `true` indicates the transaction was put in the [Transaction Queue](https://xrpl.org/transaction-queue.html), which means it is likely to be included in a future ledger version. [New in: rippled 1.5.0] | -| `open_ledger_cost` | String | The current [open ledger cost](https://xrpl.org/transaction-cost.html#open-ledger-cost) before processing this transaction. Transactions with a lower cost are likely to be [queued](https://xrpl.org/transaction-queue.html). [New in: rippled 1.5.0] | -| `validated_ledger_index` | Integer | The [ledger index](https://xrpl.org/basic-data-types.html#ledger-index) of the newest validated ledger at the time of submission. This provides a lower bound on the ledger versions that the transaction can appear in as a result of this request. (The transaction could only have been validated in this ledger version or earlier if it had already been submitted before.) | - -Note: Many situations can prevent a transaction from processing successfully, such as a lack of trust lines connecting the two accounts in a payment, or changes in the state of the ledger since the time the transaction was constructed. Even if nothing is wrong, it may take several seconds to close and validate the ledger version that includes the transaction. Do not consider the transaction's results final until they appear in a validated ledger version. - -### Example - -```javascript -const signedTransaction = '12000022800000002400000007201B007008BC61400000000754D4C068400000000000000C732103E8110048477E60F292DEDA67CF518511E70A15E1E3771B3C024026E1F824832874473045022100D659C836C24FF346A87054E463078D805B19EFE9F10348FD4C6ED6C3F3C4D750022060BE0BFD5E2C4963A1B0E0F21D5BA800969863BA486F71E75C08D76D77C45B22811492F80A3F3849DBB5714A4F2C691CE7D47BEED58083141266204CFBC657E65D9B4D30301FF98644693935'; -const failHard = false; -const result = await api.request('submit', { - tx_blob: signedTransaction, - fail_hard: failHard // optional -}); -``` - -```json -{ - "accepted": true, - "account_sequence_available": 8, - "account_sequence_next": 8, - "applied": true, - "broadcast": true, - "engine_result": "tesSUCCESS", - "engine_result_code": 0, - "engine_result_message": "The transaction was applied. Only final in a validated ledger.", - "kept": true, - "open_ledger_cost": "10", - "queued": false, - "tx_blob": "12000022800000002400000007201B007008BC61400000000754D4C068400000000000000C732103E8110048477E60F292DEDA67CF518511E70A15E1E3771B3C024026E1F824832874473045022100D659C836C24FF346A87054E463078D805B19EFE9F10348FD4C6ED6C3F3C4D750022060BE0BFD5E2C4963A1B0E0F21D5BA800969863BA486F71E75C08D76D77C45B22811492F80A3F3849DBB5714A4F2C691CE7D47BEED58083141266204CFBC657E65D9B4D30301FF98644693935", - "tx_json": { - "Account": "rNQao3Z1irwRjKWSs8heL4a8WKLPKfLrXs", - "Amount": "123000000", - "Destination": "rpgHWJdXkSvvzikdJCpuMzU7zWnuqsJRCZ", - "Fee": "12", - "Flags": 2147483648, - "LastLedgerSequence": 7342268, - "Sequence": 7, - "SigningPubKey": "03E8110048477E60F292DEDA67CF518511E70A15E1E3771B3C024026E1F8248328", - "TransactionType": "Payment", - "TxnSignature": "3045022100D659C836C24FF346A87054E463078D805B19EFE9F10348FD4C6ED6C3F3C4D750022060BE0BFD5E2C4963A1B0E0F21D5BA800969863BA486F71E75C08D76D77C45B22", - "hash": "FE8D68D7FF5805EB07AF15A1ADF07FB5463CCD2C6C0A15981EB3D26A02E1551C" - }, - "validated_ledger_index": 7341775 -} -``` - -(In ripple-lib 1.8.0, [the old `submit` method](https://github.com/ripple/ripple-lib/blob/1.7.0/docs/index.md#submit) was deprecated.) - -## generateXAddress - -`generateXAddress(options?: object): {address: string, secret: string}` - -Generate a new XRP Ledger address and corresponding secret. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -options | object | *Optional* Options to control how the address and secret are generated. -*options.* algorithm | string | *Optional* The digital signature algorithm to generate an address for. Can be `ecdsa-secp256k1` (default) or `ed25519`. -*options.* entropy | array\ | *Optional* The entropy to use to generate the seed. Must be an array of length 16 with values from 0-255 (16 bytes of entropy) -*options.* includeClassicAddress | boolean | *Optional* Specifies whether the classic address should also be included in the returned payload. -*options.* test | boolean | *Optional* Specifies whether the address is intended for use on a test network such as Testnet or Devnet. If `true`, the address should only be used for testing, and starts with `T`. If `false`, the address should only be used on Mainnet, and starts with `X`. - -### Return Value - -This method returns an object with the following structure: - -Name | Type | Description ----- | ---- | ----------- -xAddress | [xAddress](#x-address) | A randomly generated XRP Ledger address in X-address format. -secret | secret string | The secret corresponding to the address. - -### Example - -```javascript -return api.generateXAddress(); -``` - - -```json -{ - "xAddress": "XVLcsWWNiFdUEqoDmSwgxh1abfddG1LtbGFk7omPgYpbyE8", - "secret": "sp6JS7f14BuwFY8Mw6bTtLKWauoUs" -} -``` - - -## generateAddress - -`generateAddress(options?: object): {address: string, secret: string}` - -Deprecated: This method returns a classic address. If you do not need the classic address, use `generateXAddress` instead. - -Generate a new XRP Ledger address and corresponding secret. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -options | object | *Optional* Options to control how the address and secret are generated. -*options.* algorithm | string | *Optional* The digital signature algorithm to generate an address for. Can be `ecdsa-secp256k1` (default) or `ed25519`. -*options.* entropy | array\ | *Optional* The entropy to use to generate the seed. Must be an array of length 16 with values from 0-255 (16 bytes of entropy) -*options.* includeClassicAddress | boolean | *Optional* If `true`, also return the classic address. -*options.* test | boolean | *Optional* Specifies whether the address is intended for use on a test network such as Testnet or Devnet. If `true`, the address should only be used for testing, and starts with `T`. If `false`, the address should only be used on Mainnet, and starts with `X`. - -### Return Value - -This method returns an object with the following structure: - -Name | Type | Description ----- | ---- | ----------- -xAddress | [xAddress](#x-address) | A randomly generated XRP Ledger address in X-address format. -classicAddress | [classicAddress](#classic-address) | A randomly generated XRP Ledger Account ID (classic address). -address | [classicAddress](#classic-address) | Deprecated: Use `classicAddress` instead. -secret | secret string | The secret corresponding to the address. - -### Example - -```javascript -return api.generateAddress(); -``` - - -```json -{ - "xAddress": "XVLcsWWNiFdUEqoDmSwgxh1abfddG1LtbGFk7omPgYpbyE8", - "classicAddress": "rGCkuB7PBr5tNy68tPEABEtcdno4hE6Y7f", - "address": "rGCkuB7PBr5tNy68tPEABEtcdno4hE6Y7f", - "secret": "sp6JS7f14BuwFY8Mw6bTtLKWauoUs" -} -``` - - -## isValidAddress - -`isValidAddress(address: string): boolean` - -Checks if the specified string contains a valid address. X-addresses are considered valid with ripple-lib v1.4.0 and higher. - -### Parameters - -This method takes one parameter, the address to validate. - -### Return Value - -This method returns `true` if the address is valid and `false` if it is not. - -### Example - -```javascript -return api.isValidAddress("address") -``` - -## isValidSecret - -`isValidSecret(secret: string): boolean` - -Checks if the specified string contains a valid secret. - -### Parameters - -This method takes one parameter, the secret which to validate. - -### Return Value - -This method returns `true` if the secret is valid and `false` if it is not. - -### Example - -```javascript -return api.isValidSecret("secret") -``` - -## deriveKeypair - -`deriveKeypair(seed: string): {privateKey: string, publicKey: string}` - -Derive a public and private key from a seed. - -### Parameters - -This method takes one parameter, the seed from which to derive the public and private key. - -### Return Value - -This method returns an object containing the public and private components of the keypair corresponding to the seed. - -### Example - -```javascript -var keypair = api.deriveKeypair(seed) -var public_key = keypair.publicKey; -var private_key = keypair.privateKey; -``` - -## deriveAddress - -`deriveAddress(publicKey: string): string` - -Derive an XRP Ledger address from a public key. - -### Parameters - -This method takes one parameter, the public key from which to derive the address. - -### Return Value - -This method returns a string corresponding to the address derived from the public key. - -### Example - -```javascript -var address = api.deriveAddress(public_key); -``` - -## generateFaucetWallet - -`generateFaucetWallet(onTestnet = true)` - -Calls the Testnet or Devnet faucet API in order to generate a new, random wallet with some amount of test XRP. This is for testing purposes only. - -### Example - -**Request** - -Create a new wallet on the Testnet: - -```javascript -const wallet = await api.generateFaucetWallet() -``` - -**Response** - - -```json -{ - "account": { - "xAddress": "T7i2Q8yGcMcCQa2n6d9EvSEptT4CE6ap7Q1r1fmjstkLfsK", - "secret": "ssKCsaRqWh669atvv83bdYRaiHomY", - "classicAddress": "r9SYfmVxrb7iuCVfNhW2gqqzapfE2r6juG", - "address": "r9SYfmVxrb7iuCVfNhW2gqqzapfE2r6juG" - }, - "amount": 1000, - "balance": 1000 -} -``` - - -## signPaymentChannelClaim - -`signPaymentChannelClaim(channel: string, amount: string, privateKey: string): string` - -Sign a payment channel claim. A [PaymentChannelClaim](#preparepaymentchannelclaim) transaction can use the resulting signature to withdraw XRP from a payment channel. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -channel | string | 256-bit hexadecimal channel identifier. -amount | [value](#value) | Amount of XRP authorized by the claim. -privateKey | string | The private key to sign the payment channel claim. - -### Return Value - -This method returns a signature string: - -Name | Type | Description ----- | ---- | ----------- - | string | The hexadecimal representation of a signature. - -### Example - -```javascript -const channel = - '3E18C05AD40319B809520F1A136370C4075321B285217323396D6FD9EE1E9037'; -const amount = '.00001'; -const privateKey = - 'ACCD3309DB14D1A4FC9B1DAE608031F4408C85C73EE05E035B7DC8B25840107A'; -return api.signPaymentChannelClaim(channel, amount, privateKey); -``` - - -```json -"3045022100B5C54654221F154347679B97AE7791CBEF5E6772A3F894F9C781B8F1B400F89F022021E466D29DC5AEB5DFAFC76E8A88D2E388EBD25A84143B6AC3B647F479CB89B7" -``` - - -## verifyPaymentChannelClaim - -`verifyPaymentChannelClaim(channel: string, amount: string, signature: string, publicKey: string): boolean` - -Verify a payment channel claim signature. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -channel | string | 256-bit hexadecimal channel identifier. -amount | [value](#value) | Amount of XRP authorized by the claim. -signature | string | Signature of this claim. -publicKey | string | Public key of the channel's sender - -### Return Value - -This method returns `true` if the claim signature is valid. - -Name | Type | Description ----- | ---- | ----------- - | boolean | - -### Example - -```javascript -const channel = - '3E18C05AD40319B809520F1A136370C4075321B285217323396D6FD9EE1E9037'; -const amount = '.00001'; -const signature = "3045022100B5C54654221F154347679B97AE7791CBEF5E6772A3F894F9C781B8F1B400F89F022021E466D29DC5AEB5DFAFC76E8A88D2E388EBD25A84143B6AC3B647F479CB89B7"; -const publicKey = - '02F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8'; -return api.verifyPaymentChannelClaim(channel, amount, signature, publicKey); -``` - -```json -true -``` - -## computeLedgerHash - -`computeLedgerHash(ledger: object): string` - -Compute the hash of a ledger. - -### Parameters - - - -Name | Type | Description ----- | ---- | ----------- -ledger | object | The ledger header to hash. -*ledger.* stateHash | string | Hash of all state information in this ledger. -*ledger.* closeTime | date-time string | The approximate time when this ledger was closed. This number is rounded based on the `closeTimeResolution`. If it would have been rounded to the same time as a previous ledger, the close time is recorded as 1 second later instead. -*ledger.* closeTimeResolution | integer | A number of seconds, indicating how much the `closeTime` could be rounded. Ledger close times are approximate so that small differences in servers clocks don't hinder consensus. -*ledger.* closeFlags | integer | A bit-map of flags relating to the closing of this ledger. Currently, the ledger has only one flag defined for `closeFlags`: **sLCF_NoConsensusTime** (value 1). If this flag is enabled, it means that validators disagreed on the correct close time for the ledger, but built otherwise the same ledger, so they declared consensus while "agreeing to disagree" on the close time. In this case, the consensus ledger contains a `closeTime` value that is 1 second after that of the previous ledger. (In this case, there is no official close time, but the actual real-world close time is probably 3-6 seconds later than the specified `closeTime`.) -*ledger.* ledgerHash | string | Unique identifying hash of the entire ledger. -*ledger.* ledgerVersion | integer | The ledger version of this ledger. -*ledger.* ledgerVersion | string | The ledger version of this ledger. -*ledger.* parentLedgerHash | string | Unique identifying hash of the ledger that came immediately before this one. -*ledger.* parentCloseTime | date-time string | The previous ledger's recorded close time. -*ledger.* totalDrops | [value](#value) | Total number of drops (1/1,000,000th of an XRP) in the network, as a quoted integer. (This decreases as transaction fees cause XRP to be destroyed.) -*ledger.* transactionHash | string | Hash of the transaction information included in this ledger. -*ledger.* rawState | string | *Optional* A JSON string containing all state data for this ledger in rippled JSON format. -*ledger.* stateHashes | array\ | *Optional* An array of hashes of all state data in this ledger. -*ledger.* transactionHashes | array\<[transactionHash](#transaction-id)\> | *Optional* An array of hashes of all transactions that were validated in this ledger. -*ledger.* transactions | array\<[getTransaction](#gettransaction)\> | *Optional* Array of all transactions that were validated in this ledger. Transactions are represented in the same format as the return value of [getTransaction](#gettransaction). - -### Return Value - -This method returns an uppercase hexadecimal string representing the hash of the ledger. - -### Example - -```javascript -const ledger = { - "stateHash": "D9ABF622DA26EEEE48203085D4BC23B0F77DC6F8724AC33D975DA3CA492D2E44", - "closeTime": "2015-08-12T01:01:10.000Z", - "parentCloseTime": "2015-08-12T01:01:00.000Z", - "closeFlags": 0, - "closeTimeResolution": 10, - "ledgerVersion": 15202439, - "parentLedgerHash": "12724A65B030C15A1573AA28B1BBB5DF3DA4589AA3623675A31CAE69B23B1C4E", - "totalDrops": "99998831688050493", - "transactionHash": "325EACC5271322539EEEC2D6A5292471EF1B3E72AE7180533EFC3B8F0AD435C8" -}; -return api.computeLedgerHash(ledger); -``` - -```json -"F4D865D83EB88C1A1911B9E90641919A1314F36E1B099F8E95FE3B7C77BE3349" -``` - -## xrpToDrops - -`xrpToDrops(xrp: string | BigNumber): string` - -Converts an XRP amount to drops. 1 XRP = 1,000,000 drops, so 1 drop = 0.000001 XRP. This method is useful when converting amounts for use with the rippled API, which requires XRP amounts to be specified in drops. - -### Parameters - -`xrp`: A string or BigNumber representing an amount of XRP. If `xrp` is a string, it may start with `-`, must contain at least one number, and may contain up to one `.`. This method throws a `ValidationError` for invalid input. - -### Return Value - -A string representing an equivalent amount of drops. - -### Example - -```javascript -return api.xrpToDrops('1'); -``` - -```json -'1000000' -``` - -## dropsToXrp - -`dropsToXrp(drops: string | BigNumber): string` - -Converts an amount of drops to XRP. 1 drop = 0.000001 XRP, so 1 XRP = 1,000,000 drops. This method is useful when converting amounts from the rippled API, which describes XRP amounts in drops. - -### Parameters - -`drops`: A string or BigNumber representing an amount of drops. If `drops` is a string, it may start with `-` and must contain at least one number. This method throws a `ValidationError` for invalid input. - -### Return Value - -A string representing an equivalent amount of XRP. - -### Example - -```javascript -return api.dropsToXrp('1'); -``` - -```json -'0.000001' -``` - -## iso8601ToRippleTime - -`iso8601ToRippleTime(iso8601: string): number` - -This method parses a string representation of a date, and returns the number of seconds since the "Ripple Epoch" of January 1, 2000 (00:00 UTC). - -The Ripple Epoch is 946684800 seconds after the Unix Epoch. - -This method is useful for creating timestamps to use with the rippled APIs. The rippled APIs represent time as an unsigned integer of the number of seconds since the Ripple Epoch. - -### Parameters - -`iso8601`: A string representing a date and time. This string is parsed using JavaScript's `Date.parse()` method. - -### Return Value - -The number of seconds since the Ripple Epoch. - -### Example - -```javascript -api.iso8601ToRippleTime('2017-02-17T15:04:57Z'); -``` - -```json -540659097 -``` - -## rippleTimeToISO8601 - -`rippleTimeToISO8601(rippleTime: number): string` - -This method takes the number of seconds since the "Ripple Epoch" of January 1, 2000 (00:00 UTC) and returns a string representation of a date. - -The Ripple Epoch is 946684800 seconds after the Unix Epoch. - -This method is useful for interpreting timestamps returned by the rippled APIs. The rippled APIs represent time as an unsigned integer of the number of seconds since the Ripple Epoch. - -### Parameters - -`rippleTime`: A number of seconds since the Ripple Epoch. - -### Return Value - -A string representing a date and time, created by calling a `Date` object's `toISOString()` method. - -### Example - -```javascript -api.rippleTimeToISO8601(540659097); -``` - -```json -'2017-02-17T15:04:57.000Z' -``` - -## txFlags - -`txFlags.TRANSACTION_TYPE.FLAG` - -This object provides constants for use when creating or interpreting transaction flags. Most transactions have a set of bit-flags that represent various options that affect how a transaction should behave. These options are represented as binary values that can be combined with bitwise-or operations to encode multiple flags at once. - -Most flags only have meaning for a specific transaction type. The same bitwise value may be reused for flags on different transaction types, so it is important to pay attention to the transaction type when setting and reading flags. - -Bits that are not defined as flags MUST be 0. - -### Global Flag - -Applies globally to all transactions. - -`txFlags.Universal.FullyCanonicalSig`: Require a fully-canonical signature. When preparing transactions, ripple-lib enables this flag for you. - -### Payment Flags - -`txFlags.Payment.NoRippleDirect`: Do not use the default path; only use specified paths. This is intended to force the transaction to take arbitrage opportunities. Most clients do not need this. - -`txFlags.Payment.PartialPayment`: If the specified destination amount cannot be sent without spending more than the source maxAmount, reduce the received amount instead of failing outright. See [Partial Payments](https://xrpl.org/partial-payments.html) for more details. - -`txFlags.Payment.LimitQuality`: Only take paths where all the conversions have an input:output ratio that is equal or better than the ratio of `destination.amount`:`source.maxAmount`. See [Limit Quality](https://xrpl.org/payment.html#limit-quality) for details. - -### OfferCreate Flags - -`txFlags.OfferCreate.Passive`: If enabled, the offer does not consume offers that exactly match it, and instead becomes an Offer object in the ledger. It still consumes offers that cross it. - -`txFlags.OfferCreate.ImmediateOrCancel`: Treat the offer as an Immediate or Cancel order. If enabled, the offer never becomes a ledger object: it only tries to match existing offers in the ledger. - -`txFlags.OfferCreate.FillOrKill`: Treat the offer as a Fill or Kill order. - -`txFlags.OfferCreate.Sell`: Treat the offer as a Sell order. With `order.direction = 'sell'`, exchange the entire `order.quantity`, even if it means obtaining more than the `order.totalPrice` amount in exchange. If using `prepareOrder`, ripple-lib sets this flag for you. - -### TrustSet Flags - -`txFlags.TrustSet.SetAuth`: Authorize the other party to hold issuances from this account. (No effect unless using the AccountSet.RequireAuth flag.) Cannot be unset. - -`txFlags.TrustSet.NoRipple`: Obsolete. - -`txFlags.TrustSet.SetNoRipple`: Blocks [rippling](https://xrpl.org/rippling.html) between two trustlines of the same currency, if this flag is set on both. - -`txFlags.TrustSet.ClearNoRipple`: Clears the No-[Rippling](https://xrpl.org/rippling.html) flag. - -`txFlags.TrustSet.SetFreeze`: Freeze the trustline. A non-XRP currency can be frozen by the exchange or gateway that issued it. XRP cannot be frozen. - -`txFlags.TrustSet.ClearFreeze`: Unfreeze the trustline. - -### AccountSet Flags - -You can use the `prepareSettings` method to change your account flags. This method uses AccountSet flags internally. - -In the rippled API, Account Flags can be enabled and disabled with the SetFlag and ClearFlag parameters. See [AccountSet Flags](https://xrpl.org/accountset.html#accountset-flags). - -The AccountSet transaction type has some transaction flags, but their use is discouraged. - -* `txFlags.AccountSet.RequireDestTag` -* `txFlags.AccountSet.OptionalDestTag` -* `txFlags.AccountSet.RequireAuth` -* `txFlags.AccountSet.OptionalAuth` -* `txFlags.AccountSet.DisallowXRP` -* `txFlags.AccountSet.AllowXRP` - -### PaymentChannelClaim Flags - -`txFlags.PaymentChannelClaim.Renew`: Clear the channel's Expiration time. (Expiration is different from the channel's immutable CancelAfter time.) Only the source address of the payment channel can use this flag. - -`txFlags.PaymentChannelClaim.Close`: Request to close the channel. Only the channel source and destination addresses can use this flag. This flag closes the channel immediately if it has no more XRP allocated to it after processing the current claim, or if the destination address uses it. If the source address uses this flag when the channel still holds XRP, this schedules the channel to close after SettleDelay seconds have passed. (Specifically, this sets the Expiration of the channel to the close time of the previous ledger plus the channel's SettleDelay time, unless the channel already has an earlier Expiration time.) If the destination address uses this flag when the channel still holds XRP, any XRP that remains after processing the claim is returned to the source address. - -### Other Transaction Types - -The remaining transaction types do not have any flags at this time. - -* OfferCancel -* SetRegularKey -* SignerListSet -* EscrowCreate -* EscrowFinish -* EscrowCancel -* PaymentChannelCreate -* PaymentChannelFund - -## AccountSet Flags - -To modify account flags, you can use an AccountSet transaction and its `SetFlag` or `ClearFlag` fields. - -The flags are called [AccountSet flags (asf*)](https://xrpl.org/accountset.html#accountset-flags): - -`RippleAPI.accountSetFlags.requireDestinationTag`: Require a destination tag to send transactions to this account. - -`RippleAPI.accountSetFlags.requireAuthorization`: Require authorization for users to hold balances issued by this address. Can only be enabled if the address has no trust lines connected to it. - -`RippleAPI.accountSetFlags.disallowIncomingXRP`: XRP should not be sent to this account. (Enforced by client applications, not by rippled) - -`RippleAPI.accountSetFlags.disableMasterKey`: Disallow use of the master key pair. Can only be enabled if the account has configured another way to sign transactions. - -`RippleAPI.accountSetFlags.enableTransactionIDTracking`: Track the ID of this account's most recent transaction. - -`RippleAPI.accountSetFlags.noFreeze`: Permanently give up the ability to freeze individual trust lines or disable Global Freeze. This flag can never be disabled after being enabled. - -`RippleAPI.accountSetFlags.globalFreeze`: Freeze all assets issued by this account. - -`RippleAPI.accountSetFlags.defaultRipple`: Enable [rippling](https://xrpl.org/rippling.html) on this account's trust lines by default. - -`RippleAPI.accountSetFlags.depositAuth`:Enable Deposit Authorization on this account. - -## schemaValidator - -Unlike the rest of the ripple-lib API, schemaValidator is a static object on RippleAPI. It provides utility methods that do not use a server. - -## schemaValidate - -`RippleAPI.schemaValidator.schemaValidate(schemaName: string, object: any): void` - -This method checks an object for conformance to a specified schema. It does not return anything, but throws a `ValidationError` if the object does not conform to the schema. - -### Example - -```javascript -RippleAPI.schemaValidator.schemaValidate('sign', { - signedTransaction: '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8744630440220680070A157682D9EB510E8AD58C35DC9C8346B155077D73792E88120B7A3B6B1022079537D3300C9B4D2D3D62ACCE1E66CDA893F9612CB2577ADEC8154B933765336770B6578616D706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304', - id: '10B54D31384A49336C36A5907E3C28227139E282D3C7F734FEA351DE446F3674' -}) -``` - -```json -undefined -``` - -If the object is valid (conforms to the schema), nothing is returned. Otherwise, `schemaValidate` throws an error: - -```javascript -RippleAPI.schemaValidator.schemaValidate('sign', { - signedTransaction: '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8744630440220680070A157682D9EB510E8AD58C35DC9C8346B155077D73792E88120B7A3B6B1022079537D3300C9B4D2D3D62ACCE1E66CDA893F9612CB2577ADEC8154B933765336770B6578616D706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304', - id: '123' -}) -``` - -``` -[ValidationError(instance.id does not match pattern "^[A-F0-9]{64}$")] -``` - -# API Events - -## ledger - -This event is emitted whenever a new ledger version is validated on the connected server. - -### Return Value - -Name | Type | Description ----- | ---- | ----------- -baseFeeXRP | [value](#value) | Base fee, in XRP. -ledgerHash | string | Unique hash of the ledger that was closed, as hex. -ledgerTimestamp | date-time string | The time at which this ledger closed. -reserveBaseXRP | [value](#value) | The minimum reserve, in XRP, that is required for an account. -reserveIncrementXRP | [value](#value) | The increase in account reserve that is added for each item the account owns, such as offers or trust lines. -transactionCount | integer | Number of new transactions included in this ledger. -ledgerVersion | integer | Ledger version of the ledger that closed. -ledgerVersion | string | Ledger version of the ledger that closed. -validatedLedgerVersions | string | Range of ledgers that the server has available. This may be discontiguous. - -### Example - -```javascript -api.on('ledger', ledger => { - console.log(JSON.stringify(ledger, null, 2)); -}); -``` - - -```json -{ - "baseFeeXRP": "0.00001", - "ledgerVersion": 14804627, - "ledgerHash": "9141FA171F2C0CE63E609466AF728FF66C12F7ACD4B4B50B0947A7F3409D593A", - "ledgerTimestamp": "2015-07-23T05:50:40.000Z", - "reserveBaseXRP": "20", - "reserveIncrementXRP": "5", - "transactionCount": 19, - "validatedLedgerVersions": "13983423-14804627" -} -``` - - -## error - -This event is emitted when there is an error on the connection to the server that cannot be associated to a specific request. - -### Return Value - -The first parameter is a string indicating the error type: -* `badMessage` - rippled returned a malformed message -* `websocket` - the websocket library emitted an error -* one of the error codes found in the [`rippled` Universal Errors](https://xrpl.org/error-formatting.html#universal-errors). - -The second parameter is a message explaining the error. - -The third parameter is: -* the message that caused the error for `badMessage` -* the error object emitted for `websocket` -* the parsed response for rippled errors - -### Example - -```javascript -api.on('error', (errorCode, errorMessage, data) => { - console.log(errorCode + ': ' + errorMessage); -}); -``` - -``` -tooBusy: The server is too busy to help you now. -``` - -## connected - -This event is emitted after connection successfully opened. - -### Example - -```javascript -api.on('connected', () => { - console.log('Connection is open now.'); -}); -``` - -## disconnected - -This event is emitted when connection is closed. - -### Return Value - -The only parameter is a number containing the [close code](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) send by the server. - -### Example - -```javascript -api.on('disconnected', (code) => { - if (code !== 1000) { - console.log('Connection is closed due to error.'); - } else { - console.log('Connection is closed normally.'); - } -}); -``` - diff --git a/docs/interfaces/AccountChannelsRequest.html b/docs/interfaces/AccountChannelsRequest.html new file mode 100644 index 00000000..c22182b0 --- /dev/null +++ b/docs/interfaces/AccountChannelsRequest.html @@ -0,0 +1,283 @@ + + + + + + AccountChannelsRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountChannelsRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + AccountChannelsRequest +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

account

+
account: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "account_channels"
+ +
+
+ +

Optional destination_account

+
destination_account: string
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

limit

+
limit: number
+ +
+
+ +

Optional marker

+
marker: unknown
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountChannelsResponse.html b/docs/interfaces/AccountChannelsResponse.html new file mode 100644 index 00000000..efc17ed8 --- /dev/null +++ b/docs/interfaces/AccountChannelsResponse.html @@ -0,0 +1,345 @@ + + + + + + AccountChannelsResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountChannelsResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + AccountChannelsResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { account: string; channels: Channel[]; ledger_hash: string; ledger_index: number; limit?: number; marker?: unknown; validated?: boolean }
+ +
+

Type declaration

+
    +
  • +
    account: string
    +
  • +
  • +
    channels: Channel[]
    +
  • +
  • +
    ledger_hash: string
    +
  • +
  • +
    ledger_index: number
    +
  • +
  • +
    Optional limit?: number
    +
  • +
  • +
    Optional marker?: unknown
    +
  • +
  • +
    Optional validated?: boolean
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountCurrenciesRequest.html b/docs/interfaces/AccountCurrenciesRequest.html new file mode 100644 index 00000000..6c0f05d2 --- /dev/null +++ b/docs/interfaces/AccountCurrenciesRequest.html @@ -0,0 +1,269 @@ + + + + + + AccountCurrenciesRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountCurrenciesRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + AccountCurrenciesRequest +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

account

+
account: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "account_currencies"
+ +
+
+ +

Optional destination_account

+
destination_account: string
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional strict

+
strict: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountCurrenciesResponse.html b/docs/interfaces/AccountCurrenciesResponse.html new file mode 100644 index 00000000..c1d9383b --- /dev/null +++ b/docs/interfaces/AccountCurrenciesResponse.html @@ -0,0 +1,339 @@ + + + + + + AccountCurrenciesResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountCurrenciesResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + AccountCurrenciesResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { ledger_hash?: string; ledger_index: number; receive_currencies: string[]; send_currencies: string[]; validated: boolean }
+ +
+

Type declaration

+
    +
  • +
    Optional ledger_hash?: string
    +
  • +
  • +
    ledger_index: number
    +
  • +
  • +
    receive_currencies: string[]
    +
  • +
  • +
    send_currencies: string[]
    +
  • +
  • +
    validated: boolean
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountInfoRequest.html b/docs/interfaces/AccountInfoRequest.html new file mode 100644 index 00000000..c313c55e --- /dev/null +++ b/docs/interfaces/AccountInfoRequest.html @@ -0,0 +1,283 @@ + + + + + + AccountInfoRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountInfoRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + AccountInfoRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

account

+
account: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "account_info"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional queue

+
queue: boolean
+ +
+
+ +

Optional signer_lists

+
signer_lists: boolean
+ +
+
+ +

Optional strict

+
strict: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountInfoResponse.html b/docs/interfaces/AccountInfoResponse.html new file mode 100644 index 00000000..c1fc026c --- /dev/null +++ b/docs/interfaces/AccountInfoResponse.html @@ -0,0 +1,342 @@ + + + + + + AccountInfoResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountInfoResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + AccountInfoResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { account_data: default; ledger_current_index?: number; ledger_index?: number; queue_data?: QueueData; signer_lists?: default[]; validated?: boolean }
+ +
+

Type declaration

+
    +
  • +
    account_data: default
    +
  • +
  • +
    Optional ledger_current_index?: number
    +
  • +
  • +
    Optional ledger_index?: number
    +
  • +
  • +
    Optional queue_data?: QueueData
    +
  • +
  • +
    Optional signer_lists?: default[]
    +
  • +
  • +
    Optional validated?: boolean
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountLinesRequest.html b/docs/interfaces/AccountLinesRequest.html new file mode 100644 index 00000000..7669c423 --- /dev/null +++ b/docs/interfaces/AccountLinesRequest.html @@ -0,0 +1,283 @@ + + + + + + AccountLinesRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountLinesRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + AccountLinesRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

account

+
account: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "account_lines"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional limit

+
limit: number
+ +
+
+ +

Optional marker

+
marker: unknown
+ +
+
+ +

Optional peer

+
peer: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountLinesResponse.html b/docs/interfaces/AccountLinesResponse.html new file mode 100644 index 00000000..3693eab4 --- /dev/null +++ b/docs/interfaces/AccountLinesResponse.html @@ -0,0 +1,342 @@ + + + + + + AccountLinesResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountLinesResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + AccountLinesResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { account: string; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; lines: Trustline[]; marker?: unknown }
+ +
+

Type declaration

+
    +
  • +
    account: string
    +
  • +
  • +
    Optional ledger_current_index?: number
    +
  • +
  • +
    Optional ledger_hash?: string
    +
  • +
  • +
    Optional ledger_index?: number
    +
  • +
  • +
    lines: Trustline[]
    +
  • +
  • +
    Optional marker?: unknown
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountObjectsRequest.html b/docs/interfaces/AccountObjectsRequest.html new file mode 100644 index 00000000..b6164c44 --- /dev/null +++ b/docs/interfaces/AccountObjectsRequest.html @@ -0,0 +1,297 @@ + + + + + + AccountObjectsRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountObjectsRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + AccountObjectsRequest +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

account

+
account: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "account_objects"
+ +
+
+ +

Optional deletion_blockers_only

+
deletion_blockers_only: boolean
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional limit

+
limit: number
+ +
+
+ +

Optional marker

+
marker: unknown
+ +
+
+ +

Optional type

+
type: AccountObjectType
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountObjectsResponse.html b/docs/interfaces/AccountObjectsResponse.html new file mode 100644 index 00000000..5bb186ba --- /dev/null +++ b/docs/interfaces/AccountObjectsResponse.html @@ -0,0 +1,348 @@ + + + + + + AccountObjectsResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountObjectsResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + AccountObjectsResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { account: string; account_objects: AccountObject[]; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; limit?: number; marker?: string; validated?: boolean }
+ +
+

Type declaration

+
    +
  • +
    account: string
    +
  • +
  • +
    account_objects: AccountObject[]
    +
  • +
  • +
    Optional ledger_current_index?: number
    +
  • +
  • +
    Optional ledger_hash?: string
    +
  • +
  • +
    Optional ledger_index?: number
    +
  • +
  • +
    Optional limit?: number
    +
  • +
  • +
    Optional marker?: string
    +
  • +
  • +
    Optional validated?: boolean
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountOffersRequest.html b/docs/interfaces/AccountOffersRequest.html new file mode 100644 index 00000000..e5826837 --- /dev/null +++ b/docs/interfaces/AccountOffersRequest.html @@ -0,0 +1,283 @@ + + + + + + AccountOffersRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountOffersRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + AccountOffersRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

account

+
account: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "account_offers"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional limit

+
limit: number
+ +
+
+ +

Optional marker

+
marker: unknown
+ +
+
+ +

Optional strict

+
strict: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountOffersResponse.html b/docs/interfaces/AccountOffersResponse.html new file mode 100644 index 00000000..56126210 --- /dev/null +++ b/docs/interfaces/AccountOffersResponse.html @@ -0,0 +1,342 @@ + + + + + + AccountOffersResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountOffersResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + AccountOffersResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { account: string; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; marker?: unknown; offers?: AccountOffer[] }
+ +
+

Type declaration

+
    +
  • +
    account: string
    +
  • +
  • +
    Optional ledger_current_index?: number
    +
  • +
  • +
    Optional ledger_hash?: string
    +
  • +
  • +
    Optional ledger_index?: number
    +
  • +
  • +
    Optional marker?: unknown
    +
  • +
  • +
    Optional offers?: AccountOffer[]
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountTxRequest.html b/docs/interfaces/AccountTxRequest.html new file mode 100644 index 00000000..2a9af2b6 --- /dev/null +++ b/docs/interfaces/AccountTxRequest.html @@ -0,0 +1,325 @@ + + + + + + AccountTxRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountTxRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + AccountTxRequest +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

account

+
account: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional binary

+
binary: boolean
+ +
+
+ +

command

+
command: "account_tx"
+ +
+
+ +

Optional forward

+
forward: boolean
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional ledger_index_max

+
ledger_index_max: number
+ +
+
+ +

Optional ledger_index_min

+
ledger_index_min: number
+ +
+
+ +

Optional limit

+
limit: number
+ +
+
+ +

Optional marker

+
marker: unknown
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/AccountTxResponse.html b/docs/interfaces/AccountTxResponse.html new file mode 100644 index 00000000..92ff254f --- /dev/null +++ b/docs/interfaces/AccountTxResponse.html @@ -0,0 +1,345 @@ + + + + + + AccountTxResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface AccountTxResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + AccountTxResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { account: string; ledger_index_max: number; ledger_index_min: number; limit: number; marker?: unknown; transactions: AccountTransaction[]; validated?: boolean }
+ +
+

Type declaration

+
    +
  • +
    account: string
    +
  • +
  • +
    ledger_index_max: number
    +
  • +
  • +
    ledger_index_min: number
    +
  • +
  • +
    limit: number
    +
  • +
  • +
    Optional marker?: unknown
    +
  • +
  • +
    transactions: AccountTransaction[]
    +
  • +
  • +
    Optional validated?: boolean
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/BookOffersRequest.html b/docs/interfaces/BookOffersRequest.html new file mode 100644 index 00000000..d831966f --- /dev/null +++ b/docs/interfaces/BookOffersRequest.html @@ -0,0 +1,283 @@ + + + + + + BookOffersRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface BookOffersRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + BookOffersRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "book_offers"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional limit

+
limit: number
+ +
+
+ +

Optional taker

+
taker: string
+ +
+
+ +

taker_gets

+
taker_gets: TakerAmount
+ +
+
+ +

taker_pays

+
taker_pays: TakerAmount
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/BookOffersResponse.html b/docs/interfaces/BookOffersResponse.html new file mode 100644 index 00000000..0a39985f --- /dev/null +++ b/docs/interfaces/BookOffersResponse.html @@ -0,0 +1,336 @@ + + + + + + BookOffersResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface BookOffersResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + BookOffersResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; offers: BookOffer[] }
+ +
+

Type declaration

+
    +
  • +
    Optional ledger_current_index?: number
    +
  • +
  • +
    Optional ledger_hash?: string
    +
  • +
  • +
    Optional ledger_index?: number
    +
  • +
  • +
    offers: BookOffer[]
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/ChannelVerifyRequest.html b/docs/interfaces/ChannelVerifyRequest.html new file mode 100644 index 00000000..064909ec --- /dev/null +++ b/docs/interfaces/ChannelVerifyRequest.html @@ -0,0 +1,255 @@ + + + + + + ChannelVerifyRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ChannelVerifyRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + ChannelVerifyRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

amount

+
amount: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

channel_id

+
channel_id: string
+ +
+
+ +

command

+
command: "channel_verify"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

public_key

+
public_key: string
+ +
+
+ +

signature

+
signature: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/ChannelVerifyResponse.html b/docs/interfaces/ChannelVerifyResponse.html new file mode 100644 index 00000000..ecff1eb4 --- /dev/null +++ b/docs/interfaces/ChannelVerifyResponse.html @@ -0,0 +1,327 @@ + + + + + + ChannelVerifyResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ChannelVerifyResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + ChannelVerifyResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { signature_verified: boolean }
+ +
+

Type declaration

+
    +
  • +
    signature_verified: boolean
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/ConsensusStream.html b/docs/interfaces/ConsensusStream.html new file mode 100644 index 00000000..a50a12b8 --- /dev/null +++ b/docs/interfaces/ConsensusStream.html @@ -0,0 +1,183 @@ + + + + + + ConsensusStream | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ConsensusStream

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseStream +
      +
    • + ConsensusStream +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

consensus

+
consensus: "open" | "establish" | "accepted"
+ +
+
+ +

type

+
type: "consensusPhase"
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/DepositAuthorizedRequest.html b/docs/interfaces/DepositAuthorizedRequest.html new file mode 100644 index 00000000..59751b4f --- /dev/null +++ b/docs/interfaces/DepositAuthorizedRequest.html @@ -0,0 +1,255 @@ + + + + + + DepositAuthorizedRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DepositAuthorizedRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + DepositAuthorizedRequest +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "deposit_authorized"
+ +
+
+ +

destination_account

+
destination_account: string
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

source_account

+
source_account: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/DepositAuthorizedResponse.html b/docs/interfaces/DepositAuthorizedResponse.html new file mode 100644 index 00000000..4ac6c0c8 --- /dev/null +++ b/docs/interfaces/DepositAuthorizedResponse.html @@ -0,0 +1,345 @@ + + + + + + DepositAuthorizedResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DepositAuthorizedResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + DepositAuthorizedResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { deposit_authorized: boolean; destination_account: string; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; source_account: string; validated?: boolean }
+ +
+

Type declaration

+
    +
  • +
    deposit_authorized: boolean
    +
  • +
  • +
    destination_account: string
    +
  • +
  • +
    Optional ledger_current_index?: number
    +
  • +
  • +
    Optional ledger_hash?: string
    +
  • +
  • +
    Optional ledger_index?: number
    +
  • +
  • +
    source_account: string
    +
  • +
  • +
    Optional validated?: boolean
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/FeeRequest.html b/docs/interfaces/FeeRequest.html new file mode 100644 index 00000000..b9c98258 --- /dev/null +++ b/docs/interfaces/FeeRequest.html @@ -0,0 +1,199 @@ + + + + + + FeeRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface FeeRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + FeeRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "fee"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/FeeResponse.html b/docs/interfaces/FeeResponse.html new file mode 100644 index 00000000..b5ce0c3c --- /dev/null +++ b/docs/interfaces/FeeResponse.html @@ -0,0 +1,373 @@ + + + + + + FeeResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface FeeResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + FeeResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { current_ledger_size: string; current_queue_size: string; drops: { base_fee: string; median_fee: string; minimum_fee: string; open_ledger_fee: string }; expected_ledger_size: string; ledger_current_index: number; levels: { median_level: string; minimum_level: string; open_ledger_level: string; reference_level: string }; max_queue_size: string }
+ +
+

Type declaration

+
    +
  • +
    current_ledger_size: string
    +
  • +
  • +
    current_queue_size: string
    +
  • +
  • +
    drops: { base_fee: string; median_fee: string; minimum_fee: string; open_ledger_fee: string }
    +
      +
    • +
      base_fee: string
      +
    • +
    • +
      median_fee: string
      +
    • +
    • +
      minimum_fee: string
      +
    • +
    • +
      open_ledger_fee: string
      +
    • +
    +
  • +
  • +
    expected_ledger_size: string
    +
  • +
  • +
    ledger_current_index: number
    +
  • +
  • +
    levels: { median_level: string; minimum_level: string; open_ledger_level: string; reference_level: string }
    +
      +
    • +
      median_level: string
      +
    • +
    • +
      minimum_level: string
      +
    • +
    • +
      open_ledger_level: string
      +
    • +
    • +
      reference_level: string
      +
    • +
    +
  • +
  • +
    max_queue_size: string
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/FormattedOrderCancellation.html b/docs/interfaces/FormattedOrderCancellation.html new file mode 100644 index 00000000..6d77598d --- /dev/null +++ b/docs/interfaces/FormattedOrderCancellation.html @@ -0,0 +1,163 @@ + + + + + + FormattedOrderCancellation | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface FormattedOrderCancellation

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + FormattedOrderCancellation +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

orderSequence

+
orderSequence: number
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/FormattedOrderCancellationTransaction.html b/docs/interfaces/FormattedOrderCancellationTransaction.html new file mode 100644 index 00000000..932bf40b --- /dev/null +++ b/docs/interfaces/FormattedOrderCancellationTransaction.html @@ -0,0 +1,233 @@ + + + + + + FormattedOrderCancellationTransaction | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface FormattedOrderCancellationTransaction

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + FormattedOrderCancellationTransaction +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

address

+
address: string
+ +
+
+ +

id

+
id: string
+ +
+
+ +

outcome

+
outcome: Outcome
+ +
+
+ +

sequence

+
sequence: number
+ +
+
+ +

specification

+ + +
+
+ +

type

+
type: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/FormattedOrderTransaction.html b/docs/interfaces/FormattedOrderTransaction.html new file mode 100644 index 00000000..5802a14f --- /dev/null +++ b/docs/interfaces/FormattedOrderTransaction.html @@ -0,0 +1,233 @@ + + + + + + FormattedOrderTransaction | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface FormattedOrderTransaction

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + FormattedOrderTransaction +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

address

+
address: string
+ +
+
+ +

id

+
id: string
+ +
+
+ +

outcome

+
outcome: Outcome
+ +
+
+ +

sequence

+
sequence: number
+ +
+
+ +

specification

+
specification: FormattedOrderSpecification
+ +
+
+ +

type

+
type: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/FormattedPayment.html b/docs/interfaces/FormattedPayment.html new file mode 100644 index 00000000..5acb2265 --- /dev/null +++ b/docs/interfaces/FormattedPayment.html @@ -0,0 +1,261 @@ + + + + + + FormattedPayment | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface FormattedPayment

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + FormattedPayment +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional allowPartialPayment

+
allowPartialPayment: boolean
+ +
+
+ +

destination

+
destination: Adjustment
+ +
+
+ +

Optional invoiceID

+
invoiceID: string
+ +
+
+ +

Optional limitQuality

+
limitQuality: boolean
+ +
+
+ +

Optional memos

+
memos: Memo[]
+ +
+
+ +

Optional noDirectRipple

+
noDirectRipple: boolean
+ +
+
+ +

Optional paths

+
paths: string
+ +
+
+ +

source

+
source: Adjustment
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/FormattedPaymentTransaction.html b/docs/interfaces/FormattedPaymentTransaction.html new file mode 100644 index 00000000..23ff13a5 --- /dev/null +++ b/docs/interfaces/FormattedPaymentTransaction.html @@ -0,0 +1,233 @@ + + + + + + FormattedPaymentTransaction | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface FormattedPaymentTransaction

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + FormattedPaymentTransaction +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

address

+
address: string
+ +
+
+ +

id

+
id: string
+ +
+
+ +

outcome

+
outcome: Outcome
+ +
+
+ +

sequence

+
sequence: number
+ +
+
+ +

specification

+
specification: FormattedPayment
+ +
+
+ +

type

+
type: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/FormattedSettingsTransaction.html b/docs/interfaces/FormattedSettingsTransaction.html new file mode 100644 index 00000000..89c961ae --- /dev/null +++ b/docs/interfaces/FormattedSettingsTransaction.html @@ -0,0 +1,233 @@ + + + + + + FormattedSettingsTransaction | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface FormattedSettingsTransaction

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + FormattedSettingsTransaction +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

address

+
address: string
+ +
+
+ +

id

+
id: string
+ +
+
+ +

outcome

+
outcome: Outcome
+ +
+
+ +

sequence

+
sequence: number
+ +
+
+ +

specification

+
specification: FormattedSettings
+ +
+
+ +

type

+
type: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/FormattedTrustlineTransaction.html b/docs/interfaces/FormattedTrustlineTransaction.html new file mode 100644 index 00000000..c6dac805 --- /dev/null +++ b/docs/interfaces/FormattedTrustlineTransaction.html @@ -0,0 +1,233 @@ + + + + + + FormattedTrustlineTransaction | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface FormattedTrustlineTransaction

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + FormattedTrustlineTransaction +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

address

+
address: string
+ +
+
+ +

id

+
id: string
+ +
+
+ +

outcome

+
outcome: Outcome
+ +
+
+ +

sequence

+
sequence: number
+ +
+
+ +

specification

+
specification: FormattedTrustlineSpecification
+ +
+
+ +

type

+
type: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/GatewayBalancesRequest.html b/docs/interfaces/GatewayBalancesRequest.html new file mode 100644 index 00000000..f8f59e42 --- /dev/null +++ b/docs/interfaces/GatewayBalancesRequest.html @@ -0,0 +1,269 @@ + + + + + + GatewayBalancesRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface GatewayBalancesRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + GatewayBalancesRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

account

+
account: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "gateway_balances"
+ +
+
+ +

hotwallet

+
hotwallet: string | string[]
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional strict

+
strict: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/GatewayBalancesResponse.html b/docs/interfaces/GatewayBalancesResponse.html new file mode 100644 index 00000000..fb9ff930 --- /dev/null +++ b/docs/interfaces/GatewayBalancesResponse.html @@ -0,0 +1,360 @@ + + + + + + GatewayBalancesResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface GatewayBalancesResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + GatewayBalancesResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { account: string; assets?: {}; balances?: {}; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; obligations?: {} }
+ +
+

Type declaration

+
    +
  • +
    account: string
    +
  • +
  • +
    Optional assets?: {}
    +
      +
    • +
      [address: string]: Balance[]
      +
    • +
    +
  • +
  • +
    Optional balances?: {}
    +
      +
    • +
      [address: string]: Balance[]
      +
    • +
    +
  • +
  • +
    Optional ledger_current_index?: number
    +
  • +
  • +
    Optional ledger_hash?: string
    +
  • +
  • +
    Optional ledger_index?: number
    +
  • +
  • +
    Optional obligations?: {}
    +
      +
    • +
      [currency: string]: string
      +
    • +
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/Instructions.html b/docs/interfaces/Instructions.html new file mode 100644 index 00000000..2f1fecf1 --- /dev/null +++ b/docs/interfaces/Instructions.html @@ -0,0 +1,247 @@ + + + + + + Instructions | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Instructions

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Instructions +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional fee

+
fee: string
+ +
+
+ +

Optional maxFee

+
maxFee: string
+ +
+
+ +

Optional maxLedgerVersion

+
maxLedgerVersion: number
+ +
+
+ +

Optional maxLedgerVersionOffset

+
maxLedgerVersionOffset: number
+ +
+
+ +

Optional sequence

+
sequence: number
+ +
+
+ +

Optional signersCount

+
signersCount: number
+ +
+
+ +

Optional ticketSequence

+
ticketSequence: number
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/KeyPair.html b/docs/interfaces/KeyPair.html new file mode 100644 index 00000000..c5e63713 --- /dev/null +++ b/docs/interfaces/KeyPair.html @@ -0,0 +1,177 @@ + + + + + + KeyPair | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface KeyPair

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + KeyPair +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

privateKey

+
privateKey: string
+ +
+
+ +

publicKey

+
publicKey: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/Ledger.html b/docs/interfaces/Ledger.html new file mode 100644 index 00000000..599ee891 --- /dev/null +++ b/docs/interfaces/Ledger.html @@ -0,0 +1,359 @@ + + + + + + Ledger | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Ledger

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Ledger +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional accountState

+
accountState: any[]
+ +
+
+ +

account_hash

+
account_hash: string
+ +
+
+ +

Optional close_flags

+
close_flags: number
+ +
+
+ +

close_time

+
close_time: number
+ +
+
+ +

close_time_human

+
close_time_human: string
+ +
+
+ +

close_time_resolution

+
close_time_resolution: number
+ +
+
+ +

closed

+
closed: boolean
+ +
+
+ +

ledger_hash

+
ledger_hash: string
+ +
+
+ +

ledger_index

+
ledger_index: string
+ +
+
+ +

Optional parent_close_time

+
parent_close_time: number
+ +
+
+ +

parent_hash

+
parent_hash: string
+ +
+
+ +

total_coins

+
total_coins: string
+ +
+
+ +

transaction_hash

+
transaction_hash: string
+ +
+
+ +

transactions

+
transactions: string[] | object[]
+ +
+
+ +

Optional validated

+
validated: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerClosedEvent.html b/docs/interfaces/LedgerClosedEvent.html new file mode 100644 index 00000000..5034bdf0 --- /dev/null +++ b/docs/interfaces/LedgerClosedEvent.html @@ -0,0 +1,289 @@ + + + + + + LedgerClosedEvent | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerClosedEvent

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + LedgerClosedEvent +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

fee_base

+
fee_base: number
+ +
+
+ +

fee_ref

+
fee_ref: number
+ +
+
+ +

ledger_hash

+
ledger_hash: string
+ +
+
+ +

ledger_index

+
ledger_index: number
+ +
+
+ +

ledger_time

+
ledger_time: number
+ +
+
+ +

reserve_base

+
reserve_base: number
+ +
+
+ +

reserve_inc

+
reserve_inc: number
+ +
+
+ +

txn_count

+
txn_count: number
+ +
+
+ +

type

+
type: "ledgerClosed"
+ +
+
+ +

validated_ledgers

+
validated_ledgers: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerClosedRequest.html b/docs/interfaces/LedgerClosedRequest.html new file mode 100644 index 00000000..40300d60 --- /dev/null +++ b/docs/interfaces/LedgerClosedRequest.html @@ -0,0 +1,199 @@ + + + + + + LedgerClosedRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerClosedRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + LedgerClosedRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "ledger_closed"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerClosedResponse.html b/docs/interfaces/LedgerClosedResponse.html new file mode 100644 index 00000000..a4c084c3 --- /dev/null +++ b/docs/interfaces/LedgerClosedResponse.html @@ -0,0 +1,330 @@ + + + + + + LedgerClosedResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerClosedResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + LedgerClosedResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { ledger_hash: string; ledger_index: number }
+ +
+

Type declaration

+
    +
  • +
    ledger_hash: string
    +
  • +
  • +
    ledger_index: number
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerCurrentRequest.html b/docs/interfaces/LedgerCurrentRequest.html new file mode 100644 index 00000000..e7cb52da --- /dev/null +++ b/docs/interfaces/LedgerCurrentRequest.html @@ -0,0 +1,199 @@ + + + + + + LedgerCurrentRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerCurrentRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + LedgerCurrentRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "ledger_current"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerCurrentResponse.html b/docs/interfaces/LedgerCurrentResponse.html new file mode 100644 index 00000000..a3879e5c --- /dev/null +++ b/docs/interfaces/LedgerCurrentResponse.html @@ -0,0 +1,327 @@ + + + + + + LedgerCurrentResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerCurrentResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + LedgerCurrentResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { ledger_current_index: number }
+ +
+

Type declaration

+
    +
  • +
    ledger_current_index: number
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerDataRequest.html b/docs/interfaces/LedgerDataRequest.html new file mode 100644 index 00000000..5b5c0e41 --- /dev/null +++ b/docs/interfaces/LedgerDataRequest.html @@ -0,0 +1,269 @@ + + + + + + LedgerDataRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerDataRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + LedgerDataRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional binary

+
binary: boolean
+ +
+
+ +

command

+
command: "ledger_data"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional limit

+
limit: number
+ +
+
+ +

Optional marker

+
marker: unknown
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerDataResponse.html b/docs/interfaces/LedgerDataResponse.html new file mode 100644 index 00000000..75f1a89c --- /dev/null +++ b/docs/interfaces/LedgerDataResponse.html @@ -0,0 +1,336 @@ + + + + + + LedgerDataResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerDataResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + LedgerDataResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { ledger_hash: string; ledger_index: number; marker?: unknown; state: State[] }
+ +
+

Type declaration

+
    +
  • +
    ledger_hash: string
    +
  • +
  • +
    ledger_index: number
    +
  • +
  • +
    Optional marker?: unknown
    +
  • +
  • +
    state: State[]
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerEntryRequest.html b/docs/interfaces/LedgerEntryRequest.html new file mode 100644 index 00000000..4d3d20ff --- /dev/null +++ b/docs/interfaces/LedgerEntryRequest.html @@ -0,0 +1,392 @@ + + + + + + LedgerEntryRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerEntryRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + LedgerEntryRequest +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional account_root

+
account_root: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional binary

+
binary: boolean
+ +
+
+ +

Optional check

+
check: string
+ +
+
+ +

command

+
command: "ledger_entry"
+ +
+
+ +

Optional deposit_preauth

+
deposit_preauth: string | { authorized: string; owner: string }
+ +
+
+ +

Optional directory

+
directory: string | { dir_root?: string; owner?: string; sub_index?: number }
+ +
+
+ +

Optional escrow

+
escrow: string | { owner: string; seq: number }
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional index

+
index: string
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional offer

+
offer: string | { account: string; seq: number }
+ +
+
+ +

Optional payment_channel

+
payment_channel: string
+ +
+
+ +

Optional ripple_state

+
ripple_state: { accounts: string[]; currency: string }
+ +
+

Type declaration

+
    +
  • +
    accounts: string[]
    +
  • +
  • +
    currency: string
    +
  • +
+
+
+
+ +

Optional ticket

+
ticket: string | { owner: string; ticket_sequence: number }
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerEntryResponse.html b/docs/interfaces/LedgerEntryResponse.html new file mode 100644 index 00000000..473c5d1e --- /dev/null +++ b/docs/interfaces/LedgerEntryResponse.html @@ -0,0 +1,336 @@ + + + + + + LedgerEntryResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerEntryResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + LedgerEntryResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { index: string; ledger_index: number; node?: LedgerEntry; node_binary?: string }
+ +
+

Type declaration

+
    +
  • +
    index: string
    +
  • +
  • +
    ledger_index: number
    +
  • +
  • +
    Optional node?: LedgerEntry
    +
  • +
  • +
    Optional node_binary?: string
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerRequest.html b/docs/interfaces/LedgerRequest.html new file mode 100644 index 00000000..06eb7bce --- /dev/null +++ b/docs/interfaces/LedgerRequest.html @@ -0,0 +1,325 @@ + + + + + + LedgerRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + LedgerRequest +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional accounts

+
accounts: boolean
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional binary

+
binary: boolean
+ +
+
+ +

command

+
command: "ledger"
+ +
+
+ +

Optional expand

+
expand: boolean
+ +
+
+ +

Optional full

+
full: boolean
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional owner_funds

+
owner_funds: boolean
+ +
+
+ +

Optional queue

+
queue: boolean
+ +
+
+ +

Optional transactions

+
transactions: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerResponse.html b/docs/interfaces/LedgerResponse.html new file mode 100644 index 00000000..e4dfd706 --- /dev/null +++ b/docs/interfaces/LedgerResponse.html @@ -0,0 +1,339 @@ + + + + + + LedgerResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + LedgerResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { ledger: default | BinaryLedger; ledger_hash: string; ledger_index: number; queue_data?: (string | LedgerQueueData)[]; validated?: boolean }
+ +
+

Type declaration

+
    +
  • +
    ledger: default | BinaryLedger
    +
  • +
  • +
    ledger_hash: string
    +
  • +
  • +
    ledger_index: number
    +
  • +
  • +
    Optional queue_data?: (string | LedgerQueueData)[]
    +
  • +
  • +
    Optional validated?: boolean
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/LedgerStream.html b/docs/interfaces/LedgerStream.html new file mode 100644 index 00000000..c5d44636 --- /dev/null +++ b/docs/interfaces/LedgerStream.html @@ -0,0 +1,295 @@ + + + + + + LedgerStream | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LedgerStream

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseStream +
      +
    • + LedgerStream +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

fee_base

+
fee_base: number
+ +
+
+ +

fee_ref

+
fee_ref: number
+ +
+
+ +

ledger_hash

+
ledger_hash: string
+ +
+
+ +

ledger_index

+
ledger_index: number
+ +
+
+ +

ledger_time

+
ledger_time: number
+ +
+
+ +

reserve_base

+
reserve_base: number
+ +
+
+ +

reserve_inc

+
reserve_inc: number
+ +
+
+ +

txn_count

+
txn_count: number
+ +
+
+ +

type

+
type: "ledgerClosed"
+ +
+
+ +

Optional validated_ledgers

+
validated_ledgers: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/ManifestRequest.html b/docs/interfaces/ManifestRequest.html new file mode 100644 index 00000000..c5365649 --- /dev/null +++ b/docs/interfaces/ManifestRequest.html @@ -0,0 +1,213 @@ + + + + + + ManifestRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ManifestRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + ManifestRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "manifest"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

public_key

+
public_key: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/ManifestResponse.html b/docs/interfaces/ManifestResponse.html new file mode 100644 index 00000000..6945ef62 --- /dev/null +++ b/docs/interfaces/ManifestResponse.html @@ -0,0 +1,347 @@ + + + + + + ManifestResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ManifestResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + ManifestResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { details?: { domain: string; ephemeral_key: string; master_key: string; seq: number }; manifest?: string; requested: string }
+ +
+

Type declaration

+
    +
  • +
    Optional details?: { domain: string; ephemeral_key: string; master_key: string; seq: number }
    +
      +
    • +
      domain: string
      +
    • +
    • +
      ephemeral_key: string
      +
    • +
    • +
      master_key: string
      +
    • +
    • +
      seq: number
      +
    • +
    +
  • +
  • +
    Optional manifest?: string
    +
  • +
  • +
    requested: string
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/NoRippleCheckRequest.html b/docs/interfaces/NoRippleCheckRequest.html new file mode 100644 index 00000000..2a53db65 --- /dev/null +++ b/docs/interfaces/NoRippleCheckRequest.html @@ -0,0 +1,269 @@ + + + + + + NoRippleCheckRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface NoRippleCheckRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + NoRippleCheckRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

account

+
account: string
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "noripple_check"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

role

+
role: "gateway" | "user"
+ +
+
+ +

Optional transactions

+
transactions: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/NoRippleCheckResponse.html b/docs/interfaces/NoRippleCheckResponse.html new file mode 100644 index 00000000..a8812901 --- /dev/null +++ b/docs/interfaces/NoRippleCheckResponse.html @@ -0,0 +1,333 @@ + + + + + + NoRippleCheckResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface NoRippleCheckResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + NoRippleCheckResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { ledger_current_index: number; problems: string[]; transactions: Transaction[] }
+ +
+

Type declaration

+
    +
  • +
    ledger_current_index: number
    +
  • +
  • +
    problems: string[]
    +
  • +
  • +
    transactions: Transaction[]
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/OfferCreateTransaction.html b/docs/interfaces/OfferCreateTransaction.html new file mode 100644 index 00000000..5fd4096d --- /dev/null +++ b/docs/interfaces/OfferCreateTransaction.html @@ -0,0 +1,327 @@ + + + + + + OfferCreateTransaction | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface OfferCreateTransaction

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Account

+
Account: string
+ +
+
+ +

Optional Expiration

+
Expiration: number
+ +
+
+ +

Fee

+
Fee: string
+ +
+
+ +

Flags

+
Flags: number
+ +
+
+ +

Optional Fulfillment

+
Fulfillment: string
+ +
+
+ +

LastLedgerSequence

+
LastLedgerSequence: number
+ +
+
+ +

Optional Memos

+
Memos: { Memo: ApiMemo }[]
+ +
+
+ +

Optional OfferSequence

+
OfferSequence: number
+ +
+
+ +

Sequence

+
Sequence: number
+ +
+
+ +

TakerGets

+
TakerGets: RippledAmount
+ +
+
+ +

TakerPays

+
TakerPays: RippledAmount
+ +
+
+ +

TransactionType

+
TransactionType: "OfferCreate"
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/OrderBookStream.html b/docs/interfaces/OrderBookStream.html new file mode 100644 index 00000000..bf7daa0d --- /dev/null +++ b/docs/interfaces/OrderBookStream.html @@ -0,0 +1,309 @@ + + + + + + OrderBookStream | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface OrderBookStream

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseStream +
      +
    • + OrderBookStream +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

engine_result

+
engine_result: string
+ +
+
+ +

engine_result_code

+
engine_result_code: number
+ +
+
+ +

engine_result_message

+
engine_result_message: string
+ +
+
+ +

Optional ledger_current_index

+
ledger_current_index: number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: number
+ +
+
+ +

meta

+
meta: default
+ +
+
+ +

status

+
status: string
+ +
+
+ +

transaction

+
transaction: Transaction | ModifiedOfferCreateTransaction
+ +
+
+ +

type

+
type: "transaction"
+ +
+
+ +

validated

+
validated: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/Outcome.html b/docs/interfaces/Outcome.html new file mode 100644 index 00000000..f47a88c1 --- /dev/null +++ b/docs/interfaces/Outcome.html @@ -0,0 +1,283 @@ + + + + + + Outcome | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Outcome

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Outcome +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

balanceChanges

+
balanceChanges: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: { counterparty?: string; currency: string; value: string }[]
    +
  • +
+
+
+
+ +

Optional deliveredAmount

+
deliveredAmount: { counterparty?: string; currency: string; value: string }
+ +
+

Type declaration

+
    +
  • +
    Optional counterparty?: string
    +
  • +
  • +
    currency: string
    +
  • +
  • +
    value: string
    +
  • +
+
+
+
+ +

fee

+
fee: string
+ +
+
+ +

indexInLedger

+
indexInLedger: number
+ +
+
+ +

ledgerVersion

+
ledgerVersion: number
+ +
+
+ +

orderbookChanges

+
orderbookChanges: object
+ +
+
+ +

result

+
result: string
+ +
+
+ +

Optional timestamp

+
timestamp: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/PathFindResponse.html b/docs/interfaces/PathFindResponse.html new file mode 100644 index 00000000..300832ac --- /dev/null +++ b/docs/interfaces/PathFindResponse.html @@ -0,0 +1,348 @@ + + + + + + PathFindResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface PathFindResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + PathFindResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { alternatives: PathOption[]; closed?: true; destination_account: string; destination_amount: Amount; full_reply: boolean; id?: string | number; source_account: string; status?: true }
+ +
+

Type declaration

+
    +
  • +
    alternatives: PathOption[]
    +
  • +
  • +
    Optional closed?: true
    +
  • +
  • +
    destination_account: string
    +
  • +
  • +
    destination_amount: Amount
    +
  • +
  • +
    full_reply: boolean
    +
  • +
  • +
    Optional id?: string | number
    +
  • +
  • +
    source_account: string
    +
  • +
  • +
    Optional status?: true
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/PathFindStream.html b/docs/interfaces/PathFindStream.html new file mode 100644 index 00000000..0c863743 --- /dev/null +++ b/docs/interfaces/PathFindStream.html @@ -0,0 +1,278 @@ + + + + + + PathFindStream | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface PathFindStream

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseStream +
      +
    • + PathFindStream +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

alternatives

+
alternatives: { paths_computed: Path[]; source_amount: Amount }
+ +
+

Type declaration

+
    +
  • +
    paths_computed: Path[]
    +
  • +
  • +
    source_amount: Amount
    +
  • +
+
+
+
+ +

destination_account

+
destination_account: string
+ +
+
+ +

destination_amount

+
destination_amount: Amount
+ +
+
+ +

full_reply

+
full_reply: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional send_max

+
send_max: Amount
+ +
+
+ +

source_account

+
source_account: string
+ +
+
+ +

type

+
type: "path_find"
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/PeerStatusStream.html b/docs/interfaces/PeerStatusStream.html new file mode 100644 index 00000000..620ebf3e --- /dev/null +++ b/docs/interfaces/PeerStatusStream.html @@ -0,0 +1,253 @@ + + + + + + PeerStatusStream | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface PeerStatusStream

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseStream +
      +
    • + PeerStatusStream +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

action

+
action: "CLOSING_LEDGER" | "ACCEPTED_LEDGER" | "SWITCHED_LEDGER" | "LOST_SYNC"
+ +
+
+ +

date

+
date: number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: number
+ +
+
+ +

Optional ledger_index_max

+
ledger_index_max: number
+ +
+
+ +

Optional ledger_index_min

+
ledger_index_min: number
+ +
+
+ +

type

+
type: "peerStatusChange"
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/PingRequest.html b/docs/interfaces/PingRequest.html new file mode 100644 index 00000000..1ac4fb61 --- /dev/null +++ b/docs/interfaces/PingRequest.html @@ -0,0 +1,199 @@ + + + + + + PingRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface PingRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + PingRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "ping"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/PingResponse.html b/docs/interfaces/PingResponse.html new file mode 100644 index 00000000..2df38152 --- /dev/null +++ b/docs/interfaces/PingResponse.html @@ -0,0 +1,324 @@ + + + + + + PingResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface PingResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + PingResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: {}
+ +
+

Type declaration

+
    +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/Prepare.html b/docs/interfaces/Prepare.html new file mode 100644 index 00000000..1636a807 --- /dev/null +++ b/docs/interfaces/Prepare.html @@ -0,0 +1,194 @@ + + + + + + Prepare | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Prepare

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Prepare +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

instructions

+
instructions: { fee: string; maxLedgerVersion?: number; sequence?: number; ticketSequence?: number }
+ +
+

Type declaration

+
    +
  • +
    fee: string
    +
  • +
  • +
    Optional maxLedgerVersion?: number
    +
  • +
  • +
    Optional sequence?: number
    +
  • +
  • +
    Optional ticketSequence?: number
    +
  • +
+
+
+
+ +

txJSON

+
txJSON: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/RandomRequest.html b/docs/interfaces/RandomRequest.html new file mode 100644 index 00000000..c1f11b19 --- /dev/null +++ b/docs/interfaces/RandomRequest.html @@ -0,0 +1,199 @@ + + + + + + RandomRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface RandomRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + RandomRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "random"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/RandomResponse.html b/docs/interfaces/RandomResponse.html new file mode 100644 index 00000000..3c0511a3 --- /dev/null +++ b/docs/interfaces/RandomResponse.html @@ -0,0 +1,327 @@ + + + + + + RandomResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface RandomResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + RandomResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { random: string }
+ +
+

Type declaration

+
    +
  • +
    random: string
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/RipplePathFindRequest.html b/docs/interfaces/RipplePathFindRequest.html new file mode 100644 index 00000000..a8004e1d --- /dev/null +++ b/docs/interfaces/RipplePathFindRequest.html @@ -0,0 +1,297 @@ + + + + + + RipplePathFindRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface RipplePathFindRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + RipplePathFindRequest +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "ripple_path_find"
+ +
+
+ +

destination_account

+
destination_account: string
+ +
+
+ +

destination_amount

+
destination_amount: Amount
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

Optional send_max

+
send_max: Amount
+ +
+
+ +

source_account

+
source_account: string
+ +
+
+ +

Optional source_currencies

+
source_currencies: SourceCurrencyAmount
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/RipplePathFindResponse.html b/docs/interfaces/RipplePathFindResponse.html new file mode 100644 index 00000000..1eca0502 --- /dev/null +++ b/docs/interfaces/RipplePathFindResponse.html @@ -0,0 +1,333 @@ + + + + + + RipplePathFindResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface RipplePathFindResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + RipplePathFindResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { alternatives: PathOption[]; destination_account: string; destination_currencies: string[] }
+ +
+

Type declaration

+
    +
  • +
    alternatives: PathOption[]
    +
  • +
  • +
    destination_account: string
    +
  • +
  • +
    destination_currencies: string[]
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/ServerInfoRequest.html b/docs/interfaces/ServerInfoRequest.html new file mode 100644 index 00000000..42e22370 --- /dev/null +++ b/docs/interfaces/ServerInfoRequest.html @@ -0,0 +1,199 @@ + + + + + + ServerInfoRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ServerInfoRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + ServerInfoRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "server_info"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/ServerInfoResponse.html b/docs/interfaces/ServerInfoResponse.html new file mode 100644 index 00000000..a339022f --- /dev/null +++ b/docs/interfaces/ServerInfoResponse.html @@ -0,0 +1,469 @@ + + + + + + ServerInfoResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ServerInfoResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + ServerInfoResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { info: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; complete_ledgers: string; hostid: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_factor?: number; load_factor_cluster?: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_local?: number; load_factor_net?: number; load_factor_server?: number; network_ledger?: "waiting"; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; validation_quorum: number; validator_list_expires?: string } }
+ +
+

Type declaration

+
    +
  • +
    info: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; complete_ledgers: string; hostid: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_factor?: number; load_factor_cluster?: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_local?: number; load_factor_net?: number; load_factor_server?: number; network_ledger?: "waiting"; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; validation_quorum: number; validator_list_expires?: string }
    +
      +
    • +
      Optional amendment_blocked?: boolean
      +
    • +
    • +
      build_version: string
      +
    • +
    • +
      Optional closed_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }
      +
        +
      • +
        age: number
        +
      • +
      • +
        base_fee_xrp: number
        +
      • +
      • +
        hash: string
        +
      • +
      • +
        reserve_base_xrp: number
        +
      • +
      • +
        reserve_inc_xrp: number
        +
      • +
      • +
        seq: number
        +
      • +
      +
    • +
    • +
      complete_ledgers: string
      +
    • +
    • +
      hostid: string
      +
    • +
    • +
      io_latency_ms: number
      +
    • +
    • +
      jq_trans_overflow: string
      +
    • +
    • +
      last_close: { converge_time_s: number; proposers: number }
      +
        +
      • +
        converge_time_s: number
        +
      • +
      • +
        proposers: number
        +
      • +
      +
    • +
    • +
      Optional load?: { job_types: JobType[]; threads: number }
      +
        +
      • +
        job_types: JobType[]
        +
      • +
      • +
        threads: number
        +
      • +
      +
    • +
    • +
      Optional load_factor?: number
      +
    • +
    • +
      Optional load_factor_cluster?: number
      +
    • +
    • +
      Optional load_factor_fee_escalation?: number
      +
    • +
    • +
      Optional load_factor_fee_queue?: number
      +
    • +
    • +
      Optional load_factor_local?: number
      +
    • +
    • +
      Optional load_factor_net?: number
      +
    • +
    • +
      Optional load_factor_server?: number
      +
    • +
    • +
      Optional network_ledger?: "waiting"
      +
    • +
    • +
      peers: number
      +
    • +
    • +
      pubkey_node: string
      +
    • +
    • +
      Optional pubkey_validator?: string
      +
    • +
    • +
      server_state: ServerState
      +
    • +
    • +
      server_state_duration_us: number
      +
    • +
    • +
      state_accounting: Record<ServerState, StateAccounting>
      +
    • +
    • +
      time: string
      +
    • +
    • +
      uptime: number
      +
    • +
    • +
      Optional validated_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }
      +
        +
      • +
        age: number
        +
      • +
      • +
        base_fee_xrp: number
        +
      • +
      • +
        hash: string
        +
      • +
      • +
        reserve_base_xrp: number
        +
      • +
      • +
        reserve_inc_xrp: number
        +
      • +
      • +
        seq: number
        +
      • +
      +
    • +
    • +
      validation_quorum: number
      +
    • +
    • +
      Optional validator_list_expires?: string
      +
    • +
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/ServerStateRequest.html b/docs/interfaces/ServerStateRequest.html new file mode 100644 index 00000000..757477e8 --- /dev/null +++ b/docs/interfaces/ServerStateRequest.html @@ -0,0 +1,199 @@ + + + + + + ServerStateRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ServerStateRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + ServerStateRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "server_state"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/ServerStateResponse.html b/docs/interfaces/ServerStateResponse.html new file mode 100644 index 00000000..b4b4eed3 --- /dev/null +++ b/docs/interfaces/ServerStateResponse.html @@ -0,0 +1,460 @@ + + + + + + ServerStateResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ServerStateResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + ServerStateResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { state: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; complete_ledgers: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_base: number; load_factor: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_fee_reference?: number; load_factor_server?: number; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; validation_quorum: number; validator_list_expires?: string } }
+ +
+

Type declaration

+
    +
  • +
    state: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; complete_ledgers: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_base: number; load_factor: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_fee_reference?: number; load_factor_server?: number; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; validation_quorum: number; validator_list_expires?: string }
    +
      +
    • +
      Optional amendment_blocked?: boolean
      +
    • +
    • +
      build_version: string
      +
    • +
    • +
      Optional closed_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }
      +
        +
      • +
        age: number
        +
      • +
      • +
        base_fee: number
        +
      • +
      • +
        hash: string
        +
      • +
      • +
        reserve_base: number
        +
      • +
      • +
        reserve_inc: number
        +
      • +
      • +
        seq: number
        +
      • +
      +
    • +
    • +
      complete_ledgers: string
      +
    • +
    • +
      io_latency_ms: number
      +
    • +
    • +
      jq_trans_overflow: string
      +
    • +
    • +
      last_close: { converge_time_s: number; proposers: number }
      +
        +
      • +
        converge_time_s: number
        +
      • +
      • +
        proposers: number
        +
      • +
      +
    • +
    • +
      Optional load?: { job_types: JobType[]; threads: number }
      +
        +
      • +
        job_types: JobType[]
        +
      • +
      • +
        threads: number
        +
      • +
      +
    • +
    • +
      load_base: number
      +
    • +
    • +
      load_factor: number
      +
    • +
    • +
      Optional load_factor_fee_escalation?: number
      +
    • +
    • +
      Optional load_factor_fee_queue?: number
      +
    • +
    • +
      Optional load_factor_fee_reference?: number
      +
    • +
    • +
      Optional load_factor_server?: number
      +
    • +
    • +
      peers: number
      +
    • +
    • +
      pubkey_node: string
      +
    • +
    • +
      Optional pubkey_validator?: string
      +
    • +
    • +
      server_state: ServerState
      +
    • +
    • +
      server_state_duration_us: number
      +
    • +
    • +
      state_accounting: Record<ServerState, StateAccounting>
      +
    • +
    • +
      time: string
      +
    • +
    • +
      uptime: number
      +
    • +
    • +
      Optional validated_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }
      +
        +
      • +
        age: number
        +
      • +
      • +
        base_fee: number
        +
      • +
      • +
        hash: string
        +
      • +
      • +
        reserve_base: number
        +
      • +
      • +
        reserve_inc: number
        +
      • +
      • +
        seq: number
        +
      • +
      +
    • +
    • +
      validation_quorum: number
      +
    • +
    • +
      Optional validator_list_expires?: string
      +
    • +
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/SettingsTransaction.html b/docs/interfaces/SettingsTransaction.html new file mode 100644 index 00000000..aa073cb8 --- /dev/null +++ b/docs/interfaces/SettingsTransaction.html @@ -0,0 +1,243 @@ + + + + + + SettingsTransaction | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SettingsTransaction

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Account

+
Account: string
+ +
+
+ +

Optional Flags

+
Flags: number
+ +
+
+ +

Optional Fulfillment

+
Fulfillment: string
+ +
+
+ +

Optional Memos

+
Memos: { Memo: ApiMemo }[]
+ +
+
+ +

TransactionType

+
TransactionType: string
+ +
+
+ +

Optional TransferRate

+
TransferRate: number
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/SignOptions.html b/docs/interfaces/SignOptions.html new file mode 100644 index 00000000..6a97dfd4 --- /dev/null +++ b/docs/interfaces/SignOptions.html @@ -0,0 +1,163 @@ + + + + + + SignOptions | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SignOptions

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + SignOptions +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

signAs

+
signAs: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/Submit.html b/docs/interfaces/Submit.html new file mode 100644 index 00000000..eb40aa8d --- /dev/null +++ b/docs/interfaces/Submit.html @@ -0,0 +1,233 @@ + + + + + + Submit | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Submit

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Submit +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

engineResult

+
engineResult: string
+ +
+
+ +

engineResultCode

+
engineResultCode: number
+ +
+
+ +

Optional engineResultMessage

+
engineResultMessage: string
+ +
+
+ +

success

+
success: boolean
+ +
+
+ +

Optional txBlob

+
txBlob: string
+ +
+
+ +

Optional txJson

+
txJson: object
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/SubmitMultisignedRequest.html b/docs/interfaces/SubmitMultisignedRequest.html new file mode 100644 index 00000000..beba7953 --- /dev/null +++ b/docs/interfaces/SubmitMultisignedRequest.html @@ -0,0 +1,227 @@ + + + + + + SubmitMultisignedRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SubmitMultisignedRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + SubmitMultisignedRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "submit_multisigned"
+ +
+
+ +

Optional fail_hard

+
fail_hard: boolean
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

tx_json

+
tx_json: Transaction
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/SubmitMultisignedResponse.html b/docs/interfaces/SubmitMultisignedResponse.html new file mode 100644 index 00000000..832ec4e5 --- /dev/null +++ b/docs/interfaces/SubmitMultisignedResponse.html @@ -0,0 +1,339 @@ + + + + + + SubmitMultisignedResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SubmitMultisignedResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + SubmitMultisignedResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { engine_result: string; engine_result_code: number; engine_result_message: string; tx_blob: string; tx_json: Transaction }
+ +
+

Type declaration

+
    +
  • +
    engine_result: string
    +
  • +
  • +
    engine_result_code: number
    +
  • +
  • +
    engine_result_message: string
    +
  • +
  • +
    tx_blob: string
    +
  • +
  • +
    tx_json: Transaction
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/SubmitRequest.html b/docs/interfaces/SubmitRequest.html new file mode 100644 index 00000000..0f09e42c --- /dev/null +++ b/docs/interfaces/SubmitRequest.html @@ -0,0 +1,227 @@ + + + + + + SubmitRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SubmitRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + SubmitRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "submit"
+ +
+
+ +

Optional fail_hard

+
fail_hard: boolean
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

tx_blob

+
tx_blob: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/SubmitResponse.html b/docs/interfaces/SubmitResponse.html new file mode 100644 index 00000000..be792546 --- /dev/null +++ b/docs/interfaces/SubmitResponse.html @@ -0,0 +1,366 @@ + + + + + + SubmitResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SubmitResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + SubmitResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { accepted: boolean; account_sequence_available: number; account_sequence_next: number; applied: boolean; broadcast: boolean; engine_result: string; engine_result_code: number; engine_result_message: string; kept: boolean; open_ledger_cost: string; queued: boolean; tx_blob: string; tx_json: Transaction; validated_ledger_index: number }
+ +
+

Type declaration

+
    +
  • +
    accepted: boolean
    +
  • +
  • +
    account_sequence_available: number
    +
  • +
  • +
    account_sequence_next: number
    +
  • +
  • +
    applied: boolean
    +
  • +
  • +
    broadcast: boolean
    +
  • +
  • +
    engine_result: string
    +
  • +
  • +
    engine_result_code: number
    +
  • +
  • +
    engine_result_message: string
    +
  • +
  • +
    kept: boolean
    +
  • +
  • +
    open_ledger_cost: string
    +
  • +
  • +
    queued: boolean
    +
  • +
  • +
    tx_blob: string
    +
  • +
  • +
    tx_json: Transaction
    +
  • +
  • +
    validated_ledger_index: number
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/SubscribeRequest.html b/docs/interfaces/SubscribeRequest.html new file mode 100644 index 00000000..d7c726c9 --- /dev/null +++ b/docs/interfaces/SubscribeRequest.html @@ -0,0 +1,297 @@ + + + + + + SubscribeRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SubscribeRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + SubscribeRequest +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional accounts

+
accounts: string[]
+ +
+
+ +

Optional accounts_proposed

+
accounts_proposed: string[]
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional books

+
books: Book[]
+ +
+
+ +

command

+
command: "subscribe"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional streams

+
streams: StreamType[]
+ +
+
+ +

Optional url

+
url: string
+ +
+
+ +

Optional url_password

+
url_password: string
+ +
+
+ +

Optional url_username

+
url_username: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/SubscribeResponse.html b/docs/interfaces/SubscribeResponse.html new file mode 100644 index 00000000..bd755476 --- /dev/null +++ b/docs/interfaces/SubscribeResponse.html @@ -0,0 +1,319 @@ + + + + + + SubscribeResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SubscribeResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + SubscribeResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: {} | Stream
+ +
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/TransactionEntryRequest.html b/docs/interfaces/TransactionEntryRequest.html new file mode 100644 index 00000000..a77c29ce --- /dev/null +++ b/docs/interfaces/TransactionEntryRequest.html @@ -0,0 +1,241 @@ + + + + + + TransactionEntryRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface TransactionEntryRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + TransactionEntryRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

command

+
command: "transaction_entry"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: LedgerIndex
+ +
+
+ +

tx_hash

+
tx_hash: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/TransactionEntryResponse.html b/docs/interfaces/TransactionEntryResponse.html new file mode 100644 index 00000000..79d882db --- /dev/null +++ b/docs/interfaces/TransactionEntryResponse.html @@ -0,0 +1,336 @@ + + + + + + TransactionEntryResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface TransactionEntryResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + TransactionEntryResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { ledger_hash: string; ledger_index: number; metadata: default; tx_json: Transaction }
+ +
+

Type declaration

+
    +
  • +
    ledger_hash: string
    +
  • +
  • +
    ledger_index: number
    +
  • +
  • +
    metadata: default
    +
  • +
  • +
    tx_json: Transaction
    +
  • +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/TransactionJSON.html b/docs/interfaces/TransactionJSON.html new file mode 100644 index 00000000..a413725e --- /dev/null +++ b/docs/interfaces/TransactionJSON.html @@ -0,0 +1,231 @@ + + + + + + TransactionJSON | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface TransactionJSON

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Indexable

+
[Field: string]: string | number | any[] | RippledAmount | undefined
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Account

+
Account: string
+ +
+
+ +

Optional Flags

+
Flags: number
+ +
+
+ +

Optional Fulfillment

+
Fulfillment: string
+ +
+
+ +

Optional Memos

+
Memos: { Memo: ApiMemo }[]
+ +
+
+ +

TransactionType

+
TransactionType: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/TransactionStream.html b/docs/interfaces/TransactionStream.html new file mode 100644 index 00000000..c3da1359 --- /dev/null +++ b/docs/interfaces/TransactionStream.html @@ -0,0 +1,309 @@ + + + + + + TransactionStream | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface TransactionStream

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseStream +
      +
    • + TransactionStream +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

engine_result

+
engine_result: string
+ +
+
+ +

engine_result_code

+
engine_result_code: number
+ +
+
+ +

engine_result_message

+
engine_result_message: string
+ +
+
+ +

Optional ledger_current_index

+
ledger_current_index: number
+ +
+
+ +

Optional ledger_hash

+
ledger_hash: string
+ +
+
+ +

Optional ledger_index

+
ledger_index: number
+ +
+
+ +

Optional meta

+
meta: default
+ +
+
+ +

status

+
status: string
+ +
+
+ +

transaction

+
transaction: Transaction
+ +
+
+ +

type

+
type: "transaction"
+ +
+
+ +

Optional validated

+
validated: boolean
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/TxRequest.html b/docs/interfaces/TxRequest.html new file mode 100644 index 00000000..f503c428 --- /dev/null +++ b/docs/interfaces/TxRequest.html @@ -0,0 +1,255 @@ + + + + + + TxRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface TxRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + TxRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional binary

+
binary: boolean
+ +
+
+ +

command

+
command: "tx"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional max_ledger

+
max_ledger: number
+ +
+
+ +

Optional min_ledger

+
min_ledger: number
+ +
+
+ +

transaction

+
transaction: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/TxResponse.html b/docs/interfaces/TxResponse.html new file mode 100644 index 00000000..a69db184 --- /dev/null +++ b/docs/interfaces/TxResponse.html @@ -0,0 +1,333 @@ + + + + + + TxResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface TxResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + TxResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & AccountDelete & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & AccountSet & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & CheckCancel & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & CheckCash & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & CheckCreate & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & DepositPreauth & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & EscrowCancel & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & EscrowCreate & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & EscrowFinish & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & OfferCancel & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & OfferCreate & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & Payment & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & PaymentChannelClaim & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & PaymentChannelCreate & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & PaymentChannelFund & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & SetRegularKey & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & SignerListSet & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & TicketCreate & { hash: string; ledger_index: number; meta: string | default; validated?: boolean } & TrustSet
+ +
+
+ +

Optional searched_all

+
searched_all: boolean
+ +
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/UnsubscribeRequest.html b/docs/interfaces/UnsubscribeRequest.html new file mode 100644 index 00000000..9dacb7ab --- /dev/null +++ b/docs/interfaces/UnsubscribeRequest.html @@ -0,0 +1,255 @@ + + + + + + UnsubscribeRequest | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface UnsubscribeRequest

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseRequest +
      +
    • + UnsubscribeRequest +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional accounts

+
accounts: string[]
+ +
+
+ +

Optional accounts_proposed

+
accounts_proposed: string[]
+ +
+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional books

+
books: Book[]
+ +
+
+ +

command

+
command: "unsubscribe"
+ +
+
+ +

Optional id

+
id: string | number
+ +
+
+ +

Optional streams

+
streams: StreamType[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/UnsubscribeResponse.html b/docs/interfaces/UnsubscribeResponse.html new file mode 100644 index 00000000..1cbaf1e6 --- /dev/null +++ b/docs/interfaces/UnsubscribeResponse.html @@ -0,0 +1,324 @@ + + + + + + UnsubscribeResponse | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface UnsubscribeResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseResponse +
      +
    • + UnsubscribeResponse +
    • +
    +
  • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional api_version

+
api_version: number
+ +
+
+ +

Optional error

+
error: string
+ +
+
+ +

Optional error_message

+
error_message: string
+ +
+
+ +

Optional forwarded

+
forwarded: boolean
+ +
+
+ +

id

+
id: string | number
+ +
+
+ +

Optional request

+
request: unknown
+ +
+
+ +

result

+
result: {}
+ +
+

Type declaration

+
    +
+
+
+
+ +

status

+
status: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

Optional warning

+
warning: "load"
+ +
+
+ +

Optional warnings

+
warnings: Warning[]
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/ValidationStream.html b/docs/interfaces/ValidationStream.html new file mode 100644 index 00000000..5750ca92 --- /dev/null +++ b/docs/interfaces/ValidationStream.html @@ -0,0 +1,351 @@ + + + + + + ValidationStream | ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ValidationStream

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + BaseStream +
      +
    • + ValidationStream +
    • +
    +
  • +
+
+
+

Index

+
+ +
+
+
+

Properties

+
+ +

Optional amendments

+
amendments: string[]
+ +
+
+ +

Optional base_fee

+
base_fee: number
+ +
+
+ +

flags

+
flags: number
+ +
+
+ +

full

+
full: boolean
+ +
+
+ +

ledger_hash

+
ledger_hash: string
+ +
+
+ +

ledger_index

+
ledger_index: string
+ +
+
+ +

Optional load_fee

+
load_fee: number
+ +
+
+ +

Optional master_key

+
master_key: string
+ +
+
+ +

Optional reserve_base

+
reserve_base: number
+ +
+
+ +

Optional reserve_inc

+
reserve_inc: number
+ +
+
+ +

signature

+
signature: string
+ +
+
+ +

signing_time

+
signing_time: number
+ +
+
+ +

type

+
type: "validationReceived"
+ +
+
+ +

validation_public_key

+
validation_public_key: string
+ +
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 00000000..f056c90d --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,1428 @@ + + + + + + ripple-lib + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
  • +
  • Public/Protected
  • +
  • All
  • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+

ripple-lib

+
+
+
+
+
+
+
+

Index

+
+
+
+

References

+ +
+
+

Classes

+ +
+
+

Interfaces

+ +
+
+

Type aliases

+ +
+
+

Properties

+ +
+
+

Functions

+ +
+
+
+
+
+

References

+
+ +

deriveXAddress

+ Renames and exports __type +
+
+
+

Type aliases

+
+ +

FormattedTransactionType

+ + +
+
+ +

PathFindRequest

+
PathFindRequest: PathFindCreateRequest | PathFindCloseRequest | PathFindStatusRequest
+ +
+
+ +

Request

+ + +
+
+ +

Response

+ + +
+
+ +

Stream

+ + +
+
+
+

Properties

+
+ +

deriveAddress

+
deriveAddress: (publicKey: any) => string
+ +
+

Type declaration

+
    +
  • +
      +
    • (publicKey: any): string
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        publicKey: any
        +
      • +
      +

      Returns string

      +
    • +
    +
  • +
+
+
+
+ +

deriveKeypair

+
deriveKeypair: (seed: string, options?: object) => { privateKey: string; publicKey: string }
+ +
+

Type declaration

+
    +
  • +
      +
    • (seed: string, options?: object): { privateKey: string; publicKey: string }
    • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        seed: string
        +
      • +
      • +
        Optional options: object
        +
      • +
      +

      Returns { privateKey: string; publicKey: string }

      +
        +
      • +
        privateKey: string
        +
      • +
      • +
        publicKey: string
        +
      • +
      +
    • +
    +
  • +
+
+
+
+
+

Functions

+
+ +

ISOTimeToRippleTime

+
    +
  • ISOTimeToRippleTime(iso8601: string): number
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      iso8601: string
      +
      +

      International standard date format.

      +
      +
    • +
    +

    Returns number

    +

    Seconds since ripple epoch (1/1/2000 GMT).

    +
  • +
+
+
+ +

Const computeAccountRootIndex

+
    +
  • computeAccountRootIndex(address: string): string
  • +
+
    +
  • + +
    +
    +

    Compute Account Root Index.

    +
    +

    All objects in a ledger's state tree have a unique index. + The Account Root index is derived by hashing the + address with a namespace identifier. This ensures every + index is unique.

    +

    See Ledger Object IDs.

    +
    +

    Parameters

    +
      +
    • +
      address: string
      +
      +

      The classic account address.

      +
      +
    • +
    +

    Returns string

    +

    The Ledger Object Index for the account.

    +
  • +
+
+
+ +

Const computeBinaryTransactionHash

+
    +
  • computeBinaryTransactionHash(txBlobHex: string): string
  • +
+ +
+
+ +

Const computeBinaryTransactionSigningHash

+
    +
  • computeBinaryTransactionSigningHash(txBlobHex: string): string
  • +
+
    +
  • + +
    +
    +

    Hash the given binary transaction data with the single-signing prefix.

    +
    +

    See Serialization Format.

    +
    +

    Parameters

    +
      +
    • +
      txBlobHex: string
      +
      +

      The binary transaction blob as a hexadecimal string.

      +
      +
    • +
    +

    Returns string

    +

    The hash to sign.

    +
  • +
+
+
+ +

Const computeEscrowHash

+
    +
  • computeEscrowHash(address: any, sequence: any): string
  • +
+ +
+
+ +

Const computeLedgerHash

+
    +
  • computeLedgerHash(ledgerHeader: any): string
  • +
+ +
+
+ +

computeLedgerHeaderHash

+
    +
  • computeLedgerHeaderHash(ledger: any, options?: ComputeLedgerHeaderHashOptions): string
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      ledger: any
      +
    • +
    • +
      options: ComputeLedgerHeaderHashOptions = {}
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Const computeOfferIndex

+
    +
  • computeOfferIndex(address: string, sequence: number): string
  • +
+
    +
  • + +
    + +

    The index of a Offer object is the SHA-512Half of the following values, concatenated in order:

    +
      +
    • The Offer space key (0x006F)
    • +
    • The AccountID of the account placing the offer
    • +
    • The Sequence number of the OfferCreate transaction that created the offer.
    • +
    +

    This method computes an Offer Index (aka Order Index).

    +
    +

    Parameters

    +
      +
    • +
      address: string
      +
      +

      The classic account address of the SignerList owner (starting with r).

      +
      +
    • +
    • +
      sequence: number
      +
    • +
    +

    Returns string

    +

    The index of the account's Offer object.

    +
  • +
+
+
+ +

Const computePaymentChannelHash

+
    +
  • computePaymentChannelHash(address: any, dstAddress: any, sequence: any): string
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      address: any
      +
    • +
    • +
      dstAddress: any
      +
    • +
    • +
      sequence: any
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

Const computeSignerListIndex

+
    +
  • computeSignerListIndex(address: string): string
  • +
+
    +
  • + +
    + +

    The index of a SignerList object is the SHA-512Half of the following values, concatenated in order:

    +
      +
    • The RippleState space key (0x0053)
    • +
    • The AccountID of the owner of the SignerList
    • +
    • The SignerListID (currently always 0).
    • +
    +

    This method computes a SignerList index.

    +
    +

    Parameters

    +
      +
    • +
      address: string
      +
      +

      The classic account address of the SignerList owner (starting with r).

      +
      +
    • +
    +

    Returns string

    +

    The ID of the account's SignerList object.

    +
  • +
+
+
+ +

Const computeStateTreeHash

+
    +
  • computeStateTreeHash(entries: any[]): string
  • +
+ +
+
+ +

Const computeTransactionHash

+
    +
  • computeTransactionHash(txJSON: any): string
  • +
+ +
+
+ +

Const computeTransactionTreeHash

+
    +
  • computeTransactionTreeHash(transactions: any[]): string
  • +
+ +
+
+ +

Const computeTrustlineHash

+
    +
  • computeTrustlineHash(address1: string, address2: string, currency: string): string
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      address1: string
      +
    • +
    • +
      address2: string
      +
    • +
    • +
      currency: string
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

convertKeysFromSnakeCaseToCamelCase

+
    +
  • convertKeysFromSnakeCaseToCamelCase(obj: any): any
  • +
+ +
+
+ +

dropsToXrp

+
    +
  • dropsToXrp(drops: BigNumber.Value): string
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      drops: BigNumber.Value
      +
    • +
    +

    Returns string

    +
  • +
+
+
+ +

generateXAddress

+
    +
  • generateXAddress(options?: GenerateAddressOptions): GeneratedAddress
  • +
+ +
+
+ +

isValidSecret

+
    +
  • isValidSecret(secret: string): boolean
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      secret: string
      +
    • +
    +

    Returns boolean

    +
  • +
+
+
+ +

removeUndefined

+
    +
  • removeUndefined<T>(obj: T): T
  • +
+
    +
  • + +

    Type parameters

    +
      +
    • +

      T: object

      +
    • +
    +

    Parameters

    +
      +
    • +
      obj: T
      +
    • +
    +

    Returns T

    +
  • +
+
+
+ +

rippleTimeToISOTime

+
    +
  • rippleTimeToISOTime(rippleTime: number): string
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      rippleTime: number
      +
      +

      Is the number of seconds since Ripple Epoch (1/1/2000 GMT).

      +
      +
    • +
    +

    Returns string

    +

    Iso8601 international standard date format.

    +
  • +
+
+
+ +

signPaymentChannelClaim

+
    +
  • signPaymentChannelClaim(channel: string, amount: string, privateKey: string): string
  • +
+ +
+
+ +

toRippledAmount

+
    +
  • toRippledAmount(amount: RippledAmount): RippledAmount
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      amount: RippledAmount
      +
    • +
    +

    Returns RippledAmount

    +
  • +
+
+
+ +

verifyPaymentChannelClaim

+
    +
  • verifyPaymentChannelClaim(channel: string, amount: string, signature: string, publicKey: string): boolean
  • +
+ +
+
+ +

xrpToDrops

+
    +
  • xrpToDrops(xrp: BigNumber.Value): string
  • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      xrp: BigNumber.Value
      +
    • +
    +

    Returns string

    +
  • +
+
+
+
+ +
+
+
+
+

Legend

+
+
    +
  • Constructor
  • +
  • Property
  • +
  • Method
  • +
+
    +
  • Inherited property
  • +
  • Inherited method
  • +
+
    +
  • Private property
  • +
  • Private method
  • +
+
    +
  • Static property
  • +
  • Static method
  • +
+
    +
  • Property
  • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/samples/README.md b/docs/samples/README.md deleted file mode 100644 index 8fc52702..00000000 --- a/docs/samples/README.md +++ /dev/null @@ -1,5 +0,0 @@ -Usage: -babel-node balances.js -babel-node cancelall.js (requires setting address and secret in source file first) -babel-node payment.js (requires setting address and secret in source file first) -babel-node ticket.js (requires setting address and secret in source file first) diff --git a/docs/samples/balances.js b/docs/samples/balances.js deleted file mode 100644 index e198985c..00000000 --- a/docs/samples/balances.js +++ /dev/null @@ -1,12 +0,0 @@ -'use strict'; -const RippleAPI = require('../../src').RippleAPI; // require('ripple-lib') - -const api = new RippleAPI({server: 'wss://s1.ripple.com:443'}); -const address = 'r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV'; - -api.connect().then(() => { - api.getBalances(address).then(balances => { - console.log(JSON.stringify(balances, null, 2)); - process.exit(); - }); -}); diff --git a/docs/samples/cancelall.js b/docs/samples/cancelall.js deleted file mode 100644 index 985a8128..00000000 --- a/docs/samples/cancelall.js +++ /dev/null @@ -1,38 +0,0 @@ -'use strict'; -const RippleAPI = require('../../dist/npm').RippleAPI; // require('ripple-lib') - -const address = 'rLDYrujdKUfVx28T9vRDAbyJ7G2WVXKo4K'; -const secret = ''; - -const api = new RippleAPI({server: 'wss://s1.ripple.com:443'}); -const instructions = {maxLedgerVersionOffset: 5}; - -function fail(message) { - console.error(message); - process.exit(1); -} - -function cancelOrder(orderSequence) { - console.log('Cancelling order: ' + orderSequence.toString()); - return api.prepareOrderCancellation(address, {orderSequence}, instructions) - .then(prepared => { - const signing = api.sign(prepared.txJSON, secret); - return api.request({command: 'submit', tx_blob: signing.signedTransaction}); - }); -} - -function cancelAllOrders(orderSequences) { - if (orderSequences.length === 0) { - return Promise.resolve(); - } - const orderSequence = orderSequences.pop(); - return cancelOrder(orderSequence).then(() => cancelAllOrders(orderSequences)); -} - -api.connect().then(() => { - console.log('Connected...'); - return api.getOrders(address).then(orders => { - const orderSequences = orders.map(order => order.properties.sequence); - return cancelAllOrders(orderSequences); - }).then(() => process.exit(0)); -}).catch(fail); diff --git a/docs/samples/payment.js b/docs/samples/payment.js deleted file mode 100644 index 09511c00..00000000 --- a/docs/samples/payment.js +++ /dev/null @@ -1,45 +0,0 @@ -'use strict'; -const RippleAPI = require('../../src').RippleAPI; // require('ripple-lib') - -const address = 'INSERT ADDRESS HERE'; -const secret = 'INSERT SECRET HERE'; - -const api = new RippleAPI({server: 'wss://s1.ripple.com:443'}); -const instructions = {maxLedgerVersionOffset: 5}; - -const payment = { - source: { - address: address, - maxAmount: { - value: '0.01', - currency: 'XRP' - } - }, - destination: { - address: 'rKmBGxocj9Abgy25J51Mk1iqFzW9aVF9Tc', - amount: { - value: '0.01', - currency: 'XRP' - } - } -}; - -function quit(message) { - console.log(message); - process.exit(0); -} - -function fail(message) { - console.error(message); - process.exit(1); -} - -api.connect().then(() => { - console.log('Connected...'); - return api.preparePayment(address, payment, instructions).then(prepared => { - console.log('Payment transaction prepared...'); - const {signedTransaction} = api.sign(prepared.txJSON, secret); - console.log('Payment transaction signed...'); - api.request({command: 'submit', tx_blob: signedTransaction}).then(quit, fail); - }); -}).catch(fail); diff --git a/docs/samples/ticket.js b/docs/samples/ticket.js deleted file mode 100644 index 5b9b4007..00000000 --- a/docs/samples/ticket.js +++ /dev/null @@ -1,31 +0,0 @@ -'use strict'; -const RippleAPI = require('../../src').RippleAPI; // require('ripple-lib') - -const address = 'INSERT ADDRESS HERE'; -const secret = 'INSERT SECRET HERE'; - -const api = new RippleAPI({server: 'wss://s1.ripple.com:443'}); -const instructions = { - maxLedgerVersionOffset: 5 -}; -const numberOfTickets = 1; - -function quit(message) { - console.log(message); - process.exit(0); -} - -function fail(message) { - console.error(message); - process.exit(1); -} - -api.connect().then(() => { - console.log('Connected...'); - return api.prepareTicketCreate(address, numberOfTickets, instructions).then(prepared => { - console.log('Ticket transaction prepared...'); - const {signedTransaction} = api.sign(prepared.txJSON, secret); - console.log('Ticket transaction signed...'); - api.request({command: 'submit', tx_blob: signedTransaction}).then(quit, fail); - }); -}).catch(fail); diff --git a/docs/src/accountSetFlags.md.ejs b/docs/src/accountSetFlags.md.ejs deleted file mode 100644 index fbe9aacd..00000000 --- a/docs/src/accountSetFlags.md.ejs +++ /dev/null @@ -1,23 +0,0 @@ -## AccountSet Flags - -To modify account flags, you can use an AccountSet transaction and its `SetFlag` or `ClearFlag` fields. - -The flags are called [AccountSet flags (asf*)](https://xrpl.org/accountset.html#accountset-flags): - -`RippleAPI.accountSetFlags.requireDestinationTag`: Require a destination tag to send transactions to this account. - -`RippleAPI.accountSetFlags.requireAuthorization`: Require authorization for users to hold balances issued by this address. Can only be enabled if the address has no trust lines connected to it. - -`RippleAPI.accountSetFlags.disallowIncomingXRP`: XRP should not be sent to this account. (Enforced by client applications, not by rippled) - -`RippleAPI.accountSetFlags.disableMasterKey`: Disallow use of the master key pair. Can only be enabled if the account has configured another way to sign transactions. - -`RippleAPI.accountSetFlags.enableTransactionIDTracking`: Track the ID of this account's most recent transaction. - -`RippleAPI.accountSetFlags.noFreeze`: Permanently give up the ability to freeze individual trust lines or disable Global Freeze. This flag can never be disabled after being enabled. - -`RippleAPI.accountSetFlags.globalFreeze`: Freeze all assets issued by this account. - -`RippleAPI.accountSetFlags.defaultRipple`: Enable [rippling](https://xrpl.org/rippling.html) on this account's trust lines by default. - -`RippleAPI.accountSetFlags.depositAuth`:Enable Deposit Authorization on this account. diff --git a/docs/src/basictypes.md.ejs b/docs/src/basictypes.md.ejs deleted file mode 100644 index dab09fbc..00000000 --- a/docs/src/basictypes.md.ejs +++ /dev/null @@ -1,67 +0,0 @@ -# Basic Types - -## Address - -```json -"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" -``` - -```json -"X7AcgcsBL6XDcUb289X4mJ8djcdyKaB5hJDWMArnXr61cqZ" -``` - -An *address* refers to a specific XRP Ledger account. It is a base-58 encoding of a hash of the account's public key. There are two kinds of addresses in common use: - -### Classic Address - -A *classic address* encodes a hash of the account's public key and a checksum. It has no other data. This kind of address always starts with the lowercase letter `r`. - -### X-address - -An *X-address* encodes a hash of the account's public key, a tag, and a checksum. This kind of address starts with the uppercase letter `X` if it is intended for use on the production XRP Ledger (mainnet). It starts with the uppercase letter `T` if it is intended for use on a test network such as Testnet or Devnet. - -## Account Sequence Number - -Every XRP Ledger account has a *sequence number* that is used to keep transactions in order. Every transaction must have a sequence or a ticketSequence number. A transaction can only be executed if it has the next sequence number in order, of the account sending it, or uses a previously generated ticketSequence number. This prevents one transaction from executing twice and transactions executing out of order. The sequence number starts at `1` and increments for each transaction that the account makes. - -## Currency - -Currencies are represented as either 3-character currency codes or 40-character uppercase hexadecimal strings. We recommend using uppercase [ISO 4217 Currency Codes](http://www.xe.com/iso4217.php) only. The string "XRP" is disallowed on trustlines because it is reserved for the XRP Ledger's native currency. The following characters are permitted: all uppercase and lowercase letters, digits, as well as the symbols `?`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `<`, `>`, `(`, `)`, `{`, `}`, `[`, `]`, and `|`. - -## Value -A *value* is a quantity of a currency represented as a decimal string. Be careful: JavaScript's native number format does not have sufficient precision to represent all values. XRP has different precision from other currencies. - -**XRP** has 6 significant digits past the decimal point. In other words, XRP cannot be divided into positive values smaller than `0.000001` (1e-6). This smallest unit is called a "drop". XRP has a maximum value of `100000000000` (1e11). Some RippleAPI methods accept XRP to maintain compatibility with older versions of the API. For consistency with the `rippled` APIs, we recommend formally specifying XRP values in *drops* in all API requests, and converting them to XRP for display. This is like Bitcoin's *satoshis* and Ethereum's *wei*. 1 XRP = 1,000,000 drops. - -**Non-XRP values** have 16 decimal digits of precision, with a maximum value of `9999999999999999e80`. The smallest positive non-XRP value is `1e-81`. - -## Amount - -Example 100.00 USD amount: - -```json -{ - "currency": "USD", - "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM", - "value": "100" -} -``` - -Example 3.0 XRP amount, in drops: -```json -{ - "currency": "drops", - "value": "3000000" -} -``` -(Requires `ripple-lib` version 1.0.0 or higher.) - -An *amount* is an object specifying a currency, a quantity of that currency, and the counterparty (issuer) on the trustline that holds the value. For XRP, there is no counterparty. - -A *lax amount* allows the counterparty to be omitted for all currencies. If the counterparty is not specified in an amount within a transaction specification, then any counterparty may be used for that amount. - -A *lax lax amount* allows either or both the counterparty and value to be omitted. - -A *balance* is an amount than can have a negative value. - -<%- renderSchema('objects/amountbase.json') %> diff --git a/docs/src/boilerplate.md.ejs b/docs/src/boilerplate.md.ejs deleted file mode 100644 index 09806da7..00000000 --- a/docs/src/boilerplate.md.ejs +++ /dev/null @@ -1,60 +0,0 @@ -## Boilerplate - -Use the following [boilerplate code](https://en.wikipedia.org/wiki/Boilerplate_code) to wrap your custom code using RippleAPI. - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI; - -const api = new RippleAPI({ - server: 'wss://xrplcluster.com' // Public cluster -}); -api.on('error', (errorCode, errorMessage) => { - console.log(errorCode + ': ' + errorMessage); -}); -api.on('connected', () => { - console.log('connected'); -}); -api.on('disconnected', (code) => { - // code - [close code](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) sent by the server - // the code is 1000 for a normal closure - console.log('disconnected, code:', code); -}); -api.connect().then(() => { - /* insert code here */ -}).then(() => { - return api.disconnect(); -}).catch(console.error); -``` - -[Node.js v14](https://nodejs.org/) is recommended. Other versions may work but are not frequently tested. - - - - - - - -### Parameters - -The RippleAPI constructor optionally takes one argument, an object with the following options: - -<%- renderSchema('input/api-options.json') %> - -If you omit the `server` parameter, RippleAPI operates [offline](#offline-functionality). - - -### Installation ### - -1. Install [Node.js](https://nodejs.org) and [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). Most Linux distros have a package for Node.js; check that it's the version you want. -2. Use npm to install RippleAPI: - `npm install ripple-lib` - -After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using the Node.js executable, typically named `node`: - - `node script.js` diff --git a/docs/src/combine.md.ejs b/docs/src/combine.md.ejs deleted file mode 100644 index de7a8ec5..00000000 --- a/docs/src/combine.md.ejs +++ /dev/null @@ -1,24 +0,0 @@ -## combine - -`combine(signedTransactions: Array): {signedTransaction: string, id: string}` - -Combines signed transactions from multiple accounts for a multisignature transaction into a form that can be [submitted](#submit). - -### Parameters - -<%- renderSchema("input/combine.json") %> - -### Return Value - -This method returns an object with the following structure: - -<%- renderSchema("output/sign.json") %> - -### Example - -```javascript -const signedTransactions = <%- importFile('test/fixtures/requests/combine.json') %>; -return api.combine(signedTransactions); -``` - -<%- renderFixture("responses/combine.json") %> diff --git a/docs/src/computeLedgerHash.md.ejs b/docs/src/computeLedgerHash.md.ejs deleted file mode 100644 index 2ffe6192..00000000 --- a/docs/src/computeLedgerHash.md.ejs +++ /dev/null @@ -1,28 +0,0 @@ -## computeLedgerHash - -`computeLedgerHash(ledger: object): string` - -Compute the hash of a ledger. - -### Parameters - - - -<%- renderSchema('input/compute-ledger-hash.json') %> - -### Return Value - -This method returns an uppercase hexadecimal string representing the hash of the ledger. - -### Example - -```javascript -const ledger = <%- importFile('test/fixtures/requests/computeLedgerHash.json') %>; -return api.computeLedgerHash(ledger); -``` - -```json -"F4D865D83EB88C1A1911B9E90641919A1314F36E1B099F8E95FE3B7C77BE3349" -``` diff --git a/docs/src/connect.md.ejs b/docs/src/connect.md.ejs deleted file mode 100644 index 839c5676..00000000 --- a/docs/src/connect.md.ejs +++ /dev/null @@ -1,17 +0,0 @@ -## connect - -`connect(): Promise` - -Tells the RippleAPI instance to connect to its rippled server. - -### Parameters - -This method has no parameters. - -### Return Value - -This method returns a promise that resolves with a void value when a connection is established. - -### Example - -See [Boilerplate](#boilerplate) for code sample. diff --git a/docs/src/deriveAddress.md.ejs b/docs/src/deriveAddress.md.ejs deleted file mode 100644 index b9ec496f..00000000 --- a/docs/src/deriveAddress.md.ejs +++ /dev/null @@ -1,19 +0,0 @@ -## deriveAddress - -`deriveAddress(publicKey: string): string` - -Derive an XRP Ledger address from a public key. - -### Parameters - -This method takes one parameter, the public key from which to derive the address. - -### Return Value - -This method returns a string corresponding to the address derived from the public key. - -### Example - -```javascript -var address = api.deriveAddress(public_key); -``` diff --git a/docs/src/deriveKeypair.md.ejs b/docs/src/deriveKeypair.md.ejs deleted file mode 100644 index b8dd163f..00000000 --- a/docs/src/deriveKeypair.md.ejs +++ /dev/null @@ -1,21 +0,0 @@ -## deriveKeypair - -`deriveKeypair(seed: string): {privateKey: string, publicKey: string}` - -Derive a public and private key from a seed. - -### Parameters - -This method takes one parameter, the seed from which to derive the public and private key. - -### Return Value - -This method returns an object containing the public and private components of the keypair corresponding to the seed. - -### Example - -```javascript -var keypair = api.deriveKeypair(seed) -var public_key = keypair.publicKey; -var private_key = keypair.privateKey; -``` diff --git a/docs/src/disconnect.md.ejs b/docs/src/disconnect.md.ejs deleted file mode 100644 index 1eddcef7..00000000 --- a/docs/src/disconnect.md.ejs +++ /dev/null @@ -1,17 +0,0 @@ -## disconnect - -`disconnect(): Promise` - -Tells the RippleAPI instance to disconnect from its rippled server. - -### Parameters - -This method has no parameters. - -### Return Value - -This method returns a promise that resolves with a void value when a connection is destroyed. - -### Example - -See [Boilerplate](#boilerplate) for code sample diff --git a/docs/src/events.md.ejs b/docs/src/events.md.ejs deleted file mode 100644 index a2d68197..00000000 --- a/docs/src/events.md.ejs +++ /dev/null @@ -1,81 +0,0 @@ -# API Events - -## ledger - -This event is emitted whenever a new ledger version is validated on the connected server. - -### Return Value - -<%- renderSchema('output/ledger-event.json') %> - -### Example - -```javascript -api.on('ledger', ledger => { - console.log(JSON.stringify(ledger, null, 2)); -}); -``` - -<%- renderFixture('responses/ledgerEvent.json') %> - -## error - -This event is emitted when there is an error on the connection to the server that cannot be associated to a specific request. - -### Return Value - -The first parameter is a string indicating the error type: -* `badMessage` - rippled returned a malformed message -* `websocket` - the websocket library emitted an error -* one of the error codes found in the [`rippled` Universal Errors](https://xrpl.org/error-formatting.html#universal-errors). - -The second parameter is a message explaining the error. - -The third parameter is: -* the message that caused the error for `badMessage` -* the error object emitted for `websocket` -* the parsed response for rippled errors - -### Example - -```javascript -api.on('error', (errorCode, errorMessage, data) => { - console.log(errorCode + ': ' + errorMessage); -}); -``` - -``` -tooBusy: The server is too busy to help you now. -``` - -## connected - -This event is emitted after connection successfully opened. - -### Example - -```javascript -api.on('connected', () => { - console.log('Connection is open now.'); -}); -``` - -## disconnected - -This event is emitted when connection is closed. - -### Return Value - -The only parameter is a number containing the [close code](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) send by the server. - -### Example - -```javascript -api.on('disconnected', (code) => { - if (code !== 1000) { - console.log('Connection is closed due to error.'); - } else { - console.log('Connection is closed normally.'); - } -}); -``` diff --git a/docs/src/formatBidsAndAsks.md.ejs b/docs/src/formatBidsAndAsks.md.ejs deleted file mode 100644 index 62e8955f..00000000 --- a/docs/src/formatBidsAndAsks.md.ejs +++ /dev/null @@ -1,254 +0,0 @@ -## formatBidsAndAsks - -`formatBidsAndAsks(orderbookInfo: {base: Issue, counter: Issue}, offers: BookOffer[]): orderbook` - -Returns formatted bids and asks, which make up an orderbook. - -This is a static method on the `RippleAPI` class. - -### Parameters - -This method takes two parameters. - -1. An `OrderbookInfo` object: `{ base: Issue, counter: Issue }`. -2. An array of `BookOffer` objects. - -### Return Value - -This method returns an object with two properties: `bids` and `asks`, each of which is an array of bids (buy orders) or asks (sell orders), respectively. Both `bids` and `asks` are formatted the same way. - -Object structure: - -<%- renderSchema('output/get-orderbook.json') %> - -**Raw order data:** The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields. - -For details, see the `rippled` [book_offers method](https://xrpl.org/book_offers.html). - -### Example - -```javascript -const orderbookInfo = { - "base": { - "currency": "USD", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "counter": { - "currency": "BTC", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } -}; - -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; - -return Promise.all( - [ - this.api.request('book_offers', { - taker_gets: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.base), - taker_pays: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.counter), - ledger_index: 'validated', - limit: 20, - taker: address - }), - this.api.request('book_offers', { - taker_gets: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.counter), - taker_pays: RippleAPI.renameCounterpartyToIssuer(orderbookInfo.base), - ledger_index: 'validated', - limit: 20, - taker: address - }) - ] -).then((directOfferResults, reverseOfferResults) => { - const directOffers = (directOfferResults ? directOfferResults : []).reduce((acc, res) => acc.concat(res.offers), []) - const reverseOffers = (reverseOfferResults ? reverseOfferResults : []).reduce((acc, res) => acc.concat(res.offers), []) - const orderbook = RippleAPI.formatBidsAndAsks(orderbookInfo, [...directOffers, ...reverseOffers]); - console.log(JSON.stringify(orderbook, null, 2)); -}); -``` - -``` -{ - "bids": [ - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "0.71800168", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.00016708342", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq", - "sequence": 262660, - "makerExchangeRate": "4297.264683713081" - }, - "data": { - "Account": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98580F4456E6FA8239", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "000000000000001D", - "PreviousTxnID": "16D75506C6317723FC03543130B5E0AAB13E8AD22514C1DB098BE05771C90447", - "PreviousTxnLgrSeq": 43127860, - "Sequence": 262660, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.00016708342" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.71800168" - }, - "index": "DE877FB94EF892A4BCC58DB8CDE063D97AB5133201905DE6C8650B5DEA19E11B", - "owner_funds": "0.03358376764081196", - "quality": "4297.264683713081" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "USD", - "value": "1.6770875", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.00038681218", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM", - "sequence": 231459, - "makerExchangeRate": "4335.663628792661" - }, - "data": { - "Account": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM", - "BookDirectory": "6EAB7C172DEFA430DBFAD120FDC373B5F5AF8B191649EC98580F67435A75B355", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000001", - "PreviousTxnID": "F049EAFDDDA7B99970F77533743D95C9E12A16FE6C56215A0B09C32C4D23163F", - "PreviousTxnLgrSeq": 43127094, - "Sequence": 231459, - "TakerGets": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.00038681218" - }, - "TakerPays": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1.6770875" - }, - "index": "3B314A51BD57601CA1509834DF9462037BF4B05AFCC1E1EFD334DB4E2D7B2AA6", - "owner_funds": "0.03906802968738533", - "quality": "4335.663628792661" - } - }, - // ... trimmed for brevity ... - ], - "asks": [ - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "0.71085738", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.00016876265", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq", - "sequence": 262664, - "makerExchangeRate": "0.0002374071856720401" - }, - "data": { - "Account": "rUKoQ1Zhn6c8EfPsaVa2Yx5NqaKN1JQSvq", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A451086F34ADB0EA11", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "000000000000001D", - "PreviousTxnID": "54CE0B2783AF973718FAFA35E864A3C172BE488EBBB6F2852611C6DAC8893BDF", - "PreviousTxnLgrSeq": 43127875, - "Sequence": 262664, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.71085738" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.00016876265" - }, - "index": "2D4ED103D6B3FEFA21BC385C53B63359F5678E5AA5429DDE6E1D8FE8B41CD6A8", - "owner_funds": "142.8821425048244", - "quality": "0.0002374071856720401" - } - }, - { - "specification": { - "direction": "sell", - "quantity": { - "currency": "USD", - "value": "1.6438778", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "totalPrice": { - "currency": "BTC", - "value": "0.00039462656", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM", - "sequence": 231483, - "makerExchangeRate": "0.0002400583303698121" - }, - "data": { - "Account": "rpmL45YbZWKgp8AH8EjBSknWo5c8dNuuBM", - "BookDirectory": "20294C923E80A51B487EB9547B3835FD483748B170D2D0A4510887515B1216C9", - "BookNode": "0000000000000000", - "Flags": 0, - "LedgerEntryType": "Offer", - "OwnerNode": "0000000000000001", - "PreviousTxnID": "6FA370F52C45F6149482156FF7B4226713AECE991FB7D053F74172CB0B8F24E9", - "PreviousTxnLgrSeq": 43127158, - "Sequence": 231483, - "TakerGets": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "1.6438778" - }, - "TakerPays": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0.00039462656" - }, - "index": "735F9661AD006BA0776859BE371D445555FC0815604603AC056469C16AC84AE3", - "owner_funds": "166.0316626329364", - "quality": "0.0002400583303698121" - } - }, - // ... trimmed for brevity ... - ] -} -``` diff --git a/docs/src/generateAddress.md.ejs b/docs/src/generateAddress.md.ejs deleted file mode 100644 index 9f20397e..00000000 --- a/docs/src/generateAddress.md.ejs +++ /dev/null @@ -1,25 +0,0 @@ -## generateAddress - -`generateAddress(options?: object): {address: string, secret: string}` - -Deprecated: This method returns a classic address. If you do not need the classic address, use `generateXAddress` instead. - -Generate a new XRP Ledger address and corresponding secret. - -### Parameters - -<%- renderSchema('input/generate-address.json') %> - -### Return Value - -This method returns an object with the following structure: - -<%- renderSchema('output/generate-address.json') %> - -### Example - -```javascript -return api.generateAddress(); -``` - -<%- renderFixture('responses/generateAddress.json') %> diff --git a/docs/src/generateFaucetWallet.md.ejs b/docs/src/generateFaucetWallet.md.ejs deleted file mode 100644 index 2e82bfd1..00000000 --- a/docs/src/generateFaucetWallet.md.ejs +++ /dev/null @@ -1,19 +0,0 @@ -## generateFaucetWallet - -`generateFaucetWallet(onTestnet = true)` - -Calls the Testnet or Devnet faucet API in order to generate a new, random wallet with some amount of test XRP. This is for testing purposes only. - -### Example - -**Request** - -Create a new wallet on the Testnet: - -```javascript -const wallet = await api.generateFaucetWallet() -``` - -**Response** - -<%- renderFixture('responses/generateFaucetWallet.json') %> diff --git a/docs/src/generateXAddress.md.ejs b/docs/src/generateXAddress.md.ejs deleted file mode 100644 index c9907dea..00000000 --- a/docs/src/generateXAddress.md.ejs +++ /dev/null @@ -1,23 +0,0 @@ -## generateXAddress - -`generateXAddress(options?: object): {address: string, secret: string}` - -Generate a new XRP Ledger address and corresponding secret. - -### Parameters - -<%- renderSchema('input/generate-x-address.json') %> - -### Return Value - -This method returns an object with the following structure: - -<%- renderSchema('output/generate-x-address.json') %> - -### Example - -```javascript -return api.generateXAddress(); -``` - -<%- renderFixture('responses/generateXAddress.json') %> diff --git a/docs/src/getAccountInfo.md.ejs b/docs/src/getAccountInfo.md.ejs deleted file mode 100644 index 6a917c7b..00000000 --- a/docs/src/getAccountInfo.md.ejs +++ /dev/null @@ -1,25 +0,0 @@ -## getAccountInfo - -`getAccountInfo(address: string, options: object): Promise` - -Returns information for the specified account. Note: For account data that is modifiable by the user, see [getSettings](#getsettings). - -### Parameters - -<%- renderSchema('input/get-account-info.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -<%- renderSchema('output/get-account-info.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getAccountInfo(address).then(info => - {/* ... */}); -``` - -<%- renderFixture('responses/getAccountInfo.json') %> diff --git a/docs/src/getAccountObjects.md.ejs b/docs/src/getAccountObjects.md.ejs deleted file mode 100644 index 0398bf29..00000000 --- a/docs/src/getAccountObjects.md.ejs +++ /dev/null @@ -1,34 +0,0 @@ -## getAccountObjects - -`getAccountObjects(address: string, options: object): Promise` - -Returns objects owned by an account. For an account's trust lines and balances, see `getTrustlines` and `getBalances`. - -### Parameters - -<%- renderSchema('input/get-account-objects.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -<%- renderSchema('output/get-account-objects.json') %> - -The types of objects that may be returned include: - -* `Offer` objects for orders that are currently live, unfunded, or expired but not yet removed. -* `RippleState` objects for trust lines where this account's side is not in the default state. -* A `SignerList` object if the account has multi-signing enabled. -* `Escrow` objects for held payments that have not yet been executed or canceled. -* `PayChannel` objects for open payment channels. -* `Check` objects for pending checks. - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getAccountObjects(address: address).then(objects => - {/* ... */}); -``` - -<%- renderFixture('responses/getAccountObjects.json') %> diff --git a/docs/src/getBalanceSheet.md.ejs b/docs/src/getBalanceSheet.md.ejs deleted file mode 100644 index 35553fdf..00000000 --- a/docs/src/getBalanceSheet.md.ejs +++ /dev/null @@ -1,25 +0,0 @@ -## getBalanceSheet - -`getBalanceSheet(address: string, options: object): Promise` - -Returns aggregate balances by currency plus a breakdown of assets and obligations for a specified account. - -### Parameters - -<%- renderSchema('input/get-balance-sheet.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -<%- renderSchema('output/get-balance-sheet.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getBalanceSheet(address).then(balanceSheet => - {/* ... */}); -``` - -<%- renderFixture('responses/getBalanceSheet.json') %> diff --git a/docs/src/getBalances.md.ejs b/docs/src/getBalances.md.ejs deleted file mode 100644 index baff6d0d..00000000 --- a/docs/src/getBalances.md.ejs +++ /dev/null @@ -1,25 +0,0 @@ -## getBalances - -`getBalances(address: string, options: object): Promise>` - -Returns balances for a specified account. - -### Parameters - -<%- renderSchema('input/get-balances.json') %> - -### Return Value - -This method returns a promise that resolves with an array of objects with the following structure: - -<%- renderSchema('output/get-balances.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getBalances(address).then(balances => - {/* ... */}); -``` - -<%- renderFixture('responses/getBalances.json') %> diff --git a/docs/src/getFee.md.ejs b/docs/src/getFee.md.ejs deleted file mode 100644 index 6bd0ba5f..00000000 --- a/docs/src/getFee.md.ejs +++ /dev/null @@ -1,25 +0,0 @@ -## getFee - -`getFee(): Promise` - -Returns the estimated transaction fee for the rippled server the RippleAPI instance is connected to. - -This uses the [feeCushion parameter](#parameters) provided to the RippleAPI constructor, or the default value of `1.2`. - -### Parameters - -<%- renderSchema('input/get-fee.json') %> - -### Return Value - -This method returns a promise that resolves with a string-encoded floating point value representing the estimated fee to submit a transaction, expressed in XRP. - -### Example - -```javascript -return api.getFee().then(fee => {/* ... */}); -``` - -```json -"0.000012" -``` diff --git a/docs/src/getLedger.md.ejs b/docs/src/getLedger.md.ejs deleted file mode 100644 index 1741e265..00000000 --- a/docs/src/getLedger.md.ejs +++ /dev/null @@ -1,24 +0,0 @@ -## getLedger - -`getLedger(options: object): Promise` - -Returns header information for the specified ledger (or the most recent validated ledger if no ledger is specified). Optionally, all the transactions that were validated in the ledger or the account state information can be returned with the ledger header. - -### Parameters - -<%- renderSchema('input/get-ledger.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -<%- renderSchema('output/get-ledger.json') %> - -### Example - -```javascript -return api.getLedger() - .then(ledger => {/* ... */}); -``` - -<%- renderFixture('responses/getLedger.json') %> diff --git a/docs/src/getLedgerVersion.md.ejs b/docs/src/getLedgerVersion.md.ejs deleted file mode 100644 index efd2203b..00000000 --- a/docs/src/getLedgerVersion.md.ejs +++ /dev/null @@ -1,26 +0,0 @@ -## getLedgerVersion - -`getLedgerVersion(): Promise` - -Returns the most recent validated ledger version number known to the connected server. - -### Parameters - -This method has no parameters. - -### Return Value - -This method returns a promise that resolves with a positive integer representing the most recent validated ledger version number known to the connected server. - -### Example - -```javascript -return api.getLedgerVersion().then(ledgerVersion => { - /* ... */ -}); -``` - -```json -16869039 -``` - diff --git a/docs/src/getOrderbook.md.ejs b/docs/src/getOrderbook.md.ejs deleted file mode 100644 index a18d8d17..00000000 --- a/docs/src/getOrderbook.md.ejs +++ /dev/null @@ -1,34 +0,0 @@ -## getOrderbook - -`getOrderbook(address: string, orderbook: object, options: object): Promise` - -Returns open orders for the specified account. Open orders are orders that have not yet been fully executed and are still in the order book. - -**Breaking change:** In ripple-lib 1.1.0 and earlier, orders returned by this method were not sorted correctly. Orders are now sorted correctly, from best to worst. - -**See also:** An alternative way to get orderbooks is with `request` and [`formatBidsAndAsks`](#formatbidsandasks). - -### Parameters - -<%- renderSchema('input/get-orderbook.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure Both `bids` and `asks` have the same format: - -<%- renderSchema('output/get-orderbook.json') %> - -**Raw order data:** The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields. - -For details, see the `rippled` [book_offers method](https://xrpl.org/book_offers.html). - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const orderbook = <%- importFile('test/fixtures/requests/getOrderbook.json') %>; -return api.getOrderbook(address, orderbook) - .then(orderbook => {/* ... */}); -``` - -<%- renderFixture('responses/getOrderbook.json') %> diff --git a/docs/src/getOrders.md.ejs b/docs/src/getOrders.md.ejs deleted file mode 100644 index 343b8daf..00000000 --- a/docs/src/getOrders.md.ejs +++ /dev/null @@ -1,25 +0,0 @@ -## getOrders - -`getOrders(address: string, options: object): Promise>` - -Returns open orders for the specified account. Open orders are orders that have not yet been fully executed and are still in the order book. - -### Parameters - -<%- renderSchema('input/get-orders.json') %> - -### Return Value - -This method returns a promise that resolves with an array of objects with the following structure: - -<%- renderSchema('output/get-orders.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getOrders(address).then(orders => - {/* ... */}); -``` - -<%- renderFixture('responses/getOrders.json') %> diff --git a/docs/src/getPaths.md.ejs b/docs/src/getPaths.md.ejs deleted file mode 100644 index 3829154a..00000000 --- a/docs/src/getPaths.md.ejs +++ /dev/null @@ -1,25 +0,0 @@ -## getPaths - -`getPaths(pathfind: object): Promise>` - -Finds paths to send a payment. Paths are options for how to route a payment. - -### Parameters - -<%- renderSchema("input/get-paths.json") %> - -### Return Value - -This method returns a promise that resolves with an array of objects with the following structure: - -<%- renderSchema("output/get-paths.json") %> - -### Example - -```javascript -const pathfind = <%- importFile('test/fixtures/requests/getpaths/normal.json') %>; -return api.getPaths(pathfind) - .then(paths => {/* ... */}); -``` - -<%- renderFixture("responses/getPaths.json") %> diff --git a/docs/src/getPaymentChannel.md.ejs b/docs/src/getPaymentChannel.md.ejs deleted file mode 100644 index f4c085b3..00000000 --- a/docs/src/getPaymentChannel.md.ejs +++ /dev/null @@ -1,26 +0,0 @@ -## getPaymentChannel - -`getPaymentChannel(id: string): Promise` - -Returns specified payment channel. - -### Parameters - -<%- renderSchema('input/get-payment-channel.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -<%- renderSchema('output/get-payment-channel.json') %> - -### Example - -```javascript -const channelId = - 'E30E709CF009A1F26E0E5C48F7AA1BFB79393764F15FB108BDC6E06D3CBD8415'; -return api.getPaymentChannel(channelId).then(channel => - {/* ... */}); -``` - -<%- renderFixture('responses/getPaymentChannel.json') %> diff --git a/docs/src/getServerInfo.md.ejs b/docs/src/getServerInfo.md.ejs deleted file mode 100644 index 17bfccfe..00000000 --- a/docs/src/getServerInfo.md.ejs +++ /dev/null @@ -1,23 +0,0 @@ -## getServerInfo - -`getServerInfo(): Promise` - -Get status information about the server that the RippleAPI instance is connected to. - -### Parameters - -This method has no parameters. - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - -<%- renderSchema('output/get-server-info.json') %> - -### Example - -```javascript -return api.getServerInfo().then(info => {/* ... */}); -``` - -<%- renderFixture('responses/getServerInfo.json') %> diff --git a/docs/src/getSettings.md.ejs b/docs/src/getSettings.md.ejs deleted file mode 100644 index f8b123e8..00000000 --- a/docs/src/getSettings.md.ejs +++ /dev/null @@ -1,25 +0,0 @@ -## getSettings - -`getSettings(address: string, options: object): Promise` - -Returns settings for the specified account. Note: For account data that is not modifiable by the user, see [getAccountInfo](#getaccountinfo). - -### Parameters - -<%- renderSchema('input/get-settings.json') %> - -### Return Value - -This method returns a promise that resolves with an array of objects with the following structure. All fields are optional, and are omitted if they are set to their default value. - -<%- renderSchema('output/get-settings.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getSettings(address).then(settings => - {/* ... */}); -``` - -<%- renderFixture('responses/getSettings.json') %> diff --git a/docs/src/getTransaction.md.ejs b/docs/src/getTransaction.md.ejs deleted file mode 100644 index 069e74c2..00000000 --- a/docs/src/getTransaction.md.ejs +++ /dev/null @@ -1,26 +0,0 @@ -## getTransaction - -`getTransaction(id: string, options: object): Promise` - -Retrieves a transaction by its [Transaction ID](#transaction-id). - -### Parameters - -<%- renderSchema('input/get-transaction.json') %> - -### Return Value - -This method returns a promise that resolves with a transaction object containing the following fields. - -<%- renderSchema('output/get-transaction.json') %> - -### Example - -```javascript -const id = '01CDEAA89BF99D97DFD47F79A0477E1DCC0989D39F70E8AACBFE68CC83BD1E94'; -return api.getTransaction(id).then(transaction => { - /* ... */ -}); -``` - -<%- renderFixture('responses/getTransactionPayment.json') %> diff --git a/docs/src/getTransactions.md.ejs b/docs/src/getTransactions.md.ejs deleted file mode 100644 index dacbb3ea..00000000 --- a/docs/src/getTransactions.md.ejs +++ /dev/null @@ -1,24 +0,0 @@ -## getTransactions - -`getTransactions(address: string, options: object): Promise>` - -Retrieves historical transactions of an account. - -### Parameters - -<%- renderSchema('input/get-transactions.json') %> - -### Return Value - -This method returns a promise that resolves with an array of transaction object in the same format as [getTransaction](#gettransaction). - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getTransactions(address).then(transaction => { - /* ... */ -}); -``` - -<%- renderFixture('responses/getTransactions.json') %> diff --git a/docs/src/getTrustlines.md.ejs b/docs/src/getTrustlines.md.ejs deleted file mode 100644 index 172291f8..00000000 --- a/docs/src/getTrustlines.md.ejs +++ /dev/null @@ -1,25 +0,0 @@ -## getTrustlines - -`getTrustlines(address: string, options: object): Promise>` - -Returns trustlines for a specified account. - -### Parameters - -<%- renderSchema("input/get-trustlines.json") %> - -### Return Value - -This method returns a promise that resolves with an array of objects with the following structure. - -<%- renderSchema("output/get-trustlines.json") %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.getTrustlines(address).then(trustlines => - {/* ... */}); -``` - -<%- renderFixture("responses/getTrustlines.json") %> diff --git a/docs/src/hasNextPage.md.ejs b/docs/src/hasNextPage.md.ejs deleted file mode 100644 index cb5efda9..00000000 --- a/docs/src/hasNextPage.md.ejs +++ /dev/null @@ -1,27 +0,0 @@ -## hasNextPage - -`hasNextPage(currentResponse): boolean` - -Returns `true` when there are more pages available. - -When there are more results than contained in the response, the response includes a `marker` field. You can use this convenience method, or check for `marker` yourself. - -See [Markers and Pagination](https://xrpl.org/markers-and-pagination.html). - -### Return Value - -This method returns `true` if `currentResponse` includes a `marker`. - -### Example - -```javascript -return api.request('ledger_data', { - ledger_index: 'validated' -}).then(response => { - /* Do something useful with response */ - - if (api.hasNextPage(response)) { - /* There are more pages available */ - } -}).catch(console.error); -``` diff --git a/docs/src/index.md.ejs b/docs/src/index.md.ejs deleted file mode 100644 index 92ff4937..00000000 --- a/docs/src/index.md.ejs +++ /dev/null @@ -1,72 +0,0 @@ -<%- include('introduction.md.ejs') %> -<%- include('boilerplate.md.ejs') %> -<%- include('offline.md.ejs') %> -<%- include('basictypes.md.ejs') %> -<%- include('transactions.md.ejs') %> -<%- include('specifications.md.ejs') %> -<%- include('rippledAPIs.md.ejs') %> -<%- include('request.md.ejs') %> -<%- include('hasNextPage.md.ejs') %> -<%- include('requestNextPage.md.ejs') %> - -<%- include('staticMethods.md.ejs') %> -<%- include('renameCounterpartyToIssuer.md.ejs') %> -<%- include('formatBidsAndAsks.md.ejs') %> - -<%- include('methods.md.ejs') %> -<%- include('connect.md.ejs') %> -<%- include('disconnect.md.ejs') %> -<%- include('isConnected.md.ejs') %> -<%- include('getServerInfo.md.ejs') %> -<%- include('getFee.md.ejs') %> -<%- include('getLedgerVersion.md.ejs') %> -<%- include('getTransaction.md.ejs') %> -<%- include('getTransactions.md.ejs') %> -<%- include('getTrustlines.md.ejs') %> -<%- include('getBalances.md.ejs') %> -<%- include('getBalanceSheet.md.ejs') %> -<%- include('getPaths.md.ejs') %> -<%- include('getOrders.md.ejs') %> -<%- include('getOrderbook.md.ejs') %> -<%- include('getSettings.md.ejs') %> -<%- include('getAccountInfo.md.ejs') %> -<%- include('getAccountObjects.md.ejs') %> -<%- include('getPaymentChannel.md.ejs') %> -<%- include('getLedger.md.ejs') %> -<%- include('parseAccountFlags.md.ejs') %> -<%- include('prepareTransaction.md.ejs') %> -<%- include('preparePayment.md.ejs') %> -<%- include('prepareTrustline.md.ejs') %> -<%- include('prepareOrder.md.ejs') %> -<%- include('prepareOrderCancellation.md.ejs') %> -<%- include('prepareSettings.md.ejs') %> -<%- include('prepareEscrowCreation.md.ejs') %> -<%- include('prepareEscrowCancellation.md.ejs') %> -<%- include('prepareEscrowExecution.md.ejs') %> -<%- include('preparePaymentChannelCreate.md.ejs') %> -<%- include('preparePaymentChannelClaim.md.ejs') %> -<%- include('preparePaymentChannelFund.md.ejs') %> -<%- include('prepareCheckCreate.md.ejs') %> -<%- include('prepareCheckCancel.md.ejs') %> -<%- include('prepareCheckCash.md.ejs') %> -<%- include('prepareTicketCreate.md.ejs') %> -<%- include('sign.md.ejs') %> -<%- include('combine.md.ejs') %> -<%- include('submit.md.ejs') %> -<%- include('generateXAddress.md.ejs') %> -<%- include('generateAddress.md.ejs') %> -<%- include('isValidAddress.md.ejs') %> -<%- include('isValidSecret.md.ejs') %> -<%- include('deriveKeypair.md.ejs') %> -<%- include('deriveAddress.md.ejs') %> -<%- include('generateFaucetWallet.md.ejs') %> -<%- include('signPaymentChannelClaim.md.ejs') %> -<%- include('verifyPaymentChannelClaim.md.ejs') %> -<%- include('computeLedgerHash.md.ejs') %> -<%- include('xrpToDropsAndDropsToXrp.md.ejs') %> -<%- include('iso8601ToRippleTime.md.ejs') %> -<%- include('rippleTimeToISO8601.md.ejs') %> -<%- include('txFlags.md.ejs') %> -<%- include('accountSetFlags.md.ejs') %> -<%- include('schemaValidator.md.ejs') %> -<%- include('events.md.ejs') %> diff --git a/docs/src/introduction.md.ejs b/docs/src/introduction.md.ejs deleted file mode 100644 index 89f49439..00000000 --- a/docs/src/introduction.md.ejs +++ /dev/null @@ -1,15 +0,0 @@ -# Introduction - -RippleAPI (ripple-lib) is the official client library to the XRP Ledger. Currently, RippleAPI is only available in JavaScript/TypeScript. - -Using RippleAPI, you can: - -* [Query transactions from the XRP Ledger history](#gettransaction) -* [Sign](#sign) transactions securely without connecting to any server -* [Submit](#submit) transactions to the XRP Ledger, including [Payments](#payment), [Orders](#order), [Settings changes](#settings), and [other types](#transaction-types) -* [Generate a new XRP Ledger Address](#generateaddress) -* ... and [much more](#api-methods). - -This page contains documentation for ripple-lib. To use ripple-lib with npm/yarn, begin with the [Getting Started](https://github.com/ripple/ripple-lib#getting-started) steps. - -**What is ripple-lib used for?** Here's a [list of applications that use `ripple-lib`](https://github.com/ripple/ripple-lib/blob/develop/APPLICATIONS.md). Open a PR to add your app or project to the list! diff --git a/docs/src/isConnected.md.ejs b/docs/src/isConnected.md.ejs deleted file mode 100644 index 92761f54..00000000 --- a/docs/src/isConnected.md.ejs +++ /dev/null @@ -1,23 +0,0 @@ -## isConnected - -`isConnected(): boolean` - -Checks if the RippleAPI instance is connected to its rippled server. - -### Parameters - -This method has no parameters. - -### Return Value - -This method returns `true` if connected and `false` if not connected. - -### Example - -```javascript -return api.isConnected(); -``` - -```json -true -``` diff --git a/docs/src/isValidAddress.md.ejs b/docs/src/isValidAddress.md.ejs deleted file mode 100644 index 312e2449..00000000 --- a/docs/src/isValidAddress.md.ejs +++ /dev/null @@ -1,19 +0,0 @@ -## isValidAddress - -`isValidAddress(address: string): boolean` - -Checks if the specified string contains a valid address. X-addresses are considered valid with ripple-lib v1.4.0 and higher. - -### Parameters - -This method takes one parameter, the address to validate. - -### Return Value - -This method returns `true` if the address is valid and `false` if it is not. - -### Example - -```javascript -return api.isValidAddress("address") -``` diff --git a/docs/src/isValidSecret.md.ejs b/docs/src/isValidSecret.md.ejs deleted file mode 100644 index 66bf1952..00000000 --- a/docs/src/isValidSecret.md.ejs +++ /dev/null @@ -1,19 +0,0 @@ -## isValidSecret - -`isValidSecret(secret: string): boolean` - -Checks if the specified string contains a valid secret. - -### Parameters - -This method takes one parameter, the secret which to validate. - -### Return Value - -This method returns `true` if the secret is valid and `false` if it is not. - -### Example - -```javascript -return api.isValidSecret("secret") -``` diff --git a/docs/src/iso8601ToRippleTime.md.ejs b/docs/src/iso8601ToRippleTime.md.ejs deleted file mode 100644 index a258e283..00000000 --- a/docs/src/iso8601ToRippleTime.md.ejs +++ /dev/null @@ -1,27 +0,0 @@ -## iso8601ToRippleTime - -`iso8601ToRippleTime(iso8601: string): number` - -This method parses a string representation of a date, and returns the number of seconds since the "Ripple Epoch" of January 1, 2000 (00:00 UTC). - -The Ripple Epoch is 946684800 seconds after the Unix Epoch. - -This method is useful for creating timestamps to use with the rippled APIs. The rippled APIs represent time as an unsigned integer of the number of seconds since the Ripple Epoch. - -### Parameters - -`iso8601`: A string representing a date and time. This string is parsed using JavaScript's `Date.parse()` method. - -### Return Value - -The number of seconds since the Ripple Epoch. - -### Example - -```javascript -api.iso8601ToRippleTime('2017-02-17T15:04:57Z'); -``` - -```json -540659097 -``` diff --git a/docs/src/methods.md.ejs b/docs/src/methods.md.ejs deleted file mode 100644 index bf0afa6a..00000000 --- a/docs/src/methods.md.ejs +++ /dev/null @@ -1 +0,0 @@ -# API Methods diff --git a/docs/src/offline.md.ejs b/docs/src/offline.md.ejs deleted file mode 100644 index 9219320d..00000000 --- a/docs/src/offline.md.ejs +++ /dev/null @@ -1,27 +0,0 @@ -## Offline functionality - -RippleAPI can also function without internet connectivity, so you can generate secrets and sign transactions from a secure, isolated machine. - -To instantiate RippleAPI in offline mode, use the following code: - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI; - -const api = new RippleAPI(); -/* insert code here */ -``` - -Methods that depend on the state of the XRP Ledger are unavailable in offline mode. To prepare transactions offline, you **must** specify the `fee`, `sequence`, and `maxLedgerVersion` parameters in the [transaction instructions](#transaction-instructions). You can use the following methods while offline: - -* [preparePayment](#preparepayment) -* [prepareTrustline](#preparetrustline) -* [prepareOrder](#prepareorder) -* [prepareOrderCancellation](#prepareordercancellation) -* [prepareSettings](#preparesettings) -* [prepareEscrowCreation](#prepareescrowcreation) -* [prepareEscrowCancellation](#prepareescrowcancellation) -* [prepareEscrowExecution](#prepareescrowexecution) -* [sign](#sign) -* [generateAddress](#generateaddress) -* [generateXAddress](#generatexaddress) -* [computeLedgerHash](#computeledgerhash) diff --git a/docs/src/parseAccountFlags.md.ejs b/docs/src/parseAccountFlags.md.ejs deleted file mode 100644 index 506e2eb8..00000000 --- a/docs/src/parseAccountFlags.md.ejs +++ /dev/null @@ -1,35 +0,0 @@ -## parseAccountFlags - -`parseAccountFlags(Flags: number): object` - -Parse an `AccountRoot` object's [`Flags`](https://xrpl.org/accountroot.html#accountroot-flags). - -### Parameters - -This method takes one parameter, the AccountRoot `Flags` number to parse. Note that flags have different mappings on other types of objects or in transactions such as AccountSet. - -### Return Value - -This method returns an object with containing a key for each AccountRoot flag known to this version of RippleAPI. Each flag has a boolean value of `true` or `false`. - -### Example - -```javascript -const account_info = await api.request('account_info', {account: 'rKsdkGhyZH6b2Zzd5hNnEqSv2wpznn4n6N'}) -const flags = api.parseAccountFlags(account_info.account_data.Flags) -console.log(JSON.stringify(flags, null, 2)) -``` - -```json -{ - "passwordSpent": false, - "requireDestinationTag": false, - "requireAuthorization": false, - "depositAuth": true, - "disallowIncomingXRP": false, - "disableMasterKey": false, - "noFreeze": false, - "globalFreeze": false, - "defaultRipple": false -} -``` diff --git a/docs/src/prepareCheckCancel.md.ejs b/docs/src/prepareCheckCancel.md.ejs deleted file mode 100644 index 1d5e3820..00000000 --- a/docs/src/prepareCheckCancel.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## prepareCheckCancel - -`prepareCheckCancel(address: string, checkCancel: object, instructions: object): Promise` - -Prepare a Check cancellation transaction. This type of transaction cancels an unredeemed Check, removing it from the ledger without sending any money. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-check-cancel.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const checkCancel = <%- importFile('test/fixtures/requests/prepareCheckCancel.json') %>; -return api.prepareCheckCancel(address, checkCancel).then(prepared => - {/* ... */}); -``` - -<%- renderFixture('responses/prepareCheckCancel.json') %> diff --git a/docs/src/prepareCheckCash.md.ejs b/docs/src/prepareCheckCash.md.ejs deleted file mode 100644 index 13bbd85b..00000000 --- a/docs/src/prepareCheckCash.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## prepareCheckCash - -`prepareCheckCash(address: string, checkCash: object, instructions: object): Promise` - -Prepare a Check cashing transaction. This redeems a Check to receive up to the amount authorized by the corresponding CheckCreate transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-check-cash.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const checkCash = <%- importFile('test/fixtures/requests/prepareCheckCashAmount.json') %>; -return api.prepareCheckCash(address, checkCash).then(prepared => - {/* ... */}); -``` - -<%- renderFixture('responses/prepareCheckCashAmount.json') %> diff --git a/docs/src/prepareCheckCreate.md.ejs b/docs/src/prepareCheckCreate.md.ejs deleted file mode 100644 index 4d3e4247..00000000 --- a/docs/src/prepareCheckCreate.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## prepareCheckCreate - -`prepareCheckCreate(address: string, checkCreate: object, instructions: object): Promise` - -Prepare a Check creation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-check-create.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const checkCreate = <%- importFile('test/fixtures/requests/prepareCheckCreate.json') %>; -return api.prepareCheckCreate(address, checkCreate).then(prepared => - {/* ... */}); -``` - -<%- renderFixture('responses/prepareCheckCreate.json') %> diff --git a/docs/src/prepareEscrowCancellation.md.ejs b/docs/src/prepareEscrowCancellation.md.ejs deleted file mode 100644 index b7f99a41..00000000 --- a/docs/src/prepareEscrowCancellation.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## prepareEscrowCancellation - -`prepareEscrowCancellation(address: string, escrowCancellation: object, instructions: object): Promise` - -Prepare an escrow cancellation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-escrow-cancellation.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const escrowCancellation = <%- importFile('test/fixtures/requests/prepareEscrowCancellation.json') %>; -return api.prepareEscrowCancellation(address, escrowCancellation).then(prepared => - {/* ... */}); -``` - -<%- renderFixture('responses/prepareEscrowCancellation.json') %> diff --git a/docs/src/prepareEscrowCreation.md.ejs b/docs/src/prepareEscrowCreation.md.ejs deleted file mode 100644 index aabacc52..00000000 --- a/docs/src/prepareEscrowCreation.md.ejs +++ /dev/null @@ -1,36 +0,0 @@ -## prepareEscrowCreation - -`prepareEscrowCreation(address: string, escrowCreation: object, instructions: object): Promise` - -Prepare an escrow creation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-escrow-creation.json') %> - -This is a convenience method for generating the EscrowCreate JSON used by rippled, so the same restrictions apply. - -Field mapping: `allowCancelAfter` is equivalent to rippled's `CancelAfter`; `allowExecuteAfter` is equivalent to `FinishAfter`. At the `allowCancelAfter` time, the escrow is considered expired. This means that the funds can only be returned to the sender. At the `allowExecuteAfter` time, the escrow is permitted to be released to the recipient (if the `condition` is fulfilled). - -Note that `allowCancelAfter` must be chronologically later than `allowExecuteAfter`. - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const escrowCreation = <%- importFile('test/fixtures/requests/prepareEscrowCreation.json') %>; -return api.prepareEscrowCreation(address, escrowCreation).then(prepared => - {/* ... */}); -``` - -<%- renderFixture('responses/prepareEscrowCreation.json') %> diff --git a/docs/src/prepareEscrowExecution.md.ejs b/docs/src/prepareEscrowExecution.md.ejs deleted file mode 100644 index bb019d9d..00000000 --- a/docs/src/prepareEscrowExecution.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## prepareEscrowExecution - -`prepareEscrowExecution(address: string, escrowExecution: object, instructions: object): Promise` - -Prepare an escrow execution transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-escrow-execution.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const escrowExecution = <%- importFile('test/fixtures/requests/prepareEscrowExecution.json') %>; -return api.prepareEscrowExecution(address, escrowExecution).then(prepared => - {/* ... */}); -``` - -<%- renderFixture('responses/prepareEscrowExecution.json') %> diff --git a/docs/src/prepareOrder.md.ejs b/docs/src/prepareOrder.md.ejs deleted file mode 100644 index cef87b13..00000000 --- a/docs/src/prepareOrder.md.ejs +++ /dev/null @@ -1,32 +0,0 @@ -## prepareOrder - -`prepareOrder(address: string, order: object, instructions: object): Promise` - -Prepare an order transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-order.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; - -// Buy 10.10 USD (of the specified issuer) for 2.0 XRP (2000000 drops), fill or kill. -const order = <%- importFile('test/fixtures/requests/prepareOrder.json') %>; -return api.prepareOrder(address, order) - .then(prepared => {/* ... */}); -``` - -<%- renderFixture('responses/prepareOrder.json') %> diff --git a/docs/src/prepareOrderCancellation.md.ejs b/docs/src/prepareOrderCancellation.md.ejs deleted file mode 100644 index 74a72f62..00000000 --- a/docs/src/prepareOrderCancellation.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## prepareOrderCancellation - -`prepareOrderCancellation(address: string, orderCancellation: object, instructions: object): Promise` - -Prepare an order cancellation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema("input/prepare-order-cancellation.json") %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema("output/prepare.json") %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const orderCancellation = {orderSequence: 123}; -return api.prepareOrderCancellation(address, orderCancellation) - .then(prepared => {/* ... */}); -``` - -<%- renderFixture("responses/prepareOrderCancellation.json") %> diff --git a/docs/src/preparePayment.md.ejs b/docs/src/preparePayment.md.ejs deleted file mode 100644 index 7439f801..00000000 --- a/docs/src/preparePayment.md.ejs +++ /dev/null @@ -1,33 +0,0 @@ -## preparePayment - -`preparePayment(address: string, payment: object, instructions: object): Promise` - -Prepare a payment transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema("input/prepare-payment.json") %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema("output/prepare.json") %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const payment = <%- importFile('test/fixtures/requests/preparePayment.json') %>; -return api.preparePayment(address, payment).then(prepared => { - /* ... */ - }).catch(error => { - /* ... as with all prepare* methods, use a Promise catch block to handle errors ... */ - }) -``` - -<%- renderFixture("responses/preparePayment.json") %> diff --git a/docs/src/preparePaymentChannelClaim.md.ejs b/docs/src/preparePaymentChannelClaim.md.ejs deleted file mode 100644 index ea320f5e..00000000 --- a/docs/src/preparePaymentChannelClaim.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## preparePaymentChannelClaim - -`preparePaymentChannelClaim(address: string, paymentChannelClaim: object, instructions: object): Promise` - -Prepare a payment channel claim transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-payment-channel-claim.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const paymentChannelClaim = <%- importFile('test/fixtures/requests/preparePaymentChannelClaim.json') %>; -return api.preparePaymentChannelClaim(address, paymentChannelClaim).then(prepared => - {/* ... */}); -``` - -<%- renderFixture('responses/preparePaymentChannelClaim.json') %> diff --git a/docs/src/preparePaymentChannelCreate.md.ejs b/docs/src/preparePaymentChannelCreate.md.ejs deleted file mode 100644 index 8b31a7fa..00000000 --- a/docs/src/preparePaymentChannelCreate.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## preparePaymentChannelCreate - -`preparePaymentChannelCreate(address: string, paymentChannelCreate: object, instructions: object): Promise` - -Prepare a payment channel creation transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-payment-channel-create.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const paymentChannelCreate = <%- importFile('test/fixtures/requests/preparePaymentChannelCreate.json') %>; -return api.preparePaymentChannelCreate(address, paymentChannelCreate).then(prepared => - {/* ... */}); -``` - -<%- renderFixture('responses/preparePaymentChannelCreate.json') %> diff --git a/docs/src/preparePaymentChannelFund.md.ejs b/docs/src/preparePaymentChannelFund.md.ejs deleted file mode 100644 index fc985f50..00000000 --- a/docs/src/preparePaymentChannelFund.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## preparePaymentChannelFund - -`preparePaymentChannelFund(address: string, paymentChannelFund: object, instructions: object): Promise` - -Prepare a payment channel fund transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-payment-channel-fund.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const paymentChannelFund = <%- importFile('test/fixtures/requests/preparePaymentChannelFund.json') %>; -return api.preparePaymentChannelFund(address, paymentChannelFund).then(prepared => - {/* ... */}); -``` - -<%- renderFixture('responses/preparePaymentChannelFund.json') %> diff --git a/docs/src/prepareSettings.md.ejs b/docs/src/prepareSettings.md.ejs deleted file mode 100644 index 9b0d4b45..00000000 --- a/docs/src/prepareSettings.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## prepareSettings - -`prepareSettings(address: string, settings: object, instructions: object): Promise` - -Prepare a settings transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema('input/prepare-settings.json') %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema('output/prepare.json') %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const settings = <%- importFile('test/fixtures/requests/prepareSettings.json') %>; -return api.prepareSettings(address, settings) - .then(prepared => {/* ... */}); -``` - -<%- renderFixture('requests/prepareSettings.json') %> diff --git a/docs/src/prepareTicketCreate.md.ejs b/docs/src/prepareTicketCreate.md.ejs deleted file mode 100644 index 0fe3e57f..00000000 --- a/docs/src/prepareTicketCreate.md.ejs +++ /dev/null @@ -1,34 +0,0 @@ -## prepareTicketCreate - -`prepareTicketCreate(address: string, ticketCount: number, instructions: object): Promise` - -Prepare a ticket transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -Ticket functionality requires the [TicketBatch amendment](https://github.com/ripple/xrpl-dev-portal/issues/898). As of 2020-11-24, this amendment is not activated on the Mainnet, Testnet, or Devnet. - -### Parameters - -<%- renderSchema("input/prepare-ticket-create.json") %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema("output/prepare.json") %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -return api.prepareTicketCreate(address, 2).then(prepared => { - /* ... */ - }).catch(error => { - /* ... as with all prepare* methods, use a Promise catch block to handle errors ... */ - }) -``` - -<%- renderFixture("responses/prepareTicketCreate.json") %> diff --git a/docs/src/prepareTransaction.md.ejs b/docs/src/prepareTransaction.md.ejs deleted file mode 100644 index 669aa986..00000000 --- a/docs/src/prepareTransaction.md.ejs +++ /dev/null @@ -1,50 +0,0 @@ -## prepareTransaction - -`prepareTransaction(transaction: object, instructions: object): Promise` - -Prepare a transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -This method works with any of [the transaction types supported by rippled](https://xrpl.org/transaction-types.html). - -Notably, this is the preferred method for preparing `DepositPreauth` or `AccountDelete` transactions. - -### Parameters - -Name | Type | Description ----- | ---- | ----------- -transaction | [Transaction](https://xrpl.org/transaction-formats.html) | The specification (JSON) of the transaction to prepare. Set `Account` to the address of the account that is creating the transaction. You may omit auto-fillable fields like `Fee`, `Flags`, and `Sequence` to have them set automatically. -instructions | [Instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction. - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema("output/prepare.json") %> - -### Example - -```javascript -async function preparedPreauth() { - const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; - return api.prepareTransaction({ - TransactionType: 'DepositPreauth', - Account: address, - Authorize: 'rMyVso4p83khNyHdV1m1PggV9QNadCj8wM' - }); -} -``` - -```javascript -{ - txJSON: '{"TransactionType":"DepositPreauth","Account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","Authorize":"rMyVso4p83khNyHdV1m1PggV9QNadCj8wM","Flags":2147483648,"LastLedgerSequence":13561714,"Fee":"12","Sequence":1}', - instructions: { - fee: '0.000012', - sequence: 1, - maxLedgerVersion: 13561714 - } -} -``` diff --git a/docs/src/prepareTrustline.md.ejs b/docs/src/prepareTrustline.md.ejs deleted file mode 100644 index 3bc1af84..00000000 --- a/docs/src/prepareTrustline.md.ejs +++ /dev/null @@ -1,30 +0,0 @@ -## prepareTrustline - -`prepareTrustline(address: string, trustline: object, instructions: object): Promise` - -Prepare a trustline transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit). - -### Parameters - -<%- renderSchema("input/prepare-trustline.json") %> - -### Return Value - -This method returns a promise that resolves with an object with the following structure: - - - -<%- renderSchema("output/prepare.json") %> - -### Example - -```javascript -const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; -const trustline = <%- importFile('test/fixtures/requests/prepareTrustline.json') %>; -return api.prepareTrustline(address, trustline).then(prepared => - {/* ... */}); -``` - -<%- renderFixture("responses/prepareTrustline.json") %> diff --git a/docs/src/renameCounterpartyToIssuer.md.ejs b/docs/src/renameCounterpartyToIssuer.md.ejs deleted file mode 100644 index 9fbc753c..00000000 --- a/docs/src/renameCounterpartyToIssuer.md.ejs +++ /dev/null @@ -1,37 +0,0 @@ -## renameCounterpartyToIssuer - -`renameCounterpartyToIssuer(issue: {currency: string, counterparty: address}): {currency: string, issuer: address}` - -Returns an object with the `counterparty` field renamed to `issuer`. This is useful because RippleAPI generally uses the name `counterparty` while the rippled API generally uses the name `issuer`. - -This is a static method on the `RippleAPI` class. - -### Parameters - -This method takes one parameter, an object with a `counterparty` field. - -### Return Value - -This method returns a new object based on the source object, but with `issuer` instead of `counterparty`. - -### Example - -```javascript -const orderbookInfo = { - "base": { - "currency": "USD", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "counter": { - "currency": "BTC", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } -}; -console.log(RippleAPI.renameCounterpartyToIssuer(orderbookInfo.base)) -console.log(RippleAPI.renameCounterpartyToIssuer(orderbookInfo.counter)) -``` - -``` -{ currency: 'USD', issuer: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' } -{ currency: 'BTC', issuer: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' } -``` diff --git a/docs/src/request.md.ejs b/docs/src/request.md.ejs deleted file mode 100644 index 595b66ce..00000000 --- a/docs/src/request.md.ejs +++ /dev/null @@ -1,27 +0,0 @@ -## request - -`request(command: string, options: object): Promise` - -Returns the response from invoking the specified command, with the specified options, on the connected rippled server. - -Refer to [HTTP / WebSocket APIs](https://xrpl.org/rippled-api.html) for commands and options. All XRP amounts must be specified in drops. One drop is equal to 0.000001 XRP. See [Specifying Currency Amounts](https://xrpl.org/basic-data-types.html#specifying-currency-amounts). - -Most commands return data for the `current` (in-progress, open) ledger by default. Do not rely on this. Always specify a ledger version in your request. In the example below, the 'validated' ledger is requested, which is the most recent ledger that has been validated by the whole network. See [Specifying Ledgers](https://xrpl.org/basic-data-types.html#specifying-ledgers). - -### Return Value - -This method returns a promise that resolves with the response from rippled. - -### Example - -```javascript -// Replace 'ledger' with your desired rippled command -return api.request('ledger', { - ledger_index: 'validated' -}).then(response => { - /* Do something useful with response */ - console.log(JSON.stringify(response, null, 2)) -}).catch(console.error); -``` - -<%- renderFixture('responses/ledger.json') %> diff --git a/docs/src/requestNextPage.md.ejs b/docs/src/requestNextPage.md.ejs deleted file mode 100644 index 8a004706..00000000 --- a/docs/src/requestNextPage.md.ejs +++ /dev/null @@ -1,29 +0,0 @@ -## requestNextPage - -`requestNextPage(command: string, params: object = {}, currentResponse: object): Promise` - -Requests the next page of data. - -You can use this convenience method, or include `currentResponse.marker` in `params` yourself, when using `request`. - -See [Markers and Pagination](https://xrpl.org/markers-and-pagination.html). - -### Return Value - -This method returns a promise that resolves with the next page of data from rippled. - -If the response does not have a next page, the promise rejects with `new errors.NotFoundError('response does not have a next page')`. - -### Example - -```javascript -const command = 'ledger_data' -const params = { - ledger_index: 'validated' -} -return api.request(command, params).then(response => { - return api.requestNextPage(command, params, response) -}).then(response_page_2 => { - /* Do something useful with second page of response */ -}).catch(console.error); -``` diff --git a/docs/src/rippleTimeToISO8601.md.ejs b/docs/src/rippleTimeToISO8601.md.ejs deleted file mode 100644 index 7193eb6e..00000000 --- a/docs/src/rippleTimeToISO8601.md.ejs +++ /dev/null @@ -1,27 +0,0 @@ -## rippleTimeToISO8601 - -`rippleTimeToISO8601(rippleTime: number): string` - -This method takes the number of seconds since the "Ripple Epoch" of January 1, 2000 (00:00 UTC) and returns a string representation of a date. - -The Ripple Epoch is 946684800 seconds after the Unix Epoch. - -This method is useful for interpreting timestamps returned by the rippled APIs. The rippled APIs represent time as an unsigned integer of the number of seconds since the Ripple Epoch. - -### Parameters - -`rippleTime`: A number of seconds since the Ripple Epoch. - -### Return Value - -A string representing a date and time, created by calling a `Date` object's `toISOString()` method. - -### Example - -```javascript -api.rippleTimeToISO8601(540659097); -``` - -```json -'2017-02-17T15:04:57.000Z' -``` diff --git a/docs/src/rippledAPIs.md.ejs b/docs/src/rippledAPIs.md.ejs deleted file mode 100644 index 56351f63..00000000 --- a/docs/src/rippledAPIs.md.ejs +++ /dev/null @@ -1,71 +0,0 @@ -# rippled APIs - -ripple-lib uses the XRP Ledger's [WebSocket API](https://xrpl.org/rippled-api.html) for online functionality. You can use ripple-lib to call these APIs directly. Use the `request()`, `hasNextPage()`, and `requestNextPage()` methods: - -* Use `request()` to issue any `rippled` command, including `account_currencies`, `subscribe`, and `unsubscribe`. [Full list of API Methods](https://xrpl.org/public-rippled-methods.html). -* Use `hasNextPage()` to determine whether a response has more pages. This is true when the response includes a [`marker` field](https://xrpl.org/markers-and-pagination.html). -* Use `requestNextPage()` to request the next page of data. - -When using rippled APIs: - -* [Specify XRP amounts in drops](https://xrpl.org/basic-data-types.html#specifying-currency-amounts). -* [Specify timestamps as the number of seconds since the "Ripple Epoch"](https://xrpl.org/basic-data-types.html#specifying-time). -* Instead of `counterparty`, use `issuer`. - -## Listening to streams - -The `rippled` server can push updates to your client when various events happen. -Refer to [Subscriptions in the `rippled` API docs](https://xrpl.org/subscribe.html) for details. - -Note that the `streams` parameter for generic streams takes an array. For example, to subscribe to the `validations` stream, use `{ streams: [ 'validations' ] }`. - -The string names of some generic streams to subscribe to are in the table below. (Refer to `rippled` for an up-to-date list of streams.) - -Type | Description ----- | ----------- -`server` | Sends a message whenever the status of the `rippled` server (for example, network connectivity) changes. -`ledger` | Sends a message whenever the consensus process declares a new validated ledger. -`transactions` | Sends a message whenever a transaction is included in a closed ledger. -`transactions_proposed` | Sends a message whenever a transaction is included in a closed ledger, as well as some transactions that have not yet been included in a validated ledger and may never be. Not all proposed transactions appear before validation. Even some transactions that don't succeed are included in validated ledgers because they take the anti-spam transaction fee. -`validations` | Sends a message whenever the server receives a validation message, also called a validation vote, regardless of whether the server trusts the validator. -`manifests` | Sends a message whenever the server receives a manifest. -`peer_status` | (Admin-only) Information about connected peer `rippled` servers, especially with regards to the consensus process. - -When you subscribe to a stream, you must also listen to the relevant message type(s). Some of the available message types are in the table below. (Refer to `rippled` for an up-to-date list of message types.) - -Type | Description ----- | ----------- -`ledgerClosed` | Sent by the `ledger` stream when the consensus process declares a new fully validated ledger. The message identifies the ledger and provides some information about its contents. -`validationReceived` | Sent by the `validations` stream when the server receives a validation message, also called a validation vote, regardless of whether the server trusts the validator. -`manifestReceived` | Sent by the `manifests` stream when the server receives a manifest. -`transaction` | Sent by many subscriptions including `transactions`, `transactions_proposed`, `accounts`, `accounts_proposed`, and `book` (Order Book). See [Transaction Streams](https://xrpl.org/subscribe.html#transaction-streams) for details. -`peerStatusChange` | (Admin-only) Reports a large amount of information on the activities of other `rippled` servers to which the server is connected. -`path_find` | Asynchronous follow-up response to the currently open path\_find request. See [rippled path\_find method](https://xrpl.org/path_find.html) for details. - -To register your listener function, use `connection.on(type, handler)`. - -Here is an example of listening for transactions on given account(s): -``` -const account = 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn' // Replace with the account you want notifications for -api.connect().then(() => { - - // 'transaction' can be replaced with the relevant `type` from the table above - api.connection.on('transaction', (event) => { - - // Do something useful with `event` - console.log(JSON.stringify(event, null, 2)) - }) - - api.request('subscribe', { - accounts: [ account ] - }).then(response => { - console.log('Successfully subscribed') - }).catch(error => { - // Handle `error` - }) -}) -``` - -The subscription ends when you unsubscribe or the WebSocket connection is closed. - -For full details, see the [subscribe method](https://xrpl.org/subscribe.html). diff --git a/docs/src/schemaValidator.md.ejs b/docs/src/schemaValidator.md.ejs deleted file mode 100644 index 5b083e2f..00000000 --- a/docs/src/schemaValidator.md.ejs +++ /dev/null @@ -1,35 +0,0 @@ -## schemaValidator - -Unlike the rest of the ripple-lib API, schemaValidator is a static object on RippleAPI. It provides utility methods that do not use a server. - -## schemaValidate - -`RippleAPI.schemaValidator.schemaValidate(schemaName: string, object: any): void` - -This method checks an object for conformance to a specified schema. It does not return anything, but throws a `ValidationError` if the object does not conform to the schema. - -### Example - -```javascript -RippleAPI.schemaValidator.schemaValidate('sign', { - signedTransaction: '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8744630440220680070A157682D9EB510E8AD58C35DC9C8346B155077D73792E88120B7A3B6B1022079537D3300C9B4D2D3D62ACCE1E66CDA893F9612CB2577ADEC8154B933765336770B6578616D706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304', - id: '10B54D31384A49336C36A5907E3C28227139E282D3C7F734FEA351DE446F3674' -}) -``` - -```json -undefined -``` - -If the object is valid (conforms to the schema), nothing is returned. Otherwise, `schemaValidate` throws an error: - -```javascript -RippleAPI.schemaValidator.schemaValidate('sign', { - signedTransaction: '12000322800000002400000017201B0086955368400000000000000C732102F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8744630440220680070A157682D9EB510E8AD58C35DC9C8346B155077D73792E88120B7A3B6B1022079537D3300C9B4D2D3D62ACCE1E66CDA893F9612CB2577ADEC8154B933765336770B6578616D706C652E636F6D81145E7B112523F68D2F5E879DB4EAC51C6698A69304', - id: '123' -}) -``` - -``` -[ValidationError(instance.id does not match pattern "^[A-F0-9]{64}$")] -``` diff --git a/docs/src/sign.md.ejs b/docs/src/sign.md.ejs deleted file mode 100644 index 50c630c7..00000000 --- a/docs/src/sign.md.ejs +++ /dev/null @@ -1,141 +0,0 @@ -## sign - -``` -sign(txJSON: string, secret: string, options: object): {signedTransaction: string, id: string} -sign(txJSON: string, keypair: object, options: object): {signedTransaction: string, id: string} -``` - -Sign a prepared transaction. The signed transaction can then be [submitted](#submit). - -This method can sign any of [the transaction types supported by ripple-binary-codec](https://github.com/ripple/ripple-binary-codec/blob/cfcde79c19c359e9a0466d7bc3dc9a3aef47bb99/src/enums/definitions.json#L1637). When a new transaction type is added to the XRP Ledger, it is unrecognized until `ripple-binary-codec` is updated. If you try to sign an unrecognized transaction type, this method throws an error like the following: - -`Error: [TRANSACTION_TYPE] is not a valid name or ordinal for TransactionType` - -### Parameters - -<%- renderSchema("input/sign.json") %> - -When this method is used for multi-signing, the `options` parameter is required. See the multi-signing example in this section for more details. - -### Return Value - -This method returns an object with the following structure: - -<%- renderSchema("output/sign.json") %> - -### Example - -```javascript -// AccountSet transaction that sets Domain to example.com: -const txJSON = '{"Flags":2147483648,"TransactionType":"AccountSet","Account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","Domain":"6578616D706C652E636F6D","LastLedgerSequence":8820051,"Fee":"12","Sequence":23}'; -const secret = 'shsWGZcmZz6YsWWmcnpfr6fLTdtFV'; -const keypair = { privateKey: '00ACCD3309DB14D1A4FC9B1DAE608031F4408C85C73EE05E035B7DC8B25840107A', publicKey: '02F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8' }; -return api.sign(txJSON, secret); // or: api.sign(txJSON, keypair); -``` - -<%- renderFixture("responses/sign.json") %> - -### Example Keypairs - -To learn how keypairs are derived read [here](https://xrpl.org/cryptographic-keys.html#generating-keys). -```javascript -// secp25519 (33 bytes) -const privateKey = "002512BBDFDBB77510883B7DCCBEF270B86DEAC8B64AC762873D75A1BEE6298665" -const publicKey = "0390A196799EE412284A5D80BF78C3E84CBB80E1437A0AECD9ADF94D7FEAAFA284" - -// ed25519 (Note the 0xED prefixes a 32 byte value for a total of 33 bytes) -const privateKey = "ED0B6CBAC838DFE7F47EA1BD0DF00EC282FDF45510C92161072CCFB84035390C4D" -const publicKey = "ED1A7C082846CFF58FF9A892BA4BA2593151CCF1DBA59F37714CC9ED39824AF85F" -``` - -### Example (multi-signing) - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI; - -// jon's address will have a multi-signing setup with a quorum of 2 -const jon = { - account: 'rJKpme4m2zBQceBuU89d7vLMzgoUw2Ptj', - secret: 'sh4Va7b1wQof8knHFV2sxwX12fSgK' -}; -const aya = { - account: 'rnrPdBjs98fFFfmRpL6hM7exT788SWQPFN', - secret: 'snaMuMrXeVc2Vd4NYvHofeGNjgYoe' -}; -const bran = { - account: 'rJ93RLnT1t5A8fCr7HTScw7WtfKJMRXodH', - secret: 'shQtQ8Um5MS218yvEU3Ehy1eZQKqH' -}; - -// Setup the signers list with a quorum of 2 -const multiSignSetupTransaction = { - "Flags": 0, - "TransactionType": "SignerListSet", - "Account": "rJKpme4m2zBQceBuU89d7vLMzgoUw2Ptj", - "Fee": "120", - "SignerQuorum": 2, - "SignerEntries": [ - { - "SignerEntry": { - "Account": "rnrPdBjs98fFFfmRpL6hM7exT788SWQPFN", - "SignerWeight": 2 - } - }, - { - "SignerEntry": { - "Account": "rJ93RLnT1t5A8fCr7HTScw7WtfKJMRXodH", - "SignerWeight": 1 - } - }, - ] -}; - -// a transaction which requires multi signing -const multiSignPaymentTransaction = { - TransactionType: 'Payment', - Account: 'rJKpme4m2zBQceBuU89d7vLMzgoUw2Ptj', - Destination: 'rJ93RLnT1t5A8fCr7HTScw7WtfKJMRXodH', - Amount: '88000000' -}; - -const multiSignPaymentInstruction = { - signersCount: 2 -}; - -const api = new RippleAPI({ - server: 'wss://s.altnet.rippletest.net:51233' -}); - -api.connect().then(() => { - // adding the multi signing feature to jon's account - api.prepareTransaction(multiSignSetupTransaction).then((prepared) => { - console.log(prepared); - jonSign = api.sign(prepared.txJSON, jon.secret).signedTransaction; - api.submit(jonSign).then( response => { - console.log(response.resultCode, response.resultMessage); - - // multi sign a transaction - api.prepareTransaction(multiSignPaymentTransaction, multiSignPaymentInstruction).then(prepared => { - console.log(prepared); - - // Aya and Bran sign it too but with 'signAs' set to their own account - let ayaSign = api.sign(prepared.txJSON, aya.secret, {'signAs': aya.account}).signedTransaction; - let branSign = api.sign(prepared.txJSON, bran.secret, {'signAs': bran.account}).signedTransaction; - - // signatures are combined and submitted - let combinedTx = api.combine([ayaSign, branSign]); - api.submit(combinedTx.signedTransaction).then(response => { - console.log(response.tx_json.hash); - return api.disconnect(); - }).catch(console.error); - }).catch(console.error); - }).catch(console.error) - }).catch(console.error); -}).catch(console.error); -``` - -If the multi-signing account was setup properly, the above example logs `resultCode: 'tesSUCCESS'` and the hash for the transaction. If any of `{signAs: some_address}` options were missing, the code returns a validation error such as: - -``` -[ValidationError(txJSON is not the same for all signedTransactions)] -``` diff --git a/docs/src/signPaymentChannelClaim.md.ejs b/docs/src/signPaymentChannelClaim.md.ejs deleted file mode 100644 index b1bc4c9b..00000000 --- a/docs/src/signPaymentChannelClaim.md.ejs +++ /dev/null @@ -1,28 +0,0 @@ -## signPaymentChannelClaim - -`signPaymentChannelClaim(channel: string, amount: string, privateKey: string): string` - -Sign a payment channel claim. A [PaymentChannelClaim](#preparepaymentchannelclaim) transaction can use the resulting signature to withdraw XRP from a payment channel. - -### Parameters - -<%- renderSchema("input/sign-payment-channel-claim.json") %> - -### Return Value - -This method returns a signature string: - -<%- renderSchema("output/sign-payment-channel-claim.json") %> - -### Example - -```javascript -const channel = - '3E18C05AD40319B809520F1A136370C4075321B285217323396D6FD9EE1E9037'; -const amount = '.00001'; -const privateKey = - 'ACCD3309DB14D1A4FC9B1DAE608031F4408C85C73EE05E035B7DC8B25840107A'; -return api.signPaymentChannelClaim(channel, amount, privateKey); -``` - -<%- renderFixture("responses/signPaymentChannelClaim.json") %> diff --git a/docs/src/specifications.md.ejs b/docs/src/specifications.md.ejs deleted file mode 100644 index b228ec3f..00000000 --- a/docs/src/specifications.md.ejs +++ /dev/null @@ -1,185 +0,0 @@ -# Transaction Specifications - -A *transaction specification* specifies what a transaction should do. Each [Transaction Type](#transaction-types) has its own type of specification, which corresponds to the [native XRP Ledger transaction types](https://xrpl.org/transaction-types.html). - -## Account Delete - -Delete your account and send the remaining XRP elsewhere. (Native transaction type: [AccountDelete](https://xrpl.org/accountdelete.html)) - -<%- renderSchema('specifications/account-delete.json') %> - -> **Note:** To prepare an Account Delete transaction, use [`prepareTransaction()`](#preparetransaction) with the [native transaction format](https://xrpl.org/accountdelete.html). - -## Check Cancel - -Cancel a Check that has not been redeemed. (Native transaction type: [CheckCancel](https://xrpl.org/checkcancel.html)) - -<%- renderSchema('specifications/check-cancel.json') %> - -#### Example - -<%- renderFixture('requests/prepareCheckCancel.json') %> - - -## Check Cash - -Redeem a Check for up to its stated value. (Native transaction type: [CheckCash](https://xrpl.org/checkcash.html)) - -<%- renderSchema('specifications/check-cash.json') %> - -#### Example - -<%- renderFixture('requests/prepareCheckCashAmount.json') %> - - -## Check Create - -Create a Check, a deferred payment that can be redeemed by the destination. (Native transaction type: [CheckCreate](https://xrpl.org/checkcreate.html)) - -<%- renderSchema('specifications/check-create.json') %> - -#### Example - -<%- renderFixture('requests/prepareCheckCreate.json') %> - - -## Deposit Preauth - -Preauthorize an sender to deposit money at an account using [Deposit Authorization](https://xrpl.org/depositauth.html). (Native transaction type: [DepositPreauth](https://xrpl.org/depositpreauth.html)) - -<%- renderSchema('specifications/deposit-preauth.json') %> - -> **Note:** To prepare a Deposit Preauth transaction, use [`prepareTransaction()`](#preparetransaction) with the [native transaction format](https://xrpl.org/depositpreauth.html). - - -## Escrow Cancellation - -Cancel an Escrow that has passed its expiration. (Native transaction type: [EscrowCancel](https://xrpl.org/escrowcancel.html)) - -<%- renderSchema('specifications/escrow-cancellation.json') %> - -#### Example - -<%- renderFixture('requests/prepareEscrowCancellation.json') %> - - -## Escrow Creation - -Create an Escrow that locks up XRP until a given time or condition is met. (Native transaction type: [EscrowCreate](https://xrpl.org/escrowcreate.html)) - -<%- renderSchema('specifications/escrow-creation.json') %> - -#### Example - -<%- renderFixture('requests/prepareEscrowCreation.json') %> - - -## Escrow Execution - -Deliver XRP from an Escrow after its conditions have been met. (Native transaction type: [EscrowFinish](https://xrpl.org/escrowfinish.html)) - -<%- renderSchema('specifications/escrow-execution.json') %> - -#### Example - -<%- renderFixture('requests/prepareEscrowExecution.json') %> - - -## Order - -Create and execute a limit order in the decentralized exchange. (Native transaction type: [OfferCreate](https://xrpl.org/offercreate.html)) - -<%- renderSchema('specifications/order.json') %> - -The following invalid flag combination causes a `ValidationError`: `immediateOrCancel` and `fillOrKill`. These fields are mutually exclusive, and cannot both be set at the same time. - -#### Example - -<%- renderFixture('requests/prepareOrder.json') %> - - -## Order Cancellation - -Cancel an order in the decentralized exchange. (Native transaction type: [OfferCancel](https://xrpl.org/offercancel.html)) - -<%- renderSchema('specifications/order-cancellation.json') %> - -#### Example - -<%- renderFixture('requests/prepareOrderCancellation.json') %> - - -## Payment - -Send value from one account to another. (Native transaction type: [Payment](https://xrpl.org/payment.html)) - -<%- renderSchema('specifications/payment.json') %> - -#### Example - -<%- renderFixture('requests/preparePayment.json') %> - - -## Payment Channel Claim - -Redeem XRP from a Payment Channel. (Native transaction type: [PaymentChannelClaim](https://xrpl.org/paymentchannelclaim.html)) - -<%- renderSchema('specifications/payment-channel-claim.json') %> - -#### Example - -<%- renderFixture('requests/preparePaymentChannelClaim.json') %> - - -## Payment Channel Create - -Create a Payment Channel with XRP set aside for asynchronous payments. (Native transaction type: [PaymentChannelCreate](https://xrpl.org/paymentchannelcreate.html)) - -<%- renderSchema('specifications/payment-channel-create.json') %> - -#### Example - -<%- renderFixture('requests/preparePaymentChannelCreate.json') %> - - -## Payment Channel Fund - -Add XRP to a Payment Channel. (Native transaction type: [PaymentChannelFund](https://xrpl.org/paymentchannelfund.html)) - -<%- renderSchema('specifications/payment-channel-fund.json') %> - -#### Example - -<%- renderFixture('requests/preparePaymentChannelFund.json') %> - - - -## Settings - -Change account settings. (Native transaction types: [AccountSet](https://xrpl.org/accountset.html), [SetRegularKey](https://xrpl.org/setregularkey.html), [SignerListSet](https://xrpl.org/signerlistset.html)) - -<%- renderSchema('output/get-settings.json') %> - -#### Example - -<%- renderFixture('requests/prepareSettings.json') %> - - -## Ticket Create - -Set aside account Sequence numbers as Tickets to be used by later transactions. - -> **Caution:** As of 2021-01-22, Tickets are not yet available on the XRP Ledger. - -> **Note:** To prepare a Ticket Create transaction, use [`prepareTransaction()`](#preparetransaction) with the native transaction format. - - -## Trustline - -Create or modify a trust line between two accounts, for an issued currency. (Native transaction type: [TrustSet](https://xrpl.org/trustset.html)) - -<%- renderSchema('specifications/trustline.json') %> - -#### Example - -<%- renderFixture('requests/prepareTrustline.json') %> diff --git a/docs/src/staticMethods.md.ejs b/docs/src/staticMethods.md.ejs deleted file mode 100644 index dc696b85..00000000 --- a/docs/src/staticMethods.md.ejs +++ /dev/null @@ -1,100 +0,0 @@ -# Static Methods - -You can access static methods directly on the `RippleAPI` class. For example, `RippleAPI.computeBinaryTransactionHash(...)`. - -A few of the most commonly-used methods are documented below. - -For a full list, refer to these docs: - -- [XRP Ledger Hashes](https://github.com/ripple/ripple-lib/blob/develop/src/common/hashes/README.md) -- [ripple-address-codec API](https://github.com/ripple/ripple-address-codec/blob/master/README.md#api) - -## computeBinaryTransactionHash - -`computeBinaryTransactionHash(txBlobHex: string): string` - -Returns the hash (id) of a binary transaction blob. - -This is a static method on the `RippleAPI` class. - -### Parameters - -This method takes one parameter, a string containing a binary transaction in hex. - -### Return Value - -This method returns a string representing the transaction's id (hash). - -### Example - -```javascript -const signed_blob = '120000228000000024000B2E5A201B0066374B61400000003B9ACA0068400000000000000C732102356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC74473045022100B3721EEB1ED6DFF29FB8B209E2DE6B54A0A6E44D52D926342F3D334BE98F08640220367A74107AD5DEAEFA3AB2984C161FC23F30B2704BB5CC984358BA262177A4568114F667B0CA50CC7709A220B0561B85E53A48461FA883142B71D8B09B4EE8DAA68FB936C23E3A974713BDAC' -if (typeof signed_blob === 'string' && signed_blob.match(/^[A-F0-9]+$/)) { - const id = RippleAPI.computeBinaryTransactionHash(signed_blob) - console.log('Transaction hash:', id') -} -``` - -``` -Transaction hash: 80C5E11E1A21A626759D6CB944B33DBAAC66BD704A289C86E330B847904F5C13 -``` - -[RunKit Example: computeBinaryTransactionHash](https://runkit.com/intelliot/computebinarytransactionhash-example) - -## classicAddressToXAddress - -`classicAddressToXAddress(classicAddress: string, tag: number | false[, test: boolean]): string` - -Convert a classic address and tag to an X-address. - -If `test` is `true`, the address starts with `T` to show that the address is intended for use on a test network. - -### Example: Encode an X-address with tag 4294967295 - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI -const xAddress = RippleAPI.classicAddressToXAddress('rGWrZyQqhTp9Xu7G5Pkayo7bXjH4k4QYpf', 4294967295) -console.log(xAddress) -``` - -``` -XVLhHMPHU98es4dbozjVtdWzVrDjtV18pX8yuPT7y4xaEHi -``` - -### Example: Encode a test address for use with Testnet or Devnet - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI -const address = RippleAPI.classicAddressToXAddress('r3SVzk8ApofDJuVBPKdmbbLjWGCCXpBQ2g', 123, true) -console.log(address) -``` - -``` -T7oKJ3q7s94kDH6tpkBowhetT1JKfcfdSCmAXbS75iATyLD -``` - -## xAddressToClassicAddress - -`xAddressToClassicAddress(xAddress: string): {classicAddress: string, tag: number | false, test: boolean}` - -Convert an X-address to a classic address and tag. - -Since `0` is a valid tag, use `if (tag !== false)` to you want to check for a tag. - -If the address is intended for use on a test network, `test === true`. Otherwise, `test === false`. - -### Example - -```javascript -const RippleAPI = require('ripple-lib').RippleAPI -const address = RippleAPI.xAddressToClassicAddress('XVLhHMPHU98es4dbozjVtdWzVrDjtV18pX8yuPT7y4xaEHi') -console.log(address) -``` - -``` -{ - classicAddress: 'rGWrZyQqhTp9Xu7G5Pkayo7bXjH4k4QYpf', - tag: 4294967295, - test: false -} -``` diff --git a/docs/src/submit.md.ejs b/docs/src/submit.md.ejs deleted file mode 100644 index 9c5f2a79..00000000 --- a/docs/src/submit.md.ejs +++ /dev/null @@ -1,83 +0,0 @@ -## submit - -`request('submit', {tx_blob: string, fail_hard: boolean}): Promise` - -The `submit` method applies a transaction and sends it to the network to be confirmed and included in future ledgers. - -This method takes a signed, serialized transaction as a binary blob, and submits it to the network as-is. Since signed transaction objects are immutable, no part of the transaction can be modified or automatically filled in after submission. - -To send a transaction as robustly as possible, you should construct and sign it in advance, persist it somewhere that you can access even after a power outage, then `submit` it as a `tx_blob`. After submission, monitor the network with the `tx` method to see if the transaction was successfully applied; if a restart or other problem occurs, you can safely re-submit the `tx_blob` transaction: it won't be applied twice since it has the same sequence number as the old transaction. - -### Parameters - -| `Field` | Type | Description | -|:------------|:--------|:-----------------------------------------------------| -| `tx_blob` | String | Hex representation of the signed transaction to submit. This can be a multi-signed transaction. | -| `fail_hard` | Boolean | (Optional, defaults to false) If true, and the transaction fails locally, do not retry or relay the transaction to other servers | - -### Return Value - -When successful, this method returns an object containing the following fields: - -| `Field` | Type | Description | -|:------------------------|:--------|:-----------------------------------------| -| `engine_result` | String | Text [result code](https://xrpl.org/transaction-results.html) indicating the preliminary result of the transaction, for example `tesSUCCESS` | -| `engine_result_code` | Integer | Numeric version of the [result code](https://xrpl.org/transaction-results.html). **Not recommended.** | -| `engine_result_message` | String | Human-readable explanation of the transaction's preliminary result | -| `tx_blob` | String | The complete transaction in hex string format | -| `tx_json` | Object | The complete transaction in JSON format | -| `accepted` | Boolean | The value `true` indicates that the transaction was applied, queued, broadcast, or kept for later. The value `false` indicates that none of those happened, so the transaction cannot possibly succeed as long as you do not submit it again and have not already submitted it another time. [New in: rippled 1.5.0] | -| `account_sequence_available` | Number | The next [Sequence Number](https://xrpl.org/basic-data-types.html#account-sequence) available for the sending account after all pending and [queued](https://xrpl.org/transaction-queue.html) transactions. [New in: rippled 1.5.0] | -| `account_sequence_next` | number | The next [Sequence Number](https://xrpl.org/basic-data-types.html#account-sequence) for the sending account after all transactions that have been provisionally applied, but not transactions in the [queue](https://xrpl.org/transaction-queue.html). [New in: rippled 1.5.0] | -| `applied` | Boolean | The value `true` indicates that this transaction was applied to the open ledger. In this case, the transaction is likely, but not guaranteed, to be validated in the next ledger version. [New in: rippled 1.5.0] | -| `broadcast` | Boolean | The value `true` indicates this transaction was broadcast to peer servers in the peer-to-peer XRP Ledger network. (Note: if the server has no peers, such as in [stand-alone mode](https://xrpl.org/rippled-server-modes.html#reasons-to-run-a-rippled-server-in-stand-alone-mode), the server uses the value `true` for cases where it _would_ have broadcast the transaction.) The value `false` indicates the transaction was not broadcast to any other servers. [New in: rippled 1.5.0] | -| `kept` | Boolean | The value `true` indicates that the transaction was kept to be retried later. [New in: rippled 1.5.0] | -| `queued` | Boolean | The value `true` indicates the transaction was put in the [Transaction Queue](https://xrpl.org/transaction-queue.html), which means it is likely to be included in a future ledger version. [New in: rippled 1.5.0] | -| `open_ledger_cost` | String | The current [open ledger cost](https://xrpl.org/transaction-cost.html#open-ledger-cost) before processing this transaction. Transactions with a lower cost are likely to be [queued](https://xrpl.org/transaction-queue.html). [New in: rippled 1.5.0] | -| `validated_ledger_index` | Integer | The [ledger index](https://xrpl.org/basic-data-types.html#ledger-index) of the newest validated ledger at the time of submission. This provides a lower bound on the ledger versions that the transaction can appear in as a result of this request. (The transaction could only have been validated in this ledger version or earlier if it had already been submitted before.) | - -Note: Many situations can prevent a transaction from processing successfully, such as a lack of trust lines connecting the two accounts in a payment, or changes in the state of the ledger since the time the transaction was constructed. Even if nothing is wrong, it may take several seconds to close and validate the ledger version that includes the transaction. Do not consider the transaction's results final until they appear in a validated ledger version. - -### Example - -```javascript -const signedTransaction = '12000022800000002400000007201B007008BC61400000000754D4C068400000000000000C732103E8110048477E60F292DEDA67CF518511E70A15E1E3771B3C024026E1F824832874473045022100D659C836C24FF346A87054E463078D805B19EFE9F10348FD4C6ED6C3F3C4D750022060BE0BFD5E2C4963A1B0E0F21D5BA800969863BA486F71E75C08D76D77C45B22811492F80A3F3849DBB5714A4F2C691CE7D47BEED58083141266204CFBC657E65D9B4D30301FF98644693935'; -const failHard = false; -const result = await api.request('submit', { - tx_blob: signedTransaction, - fail_hard: failHard // optional -}); -``` - -```json -{ - "accepted": true, - "account_sequence_available": 8, - "account_sequence_next": 8, - "applied": true, - "broadcast": true, - "engine_result": "tesSUCCESS", - "engine_result_code": 0, - "engine_result_message": "The transaction was applied. Only final in a validated ledger.", - "kept": true, - "open_ledger_cost": "10", - "queued": false, - "tx_blob": "12000022800000002400000007201B007008BC61400000000754D4C068400000000000000C732103E8110048477E60F292DEDA67CF518511E70A15E1E3771B3C024026E1F824832874473045022100D659C836C24FF346A87054E463078D805B19EFE9F10348FD4C6ED6C3F3C4D750022060BE0BFD5E2C4963A1B0E0F21D5BA800969863BA486F71E75C08D76D77C45B22811492F80A3F3849DBB5714A4F2C691CE7D47BEED58083141266204CFBC657E65D9B4D30301FF98644693935", - "tx_json": { - "Account": "rNQao3Z1irwRjKWSs8heL4a8WKLPKfLrXs", - "Amount": "123000000", - "Destination": "rpgHWJdXkSvvzikdJCpuMzU7zWnuqsJRCZ", - "Fee": "12", - "Flags": 2147483648, - "LastLedgerSequence": 7342268, - "Sequence": 7, - "SigningPubKey": "03E8110048477E60F292DEDA67CF518511E70A15E1E3771B3C024026E1F8248328", - "TransactionType": "Payment", - "TxnSignature": "3045022100D659C836C24FF346A87054E463078D805B19EFE9F10348FD4C6ED6C3F3C4D750022060BE0BFD5E2C4963A1B0E0F21D5BA800969863BA486F71E75C08D76D77C45B22", - "hash": "FE8D68D7FF5805EB07AF15A1ADF07FB5463CCD2C6C0A15981EB3D26A02E1551C" - }, - "validated_ledger_index": 7341775 -} -``` - -(In ripple-lib 1.8.0, [the old `submit` method](https://github.com/ripple/ripple-lib/blob/1.7.0/docs/index.md#submit) was deprecated.) diff --git a/docs/src/transactions.md.ejs b/docs/src/transactions.md.ejs deleted file mode 100644 index fe2546bd..00000000 --- a/docs/src/transactions.md.ejs +++ /dev/null @@ -1,76 +0,0 @@ -# Transaction Overview - -## Transaction Types - -A transaction type is specified by the strings in the first column in the table below. - -Type | Description ----- | ----------- -[payment](#payment) | A `payment` transaction represents a transfer of value from one account to another. Depending on the [path](https://xrpl.org/paths.html) taken, additional exchanges of value may occur atomically to enable the payment. -[order](#order) | An `order` transaction creates a limit order. It defines an intent to exchange currencies, and creates an order in the XRP Ledger's order book if not completely fulfilled when placed. Orders can be partially fulfilled. -[orderCancellation](#order-cancellation) | An `orderCancellation` transaction cancels an order in the XRP Ledger's order book. -[trustline](#trustline) | A `trustline` transaction creates or modifies a trust line between two accounts. -[settings](#settings) | A `settings` transaction modifies the settings of an account in the XRP Ledger. -[escrowCreation](#escrow-creation) | An `escrowCreation` transaction creates an escrow on the ledger, which locks XRP until a cryptographic condition is met or it expires. It is like an escrow service where the XRP Ledger acts as the escrow agent. -[escrowCancellation](#escrow-cancellation) | An `escrowCancellation` transaction unlocks the funds in an escrow and sends them back to the creator of the escrow, if the escrow has expired. -[escrowExecution](#escrow-execution) | An `escrowExecution` transaction unlocks the funds in an escrow and sends them to the destination of the escrow, if the conditions for the escrow are met. -[checkCreate](#check-create) | A `checkCreate` transaction creates a check on the ledger, which is a deferred payment that can be cashed by its intended destination. -[checkCancel](#check-cancel) | A `checkCancel` transaction cancels an unredeemed Check, removing it from the ledger without sending any money. -[checkCash](#check-cash) | A `checkCash` transaction redeems a Check to receive up to the amount authorized by the corresponding `checkCreate` transaction. Only the `destination` address of a Check can cash it. -[paymentChannelCreate](#payment-channel-create) | A `paymentChannelCreate` transaction opens a payment channel between two addresses with XRP set aside for asynchronous payments. -[paymentChannelFund](#payment-channel-fund) | A `paymentChannelFund` transaction adds XRP to a payment channel and optionally sets a new expiration for the channel. -[paymentChannelClaim](#payment-channel-claim) | A `paymentChannelClaim` transaction withdraws XRP from a channel and optionally requests to close it. -[ticketCreate](#ticket-create) | A successful `ticketCreate` transaction adds a Ticket in the directory of the owning account. - -## Transaction Flow - -Executing a transaction with `RippleAPI` requires the following four steps: - -1. Prepare - Create an unsigned transaction based on a [specification](#transaction-specifications) and [instructions](#transaction-instructions). There is a method to prepare each type of transaction: - * [preparePayment](#preparepayment) - * [prepareTrustline](#preparetrustline) - * [prepareOrder](#prepareorder) - * [prepareOrderCancellation](#prepareordercancellation) - * [prepareSettings](#preparesettings) - * [prepareEscrowCreation](#prepareescrowcreation) - * [prepareEscrowCancellation](#prepareescrowcancellation) - * [prepareEscrowExecution](#prepareescrowexecution) - * [prepareCheckCreate](#preparecheckcreate) - * [prepareCheckCancel](#preparecheckcancel) - * [prepareCheckCash](#preparecheckcash) - * [prepareTicketCreate](#prepareticketcreate) -2. [Sign](#sign) - Cryptographically sign the transaction locally and save the [transaction ID](#transaction-id). Signing is how the owner of an account authorizes a transaction to take place. For multisignature transactions, the `signedTransaction` fields returned by `sign` must be collected and passed to the [combine](#combine) method. -3. [Submit](#submit) - Submit the transaction to the connected server. -4. Verify - Verify that the transaction got validated by querying with [getTransaction](#gettransaction). This is necessary because transactions may fail even if they were successfully submitted. - -## Transaction Fees - -Every transaction must destroy a small amount of XRP as a cost to apply the transaction to the ledger. This is also called a *transaction fee*. The transaction cost is designed to increase along with the load on the XRP Ledger, making it very expensive to deliberately or inadvertently overload the peer-to-peer network that powers the XRP Ledger. - -You can choose the size of the fee you want to pay or let a default be used. You can get an estimate of the fee required to be included in the next ledger closing with the [getFee](#getfee) method. - -For a multi-signed transaction, ripple-lib automatically multiplies the `fee` by (1 + Number of Signatures Provided). For example, if you set `instructions.fee = '0.000020'` and `instructions.signersCount = 2`, the prepared transaction's `Fee` is 20 drops × (1 + 2 Signatures) = 60 drops. See [Transaction Cost](https://xrpl.org/transaction-cost.html). - -## Transaction Instructions - -Transaction instructions indicate how to execute a transaction, complementary with the [transaction specification](#transaction-specifications). - -<%- renderSchema("objects/instructions.json") %> - -We recommend that you specify a `maxLedgerVersion` so that you can quickly determine that a failed transaction can never succeed in the future. It is impossible for a transaction to succeed after the XRP Ledger's consensus-validated ledger version exceeds the transaction's `maxLedgerVersion`. If you omit `maxLedgerVersion`, the "prepare\*" method automatically supplies a `maxLedgerVersion` equal to the current ledger plus 3, which it includes in the return value from the "prepare\*" method. - -## Transaction ID - -```json -"F4AB442A6D4CBB935D66E1DA7309A5FC71C7143ED4049053EC14E3875B0CF9BF" -``` - -A transaction ID is a 64-bit hexadecimal string that uniquely identifies the transaction. The transaction ID is derived from the transaction instruction and specifications, using a strong hash function. - -You can look up a transaction by ID using the [getTransaction](#gettransaction) method. - -## Transaction Memos - -Every transaction can optionally have an array of memos for user applications. The `memos` field in each [transaction specification](#transaction-specifications) is an array of objects with the following structure: - -<%- renderSchema('objects/memos.json') %> diff --git a/docs/src/txFlags.md.ejs b/docs/src/txFlags.md.ejs deleted file mode 100644 index 3c43f194..00000000 --- a/docs/src/txFlags.md.ejs +++ /dev/null @@ -1,81 +0,0 @@ -## txFlags - -`txFlags.TRANSACTION_TYPE.FLAG` - -This object provides constants for use when creating or interpreting transaction flags. Most transactions have a set of bit-flags that represent various options that affect how a transaction should behave. These options are represented as binary values that can be combined with bitwise-or operations to encode multiple flags at once. - -Most flags only have meaning for a specific transaction type. The same bitwise value may be reused for flags on different transaction types, so it is important to pay attention to the transaction type when setting and reading flags. - -Bits that are not defined as flags MUST be 0. - -### Global Flag - -Applies globally to all transactions. - -`txFlags.Universal.FullyCanonicalSig`: Require a fully-canonical signature. When preparing transactions, ripple-lib enables this flag for you. - -### Payment Flags - -`txFlags.Payment.NoRippleDirect`: Do not use the default path; only use specified paths. This is intended to force the transaction to take arbitrage opportunities. Most clients do not need this. - -`txFlags.Payment.PartialPayment`: If the specified destination amount cannot be sent without spending more than the source maxAmount, reduce the received amount instead of failing outright. See [Partial Payments](https://xrpl.org/partial-payments.html) for more details. - -`txFlags.Payment.LimitQuality`: Only take paths where all the conversions have an input:output ratio that is equal or better than the ratio of `destination.amount`:`source.maxAmount`. See [Limit Quality](https://xrpl.org/payment.html#limit-quality) for details. - -### OfferCreate Flags - -`txFlags.OfferCreate.Passive`: If enabled, the offer does not consume offers that exactly match it, and instead becomes an Offer object in the ledger. It still consumes offers that cross it. - -`txFlags.OfferCreate.ImmediateOrCancel`: Treat the offer as an Immediate or Cancel order. If enabled, the offer never becomes a ledger object: it only tries to match existing offers in the ledger. - -`txFlags.OfferCreate.FillOrKill`: Treat the offer as a Fill or Kill order. - -`txFlags.OfferCreate.Sell`: Treat the offer as a Sell order. With `order.direction = 'sell'`, exchange the entire `order.quantity`, even if it means obtaining more than the `order.totalPrice` amount in exchange. If using `prepareOrder`, ripple-lib sets this flag for you. - -### TrustSet Flags - -`txFlags.TrustSet.SetAuth`: Authorize the other party to hold issuances from this account. (No effect unless using the AccountSet.RequireAuth flag.) Cannot be unset. - -`txFlags.TrustSet.NoRipple`: Obsolete. - -`txFlags.TrustSet.SetNoRipple`: Blocks [rippling](https://xrpl.org/rippling.html) between two trustlines of the same currency, if this flag is set on both. - -`txFlags.TrustSet.ClearNoRipple`: Clears the No-[Rippling](https://xrpl.org/rippling.html) flag. - -`txFlags.TrustSet.SetFreeze`: Freeze the trustline. A non-XRP currency can be frozen by the exchange or gateway that issued it. XRP cannot be frozen. - -`txFlags.TrustSet.ClearFreeze`: Unfreeze the trustline. - -### AccountSet Flags - -You can use the `prepareSettings` method to change your account flags. This method uses AccountSet flags internally. - -In the rippled API, Account Flags can be enabled and disabled with the SetFlag and ClearFlag parameters. See [AccountSet Flags](https://xrpl.org/accountset.html#accountset-flags). - -The AccountSet transaction type has some transaction flags, but their use is discouraged. - -* `txFlags.AccountSet.RequireDestTag` -* `txFlags.AccountSet.OptionalDestTag` -* `txFlags.AccountSet.RequireAuth` -* `txFlags.AccountSet.OptionalAuth` -* `txFlags.AccountSet.DisallowXRP` -* `txFlags.AccountSet.AllowXRP` - -### PaymentChannelClaim Flags - -`txFlags.PaymentChannelClaim.Renew`: Clear the channel's Expiration time. (Expiration is different from the channel's immutable CancelAfter time.) Only the source address of the payment channel can use this flag. - -`txFlags.PaymentChannelClaim.Close`: Request to close the channel. Only the channel source and destination addresses can use this flag. This flag closes the channel immediately if it has no more XRP allocated to it after processing the current claim, or if the destination address uses it. If the source address uses this flag when the channel still holds XRP, this schedules the channel to close after SettleDelay seconds have passed. (Specifically, this sets the Expiration of the channel to the close time of the previous ledger plus the channel's SettleDelay time, unless the channel already has an earlier Expiration time.) If the destination address uses this flag when the channel still holds XRP, any XRP that remains after processing the claim is returned to the source address. - -### Other Transaction Types - -The remaining transaction types do not have any flags at this time. - -* OfferCancel -* SetRegularKey -* SignerListSet -* EscrowCreate -* EscrowFinish -* EscrowCancel -* PaymentChannelCreate -* PaymentChannelFund diff --git a/docs/src/verifyPaymentChannelClaim.md.ejs b/docs/src/verifyPaymentChannelClaim.md.ejs deleted file mode 100644 index 4db60d2c..00000000 --- a/docs/src/verifyPaymentChannelClaim.md.ejs +++ /dev/null @@ -1,31 +0,0 @@ -## verifyPaymentChannelClaim - -`verifyPaymentChannelClaim(channel: string, amount: string, signature: string, publicKey: string): boolean` - -Verify a payment channel claim signature. - -### Parameters - -<%- renderSchema("input/verify-payment-channel-claim.json") %> - -### Return Value - -This method returns `true` if the claim signature is valid. - -<%- renderSchema("output/verify-payment-channel-claim.json") %> - -### Example - -```javascript -const channel = - '3E18C05AD40319B809520F1A136370C4075321B285217323396D6FD9EE1E9037'; -const amount = '.00001'; -const signature = <%- importFile("test/fixtures/responses/signPaymentChannelClaim.json") %>; -const publicKey = - '02F89EAEC7667B30F33D0687BBA86C3FE2A08CCA40A9186C5BDE2DAA6FA97A37D8'; -return api.verifyPaymentChannelClaim(channel, amount, signature, publicKey); -``` - -```json -true -``` diff --git a/docs/src/xrpToDropsAndDropsToXrp.md.ejs b/docs/src/xrpToDropsAndDropsToXrp.md.ejs deleted file mode 100644 index 51f046ec..00000000 --- a/docs/src/xrpToDropsAndDropsToXrp.md.ejs +++ /dev/null @@ -1,47 +0,0 @@ -## xrpToDrops - -`xrpToDrops(xrp: string | BigNumber): string` - -Converts an XRP amount to drops. 1 XRP = 1,000,000 drops, so 1 drop = 0.000001 XRP. This method is useful when converting amounts for use with the rippled API, which requires XRP amounts to be specified in drops. - -### Parameters - -`xrp`: A string or BigNumber representing an amount of XRP. If `xrp` is a string, it may start with `-`, must contain at least one number, and may contain up to one `.`. This method throws a `ValidationError` for invalid input. - -### Return Value - -A string representing an equivalent amount of drops. - -### Example - -```javascript -return api.xrpToDrops('1'); -``` - -```json -'1000000' -``` - -## dropsToXrp - -`dropsToXrp(drops: string | BigNumber): string` - -Converts an amount of drops to XRP. 1 drop = 0.000001 XRP, so 1 XRP = 1,000,000 drops. This method is useful when converting amounts from the rippled API, which describes XRP amounts in drops. - -### Parameters - -`drops`: A string or BigNumber representing an amount of drops. If `drops` is a string, it may start with `-` and must contain at least one number. This method throws a `ValidationError` for invalid input. - -### Return Value - -A string representing an equivalent amount of XRP. - -### Example - -```javascript -return api.dropsToXrp('1'); -``` - -```json -'0.000001' -``` diff --git a/package-lock.json b/package-lock.json index 7d0cacc7..1b44a1d9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -35,7 +35,6 @@ "buffer": "^6.0.2", "chai": "^4.3.4", "crypto-browserify": "^3.12.0", - "doctoc": "^2.0.0", "ejs": "^3.0.1", "eslint": "^7.5.0", "eslint-plugin-array-func": "^3.1.7", @@ -59,6 +58,7 @@ "stream-http": "3.2.0", "ts-loader": "^9.2.5", "ts-node": "^10.2.1", + "typedoc": "^0.21.9", "typescript": "^4.4.2", "url": "^0.11.0", "webpack": "^5.6.0", @@ -808,27 +808,6 @@ "integrity": "sha512-88p7+M0QGxKpmnkfXjS4V26AnoC/eiqZutE8GLdaI5X12NY75bXSdTY9NkmYb2Xyk1O+MmkuO6Frmsj84V6I8Q==", "dev": true }, - "node_modules/@textlint/ast-node-types": { - "version": "4.4.3", - "resolved": "https://registry.npmjs.org/@textlint/ast-node-types/-/ast-node-types-4.4.3.tgz", - "integrity": "sha512-qi2jjgO6Tn3KNPGnm6B7p6QTEPvY95NFsIAaJuwbulur8iJUEenp1OnoUfiDaC/g2WPPEFkcfXpmnu8XEMFo2A==", - "dev": true - }, - "node_modules/@textlint/markdown-to-ast": { - "version": "6.1.7", - "resolved": "https://registry.npmjs.org/@textlint/markdown-to-ast/-/markdown-to-ast-6.1.7.tgz", - "integrity": "sha512-B0QtokeQR4a9+4q0NQr8T9l7A1fFihTN5Ze57tVgqW+3ymzXEouh8DvPHeNQ4T6jEkAThvdjk95mxAMpGRJ79w==", - "dev": true, - "dependencies": { - "@textlint/ast-node-types": "^4.2.5", - "debug": "^4.1.1", - "remark-frontmatter": "^1.2.0", - "remark-parse": "^5.0.0", - "structured-source": "^3.0.2", - "traverse": "^0.6.6", - "unified": "^6.1.6" - } - }, "node_modules/@tsconfig/node10": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.8.tgz", @@ -1440,15 +1419,6 @@ "ajv": "^6.9.1" } }, - "node_modules/anchor-markdown-header": { - "version": "0.5.7", - "resolved": "https://registry.npmjs.org/anchor-markdown-header/-/anchor-markdown-header-0.5.7.tgz", - "integrity": "sha1-BFBj125qH5zTJ6V6ASaqD97Dcac=", - "dev": true, - "dependencies": { - "emoji-regex": "~6.1.0" - } - }, "node_modules/ansi-colors": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", @@ -1694,16 +1664,6 @@ "dev": true, "peer": true }, - "node_modules/bail": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/bail/-/bail-1.0.5.tgz", - "integrity": "sha512-xFbRxM1tahm08yHBP16MMjVUAvDaBMD38zsM9EMAUN61omwLmKlOpB/Zku5QkjZ8TZ4vn53pj+t518cH0S03RQ==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", @@ -1848,12 +1808,6 @@ "resolved": "https://registry.npmjs.org/bn.js/-/bn.js-5.2.0.tgz", "integrity": "sha512-D7iWRBvnZE8ecXiLj/9wbxH7Tk79fAh8IHaTNq1RWRixsS02W+5qS+iE9yq6RYl0asXx5tw0bLhmT5pIfbSquw==" }, - "node_modules/boundary": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/boundary/-/boundary-1.0.1.tgz", - "integrity": "sha1-TWfcJgLAzBbdm85+v4fpSCkPWBI=", - "dev": true - }, "node_modules/brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -2131,36 +2085,6 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, - "node_modules/character-entities": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-1.2.4.tgz", - "integrity": "sha512-iBMyeEHxfVnIakwOuDXpVkc54HijNgCyQB2w0VfGQThle6NXn50zU6V/u+LDhxHcDUPojn6Kpga3PTAD8W1bQw==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/character-entities-legacy": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-1.1.4.tgz", - "integrity": "sha512-3Xnr+7ZFS1uxeiUDvV02wQ+QDbc55o97tIV5zHScSPJpcLm/r0DFPcoY3tYRp+VZukxuMeKgXYmsXQHO05zQeA==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/character-reference-invalid": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-1.1.4.tgz", - "integrity": "sha512-mKKUkUbhPpQlCOfIuZkvSEgktjPFIsZKRRbC6KWVEMvlzblj3i3asQv5ODsrwt0N3pHAEvjP8KTQPHkp0+6jOg==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/check-error": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.2.tgz", @@ -2249,16 +2173,6 @@ "node": ">=6" } }, - "node_modules/collapse-white-space": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/collapse-white-space/-/collapse-white-space-1.0.6.tgz", - "integrity": "sha512-jEovNnrhMuqyCcjfEJA56v0Xq8SkIoPKDyaHahwo3POf4qcSXqMYuwNcOTzp74vTsR9Tn08z4MxWqAhcekogkQ==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", @@ -2558,23 +2472,6 @@ "node": ">=8" } }, - "node_modules/doctoc": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/doctoc/-/doctoc-2.0.1.tgz", - "integrity": "sha512-JsxnSVZtLCThKehjFPBDhP1+ZLmdfXQynZH/0ABAwrnd1Zf3AV6LigC9oWJyaZ+c6RXCDnlGUNJ7I+1v8VaaRg==", - "dev": true, - "dependencies": { - "@textlint/markdown-to-ast": "~6.1.7", - "anchor-markdown-header": "~0.5.7", - "htmlparser2": "~4.1.0", - "minimist": "~1.2.5", - "underscore": "~1.12.1", - "update-section": "~0.3.3" - }, - "bin": { - "doctoc": "doctoc.js" - } - }, "node_modules/doctrine": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", @@ -2587,91 +2484,6 @@ "node": ">=6.0.0" } }, - "node_modules/dom-serializer": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-1.3.2.tgz", - "integrity": "sha512-5c54Bk5Dw4qAxNOI1pFEizPSjVsx5+bpJKmL2kPn8JhBUq2q09tTCa3mjijun2NfK78NMouDYNMBkOrPZiS+ig==", - "dev": true, - "dependencies": { - "domelementtype": "^2.0.1", - "domhandler": "^4.2.0", - "entities": "^2.0.0" - }, - "funding": { - "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" - } - }, - "node_modules/dom-serializer/node_modules/domhandler": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.2.2.tgz", - "integrity": "sha512-PzE9aBMsdZO8TK4BnuJwH0QT41wgMbRzuZrHUcpYncEjmQazq8QEaBWgLG7ZyC/DAZKEgglpIA6j4Qn/HmxS3w==", - "dev": true, - "dependencies": { - "domelementtype": "^2.2.0" - }, - "engines": { - "node": ">= 4" - }, - "funding": { - "url": "https://github.com/fb55/domhandler?sponsor=1" - } - }, - "node_modules/domelementtype": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.2.0.tgz", - "integrity": "sha512-DtBMo82pv1dFtUmHyr48beiuq792Sxohr+8Hm9zoxklYPfa6n0Z3Byjj2IV7bmr2IyqClnqEQhfgHJJ5QF0R5A==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/fb55" - } - ] - }, - "node_modules/domhandler": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-3.3.0.tgz", - "integrity": "sha512-J1C5rIANUbuYK+FuFL98650rihynUOEzRLxW+90bKZRWB6A1X1Tf82GxR1qAWLyfNPRvjqfip3Q5tdYlmAa9lA==", - "dev": true, - "dependencies": { - "domelementtype": "^2.0.1" - }, - "engines": { - "node": ">= 4" - }, - "funding": { - "url": "https://github.com/fb55/domhandler?sponsor=1" - } - }, - "node_modules/domutils": { - "version": "2.8.0", - "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz", - "integrity": "sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==", - "dev": true, - "dependencies": { - "dom-serializer": "^1.0.1", - "domelementtype": "^2.2.0", - "domhandler": "^4.2.0" - }, - "funding": { - "url": "https://github.com/fb55/domutils?sponsor=1" - } - }, - "node_modules/domutils/node_modules/domhandler": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.2.2.tgz", - "integrity": "sha512-PzE9aBMsdZO8TK4BnuJwH0QT41wgMbRzuZrHUcpYncEjmQazq8QEaBWgLG7ZyC/DAZKEgglpIA6j4Qn/HmxS3w==", - "dev": true, - "dependencies": { - "domelementtype": "^2.2.0" - }, - "engines": { - "node": ">= 4" - }, - "funding": { - "url": "https://github.com/fb55/domhandler?sponsor=1" - } - }, "node_modules/duplexer": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", @@ -2718,12 +2530,6 @@ "resolved": "https://registry.npmjs.org/bn.js/-/bn.js-4.12.0.tgz", "integrity": "sha512-c98Bf3tPniI+scsdk237ku1Dc3ujXQTSgyiPUDEOe7tRkhrqridvh8klBv0HCEso1OLOYcHuCv/cS6DNxKH+ZA==" }, - "node_modules/emoji-regex": { - "version": "6.1.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-6.1.3.tgz", - "integrity": "sha1-7HmjlpsC0uzytyJUJ5v5m8eoOTI=", - "dev": true - }, "node_modules/end-of-stream": { "version": "1.4.4", "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", @@ -2758,15 +2564,6 @@ "node": ">=8.6" } }, - "node_modules/entities": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", - "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", - "dev": true, - "funding": { - "url": "https://github.com/fb55/entities?sponsor=1" - } - }, "node_modules/envinfo": { "version": "7.8.1", "resolved": "https://registry.npmjs.org/envinfo/-/envinfo-7.8.1.tgz", @@ -3613,12 +3410,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/extend": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", - "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", - "dev": true - }, "node_modules/extract-zip": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/extract-zip/-/extract-zip-2.0.1.tgz", @@ -3694,19 +3485,6 @@ "reusify": "^1.0.4" } }, - "node_modules/fault": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/fault/-/fault-1.0.4.tgz", - "integrity": "sha512-CJ0HCB5tL5fYTEA7ToAq5+kTwd++Borf1/bifxd9iT70QcXr4MRrO3Llf8Ifs70q+SJcGHFtnIE/Nw6giCtECA==", - "dev": true, - "dependencies": { - "format": "^0.2.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/fd-slicer": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/fd-slicer/-/fd-slicer-1.1.0.tgz", @@ -3911,15 +3689,6 @@ "node": ">=8.0.0" } }, - "node_modules/format": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/format/-/format-0.2.2.tgz", - "integrity": "sha1-1hcBB+nv3E7TDJ3DkBbflCtctYs=", - "dev": true, - "engines": { - "node": ">=0.4.x" - } - }, "node_modules/fromentries": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/fromentries/-/fromentries-1.3.2.tgz", @@ -4153,6 +3922,36 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/handlebars": { + "version": "4.7.7", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", + "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", + "dev": true, + "dependencies": { + "minimist": "^1.2.5", + "neo-async": "^2.6.0", + "source-map": "^0.6.1", + "wordwrap": "^1.0.0" + }, + "bin": { + "handlebars": "bin/handlebars" + }, + "engines": { + "node": ">=0.4.7" + }, + "optionalDependencies": { + "uglify-js": "^3.1.4" + } + }, + "node_modules/handlebars/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/has": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", @@ -4284,18 +4083,6 @@ "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", "dev": true }, - "node_modules/htmlparser2": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-4.1.0.tgz", - "integrity": "sha512-4zDq1a1zhE4gQso/c5LP1OtrhYTncXNSpvJYtWJBtXAETPlMfi3IFNjGuQbYLuVY4ZR0QMqRVvo4Pdy9KLyP8Q==", - "dev": true, - "dependencies": { - "domelementtype": "^2.0.1", - "domhandler": "^3.0.0", - "domutils": "^2.0.0", - "entities": "^2.0.0" - } - }, "node_modules/https-browserify": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/https-browserify/-/https-browserify-1.0.0.tgz", @@ -4520,30 +4307,6 @@ "node": ">= 0.10" } }, - "node_modules/is-alphabetical": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-1.0.4.tgz", - "integrity": "sha512-DwzsA04LQ10FHTZuL0/grVDk4rFoVH1pjAToYwBrHSxcrBIGQuXrQMtD5U1b0U2XVgKZCTLLP8u2Qxqhy3l2Vg==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/is-alphanumerical": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-1.0.4.tgz", - "integrity": "sha512-UzoZUr+XfVz3t3v4KyGEniVL9BDRoQtY7tOyrRybkVNjDFWyo1yhXNGrrBTQxp3ib9BLAWs7k2YKBQsFRkZG9A==", - "dev": true, - "dependencies": { - "is-alphabetical": "^1.0.0", - "is-decimal": "^1.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/is-arguments": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.1.1.tgz", @@ -4603,12 +4366,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-buffer": { - "version": "1.1.6", - "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", - "integrity": "sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==", - "dev": true - }, "node_modules/is-callable": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.4.tgz", @@ -4646,16 +4403,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-decimal": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-1.0.4.tgz", - "integrity": "sha512-RGdriMmQQvZ2aqaQq3awNA6dCGtKpiDFcOzrTWrDAT2MiWrKQVPmxLGHl7Y2nNu6led0kEyoX0enY0qXYsv9zw==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/is-extglob": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", @@ -4700,16 +4447,6 @@ "node": ">=0.10.0" } }, - "node_modules/is-hexadecimal": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-1.0.4.tgz", - "integrity": "sha512-gyPJuv83bHMpocVYoqof5VDiZveEoGoFL8m3BXNb2VW8Xs+rz9kqO8LOQ5DH6EsuvilT1ApazU0pyl+ytbPtlw==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/is-nan": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/is-nan/-/is-nan-1.3.2.tgz", @@ -4759,15 +4496,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-plain-obj": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz", - "integrity": "sha1-caUMhCnfync8kqOQpKA7OfzVHT4=", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/is-plain-object": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", @@ -4871,16 +4599,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/is-whitespace-character": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-whitespace-character/-/is-whitespace-character-1.0.4.tgz", - "integrity": "sha512-SDweEzfIZM0SJV0EUga669UTKlmL0Pq8Lno0QDQsPnvECB3IM2aP0gdx5TrU0A01MAPfViaZiI2V1QMZLaKK5w==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/is-windows": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz", @@ -4890,16 +4608,6 @@ "node": ">=0.10.0" } }, - "node_modules/is-word-character": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-word-character/-/is-word-character-1.0.4.tgz", - "integrity": "sha512-5SMO8RVennx3nZrqtKwCGyyetPE9VDba5ugvKLaD4KopPG5kR4mQ7tNt/r7feL5yt5h3lpuBbIUmCOG2eSzXHA==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", @@ -5225,6 +4933,12 @@ "node": ">=6" } }, + "node_modules/jsonc-parser": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.0.0.tgz", + "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==", + "dev": true + }, "node_modules/jsx-ast-utils": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.2.0.tgz", @@ -5394,6 +5108,12 @@ "node": ">=10" } }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, "node_modules/make-dir": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", @@ -5424,14 +5144,16 @@ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", "dev": true }, - "node_modules/markdown-escapes": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/markdown-escapes/-/markdown-escapes-1.0.4.tgz", - "integrity": "sha512-8z4efJYk43E0upd0NbVXwgSTQs6cT3T06etieCMEg7dRbzCbxUCK/GHlX8mhHRDcp+OLlHkPKsvqQTCvsRl2cg==", + "node_modules/marked": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/marked/-/marked-3.0.4.tgz", + "integrity": "sha512-jBo8AOayNaEcvBhNobg6/BLhdsK3NvnKWJg33MAAPbvTWiG4QBn9gpW1+7RssrKu4K1dKlN+0goVQwV41xEfOA==", "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" + "bin": { + "marked": "bin/marked" + }, + "engines": { + "node": ">= 12" } }, "node_modules/md5.js": { @@ -6348,6 +6070,30 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/onigasm": { + "version": "2.2.5", + "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", + "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", + "dev": true, + "dependencies": { + "lru-cache": "^5.1.1" + } + }, + "node_modules/onigasm/node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/onigasm/node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true + }, "node_modules/opener": { "version": "1.5.2", "resolved": "https://registry.npmjs.org/opener/-/opener-1.5.2.tgz", @@ -6459,20 +6205,6 @@ "safe-buffer": "^5.1.1" } }, - "node_modules/parse-entities": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-1.2.2.tgz", - "integrity": "sha512-NzfpbxW/NPrzZ/yYSoQxyqUZMZXIdCfE0OIN4ESsnptHJECoUk3FZktxNuzQf4tjt5UEopnxpYJbvYuxIFDdsg==", - "dev": true, - "dependencies": { - "character-entities": "^1.0.0", - "character-entities-legacy": "^1.0.0", - "character-reference-invalid": "^1.0.0", - "is-alphanumerical": "^1.0.0", - "is-decimal": "^1.0.0", - "is-hexadecimal": "^1.0.0" - } - }, "node_modules/parse-json": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", @@ -7088,61 +6820,6 @@ "node": ">=4" } }, - "node_modules/remark-frontmatter": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-1.3.3.tgz", - "integrity": "sha512-fM5eZPBvu2pVNoq3ZPW22q+5Ativ1oLozq2qYt9I2oNyxiUd/tDl0iLLntEVAegpZIslPWg1brhcP1VsaSVUag==", - "dev": true, - "dependencies": { - "fault": "^1.0.1", - "xtend": "^4.0.1" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/remark-parse": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-5.0.0.tgz", - "integrity": "sha512-b3iXszZLH1TLoyUzrATcTQUZrwNl1rE70rVdSruJFlDaJ9z5aMkhrG43Pp68OgfHndL/ADz6V69Zow8cTQu+JA==", - "dev": true, - "dependencies": { - "collapse-white-space": "^1.0.2", - "is-alphabetical": "^1.0.0", - "is-decimal": "^1.0.0", - "is-whitespace-character": "^1.0.0", - "is-word-character": "^1.0.0", - "markdown-escapes": "^1.0.0", - "parse-entities": "^1.1.0", - "repeat-string": "^1.5.4", - "state-toggle": "^1.0.0", - "trim": "0.0.1", - "trim-trailing-lines": "^1.0.0", - "unherit": "^1.0.4", - "unist-util-remove-position": "^1.0.0", - "vfile-location": "^2.0.0", - "xtend": "^4.0.1" - } - }, - "node_modules/repeat-string": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", - "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=", - "dev": true, - "engines": { - "node": ">=0.10" - } - }, - "node_modules/replace-ext": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/replace-ext/-/replace-ext-1.0.0.tgz", - "integrity": "sha1-3mMSg3P8v3w8z6TeWkgMRaZ5WOs=", - "dev": true, - "engines": { - "node": ">= 0.10" - } - }, "node_modules/require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -7453,6 +7130,17 @@ "integrity": "sha512-mRz/m/JVscCrkMyPqHc/bczi3OQHkLTqXHEFu0zDhK/qfv3UcOA4SVmRCLmos4bhjr9ekVQubj/R7waKapmiQg==", "dev": true }, + "node_modules/shiki": { + "version": "0.9.11", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.11.tgz", + "integrity": "sha512-tjruNTLFhU0hruCPoJP0y+B9LKOmcqUhTpxn7pcJB3fa+04gFChuEmxmrUfOJ7ZO6Jd+HwMnDHgY3lv3Tqonuw==", + "dev": true, + "dependencies": { + "jsonc-parser": "^3.0.0", + "onigasm": "^2.2.5", + "vscode-textmate": "5.2.0" + } + }, "node_modules/side-channel": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", @@ -7595,16 +7283,6 @@ "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", "dev": true }, - "node_modules/state-toggle": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/state-toggle/-/state-toggle-1.0.3.tgz", - "integrity": "sha512-d/5Z4/2iiCnHw6Xzghyhb+GcmF89bxwgXG60wjIiZaxnymbyOmI8Hk4VqHXiVVp6u2ysaskFfXg3ekCj4WNftQ==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/stream-browserify": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/stream-browserify/-/stream-browserify-3.0.0.tgz", @@ -7758,15 +7436,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/structured-source": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/structured-source/-/structured-source-3.0.2.tgz", - "integrity": "sha1-3YAkJeD1PcSm56yjdSkBoczaevU=", - "dev": true, - "dependencies": { - "boundary": "^1.0.1" - } - }, "node_modules/supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", @@ -8017,38 +7686,6 @@ "node": ">=6" } }, - "node_modules/traverse": { - "version": "0.6.6", - "resolved": "https://registry.npmjs.org/traverse/-/traverse-0.6.6.tgz", - "integrity": "sha1-y99WD9e5r2MlAv7UD5GMFX6pcTc=", - "dev": true - }, - "node_modules/trim": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/trim/-/trim-0.0.1.tgz", - "integrity": "sha1-WFhUf2spB1fulczMZm+1AITEYN0=", - "dev": true - }, - "node_modules/trim-trailing-lines": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/trim-trailing-lines/-/trim-trailing-lines-1.1.4.tgz", - "integrity": "sha512-rjUWSqnfTNrjbB9NQWfPMH/xRK1deHeGsHoVfpxJ++XeYXE0d6B1En37AHfw3jtfTU7dzMzZL2jjpe8Qb5gLIQ==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/trough": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/trough/-/trough-1.0.5.tgz", - "integrity": "sha512-rvuRbTarPXmMb79SmzEp8aqXNKcK+y0XaB298IXueQ8I2PsrATcPBCSPyK/dDNa2iWOhKlfNnOjdAOTBU/nkFA==", - "dev": true, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, "node_modules/ts-loader": { "version": "9.2.5", "resolved": "https://registry.npmjs.org/ts-loader/-/ts-loader-9.2.5.tgz", @@ -8214,6 +7851,40 @@ "is-typedarray": "^1.0.0" } }, + "node_modules/typedoc": { + "version": "0.21.9", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.21.9.tgz", + "integrity": "sha512-VRo7aII4bnYaBBM1lhw4bQFmUcDQV8m8tqgjtc7oXl87jc1Slbhfw2X5MccfcR2YnEClHDWgsiQGgNB8KJXocA==", + "dev": true, + "dependencies": { + "glob": "^7.1.7", + "handlebars": "^4.7.7", + "lunr": "^2.3.9", + "marked": "^3.0.2", + "minimatch": "^3.0.0", + "progress": "^2.0.3", + "shiki": "^0.9.8", + "typedoc-default-themes": "^0.12.10" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 12.10.0" + }, + "peerDependencies": { + "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x" + } + }, + "node_modules/typedoc-default-themes": { + "version": "0.12.10", + "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.10.tgz", + "integrity": "sha512-fIS001cAYHkyQPidWXmHuhs8usjP5XVJjWB8oZGqkTowZaz3v7g3KDZeeqE82FBrmkAnIBOY3jgy7lnPnqATbA==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, "node_modules/typeforce": { "version": "1.18.0", "resolved": "https://registry.npmjs.org/typeforce/-/typeforce-1.18.0.tgz", @@ -8232,6 +7903,19 @@ "node": ">=4.2.0" } }, + "node_modules/uglify-js": { + "version": "3.14.2", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.14.2.tgz", + "integrity": "sha512-rtPMlmcO4agTUfz10CbgJ1k6UAoXM2gWb3GoMPPZB/+/Ackf8lNWk11K4rYi2D0apgoFRLtQOZhb+/iGNJq26A==", + "dev": true, + "optional": true, + "bin": { + "uglifyjs": "bin/uglifyjs" + }, + "engines": { + "node": ">=0.8.0" + } + }, "node_modules/unbox-primitive": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", @@ -8280,89 +7964,6 @@ "ieee754": "^1.1.13" } }, - "node_modules/underscore": { - "version": "1.12.1", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.12.1.tgz", - "integrity": "sha512-hEQt0+ZLDVUMhebKxL4x1BTtDY7bavVofhZ9KZ4aI26X9SRaE+Y3m83XUL1UP2jn8ynjndwCCpEHdUG+9pP1Tw==", - "dev": true - }, - "node_modules/unherit": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/unherit/-/unherit-1.1.3.tgz", - "integrity": "sha512-Ft16BJcnapDKp0+J/rqFC3Rrk6Y/Ng4nzsC028k2jdDII/rdZ7Wd3pPT/6+vIIxRagwRc9K0IUX0Ra4fKvw+WQ==", - "dev": true, - "dependencies": { - "inherits": "^2.0.0", - "xtend": "^4.0.0" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/wooorm" - } - }, - "node_modules/unified": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/unified/-/unified-6.2.0.tgz", - "integrity": "sha512-1k+KPhlVtqmG99RaTbAv/usu85fcSRu3wY8X+vnsEhIxNP5VbVIDiXnLqyKIG+UMdyTg0ZX9EI6k2AfjJkHPtA==", - "dev": true, - "dependencies": { - "bail": "^1.0.0", - "extend": "^3.0.0", - "is-plain-obj": "^1.1.0", - "trough": "^1.0.0", - "vfile": "^2.0.0", - "x-is-string": "^0.1.0" - } - }, - "node_modules/unist-util-is": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-3.0.0.tgz", - "integrity": "sha512-sVZZX3+kspVNmLWBPAB6r+7D9ZgAFPNWm66f7YNb420RlQSbn+n8rG8dGZSkrER7ZIXGQYNm5pqC3v3HopH24A==", - "dev": true - }, - "node_modules/unist-util-remove-position": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/unist-util-remove-position/-/unist-util-remove-position-1.1.4.tgz", - "integrity": "sha512-tLqd653ArxJIPnKII6LMZwH+mb5q+n/GtXQZo6S6csPRs5zB0u79Yw8ouR3wTw8wxvdJFhpP6Y7jorWdCgLO0A==", - "dev": true, - "dependencies": { - "unist-util-visit": "^1.1.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/unist-util-stringify-position": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-1.1.2.tgz", - "integrity": "sha512-pNCVrk64LZv1kElr0N1wPiHEUoXNVFERp+mlTg/s9R5Lwg87f9bM/3sQB99w+N9D/qnM9ar3+AKDBwo/gm/iQQ==", - "dev": true - }, - "node_modules/unist-util-visit": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-1.4.1.tgz", - "integrity": "sha512-AvGNk7Bb//EmJZyhtRUnNMEpId/AZ5Ph/KUpTI09WHQuDZHKovQ1oEv3mfmKpWKtoMzyMC4GLBm1Zy5k12fjIw==", - "dev": true, - "dependencies": { - "unist-util-visit-parents": "^2.0.0" - } - }, - "node_modules/unist-util-visit-parents": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-2.1.2.tgz", - "integrity": "sha512-DyN5vD4NE3aSeB+PXYNKxzGsfocxp6asDc2XXE3b0ekO2BaRUpBicbbUygfSvYfUz1IkmjFR1YF7dPklraMZ2g==", - "dev": true, - "dependencies": { - "unist-util-is": "^3.0.0" - } - }, - "node_modules/update-section": { - "version": "0.3.3", - "resolved": "https://registry.npmjs.org/update-section/-/update-section-0.3.3.tgz", - "integrity": "sha1-RY8Xgg03gg3GDiC4bZQ5GwASMVg=", - "dev": true - }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -8432,36 +8033,11 @@ "spdx-expression-parse": "^3.0.0" } }, - "node_modules/vfile": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/vfile/-/vfile-2.3.0.tgz", - "integrity": "sha512-ASt4mBUHcTpMKD/l5Q+WJXNtshlWxOogYyGYYrg4lt/vuRjC1EFQtlAofL5VmtVNIZJzWYFJjzGWZ0Gw8pzW1w==", - "dev": true, - "dependencies": { - "is-buffer": "^1.1.4", - "replace-ext": "1.0.0", - "unist-util-stringify-position": "^1.0.0", - "vfile-message": "^1.0.0" - } - }, - "node_modules/vfile-location": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/vfile-location/-/vfile-location-2.0.6.tgz", - "integrity": "sha512-sSFdyCP3G6Ka0CEmN83A2YCMKIieHx0EDaj5IDP4g1pa5ZJ4FJDvpO0WODLxo4LUX4oe52gmSCK7Jw4SBghqxA==", - "dev": true, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/unified" - } - }, - "node_modules/vfile-message": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-1.1.1.tgz", - "integrity": "sha512-1WmsopSGhWt5laNir+633LszXvZ+Z/lxveBf6yhGsqnQIhlhzooZae7zV6YVM1Sdkw68dtAW3ow0pOdPANugvA==", - "dev": true, - "dependencies": { - "unist-util-stringify-position": "^1.1.1" - } + "node_modules/vscode-textmate": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", + "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", + "dev": true }, "node_modules/watchpack": { "version": "2.2.0", @@ -8814,6 +8390,12 @@ "node": ">=0.10.0" } }, + "node_modules/wordwrap": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", + "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", + "dev": true + }, "node_modules/workerpool": { "version": "6.1.5", "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.1.5.tgz", @@ -8875,12 +8457,6 @@ } } }, - "node_modules/x-is-string": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/x-is-string/-/x-is-string-0.1.0.tgz", - "integrity": "sha1-R0tQhlrzpJqcRlfwWs0UVFj3fYI=", - "dev": true - }, "node_modules/xtend": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz", @@ -9590,27 +9166,6 @@ "integrity": "sha512-88p7+M0QGxKpmnkfXjS4V26AnoC/eiqZutE8GLdaI5X12NY75bXSdTY9NkmYb2Xyk1O+MmkuO6Frmsj84V6I8Q==", "dev": true }, - "@textlint/ast-node-types": { - "version": "4.4.3", - "resolved": "https://registry.npmjs.org/@textlint/ast-node-types/-/ast-node-types-4.4.3.tgz", - "integrity": "sha512-qi2jjgO6Tn3KNPGnm6B7p6QTEPvY95NFsIAaJuwbulur8iJUEenp1OnoUfiDaC/g2WPPEFkcfXpmnu8XEMFo2A==", - "dev": true - }, - "@textlint/markdown-to-ast": { - "version": "6.1.7", - "resolved": "https://registry.npmjs.org/@textlint/markdown-to-ast/-/markdown-to-ast-6.1.7.tgz", - "integrity": "sha512-B0QtokeQR4a9+4q0NQr8T9l7A1fFihTN5Ze57tVgqW+3ymzXEouh8DvPHeNQ4T6jEkAThvdjk95mxAMpGRJ79w==", - "dev": true, - "requires": { - "@textlint/ast-node-types": "^4.2.5", - "debug": "^4.1.1", - "remark-frontmatter": "^1.2.0", - "remark-parse": "^5.0.0", - "structured-source": "^3.0.2", - "traverse": "^0.6.6", - "unified": "^6.1.6" - } - }, "@tsconfig/node10": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.8.tgz", @@ -10086,15 +9641,6 @@ "dev": true, "requires": {} }, - "anchor-markdown-header": { - "version": "0.5.7", - "resolved": "https://registry.npmjs.org/anchor-markdown-header/-/anchor-markdown-header-0.5.7.tgz", - "integrity": "sha1-BFBj125qH5zTJ6V6ASaqD97Dcac=", - "dev": true, - "requires": { - "emoji-regex": "~6.1.0" - } - }, "ansi-colors": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", @@ -10285,12 +9831,6 @@ "dev": true, "peer": true }, - "bail": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/bail/-/bail-1.0.5.tgz", - "integrity": "sha512-xFbRxM1tahm08yHBP16MMjVUAvDaBMD38zsM9EMAUN61omwLmKlOpB/Zku5QkjZ8TZ4vn53pj+t518cH0S03RQ==", - "dev": true - }, "balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", @@ -10401,12 +9941,6 @@ "resolved": "https://registry.npmjs.org/bn.js/-/bn.js-5.2.0.tgz", "integrity": "sha512-D7iWRBvnZE8ecXiLj/9wbxH7Tk79fAh8IHaTNq1RWRixsS02W+5qS+iE9yq6RYl0asXx5tw0bLhmT5pIfbSquw==" }, - "boundary": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/boundary/-/boundary-1.0.1.tgz", - "integrity": "sha1-TWfcJgLAzBbdm85+v4fpSCkPWBI=", - "dev": true - }, "brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -10629,24 +10163,6 @@ "supports-color": "^7.1.0" } }, - "character-entities": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-1.2.4.tgz", - "integrity": "sha512-iBMyeEHxfVnIakwOuDXpVkc54HijNgCyQB2w0VfGQThle6NXn50zU6V/u+LDhxHcDUPojn6Kpga3PTAD8W1bQw==", - "dev": true - }, - "character-entities-legacy": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-1.1.4.tgz", - "integrity": "sha512-3Xnr+7ZFS1uxeiUDvV02wQ+QDbc55o97tIV5zHScSPJpcLm/r0DFPcoY3tYRp+VZukxuMeKgXYmsXQHO05zQeA==", - "dev": true - }, - "character-reference-invalid": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-1.1.4.tgz", - "integrity": "sha512-mKKUkUbhPpQlCOfIuZkvSEgktjPFIsZKRRbC6KWVEMvlzblj3i3asQv5ODsrwt0N3pHAEvjP8KTQPHkp0+6jOg==", - "dev": true - }, "check-error": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.2.tgz", @@ -10718,12 +10234,6 @@ "shallow-clone": "^3.0.0" } }, - "collapse-white-space": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/collapse-white-space/-/collapse-white-space-1.0.6.tgz", - "integrity": "sha512-jEovNnrhMuqyCcjfEJA56v0Xq8SkIoPKDyaHahwo3POf4qcSXqMYuwNcOTzp74vTsR9Tn08z4MxWqAhcekogkQ==", - "dev": true - }, "color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", @@ -10986,20 +10496,6 @@ "path-type": "^4.0.0" } }, - "doctoc": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/doctoc/-/doctoc-2.0.1.tgz", - "integrity": "sha512-JsxnSVZtLCThKehjFPBDhP1+ZLmdfXQynZH/0ABAwrnd1Zf3AV6LigC9oWJyaZ+c6RXCDnlGUNJ7I+1v8VaaRg==", - "dev": true, - "requires": { - "@textlint/markdown-to-ast": "~6.1.7", - "anchor-markdown-header": "~0.5.7", - "htmlparser2": "~4.1.0", - "minimist": "~1.2.5", - "underscore": "~1.12.1", - "update-section": "~0.3.3" - } - }, "doctrine": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", @@ -11009,65 +10505,6 @@ "esutils": "^2.0.2" } }, - "dom-serializer": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-1.3.2.tgz", - "integrity": "sha512-5c54Bk5Dw4qAxNOI1pFEizPSjVsx5+bpJKmL2kPn8JhBUq2q09tTCa3mjijun2NfK78NMouDYNMBkOrPZiS+ig==", - "dev": true, - "requires": { - "domelementtype": "^2.0.1", - "domhandler": "^4.2.0", - "entities": "^2.0.0" - }, - "dependencies": { - "domhandler": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.2.2.tgz", - "integrity": "sha512-PzE9aBMsdZO8TK4BnuJwH0QT41wgMbRzuZrHUcpYncEjmQazq8QEaBWgLG7ZyC/DAZKEgglpIA6j4Qn/HmxS3w==", - "dev": true, - "requires": { - "domelementtype": "^2.2.0" - } - } - } - }, - "domelementtype": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.2.0.tgz", - "integrity": "sha512-DtBMo82pv1dFtUmHyr48beiuq792Sxohr+8Hm9zoxklYPfa6n0Z3Byjj2IV7bmr2IyqClnqEQhfgHJJ5QF0R5A==", - "dev": true - }, - "domhandler": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-3.3.0.tgz", - "integrity": "sha512-J1C5rIANUbuYK+FuFL98650rihynUOEzRLxW+90bKZRWB6A1X1Tf82GxR1qAWLyfNPRvjqfip3Q5tdYlmAa9lA==", - "dev": true, - "requires": { - "domelementtype": "^2.0.1" - } - }, - "domutils": { - "version": "2.8.0", - "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz", - "integrity": "sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==", - "dev": true, - "requires": { - "dom-serializer": "^1.0.1", - "domelementtype": "^2.2.0", - "domhandler": "^4.2.0" - }, - "dependencies": { - "domhandler": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.2.2.tgz", - "integrity": "sha512-PzE9aBMsdZO8TK4BnuJwH0QT41wgMbRzuZrHUcpYncEjmQazq8QEaBWgLG7ZyC/DAZKEgglpIA6j4Qn/HmxS3w==", - "dev": true, - "requires": { - "domelementtype": "^2.2.0" - } - } - } - }, "duplexer": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", @@ -11110,12 +10547,6 @@ } } }, - "emoji-regex": { - "version": "6.1.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-6.1.3.tgz", - "integrity": "sha1-7HmjlpsC0uzytyJUJ5v5m8eoOTI=", - "dev": true - }, "end-of-stream": { "version": "1.4.4", "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", @@ -11144,12 +10575,6 @@ "ansi-colors": "^4.1.1" } }, - "entities": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", - "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", - "dev": true - }, "envinfo": { "version": "7.8.1", "resolved": "https://registry.npmjs.org/envinfo/-/envinfo-7.8.1.tgz", @@ -11779,12 +11204,6 @@ } } }, - "extend": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", - "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", - "dev": true - }, "extract-zip": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/extract-zip/-/extract-zip-2.0.1.tgz", @@ -11849,15 +11268,6 @@ "reusify": "^1.0.4" } }, - "fault": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/fault/-/fault-1.0.4.tgz", - "integrity": "sha512-CJ0HCB5tL5fYTEA7ToAq5+kTwd++Borf1/bifxd9iT70QcXr4MRrO3Llf8Ifs70q+SJcGHFtnIE/Nw6giCtECA==", - "dev": true, - "requires": { - "format": "^0.2.0" - } - }, "fd-slicer": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/fd-slicer/-/fd-slicer-1.1.0.tgz", @@ -12016,12 +11426,6 @@ "signal-exit": "^3.0.2" } }, - "format": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/format/-/format-0.2.2.tgz", - "integrity": "sha1-1hcBB+nv3E7TDJ3DkBbflCtctYs=", - "dev": true - }, "fromentries": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/fromentries/-/fromentries-1.3.2.tgz", @@ -12182,6 +11586,27 @@ "duplexer": "^0.1.2" } }, + "handlebars": { + "version": "4.7.7", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", + "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", + "dev": true, + "requires": { + "minimist": "^1.2.5", + "neo-async": "^2.6.0", + "source-map": "^0.6.1", + "uglify-js": "^3.1.4", + "wordwrap": "^1.0.0" + }, + "dependencies": { + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true + } + } + }, "has": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", @@ -12279,18 +11704,6 @@ "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", "dev": true }, - "htmlparser2": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-4.1.0.tgz", - "integrity": "sha512-4zDq1a1zhE4gQso/c5LP1OtrhYTncXNSpvJYtWJBtXAETPlMfi3IFNjGuQbYLuVY4ZR0QMqRVvo4Pdy9KLyP8Q==", - "dev": true, - "requires": { - "domelementtype": "^2.0.1", - "domhandler": "^3.0.0", - "domutils": "^2.0.0", - "entities": "^2.0.0" - } - }, "https-browserify": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/https-browserify/-/https-browserify-1.0.0.tgz", @@ -12446,22 +11859,6 @@ "integrity": "sha512-Ju0Bz/cEia55xDwUWEa8+olFpCiQoypjnQySseKtmjNrnps3P+xfpUmGr90T7yjlVJmOtybRvPXhKMbHr+fWnw==", "dev": true }, - "is-alphabetical": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-1.0.4.tgz", - "integrity": "sha512-DwzsA04LQ10FHTZuL0/grVDk4rFoVH1pjAToYwBrHSxcrBIGQuXrQMtD5U1b0U2XVgKZCTLLP8u2Qxqhy3l2Vg==", - "dev": true - }, - "is-alphanumerical": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-1.0.4.tgz", - "integrity": "sha512-UzoZUr+XfVz3t3v4KyGEniVL9BDRoQtY7tOyrRybkVNjDFWyo1yhXNGrrBTQxp3ib9BLAWs7k2YKBQsFRkZG9A==", - "dev": true, - "requires": { - "is-alphabetical": "^1.0.0", - "is-decimal": "^1.0.0" - } - }, "is-arguments": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.1.1.tgz", @@ -12503,12 +11900,6 @@ "has-tostringtag": "^1.0.0" } }, - "is-buffer": { - "version": "1.1.6", - "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", - "integrity": "sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==", - "dev": true - }, "is-callable": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.4.tgz", @@ -12531,12 +11922,6 @@ "has-tostringtag": "^1.0.0" } }, - "is-decimal": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-1.0.4.tgz", - "integrity": "sha512-RGdriMmQQvZ2aqaQq3awNA6dCGtKpiDFcOzrTWrDAT2MiWrKQVPmxLGHl7Y2nNu6led0kEyoX0enY0qXYsv9zw==", - "dev": true - }, "is-extglob": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", @@ -12566,12 +11951,6 @@ "is-extglob": "^2.1.1" } }, - "is-hexadecimal": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-1.0.4.tgz", - "integrity": "sha512-gyPJuv83bHMpocVYoqof5VDiZveEoGoFL8m3BXNb2VW8Xs+rz9kqO8LOQ5DH6EsuvilT1ApazU0pyl+ytbPtlw==", - "dev": true - }, "is-nan": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/is-nan/-/is-nan-1.3.2.tgz", @@ -12600,12 +11979,6 @@ "has-tostringtag": "^1.0.0" } }, - "is-plain-obj": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz", - "integrity": "sha1-caUMhCnfync8kqOQpKA7OfzVHT4=", - "dev": true - }, "is-plain-object": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", @@ -12670,24 +12043,12 @@ "integrity": "sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==", "dev": true }, - "is-whitespace-character": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-whitespace-character/-/is-whitespace-character-1.0.4.tgz", - "integrity": "sha512-SDweEzfIZM0SJV0EUga669UTKlmL0Pq8Lno0QDQsPnvECB3IM2aP0gdx5TrU0A01MAPfViaZiI2V1QMZLaKK5w==", - "dev": true - }, "is-windows": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz", "integrity": "sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==", "dev": true }, - "is-word-character": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-word-character/-/is-word-character-1.0.4.tgz", - "integrity": "sha512-5SMO8RVennx3nZrqtKwCGyyetPE9VDba5ugvKLaD4KopPG5kR4mQ7tNt/r7feL5yt5h3lpuBbIUmCOG2eSzXHA==", - "dev": true - }, "isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", @@ -12943,6 +12304,12 @@ "minimist": "^1.2.5" } }, + "jsonc-parser": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.0.0.tgz", + "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==", + "dev": true + }, "jsx-ast-utils": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.2.0.tgz", @@ -13081,6 +12448,12 @@ "yallist": "^4.0.0" } }, + "lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, "make-dir": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", @@ -13104,10 +12477,10 @@ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", "dev": true }, - "markdown-escapes": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/markdown-escapes/-/markdown-escapes-1.0.4.tgz", - "integrity": "sha512-8z4efJYk43E0upd0NbVXwgSTQs6cT3T06etieCMEg7dRbzCbxUCK/GHlX8mhHRDcp+OLlHkPKsvqQTCvsRl2cg==", + "marked": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/marked/-/marked-3.0.4.tgz", + "integrity": "sha512-jBo8AOayNaEcvBhNobg6/BLhdsK3NvnKWJg33MAAPbvTWiG4QBn9gpW1+7RssrKu4K1dKlN+0goVQwV41xEfOA==", "dev": true }, "md5.js": { @@ -13805,6 +13178,32 @@ "mimic-fn": "^2.1.0" } }, + "onigasm": { + "version": "2.2.5", + "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", + "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", + "dev": true, + "requires": { + "lru-cache": "^5.1.1" + }, + "dependencies": { + "lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "requires": { + "yallist": "^3.0.2" + } + }, + "yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true + } + } + }, "opener": { "version": "1.5.2", "resolved": "https://registry.npmjs.org/opener/-/opener-1.5.2.tgz", @@ -13892,20 +13291,6 @@ "safe-buffer": "^5.1.1" } }, - "parse-entities": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-1.2.2.tgz", - "integrity": "sha512-NzfpbxW/NPrzZ/yYSoQxyqUZMZXIdCfE0OIN4ESsnptHJECoUk3FZktxNuzQf4tjt5UEopnxpYJbvYuxIFDdsg==", - "dev": true, - "requires": { - "character-entities": "^1.0.0", - "character-entities-legacy": "^1.0.0", - "character-reference-invalid": "^1.0.0", - "is-alphanumerical": "^1.0.0", - "is-decimal": "^1.0.0", - "is-hexadecimal": "^1.0.0" - } - }, "parse-json": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", @@ -14354,51 +13739,6 @@ "es6-error": "^4.0.1" } }, - "remark-frontmatter": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-1.3.3.tgz", - "integrity": "sha512-fM5eZPBvu2pVNoq3ZPW22q+5Ativ1oLozq2qYt9I2oNyxiUd/tDl0iLLntEVAegpZIslPWg1brhcP1VsaSVUag==", - "dev": true, - "requires": { - "fault": "^1.0.1", - "xtend": "^4.0.1" - } - }, - "remark-parse": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-5.0.0.tgz", - "integrity": "sha512-b3iXszZLH1TLoyUzrATcTQUZrwNl1rE70rVdSruJFlDaJ9z5aMkhrG43Pp68OgfHndL/ADz6V69Zow8cTQu+JA==", - "dev": true, - "requires": { - "collapse-white-space": "^1.0.2", - "is-alphabetical": "^1.0.0", - "is-decimal": "^1.0.0", - "is-whitespace-character": "^1.0.0", - "is-word-character": "^1.0.0", - "markdown-escapes": "^1.0.0", - "parse-entities": "^1.1.0", - "repeat-string": "^1.5.4", - "state-toggle": "^1.0.0", - "trim": "0.0.1", - "trim-trailing-lines": "^1.0.0", - "unherit": "^1.0.4", - "unist-util-remove-position": "^1.0.0", - "vfile-location": "^2.0.0", - "xtend": "^4.0.1" - } - }, - "repeat-string": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", - "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=", - "dev": true - }, - "replace-ext": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/replace-ext/-/replace-ext-1.0.0.tgz", - "integrity": "sha1-3mMSg3P8v3w8z6TeWkgMRaZ5WOs=", - "dev": true - }, "require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -14622,6 +13962,17 @@ "integrity": "sha512-mRz/m/JVscCrkMyPqHc/bczi3OQHkLTqXHEFu0zDhK/qfv3UcOA4SVmRCLmos4bhjr9ekVQubj/R7waKapmiQg==", "dev": true }, + "shiki": { + "version": "0.9.11", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.11.tgz", + "integrity": "sha512-tjruNTLFhU0hruCPoJP0y+B9LKOmcqUhTpxn7pcJB3fa+04gFChuEmxmrUfOJ7ZO6Jd+HwMnDHgY3lv3Tqonuw==", + "dev": true, + "requires": { + "jsonc-parser": "^3.0.0", + "onigasm": "^2.2.5", + "vscode-textmate": "5.2.0" + } + }, "side-channel": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", @@ -14742,12 +14093,6 @@ "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", "dev": true }, - "state-toggle": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/state-toggle/-/state-toggle-1.0.3.tgz", - "integrity": "sha512-d/5Z4/2iiCnHw6Xzghyhb+GcmF89bxwgXG60wjIiZaxnymbyOmI8Hk4VqHXiVVp6u2ysaskFfXg3ekCj4WNftQ==", - "dev": true - }, "stream-browserify": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/stream-browserify/-/stream-browserify-3.0.0.tgz", @@ -14870,15 +14215,6 @@ "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", "dev": true }, - "structured-source": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/structured-source/-/structured-source-3.0.2.tgz", - "integrity": "sha1-3YAkJeD1PcSm56yjdSkBoczaevU=", - "dev": true, - "requires": { - "boundary": "^1.0.1" - } - }, "supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", @@ -15066,30 +14402,6 @@ "integrity": "sha512-gduQwd1rOdDMGxFG1gEvhV88Oirdo2p+KjoYFU7k2g+i7n6AFFbDQ5kMPUsW0pNbfQsB/cwXvT1i4Bue0s9g5g==", "dev": true }, - "traverse": { - "version": "0.6.6", - "resolved": "https://registry.npmjs.org/traverse/-/traverse-0.6.6.tgz", - "integrity": "sha1-y99WD9e5r2MlAv7UD5GMFX6pcTc=", - "dev": true - }, - "trim": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/trim/-/trim-0.0.1.tgz", - "integrity": "sha1-WFhUf2spB1fulczMZm+1AITEYN0=", - "dev": true - }, - "trim-trailing-lines": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/trim-trailing-lines/-/trim-trailing-lines-1.1.4.tgz", - "integrity": "sha512-rjUWSqnfTNrjbB9NQWfPMH/xRK1deHeGsHoVfpxJ++XeYXE0d6B1En37AHfw3jtfTU7dzMzZL2jjpe8Qb5gLIQ==", - "dev": true - }, - "trough": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/trough/-/trough-1.0.5.tgz", - "integrity": "sha512-rvuRbTarPXmMb79SmzEp8aqXNKcK+y0XaB298IXueQ8I2PsrATcPBCSPyK/dDNa2iWOhKlfNnOjdAOTBU/nkFA==", - "dev": true - }, "ts-loader": { "version": "9.2.5", "resolved": "https://registry.npmjs.org/ts-loader/-/ts-loader-9.2.5.tgz", @@ -15201,6 +14513,28 @@ "is-typedarray": "^1.0.0" } }, + "typedoc": { + "version": "0.21.9", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.21.9.tgz", + "integrity": "sha512-VRo7aII4bnYaBBM1lhw4bQFmUcDQV8m8tqgjtc7oXl87jc1Slbhfw2X5MccfcR2YnEClHDWgsiQGgNB8KJXocA==", + "dev": true, + "requires": { + "glob": "^7.1.7", + "handlebars": "^4.7.7", + "lunr": "^2.3.9", + "marked": "^3.0.2", + "minimatch": "^3.0.0", + "progress": "^2.0.3", + "shiki": "^0.9.8", + "typedoc-default-themes": "^0.12.10" + } + }, + "typedoc-default-themes": { + "version": "0.12.10", + "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.10.tgz", + "integrity": "sha512-fIS001cAYHkyQPidWXmHuhs8usjP5XVJjWB8oZGqkTowZaz3v7g3KDZeeqE82FBrmkAnIBOY3jgy7lnPnqATbA==", + "dev": true + }, "typeforce": { "version": "1.18.0", "resolved": "https://registry.npmjs.org/typeforce/-/typeforce-1.18.0.tgz", @@ -15212,6 +14546,13 @@ "integrity": "sha512-4xfscpisVgqqDfPaJo5vkd+Qd/ItkoagnHpufr+i2QCHBsNYp+G7UAoyFl8aPtx879u38wPV65rZ8qbGZijalA==", "dev": true }, + "uglify-js": { + "version": "3.14.2", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.14.2.tgz", + "integrity": "sha512-rtPMlmcO4agTUfz10CbgJ1k6UAoXM2gWb3GoMPPZB/+/Ackf8lNWk11K4rYi2D0apgoFRLtQOZhb+/iGNJq26A==", + "dev": true, + "optional": true + }, "unbox-primitive": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", @@ -15245,81 +14586,6 @@ } } }, - "underscore": { - "version": "1.12.1", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.12.1.tgz", - "integrity": "sha512-hEQt0+ZLDVUMhebKxL4x1BTtDY7bavVofhZ9KZ4aI26X9SRaE+Y3m83XUL1UP2jn8ynjndwCCpEHdUG+9pP1Tw==", - "dev": true - }, - "unherit": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/unherit/-/unherit-1.1.3.tgz", - "integrity": "sha512-Ft16BJcnapDKp0+J/rqFC3Rrk6Y/Ng4nzsC028k2jdDII/rdZ7Wd3pPT/6+vIIxRagwRc9K0IUX0Ra4fKvw+WQ==", - "dev": true, - "requires": { - "inherits": "^2.0.0", - "xtend": "^4.0.0" - } - }, - "unified": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/unified/-/unified-6.2.0.tgz", - "integrity": "sha512-1k+KPhlVtqmG99RaTbAv/usu85fcSRu3wY8X+vnsEhIxNP5VbVIDiXnLqyKIG+UMdyTg0ZX9EI6k2AfjJkHPtA==", - "dev": true, - "requires": { - "bail": "^1.0.0", - "extend": "^3.0.0", - "is-plain-obj": "^1.1.0", - "trough": "^1.0.0", - "vfile": "^2.0.0", - "x-is-string": "^0.1.0" - } - }, - "unist-util-is": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-3.0.0.tgz", - "integrity": "sha512-sVZZX3+kspVNmLWBPAB6r+7D9ZgAFPNWm66f7YNb420RlQSbn+n8rG8dGZSkrER7ZIXGQYNm5pqC3v3HopH24A==", - "dev": true - }, - "unist-util-remove-position": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/unist-util-remove-position/-/unist-util-remove-position-1.1.4.tgz", - "integrity": "sha512-tLqd653ArxJIPnKII6LMZwH+mb5q+n/GtXQZo6S6csPRs5zB0u79Yw8ouR3wTw8wxvdJFhpP6Y7jorWdCgLO0A==", - "dev": true, - "requires": { - "unist-util-visit": "^1.1.0" - } - }, - "unist-util-stringify-position": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-1.1.2.tgz", - "integrity": "sha512-pNCVrk64LZv1kElr0N1wPiHEUoXNVFERp+mlTg/s9R5Lwg87f9bM/3sQB99w+N9D/qnM9ar3+AKDBwo/gm/iQQ==", - "dev": true - }, - "unist-util-visit": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-1.4.1.tgz", - "integrity": "sha512-AvGNk7Bb//EmJZyhtRUnNMEpId/AZ5Ph/KUpTI09WHQuDZHKovQ1oEv3mfmKpWKtoMzyMC4GLBm1Zy5k12fjIw==", - "dev": true, - "requires": { - "unist-util-visit-parents": "^2.0.0" - } - }, - "unist-util-visit-parents": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-2.1.2.tgz", - "integrity": "sha512-DyN5vD4NE3aSeB+PXYNKxzGsfocxp6asDc2XXE3b0ekO2BaRUpBicbbUygfSvYfUz1IkmjFR1YF7dPklraMZ2g==", - "dev": true, - "requires": { - "unist-util-is": "^3.0.0" - } - }, - "update-section": { - "version": "0.3.3", - "resolved": "https://registry.npmjs.org/update-section/-/update-section-0.3.3.tgz", - "integrity": "sha1-RY8Xgg03gg3GDiC4bZQ5GwASMVg=", - "dev": true - }, "uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -15387,33 +14653,12 @@ "spdx-expression-parse": "^3.0.0" } }, - "vfile": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/vfile/-/vfile-2.3.0.tgz", - "integrity": "sha512-ASt4mBUHcTpMKD/l5Q+WJXNtshlWxOogYyGYYrg4lt/vuRjC1EFQtlAofL5VmtVNIZJzWYFJjzGWZ0Gw8pzW1w==", - "dev": true, - "requires": { - "is-buffer": "^1.1.4", - "replace-ext": "1.0.0", - "unist-util-stringify-position": "^1.0.0", - "vfile-message": "^1.0.0" - } - }, - "vfile-location": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/vfile-location/-/vfile-location-2.0.6.tgz", - "integrity": "sha512-sSFdyCP3G6Ka0CEmN83A2YCMKIieHx0EDaj5IDP4g1pa5ZJ4FJDvpO0WODLxo4LUX4oe52gmSCK7Jw4SBghqxA==", + "vscode-textmate": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", + "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", "dev": true }, - "vfile-message": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-1.1.1.tgz", - "integrity": "sha512-1WmsopSGhWt5laNir+633LszXvZ+Z/lxveBf6yhGsqnQIhlhzooZae7zV6YVM1Sdkw68dtAW3ow0pOdPANugvA==", - "dev": true, - "requires": { - "unist-util-stringify-position": "^1.1.1" - } - }, "watchpack": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.2.0.tgz", @@ -15656,6 +14901,12 @@ "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", "dev": true }, + "wordwrap": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", + "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", + "dev": true + }, "workerpool": { "version": "6.1.5", "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.1.5.tgz", @@ -15697,12 +14948,6 @@ "integrity": "sha512-Q6B6H2oc8QY3llc3cB8kVmQ6pnJWVQbP7Q5algTcIxx7YEpc0oU4NBVHlztA7Ekzfhw2r0rPducMUiCGWKQRzw==", "requires": {} }, - "x-is-string": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/x-is-string/-/x-is-string-0.1.0.tgz", - "integrity": "sha1-R0tQhlrzpJqcRlfwWs0UVFj3fYI=", - "dev": true - }, "xtend": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz", diff --git a/package.json b/package.json index 557ed7e6..485937ec 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,6 @@ "buffer": "^6.0.2", "chai": "^4.3.4", "crypto-browserify": "^3.12.0", - "doctoc": "^2.0.0", "ejs": "^3.0.1", "eslint": "^7.5.0", "eslint-plugin-array-func": "^3.1.7", @@ -69,6 +68,7 @@ "stream-http": "3.2.0", "ts-loader": "^9.2.5", "ts-node": "^10.2.1", + "typedoc": "^0.21.9", "typescript": "^4.4.2", "url": "^0.11.0", "webpack": "^5.6.0", @@ -83,8 +83,7 @@ "analyze": "run-s build:web --analyze", "watch": "run-s build:lib --watch", "clean": "rm -rf dist", - "doctoc": "doctoc docs/index.md --title '# RippleAPI Reference' --github --maxlevel 2", - "docgen": "node --harmony scripts/build_docs.js", + "docgen": "typedoc ./src/index.ts", "prepublish": "run-s clean build", "test": "nyc mocha --config=test/.mocharc.json --exit", "test:integration": "TS_NODE_PROJECT=tsconfig.build.json nyc mocha ./test/integration/*.ts", diff --git a/test/connection.ts b/test/connection.ts index dda246f9..505e39c5 100644 --- a/test/connection.ts +++ b/test/connection.ts @@ -265,7 +265,7 @@ describe('Connection', function () { if (!(error instanceof Error)) { throw error } - + assert.instanceOf(error, DisconnectedError) assert.strictEqual( error.message,