diff --git a/.vscode/settings.json b/.vscode/settings.json index 0131dd87..71c9b25f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,7 +1,11 @@ { "editor.tabSize": 2, "cSpell.words": [ - "secp256k1" + "Multisigned", + "Setf", + "hostid", + "preauthorization", + "secp256k1" ], "[javascript]": { "editor.defaultFormatter": "esbenp.prettier-vscode", diff --git a/README.md b/README.md index 0a9609c5..a17c54c4 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,72 @@ main() For more examples, see the [documentation](#documentation). +### Using xrpl.js with `create-react-app` +To use `xrpl.js` with React, you need to install shims for core NodeJS modules. Starting with version 5, Webpack stopped including shims by default, so you must modify your Webpack configuration to add the shims you need. Either you can eject your config and modify it, or you can use a library such as `react-app-rewired`. The example below uses `react-app-rewired`. + +1. Install shims (you can use `yarn` as well): + + ```shell + npm install --save-dev \ + assert \ + buffer \ + crypto-browserify \ + https-browserify \ + os-browserify \ + process \ + stream-browserify \ + stream-http \ + url + ``` +2. Modify your webpack configuration + 1. Install `react-app-rewired` + + ````shell + npm install --save-dev react-app-rewired + ```` + + 2. At the project root, add a file named `config-overrides.js` with the following content: + + ```javascript + const webpack = require('webpack'); + + module.exports = function override(config) { + const fallback = config.resolve.fallback || {}; + Object.assign(fallback, { + "assert": require.resolve("assert"), + "crypto": require.resolve("crypto-browserify"), + "http": require.resolve("stream-http"), + "https": require.resolve("https-browserify"), + "os": require.resolve("os-browserify"), + "stream": require.resolve("stream-browserify"), + "url": require.resolve("url"), + "ws": require.resolve('xrpl/dist/npm/client/WSWrapper'), + }) + config.resolve.fallback = fallback + config.plugins = (config.plugins || []).concat([ + new webpack.ProvidePlugin({ + process: 'process/browser', + Buffer: ['buffer', 'Buffer'] + }) + ]) + + // This is deprecated in webpack 5 but alias false does not seem to work + config.module.rules.push({ + test: /node_modules[\\\/]https-proxy-agent[\\\/]/, + use: 'null-loader', + }) + return config; + } + ``` + + 3. Update package.json scripts section with + + ``` + "start": "react-app-rewired start", + "build": "react-app-rewired build", + "test": "react-app-rewired test", + ``` + ### Using xrpl.js with React Native If you want to use `xrpl.js` with React Native you will need to install shims for core NodeJS modules. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify). @@ -147,4 +213,4 @@ Experienced an issue? Report it [here](https://github.com/XRPLF/xrpl.js/issues/n + [xrpl-announce mailing list](https://groups.google.com/g/xrpl-announce) - subscribe for release announcements + [xrpl.js API Reference](https://js.xrpl.org) -+ [XRP Ledger Dev Portal](https://xrpl.org) \ No newline at end of file ++ [XRP Ledger Dev Portal](https://xrpl.org) diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 2740d785..3499f1c1 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,20 +1,20 @@ :root { - --light-hl-0: #0000FF; - --dark-hl-0: #569CD6; + --light-hl-0: #001080; + --dark-hl-0: #9CDCFE; --light-hl-1: #000000; --dark-hl-1: #D4D4D4; - --light-hl-2: #0070C1; - --dark-hl-2: #4FC1FF; - --light-hl-3: #795E26; - --dark-hl-3: #DCDCAA; - --light-hl-4: #001080; - --dark-hl-4: #9CDCFE; - --light-hl-5: #008000; - --dark-hl-5: #6A9955; + --light-hl-2: #0000FF; + --dark-hl-2: #569CD6; + --light-hl-3: #0070C1; + --dark-hl-3: #4FC1FF; + --light-hl-4: #795E26; + --dark-hl-4: #DCDCAA; + --light-hl-5: #A31515; + --dark-hl-5: #CE9178; --light-hl-6: #AF00DB; --dark-hl-6: #C586C0; - --light-hl-7: #A31515; - --dark-hl-7: #CE9178; + --light-hl-7: #008000; + --dark-hl-7: #6A9955; --light-hl-8: #267F99; --dark-hl-8: #4EC9B0; --light-hl-9: #098658; diff --git a/docs/assets/main.js b/docs/assets/main.js index c815b334..abd0485a 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,5 +1,5 @@ "use strict"; -(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function j(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r}),r.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends k{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return(...r)=>{clearTimeout(n),n=setTimeout(()=>t(r),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{Ae(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function Ae(t,e,n,r){if(He(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${pe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function fe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function pe(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",B="mouseup",Z={x:0,y:0},ge=!1,se=!1,je=!1,H=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(je=!0,F="touchstart",ye="touchmove",B="touchend");document.addEventListener(F,t=>{se=!0,H=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(!!se&&!H){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);H=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends k{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){H||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!H&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends k{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends k{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();j(X,".menu-highlight");j(K,"a[data-toggle]");j(te,".tsd-index-accordion");j(ee,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("theme");Se&&be(Se);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); /*! diff --git a/docs/assets/style.css b/docs/assets/style.css index 8f6ed2c4..958d2c26 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1124,6 +1124,7 @@ ul.tsd-type-parameter-list h5 { display: flex; justify-content: space-between; height: 2.5rem; + margin: 0 auto; } .tsd-page-toolbar .table-cell { position: relative; diff --git a/docs/assets/widgets.png b/docs/assets/widgets.png deleted file mode 100644 index c7380532..00000000 Binary files a/docs/assets/widgets.png and /dev/null differ diff --git a/docs/assets/widgets@2x.png b/docs/assets/widgets@2x.png deleted file mode 100644 index 4bbbd572..00000000 Binary files a/docs/assets/widgets@2x.png and /dev/null differ diff --git a/docs/classes/BroadcastClient.html b/docs/classes/BroadcastClient.html index b76a2c25..802268f5 100644 --- a/docs/classes/BroadcastClient.html +++ b/docs/classes/BroadcastClient.html @@ -31,7 +31,7 @@ using xrpl-client

  • BroadcastClient
+
  • Defined in packages/xrpl/src/client/BroadcastClient.ts:18
    • @@ -127,18 +127,18 @@ using xrpl-client

    Returns BroadcastClient

    +
  • Defined in packages/xrpl/src/client/BroadcastClient.ts:28

    • Abstraction

    getBalances

    -
    getBalances: ((this: Client, address: string, options?: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; peer?: string }) => Promise<{ currency: string; issuer?: string; value: string }[]>) = getBalances
    +
    getBalances: ((this: Client, address: string, options?: {
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
        limit?: number;
        peer?: string;
    }) => Promise<{
        currency: string;
        issuer?: string;
        value: string;
    }[]>) = getBalances

    Type declaration

      • -
      • (this: Client, address: string, options?: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; peer?: string }): Promise<{ currency: string; issuer?: string; value: string }[]>
        • +
      • (this: Client, address: string, options?: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
            limit?: number;
            peer?: string;
        }): Promise<{
            currency: string;
            issuer?: string;
            value: string;
        }[]>

      • Get XRP/non-XRP balances for an account.

        @@ -156,7 +156,7 @@ using xrpl-client

        Address of the account to retrieve balances for.

      • -
        options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; peer?: string } = {}
        +
        options: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
            limit?: number;
            peer?: string;
        } = {}

        Allows the client to specify a ledger_hash, ledger_index, filter by peer, and/or limit number of balances.

        @@ -179,10 +179,10 @@ ledger_index.

        Optional peer?: string

        Filter balances by peer.

    -

    Returns Promise<{ currency: string; issuer?: string; value: string }[]>

    +
  • Defined in packages/xrpl/src/client/index.ts:620

    • getLedgerIndex

    getLedgerIndex: ((this: Client) => Promise<number>) = getLedgerIndex
    @@ -207,16 +207,16 @@ ledger_index.

    Returns Promise<number>

    +
  • Defined in packages/xrpl/src/client/index.ts:630

    • getOrderbook

    -
    getOrderbook: ((this: Client, takerPays: TakerAmount, takerGets: TakerAmount, options?: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }) => Promise<{ buy: BookOffer[]; sell: BookOffer[] }>) = getOrderbook
    +
    getOrderbook: ((this: Client, takerPays: TakerAmount, takerGets: TakerAmount, options?: {
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
        limit?: number;
        taker?: string;
    }) => Promise<{
        buy: BookOffer[];
        sell: BookOffer[];
    }>) = getOrderbook

    Type declaration

      • -
      • (this: Client, takerPays: TakerAmount, takerGets: TakerAmount, options?: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }): Promise<{ buy: BookOffer[]; sell: BookOffer[] }>
        • +
      • (this: Client, takerPays: TakerAmount, takerGets: TakerAmount, options?: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
            limit?: number;
            taker?: string;
        }): Promise<{
            buy: BookOffer[];
            sell: BookOffer[];
        }>

      • Fetch orderbook (buy/sell orders) between two accounts.

        @@ -240,7 +240,7 @@ offer would pay, as an object with currency and issuer offer would receive, as an object with currency and issuer fields.

      • -
        options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string } = {}
        +
        options: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
            limit?: number;
            taker?: string;
        } = {}

        Options allowing the client to specify ledger_index, ledger_hash, filter by taker, and/or limit number of orders.

        @@ -263,23 +263,23 @@ the order book. Defaults to 20.

        Optional taker?: string

        Filter orders by taker.

    -

    Returns Promise<{ buy: BookOffer[]; sell: BookOffer[] }>

    +
  • Defined in packages/xrpl/src/client/index.ts:625

    • getXrpBalance

    -
    getXrpBalance: ((this: Client, address: string, options?: { ledger_hash?: string; ledger_index?: LedgerIndex }) => Promise<string>) = getXrpBalance
    +
    getXrpBalance: ((this: Client, address: string, options?: {
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
    }) => Promise<string>) = getXrpBalance

    Type declaration

      • -
      • (this: Client, address: string, options?: { ledger_hash?: string; ledger_index?: LedgerIndex }): Promise<string>
        • +
      • (this: Client, address: string, options?: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
        }): Promise<string>

      • Get the XRP balance for an account.

        -

        Example

        const client = new Client(wss://s.altnet.rippletest.net:51233)
        const balance = await client.getXrpBalance('rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn')
        console.log(balance)
        /// '200'
+
        Example
        const client = new Client(wss://s.altnet.rippletest.net:51233)
        const balance = await client.getXrpBalance('rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn')
        console.log(balance)
        /// '200'
 
        
 
 
        Returns
        The XRP balance of the account (as a string).
        
@@ -296,7 +296,7 @@ the order book. Defaults to 20.
        
 
        Address of the account to retrieve XRP balance.
      • -
        options: { ledger_hash?: string; ledger_index?: LedgerIndex } = {}
        +
        options: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
        } = {}

        Options to include for getting the XRP balance.

          @@ -313,7 +313,7 @@ ledger_index.

          Returns Promise<string>

    +
  • Defined in packages/xrpl/src/client/index.ts:615

    • Core

    @@ -333,11 +333,11 @@ flags interfaces into numbers.

    Returns

    The autofilled transaction.

    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    T extends Transaction

    Parameters

      @@ -357,16 +357,16 @@ Only used for multisigned transactions.

      Returns Promise<T>

    +
  • Defined in packages/xrpl/src/client/index.ts:596

    • submit

    -
    submit: ((this: Client, transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<SubmitResponse>) = submit
    +
    submit: ((this: Client, transaction: string | Transaction, opts?: {
        autofill?: boolean;
        failHard?: boolean;
        wallet?: Wallet;
    }) => Promise<SubmitResponse>) = submit

    Type declaration

      • -
      • (this: Client, transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }): Promise<SubmitResponse>
        • +
      • (this: Client, transaction: string | Transaction, opts?: {
            autofill?: boolean;
            failHard?: boolean;
            wallet?: Wallet;
        }): Promise<SubmitResponse>

      • Submits a signed/unsigned transaction. Steps performed on a transaction:

        @@ -392,7 +392,7 @@ Steps performed on a transaction:

        A transaction to autofill, sign & encode, and submit.

      • -
        Optional opts: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }
        +
        Optional opts: {
            autofill?: boolean;
            failHard?: boolean;
            wallet?: Wallet;
        }

        (Optional) Options used to sign and submit a transaction.

          @@ -411,16 +411,16 @@ Steps performed on a transaction:

          Returns Promise<SubmitResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:601

    • submitAndWait

    -
    submitAndWait: ((this: Client, transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<TxResponse>) = submitAndWait
    +
    submitAndWait: ((this: Client, transaction: string | Transaction, opts?: {
        autofill?: boolean;
        failHard?: boolean;
        wallet?: Wallet;
    }) => Promise<TxResponse>) = submitAndWait

    Type declaration

    +
  • Defined in packages/xrpl/src/client/index.ts:605

    • Faucet

    fundWallet

    -
    fundWallet: ((this: Client, wallet?: null | Wallet, options?: { faucetHost?: string }) => Promise<{ balance: number; wallet: Wallet }>) = fundWallet
    +
    fundWallet: ((this: Client, wallet?: null | Wallet, options?: {
        faucetHost?: string;
    }) => Promise<{
        balance: number;
        wallet: Wallet;
    }>) = fundWallet

    Type declaration

      • -
      • (this: Client, wallet?: null | Wallet, options?: { faucetHost?: string }): Promise<{ balance: number; wallet: Wallet }>
        • +
      • (this: Client, wallet?: null | Wallet, options?: {
            faucetHost?: string;
        }): Promise<{
            balance: number;
            wallet: Wallet;
        }>

      • Generates a random wallet with some amount of XRP (usually 1000 XRP).

        -

        Example

        const api = new xrpl.Client("wss://s.altnet.rippletest.net:51233")
        await api.connect()
        const { wallet, balance } = await api.fundWallet()
+
        Example
        const api = new xrpl.Client("wss://s.altnet.rippletest.net:51233")
        await api.connect()
        const { wallet, balance } = await api.fundWallet()
 
        
 
 
        Returns
        A Wallet on the Testnet or Devnet that contains some amount of XRP,
@@ -494,7 +494,7 @@ and that wallet's balance in XRP.
        
 
        An existing XRPL Wallet to fund. If undefined or null, a new Wallet will be created.
      • -
        Optional options: { faucetHost?: string }
        +
        Optional options: {
            faucetHost?: string;
        }

        See below.

          @@ -506,10 +506,10 @@ automatically. In other environments, or if you would like to customize the faucet host in devnet or testnet, you should provide the host using this option.

    -

    Returns Promise<{ balance: number; wallet: Wallet }>

    +
  • Defined in packages/xrpl/src/client/index.ts:635

    • Fee

    @@ -520,7 +520,7 @@ required fee rises during submission of a transaction. Defaults to 1.2.

    +
  • Defined in packages/xrpl/src/client/index.ts:192

    • Readonly maxFeeXRP

    maxFeeXRP: string
    @@ -529,7 +529,7 @@ number. Defaults to '2'.

    +
  • Defined in packages/xrpl/src/client/index.ts:200

    • Network

    @@ -544,7 +544,7 @@ number. Defaults to '2'.

    Returns string

    +
  • Defined in packages/xrpl/src/client/index.ts:280

    • connect

    +
  • Defined in packages/xrpl/src/client/index.ts:565

    • disconnect

    +
  • Defined in packages/xrpl/src/client/index.ts:575

    • isConnected

    +
  • Defined in packages/xrpl/src/client/index.ts:589

    • on

      @@ -591,7 +591,7 @@ number. Defaults to '2'.

    • Event handler for subscription streams.

      -

      Example

      const api = new Client('wss://s.altnet.rippletest.net:51233')

      api.on('transactions', (tx: TransactionStream) => {
       console.log("Received Transaction")
       console.log(tx)
      })

      await api.connect()
      const response = await api.request({
          command: 'subscribe',
          streams: ['transactions_proposed']
      })
+
      Example
      const api = new Client('wss://s.altnet.rippletest.net:51233')

      api.on('transactions', (tx: TransactionStream) => {
       console.log("Received Transaction")
       console.log(tx)
      })

      await api.connect()
      const response = await api.request({
          command: 'subscribe',
          streams: ['transactions_proposed']
      })
      @@ -610,7 +610,7 @@ number. Defaults to '2'.

      Returns BroadcastClient

      • +
    • Defined in packages/xrpl/src/client/index.ts:435

  • Event handler for subscription streams.

    @@ -640,7 +640,7 @@ number. Defaults to '2'.

    Returns BroadcastClient

    • +
  • Defined in packages/xrpl/src/client/index.ts:436

  • Event handler for subscription streams.

    @@ -670,7 +670,7 @@ number. Defaults to '2'.

    Returns BroadcastClient

    • +
  • Defined in packages/xrpl/src/client/index.ts:437

  • Event handler for subscription streams.

    @@ -700,7 +700,7 @@ number. Defaults to '2'.

    Returns BroadcastClient

    • +
  • Defined in packages/xrpl/src/client/index.ts:441

  • Event handler for subscription streams.

    @@ -730,7 +730,7 @@ number. Defaults to '2'.

    Returns BroadcastClient

    • +
  • Defined in packages/xrpl/src/client/index.ts:445

  • Event handler for subscription streams.

    @@ -760,7 +760,7 @@ number. Defaults to '2'.

    Returns BroadcastClient

    • +
  • Defined in packages/xrpl/src/client/index.ts:449

  • Event handler for subscription streams.

    @@ -790,7 +790,7 @@ number. Defaults to '2'.

    Returns BroadcastClient

    • +
  • Defined in packages/xrpl/src/client/index.ts:453

  • Event handler for subscription streams.

    @@ -820,7 +820,7 @@ number. Defaults to '2'.

    Returns BroadcastClient

    • +
  • Defined in packages/xrpl/src/client/index.ts:457

  • Event handler for subscription streams.

    @@ -850,7 +850,7 @@ number. Defaults to '2'.

    Returns BroadcastClient

    • +
  • Defined in packages/xrpl/src/client/index.ts:459

    • request

  • Makes a request to the client with the given command and @@ -880,7 +880,7 @@ additional request body parameters.

    Returns Promise<AccountCurrenciesResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:290

  • Makes a request to the client with the given command and @@ -896,7 +896,7 @@ additional request body parameters.

    Returns Promise<AccountInfoResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:293

  • Makes a request to the client with the given command and @@ -912,7 +912,7 @@ additional request body parameters.

    Returns Promise<AccountLinesResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:294

  • Makes a request to the client with the given command and @@ -928,7 +928,7 @@ additional request body parameters.

    Returns Promise<AccountNFTsResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:295

  • Makes a request to the client with the given command and @@ -944,7 +944,7 @@ additional request body parameters.

    Returns Promise<AccountObjectsResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:296

  • Makes a request to the client with the given command and @@ -960,7 +960,7 @@ additional request body parameters.

    Returns Promise<AccountOffersResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:299

  • Makes a request to the client with the given command and @@ -976,7 +976,7 @@ additional request body parameters.

    Returns Promise<AccountTxResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:300

  • Makes a request to the client with the given command and @@ -992,7 +992,7 @@ additional request body parameters.

    Returns Promise<BookOffersResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:301

  • Makes a request to the client with the given command and @@ -1008,7 +1008,7 @@ additional request body parameters.

    Returns Promise<ChannelVerifyResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:302

  • Makes a request to the client with the given command and @@ -1024,7 +1024,7 @@ additional request body parameters.

    Returns Promise<DepositAuthorizedResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:303

  • Makes a request to the client with the given command and @@ -1040,7 +1040,7 @@ additional request body parameters.

    Returns Promise<FeeResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:306

  • Makes a request to the client with the given command and @@ -1056,7 +1056,7 @@ additional request body parameters.

    Returns Promise<GatewayBalancesResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:307

  • Makes a request to the client with the given command and @@ -1072,7 +1072,7 @@ additional request body parameters.

    Returns Promise<LedgerResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:310

  • Makes a request to the client with the given command and @@ -1088,7 +1088,7 @@ additional request body parameters.

    Returns Promise<LedgerClosedResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:311

  • Makes a request to the client with the given command and @@ -1104,7 +1104,7 @@ additional request body parameters.

    Returns Promise<LedgerCurrentResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:312

  • Makes a request to the client with the given command and @@ -1120,7 +1120,7 @@ additional request body parameters.

    Returns Promise<LedgerDataResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:313

  • Makes a request to the client with the given command and @@ -1136,7 +1136,7 @@ additional request body parameters.

    Returns Promise<LedgerEntryResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:314

  • Makes a request to the client with the given command and @@ -1152,7 +1152,7 @@ additional request body parameters.

    Returns Promise<ManifestResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:315

  • Makes a request to the client with the given command and @@ -1168,7 +1168,7 @@ additional request body parameters.

    Returns Promise<NFTBuyOffersResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:316

  • Makes a request to the client with the given command and @@ -1184,7 +1184,7 @@ additional request body parameters.

    Returns Promise<NFTSellOffersResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:317

  • Makes a request to the client with the given command and @@ -1200,7 +1200,7 @@ additional request body parameters.

    Returns Promise<NoRippleCheckResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:318

  • Makes a request to the client with the given command and @@ -1216,7 +1216,7 @@ additional request body parameters.

    Returns Promise<PathFindResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:319

  • Makes a request to the client with the given command and @@ -1232,7 +1232,7 @@ additional request body parameters.

    Returns Promise<PingResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:320

  • Makes a request to the client with the given command and @@ -1248,7 +1248,7 @@ additional request body parameters.

    Returns Promise<RandomResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:321

  • Makes a request to the client with the given command and @@ -1264,7 +1264,7 @@ additional request body parameters.

    Returns Promise<RipplePathFindResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:322

  • Makes a request to the client with the given command and @@ -1280,7 +1280,7 @@ additional request body parameters.

    Returns Promise<ServerInfoResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:325

  • Makes a request to the client with the given command and @@ -1296,7 +1296,7 @@ additional request body parameters.

    Returns Promise<ServerStateResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:326

  • Makes a request to the client with the given command and @@ -1312,7 +1312,7 @@ additional request body parameters.

    Returns Promise<SubmitResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:327

  • Makes a request to the client with the given command and @@ -1328,7 +1328,7 @@ additional request body parameters.

    Returns Promise<SubmitMultisignedResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:328

  • Makes a request to the client with the given command and @@ -1344,7 +1344,7 @@ additional request body parameters.

    Returns Promise<SubscribeResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:331

  • Makes a request to the client with the given command and @@ -1360,7 +1360,7 @@ additional request body parameters.

    Returns Promise<UnsubscribeResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:332

  • Makes a request to the client with the given command and @@ -1376,7 +1376,7 @@ additional request body parameters.

    Returns Promise<TransactionEntryResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:333

  • Makes a request to the client with the given command and @@ -1392,7 +1392,7 @@ additional request body parameters.

    Returns Promise<TxResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:336

  • Makes a request to the client with the given command and @@ -1400,13 +1400,13 @@ additional request body parameters.

    Returns

    The response from the server.

    -
    -

    Type Parameters

    +
    +

    Type Parameters

    • R extends BaseRequest

    • -

      T extends BaseResponse

    +

    T extends BaseResponse

    • Parameters

    +
  • Defined in packages/xrpl/src/client/index.ts:337

    • requestAll

  • Makes multiple paged requests to the client to return a given number of @@ -1454,7 +1454,7 @@ requests as needed.

    Returns Promise<AccountLinesResponse[]>

    • +
  • Defined in packages/xrpl/src/client/index.ts:478

  • Makes multiple paged requests to the client to return a given number of @@ -1479,7 +1479,7 @@ requests as needed.

    Returns Promise<AccountObjectsResponse[]>

    • +
  • Defined in packages/xrpl/src/client/index.ts:481

  • Makes multiple paged requests to the client to return a given number of @@ -1504,7 +1504,7 @@ requests as needed.

    Returns Promise<AccountOffersResponse[]>

    • +
  • Defined in packages/xrpl/src/client/index.ts:484

  • Makes multiple paged requests to the client to return a given number of @@ -1529,7 +1529,7 @@ requests as needed.

    Returns Promise<AccountTxResponse[]>

    • +
  • Defined in packages/xrpl/src/client/index.ts:487

  • Makes multiple paged requests to the client to return a given number of @@ -1554,7 +1554,7 @@ requests as needed.

    Returns Promise<BookOffersResponse[]>

    • +
  • Defined in packages/xrpl/src/client/index.ts:488

  • Makes multiple paged requests to the client to return a given number of @@ -1579,7 +1579,7 @@ requests as needed.

    Returns Promise<LedgerDataResponse[]>

    • +
  • Defined in packages/xrpl/src/client/index.ts:489

    • requestNextPage

  • Requests the next page of data.

    @@ -1616,7 +1616,7 @@ requests as needed.

    Returns Promise<AccountLinesResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:373

  • Requests the next page of data.

    @@ -1637,7 +1637,7 @@ requests as needed.

    Returns Promise<AccountObjectsResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:377

  • Requests the next page of data.

    @@ -1658,7 +1658,7 @@ requests as needed.

    Returns Promise<AccountOffersResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:381

  • Requests the next page of data.

    @@ -1679,7 +1679,7 @@ requests as needed.

    Returns Promise<AccountTxResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:385

  • Requests the next page of data.

    @@ -1700,20 +1700,20 @@ requests as needed.

    Returns Promise<LedgerDataResponse>

    • +
  • Defined in packages/xrpl/src/client/index.ts:389

    • Other

    Private Readonly clients

    clients: Client[]
    +
  • Defined in packages/xrpl/src/client/BroadcastClient.ts:19

    • Readonly connection

    connection: Connection
    +
  • Defined in packages/xrpl/src/client/index.ts:184

    • prepareTransaction

    prepareTransaction: (<T>(this: Client, transaction: T, signersCount?: number) => Promise<T>) = autofill
    @@ -1731,11 +1731,11 @@ flags interfaces into numbers.

    Returns

    The autofilled transaction.

    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    T extends Transaction

    Parameters

      @@ -1755,7 +1755,7 @@ Only used for multisigned transactions.

      Returns Promise<T>

    +
  • Defined in packages/xrpl/src/client/index.ts:610

    • Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol
    +
  • Defined in packages/xrpl/src/client/BroadcastClient.ts:66

    • listenerCount

    +
  • Defined in packages/xrpl/src/client/index.ts:180
    • @@ -119,18 +119,18 @@

    Returns Client

    +
  • Defined in packages/xrpl/src/client/index.ts:210

    • Abstraction

    getBalances

    -
    getBalances: ((this: Client, address: string, options?: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; peer?: string }) => Promise<{ currency: string; issuer?: string; value: string }[]>) = getBalances
    +
    getBalances: ((this: Client, address: string, options?: {
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
        limit?: number;
        peer?: string;
    }) => Promise<{
        currency: string;
        issuer?: string;
        value: string;
    }[]>) = getBalances

    Type declaration

      • -
      • (this: Client, address: string, options?: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; peer?: string }): Promise<{ currency: string; issuer?: string; value: string }[]>
        • +
      • (this: Client, address: string, options?: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
            limit?: number;
            peer?: string;
        }): Promise<{
            currency: string;
            issuer?: string;
            value: string;
        }[]>

      • Get XRP/non-XRP balances for an account.

        @@ -148,7 +148,7 @@

        Address of the account to retrieve balances for.

      • -
        options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; peer?: string } = {}
        +
        options: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
            limit?: number;
            peer?: string;
        } = {}

        Allows the client to specify a ledger_hash, ledger_index, filter by peer, and/or limit number of balances.

        @@ -171,9 +171,9 @@ ledger_index.

        Optional peer?: string

        Filter balances by peer.

    -

    Returns Promise<{ currency: string; issuer?: string; value: string }[]>

    +
  • Defined in packages/xrpl/src/client/index.ts:620

    • getLedgerIndex

    getLedgerIndex: ((this: Client) => Promise<number>) = getLedgerIndex
    @@ -197,16 +197,16 @@ ledger_index.

    Returns Promise<number>

    +
  • Defined in packages/xrpl/src/client/index.ts:630

    • getOrderbook

    -
    getOrderbook: ((this: Client, takerPays: TakerAmount, takerGets: TakerAmount, options?: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }) => Promise<{ buy: BookOffer[]; sell: BookOffer[] }>) = getOrderbook
    +
    getOrderbook: ((this: Client, takerPays: TakerAmount, takerGets: TakerAmount, options?: {
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
        limit?: number;
        taker?: string;
    }) => Promise<{
        buy: BookOffer[];
        sell: BookOffer[];
    }>) = getOrderbook

    Type declaration

      • -
      • (this: Client, takerPays: TakerAmount, takerGets: TakerAmount, options?: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }): Promise<{ buy: BookOffer[]; sell: BookOffer[] }>
        • +
      • (this: Client, takerPays: TakerAmount, takerGets: TakerAmount, options?: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
            limit?: number;
            taker?: string;
        }): Promise<{
            buy: BookOffer[];
            sell: BookOffer[];
        }>

      • Fetch orderbook (buy/sell orders) between two accounts.

        @@ -230,7 +230,7 @@ offer would pay, as an object with currency and issuer offer would receive, as an object with currency and issuer fields.

      • -
        options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string } = {}
        +
        options: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
            limit?: number;
            taker?: string;
        } = {}

        Options allowing the client to specify ledger_index, ledger_hash, filter by taker, and/or limit number of orders.

        @@ -253,22 +253,22 @@ the order book. Defaults to 20.

        Optional taker?: string

        Filter orders by taker.

    -

    Returns Promise<{ buy: BookOffer[]; sell: BookOffer[] }>

    +
  • Defined in packages/xrpl/src/client/index.ts:625

    • getXrpBalance

    -
    getXrpBalance: ((this: Client, address: string, options?: { ledger_hash?: string; ledger_index?: LedgerIndex }) => Promise<string>) = getXrpBalance
    +
    getXrpBalance: ((this: Client, address: string, options?: {
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
    }) => Promise<string>) = getXrpBalance

    Type declaration

      • -
      • (this: Client, address: string, options?: { ledger_hash?: string; ledger_index?: LedgerIndex }): Promise<string>
        • +
      • (this: Client, address: string, options?: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
        }): Promise<string>

      • Get the XRP balance for an account.

        -

        Example

        const client = new Client(wss://s.altnet.rippletest.net:51233)
        const balance = await client.getXrpBalance('rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn')
        console.log(balance)
        /// '200'
+
        Example
        const client = new Client(wss://s.altnet.rippletest.net:51233)
        const balance = await client.getXrpBalance('rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn')
        console.log(balance)
        /// '200'
 
        
 
 
        Returns
        The XRP balance of the account (as a string).
        
@@ -285,7 +285,7 @@ the order book. Defaults to 20.
        
 
        Address of the account to retrieve XRP balance.
      • -
        options: { ledger_hash?: string; ledger_index?: LedgerIndex } = {}
        +
        options: {
            ledger_hash?: string;
            ledger_index?: LedgerIndex;
        } = {}

        Options to include for getting the XRP balance.

          @@ -301,7 +301,7 @@ ledger_index.

    Returns Promise<string>

    +
  • Defined in packages/xrpl/src/client/index.ts:615

    • Core

    @@ -321,11 +321,11 @@ flags interfaces into numbers.

    Returns

    The autofilled transaction.

    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    T extends Transaction

    Parameters

      @@ -344,16 +344,16 @@ Only used for multisigned transactions.

    Returns Promise<T>

    +
  • Defined in packages/xrpl/src/client/index.ts:596

    • submit

    -
    submit: ((this: Client, transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<SubmitResponse>) = submit
    +
    submit: ((this: Client, transaction: string | Transaction, opts?: {
        autofill?: boolean;
        failHard?: boolean;
        wallet?: Wallet;
    }) => Promise<SubmitResponse>) = submit

    Type declaration

      • -
      • (this: Client, transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }): Promise<SubmitResponse>
        • +
      • (this: Client, transaction: string | Transaction, opts?: {
            autofill?: boolean;
            failHard?: boolean;
            wallet?: Wallet;
        }): Promise<SubmitResponse>

      • Submits a signed/unsigned transaction. Steps performed on a transaction:

        @@ -379,7 +379,7 @@ Steps performed on a transaction:

        A transaction to autofill, sign & encode, and submit.

      • -
        Optional opts: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }
        +
        Optional opts: {
            autofill?: boolean;
            failHard?: boolean;
            wallet?: Wallet;
        }

        (Optional) Options used to sign and submit a transaction.

          @@ -397,16 +397,16 @@ Steps performed on a transaction:

    Returns Promise<SubmitResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:601

    • submitAndWait

    -
    submitAndWait: ((this: Client, transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<TxResponse>) = submitAndWait
    +
    submitAndWait: ((this: Client, transaction: string | Transaction, opts?: {
        autofill?: boolean;
        failHard?: boolean;
        wallet?: Wallet;
    }) => Promise<TxResponse>) = submitAndWait

    Type declaration

    Returns Promise<TxResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:605

    • Faucet

    fundWallet

    -
    fundWallet: ((this: Client, wallet?: null | Wallet, options?: { faucetHost?: string }) => Promise<{ balance: number; wallet: Wallet }>) = fundWallet
    +
    fundWallet: ((this: Client, wallet?: null | Wallet, options?: {
        faucetHost?: string;
    }) => Promise<{
        balance: number;
        wallet: Wallet;
    }>) = fundWallet

    Type declaration

      • -
      • (this: Client, wallet?: null | Wallet, options?: { faucetHost?: string }): Promise<{ balance: number; wallet: Wallet }>
        • +
      • (this: Client, wallet?: null | Wallet, options?: {
            faucetHost?: string;
        }): Promise<{
            balance: number;
            wallet: Wallet;
        }>

      • Generates a random wallet with some amount of XRP (usually 1000 XRP).

        -

        Example

        const api = new xrpl.Client("wss://s.altnet.rippletest.net:51233")
        await api.connect()
        const { wallet, balance } = await api.fundWallet()
+
        Example
        const api = new xrpl.Client("wss://s.altnet.rippletest.net:51233")
        await api.connect()
        const { wallet, balance } = await api.fundWallet()
 
        
 
 
        Returns
        A Wallet on the Testnet or Devnet that contains some amount of XRP,
@@ -479,7 +479,7 @@ and that wallet's balance in XRP.
        
 
        An existing XRPL Wallet to fund. If undefined or null, a new Wallet will be created.
      • -
        Optional options: { faucetHost?: string }
        +
        Optional options: {
            faucetHost?: string;
        }

        See below.

          @@ -491,9 +491,9 @@ automatically. In other environments, or if you would like to customize the faucet host in devnet or testnet, you should provide the host using this option.

    -

    Returns Promise<{ balance: number; wallet: Wallet }>

    +
  • Defined in packages/xrpl/src/client/index.ts:635

    • Fee

    @@ -503,7 +503,7 @@ option.

    required fee rises during submission of a transaction. Defaults to 1.2.

    +
  • Defined in packages/xrpl/src/client/index.ts:192

    • Readonly maxFeeXRP

    maxFeeXRP: string
    @@ -511,7 +511,7 @@ required fee rises during submission of a transaction. Defaults to 1.2.

    number. Defaults to '2'.

    +
  • Defined in packages/xrpl/src/client/index.ts:200

    • Network

    @@ -525,7 +525,7 @@ number. Defaults to '2'.

    Returns string

    +
  • Defined in packages/xrpl/src/client/index.ts:280

    • connect

    +
  • Defined in packages/xrpl/src/client/index.ts:565

    • disconnect

    +
  • Defined in packages/xrpl/src/client/index.ts:575

    • isConnected

    +
  • Defined in packages/xrpl/src/client/index.ts:589

    • on

      @@ -569,7 +569,7 @@ number. Defaults to '2'.

    • Event handler for subscription streams.

      -

      Example

      const api = new Client('wss://s.altnet.rippletest.net:51233')

      api.on('transactions', (tx: TransactionStream) => {
       console.log("Received Transaction")
       console.log(tx)
      })

      await api.connect()
      const response = await api.request({
          command: 'subscribe',
          streams: ['transactions_proposed']
      })
+
      Example
      const api = new Client('wss://s.altnet.rippletest.net:51233')

      api.on('transactions', (tx: TransactionStream) => {
       console.log("Received Transaction")
       console.log(tx)
      })

      await api.connect()
      const response = await api.request({
          command: 'subscribe',
          streams: ['transactions_proposed']
      })
      @@ -588,7 +588,7 @@ number. Defaults to '2'.

      Returns Client

      • +
    • Defined in packages/xrpl/src/client/index.ts:435

  • Event handler for subscription streams.

    @@ -618,7 +618,7 @@ number. Defaults to '2'.

    Returns Client

    • +
  • Defined in packages/xrpl/src/client/index.ts:436

  • Event handler for subscription streams.

    @@ -648,7 +648,7 @@ number. Defaults to '2'.

    Returns Client

    • +
  • Defined in packages/xrpl/src/client/index.ts:437

  • Event handler for subscription streams.

    @@ -678,7 +678,7 @@ number. Defaults to '2'.

    Returns Client

    • +
  • Defined in packages/xrpl/src/client/index.ts:441

  • Event handler for subscription streams.

    @@ -708,7 +708,7 @@ number. Defaults to '2'.

    Returns Client

    • +
  • Defined in packages/xrpl/src/client/index.ts:445

  • Event handler for subscription streams.

    @@ -738,7 +738,7 @@ number. Defaults to '2'.

    Returns Client

    • +
  • Defined in packages/xrpl/src/client/index.ts:449

  • Event handler for subscription streams.

    @@ -768,7 +768,7 @@ number. Defaults to '2'.

    Returns Client

    • +
  • Defined in packages/xrpl/src/client/index.ts:453

  • Event handler for subscription streams.

    @@ -798,7 +798,7 @@ number. Defaults to '2'.

    Returns Client

    • +
  • Defined in packages/xrpl/src/client/index.ts:457

  • Event handler for subscription streams.

    @@ -828,7 +828,7 @@ number. Defaults to '2'.

    Returns Client

    • +
  • Defined in packages/xrpl/src/client/index.ts:459

    • request

    Returns Promise<AccountChannelsResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:287

  • Makes a request to the client with the given command and @@ -856,7 +856,7 @@ additional request body parameters.

    r: AccountCurrenciesRequest

    • Returns Promise<AccountCurrenciesResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:290

  • Makes a request to the client with the given command and @@ -871,7 +871,7 @@ additional request body parameters.

    r: AccountInfoRequest

    • Returns Promise<AccountInfoResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:293

  • Makes a request to the client with the given command and @@ -886,7 +886,7 @@ additional request body parameters.

    r: AccountLinesRequest

    • Returns Promise<AccountLinesResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:294

  • Makes a request to the client with the given command and @@ -901,7 +901,7 @@ additional request body parameters.

    r: AccountNFTsRequest

    • Returns Promise<AccountNFTsResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:295

  • Makes a request to the client with the given command and @@ -916,7 +916,7 @@ additional request body parameters.

    r: AccountObjectsRequest

    • Returns Promise<AccountObjectsResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:296

  • Makes a request to the client with the given command and @@ -931,7 +931,7 @@ additional request body parameters.

    r: AccountOffersRequest

    • Returns Promise<AccountOffersResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:299

  • Makes a request to the client with the given command and @@ -946,7 +946,7 @@ additional request body parameters.

    r: AccountTxRequest

    • Returns Promise<AccountTxResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:300

  • Makes a request to the client with the given command and @@ -961,7 +961,7 @@ additional request body parameters.

    r: BookOffersRequest

    • Returns Promise<BookOffersResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:301

  • Makes a request to the client with the given command and @@ -976,7 +976,7 @@ additional request body parameters.

    r: ChannelVerifyRequest

    • Returns Promise<ChannelVerifyResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:302

  • Makes a request to the client with the given command and @@ -991,7 +991,7 @@ additional request body parameters.

    r: DepositAuthorizedRequest

    • Returns Promise<DepositAuthorizedResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:303

  • Makes a request to the client with the given command and @@ -1006,7 +1006,7 @@ additional request body parameters.

    r: FeeRequest

    • Returns Promise<FeeResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:306

  • Makes a request to the client with the given command and @@ -1021,7 +1021,7 @@ additional request body parameters.

    r: GatewayBalancesRequest

    • Returns Promise<GatewayBalancesResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:307

  • Makes a request to the client with the given command and @@ -1036,7 +1036,7 @@ additional request body parameters.

    r: LedgerRequest

    • Returns Promise<LedgerResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:310

  • Makes a request to the client with the given command and @@ -1051,7 +1051,7 @@ additional request body parameters.

    r: LedgerClosedRequest

    • Returns Promise<LedgerClosedResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:311

  • Makes a request to the client with the given command and @@ -1066,7 +1066,7 @@ additional request body parameters.

    r: LedgerCurrentRequest

    • Returns Promise<LedgerCurrentResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:312

  • Makes a request to the client with the given command and @@ -1081,7 +1081,7 @@ additional request body parameters.

    r: LedgerDataRequest

    • Returns Promise<LedgerDataResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:313

  • Makes a request to the client with the given command and @@ -1096,7 +1096,7 @@ additional request body parameters.

    r: LedgerEntryRequest

    • Returns Promise<LedgerEntryResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:314

  • Makes a request to the client with the given command and @@ -1111,7 +1111,7 @@ additional request body parameters.

    r: ManifestRequest

    • Returns Promise<ManifestResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:315

  • Makes a request to the client with the given command and @@ -1126,7 +1126,7 @@ additional request body parameters.

    r: NFTBuyOffersRequest

    • Returns Promise<NFTBuyOffersResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:316

  • Makes a request to the client with the given command and @@ -1141,7 +1141,7 @@ additional request body parameters.

    r: NFTSellOffersRequest

    • Returns Promise<NFTSellOffersResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:317

  • Makes a request to the client with the given command and @@ -1156,7 +1156,7 @@ additional request body parameters.

    r: NoRippleCheckRequest

    • Returns Promise<NoRippleCheckResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:318

  • Makes a request to the client with the given command and @@ -1171,7 +1171,7 @@ additional request body parameters.

    r: PathFindRequest

    • Returns Promise<PathFindResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:319

  • Makes a request to the client with the given command and @@ -1186,7 +1186,7 @@ additional request body parameters.

    r: PingRequest

    • Returns Promise<PingResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:320

  • Makes a request to the client with the given command and @@ -1201,7 +1201,7 @@ additional request body parameters.

    r: RandomRequest

    • Returns Promise<RandomResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:321

  • Makes a request to the client with the given command and @@ -1216,7 +1216,7 @@ additional request body parameters.

    r: RipplePathFindRequest

    • Returns Promise<RipplePathFindResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:322

  • Makes a request to the client with the given command and @@ -1231,7 +1231,7 @@ additional request body parameters.

    r: ServerInfoRequest

    • Returns Promise<ServerInfoResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:325

  • Makes a request to the client with the given command and @@ -1246,7 +1246,7 @@ additional request body parameters.

    r: ServerStateRequest

    • Returns Promise<ServerStateResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:326

  • Makes a request to the client with the given command and @@ -1261,7 +1261,7 @@ additional request body parameters.

    r: SubmitRequest

    • Returns Promise<SubmitResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:327

  • Makes a request to the client with the given command and @@ -1276,7 +1276,7 @@ additional request body parameters.

    r: SubmitMultisignedRequest

    • Returns Promise<SubmitMultisignedResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:328

  • Makes a request to the client with the given command and @@ -1291,7 +1291,7 @@ additional request body parameters.

    r: SubscribeRequest

    • Returns Promise<SubscribeResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:331

  • Makes a request to the client with the given command and @@ -1306,7 +1306,7 @@ additional request body parameters.

    r: UnsubscribeRequest

    • Returns Promise<UnsubscribeResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:332

  • Makes a request to the client with the given command and @@ -1321,7 +1321,7 @@ additional request body parameters.

    r: TransactionEntryRequest

    • Returns Promise<TransactionEntryResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:333

  • Makes a request to the client with the given command and @@ -1336,7 +1336,7 @@ additional request body parameters.

    r: TxRequest

    • Returns Promise<TxResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:336

  • Makes a request to the client with the given command and @@ -1344,13 +1344,13 @@ additional request body parameters.

    Returns

    The response from the server.

    -
    -

    Type Parameters

    +
    +

    Type Parameters

    • R extends BaseRequest

    • -

      T extends BaseResponse

    +

    T extends BaseResponse

    • Parameters

      @@ -1358,7 +1358,7 @@ additional request body parameters.

      r: R

    Returns Promise<T>

    +
  • Defined in packages/xrpl/src/client/index.ts:337

    • requestAll

    Returns Promise<AccountChannelsResponse[]>

    +
  • Defined in packages/xrpl/src/client/index.ts:475

  • Makes multiple paged requests to the client to return a given number of @@ -1395,7 +1395,7 @@ requests as needed.

    req: AccountLinesRequest

    • Returns Promise<AccountLinesResponse[]>

    +
  • Defined in packages/xrpl/src/client/index.ts:478

  • Makes multiple paged requests to the client to return a given number of @@ -1419,7 +1419,7 @@ requests as needed.

    req: AccountObjectsRequest

    • Returns Promise<AccountObjectsResponse[]>

    +
  • Defined in packages/xrpl/src/client/index.ts:481

  • Makes multiple paged requests to the client to return a given number of @@ -1443,7 +1443,7 @@ requests as needed.

    req: AccountOffersRequest

    • Returns Promise<AccountOffersResponse[]>

    +
  • Defined in packages/xrpl/src/client/index.ts:484

  • Makes multiple paged requests to the client to return a given number of @@ -1467,7 +1467,7 @@ requests as needed.

    req: AccountTxRequest

    • Returns Promise<AccountTxResponse[]>

    +
  • Defined in packages/xrpl/src/client/index.ts:487

  • Makes multiple paged requests to the client to return a given number of @@ -1491,7 +1491,7 @@ requests as needed.

    req: BookOffersRequest

    • Returns Promise<BookOffersResponse[]>

    +
  • Defined in packages/xrpl/src/client/index.ts:488

  • Makes multiple paged requests to the client to return a given number of @@ -1515,7 +1515,7 @@ requests as needed.

    req: LedgerDataRequest

    • Returns Promise<LedgerDataResponse[]>

    +
  • Defined in packages/xrpl/src/client/index.ts:489

    • requestNextPage

    Returns Promise<AccountChannelsResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:369

  • Requests the next page of data.

    @@ -1550,7 +1550,7 @@ requests as needed.

    • Returns Promise<AccountLinesResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:373

  • Requests the next page of data.

    @@ -1570,7 +1570,7 @@ requests as needed.

    • Returns Promise<AccountObjectsResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:377

  • Requests the next page of data.

    @@ -1590,7 +1590,7 @@ requests as needed.

    • Returns Promise<AccountOffersResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:381

  • Requests the next page of data.

    @@ -1610,7 +1610,7 @@ requests as needed.

    • Returns Promise<AccountTxResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:385

  • Requests the next page of data.

    @@ -1630,14 +1630,14 @@ requests as needed.

    • Returns Promise<LedgerDataResponse>

    +
  • Defined in packages/xrpl/src/client/index.ts:389

    • Other

    Readonly connection

    connection: Connection
    +
  • Defined in packages/xrpl/src/client/index.ts:184

    • prepareTransaction

    prepareTransaction: (<T>(this: Client, transaction: T, signersCount?: number) => Promise<T>) = autofill
    @@ -1655,11 +1655,11 @@ flags interfaces into numbers.

    Returns

    The autofilled transaction.

    -
    -

    Type Parameters

    +
    +

    Type Parameters

    +

    T extends Transaction

    Parameters

      @@ -1678,7 +1678,7 @@ Only used for multisigned transactions.

    Returns Promise<T>

    +
  • Defined in packages/xrpl/src/client/index.ts:610

    • Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol
    +
  • Defined in packages/xrpl/src/errors.ts:78
    • @@ -41,11 +41,11 @@

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -77,7 +77,7 @@

    Returns ConnectionError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -85,19 +85,19 @@
    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:92
    • @@ -35,11 +35,11 @@

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -71,7 +71,7 @@

    Returns DisconnectedError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -79,19 +79,19 @@
    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:85
    • @@ -35,11 +35,11 @@

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -71,7 +71,7 @@

    Returns NotConnectedError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -79,19 +79,19 @@
    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:137
    • @@ -36,11 +36,11 @@ From rippled.

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -68,7 +68,7 @@ From rippled.

    Returns NotFoundError

    +
  • Defined in packages/xrpl/src/errors.ts:143

    • Properties

    @@ -76,19 +76,19 @@ From rippled.

    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:113
    • @@ -35,11 +35,11 @@

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -71,7 +71,7 @@

    Returns ResponseFormatError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -79,19 +79,19 @@
    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:64
    • @@ -35,11 +35,11 @@

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -71,7 +71,7 @@

    Returns RippledError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -79,19 +79,19 @@
    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:99
    • @@ -35,11 +35,11 @@

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -71,7 +71,7 @@

    Returns RippledNotInitializedError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -79,19 +79,19 @@
    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:106
    • @@ -35,11 +35,11 @@

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -71,7 +71,7 @@

    Returns TimeoutError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -79,19 +79,19 @@
    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:71
    • @@ -35,11 +35,11 @@

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -71,7 +71,7 @@

    Returns UnexpectedError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -79,19 +79,19 @@
    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:120
    • @@ -35,11 +35,11 @@

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -71,7 +71,7 @@

    Returns ValidationError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -79,19 +79,19 @@
    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

      @@ -204,11 +204,11 @@ us to customize its output:
    • ValidationError
      • constructor
        • -
      • data
        • +
      • data?
      • message
      • name
        • -
      • stack
        • -
      • prepareStackTrace
        • +
      • stack?
        • +
      • prepareStackTrace?
      • stackTraceLimit
      • inspect
      • toString
        • diff --git a/docs/classes/Wallet.html b/docs/classes/Wallet.html index 07ef5f52..2dc76f8c 100644 --- a/docs/classes/Wallet.html +++ b/docs/classes/Wallet.html @@ -18,7 +18,7 @@ A wallet can be derived from either a seed, mnemonic, or entropy (array of random numbers). It provides functionality to sign/verify transactions offline.

        -

        Example

        // Derive a wallet from a bip39 Mnemonic
        const wallet = Wallet.fromMnemonic(
          'jewel insect retreat jump claim horse second chef west gossip bone frown exotic embark laundry'
        )
        console.log(wallet)
        // Wallet {
        // publicKey: '02348F89E9A6A3615BA317F8474A3F51D66221562D3CA32BFA8D21348FF67012B2',
        // privateKey: '00A8F2E77FC0E05890C1B5088AFE0ECF9D96466A4419B897B1AB383E336E1735A2',
        // classicAddress: 'rwZiksrExmVkR64pf87Jor4cYbmff47SUm',
        // seed: undefined
        // }.

        // Derive a wallet from a base58 encoded seed.
        const seedWallet = Wallet.fromSeed('ssZkdwURFMBXenJPbrpE14b6noJSu')
        console.log(seedWallet)
        // Wallet {
        // publicKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
        // privateKey: '00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7',
        // classicAddress: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo',
        // seed: 'ssZkdwURFMBXenJPbrpE14b6noJSu'
        // }.

        // Sign a JSON Transaction
         const signed = seedWallet.signTransaction({
             TransactionType: 'Payment',
             Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
             ...........
        }).

        console.log(signed)
        // '1200007321......B01BE1DFF3'.
        console.log(decode(signed))
        // {
        //   TransactionType: 'Payment',
        //   SigningPubKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
        //   TxnSignature: '3045022100AAD......5B631ABD21171B61B07D304',
        //   Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
        //   ...........
        // }
+
        Example
        // Derive a wallet from a bip39 Mnemonic
        const wallet = Wallet.fromMnemonic(
          'jewel insect retreat jump claim horse second chef west gossip bone frown exotic embark laundry'
        )
        console.log(wallet)
        // Wallet {
        // publicKey: '02348F89E9A6A3615BA317F8474A3F51D66221562D3CA32BFA8D21348FF67012B2',
        // privateKey: '00A8F2E77FC0E05890C1B5088AFE0ECF9D96466A4419B897B1AB383E336E1735A2',
        // classicAddress: 'rwZiksrExmVkR64pf87Jor4cYbmff47SUm',
        // seed: undefined
        // }.

        // Derive a wallet from a base58 encoded seed.
        const seedWallet = Wallet.fromSeed('ssZkdwURFMBXenJPbrpE14b6noJSu')
        console.log(seedWallet)
        // Wallet {
        // publicKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
        // privateKey: '00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7',
        // classicAddress: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo',
        // seed: 'ssZkdwURFMBXenJPbrpE14b6noJSu'
        // }.

        // Sign a JSON Transaction
         const signed = seedWallet.signTransaction({
             TransactionType: 'Payment',
             Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
             ...........
        }).

        console.log(signed)
        // '1200007321......B01BE1DFF3'.
        console.log(decode(signed))
        // {
        //   TransactionType: 'Payment',
        //   SigningPubKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
        //   TxnSignature: '3045022100AAD......5B631ABD21171B61B07D304',
        //   Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
        //   ...........
        // }
    @@ -26,7 +26,7 @@ It provides functionality to sign/verify transactions offline.

    • Wallet
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:94
    • @@ -41,7 +41,7 @@ It provides functionality to sign/verify transactions offline.

    classicAddress privateKey publicKey -seed +seed? fromSecret
    @@ -66,7 +66,7 @@ It provides functionality to sign/verify transactions offline.

    constructor

      - +

    • Creates a new Wallet.

      @@ -82,7 +82,7 @@ It provides functionality to sign/verify transactions offline.

      The private key used for signing transactions for the account.

    • -
      opts: { masterAddress?: string; seed?: string } = {}
      +
      opts: {
          masterAddress?: string;
          seed?: string;
      } = {}

      (Optional) Options to initialize a Wallet.

        @@ -96,38 +96,38 @@ It provides functionality to sign/verify transactions offline.

    Returns Wallet

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:118

    • Properties

    Readonly classicAddress

    classicAddress: string
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:97

    • Readonly privateKey

    privateKey: string
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:96

    • Readonly publicKey

    publicKey: string
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:95

    • Optional Readonly seed

    seed?: string
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:98

    • Static fromSecret

    -
    fromSecret: ((seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }) => Wallet) = Wallet.fromSeed
    +
    fromSecret: ((seed: string, opts?: {
        algorithm?: ECDSA;
        masterAddress?: string;
    }) => Wallet) = Wallet.fromSeed

    Type declaration

      • -
      • (seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }): Wallet
        • +
      • (seed: string, opts?: {
            algorithm?: ECDSA;
            masterAddress?: string;
        }): Wallet

      • Derives a wallet from a seed.

        @@ -141,7 +141,7 @@ It provides functionality to sign/verify transactions offline.

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

      • -
        opts: { algorithm?: ECDSA; masterAddress?: string } = {}
        +
        opts: {
            algorithm?: ECDSA;
            masterAddress?: string;
        } = {}

        (Optional) Options to derive a Wallet.

          @@ -155,7 +155,7 @@ It provides functionality to sign/verify transactions offline.

    Returns Wallet

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:174

    • Accessors

    @@ -169,7 +169,7 @@ It provides functionality to sign/verify transactions offline.

    Returns string

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:105

    • Methods

    @@ -199,7 +199,7 @@ the serialized Transaction desn't match the original transaction.

    Returns void

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:408

    • getXAddress

      @@ -222,11 +222,11 @@ the serialized Transaction desn't match the original transaction.

    Returns string

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:392

    • sign

      - +

    • Signs a transaction offline.

      @@ -251,14 +251,14 @@ the serialized Transaction desn't match the original transaction.

      Optional multisign: string | boolean

      Specify true/false to use multisign or actual address (classic/x-address) to make multisign tx request.

    -

    Returns { hash: string; tx_blob: string }

    +

    Returns {
        hash: string;
        tx_blob: string;
    }

    • hash: string
    • tx_blob: string
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:317

    • verifyTransaction

      @@ -277,11 +277,11 @@ the serialized Transaction desn't match the original transaction.

    Returns boolean

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:378

    • Static Private deriveWallet

      - +

    • Derive a Wallet from a seed.

      @@ -295,7 +295,7 @@ the serialized Transaction desn't match the original transaction.

      The seed used to derive the wallet.

    • -
      opts: { algorithm?: ECDSA; masterAddress?: string } = {}
      +
      opts: {
          algorithm?: ECDSA;
          masterAddress?: string;
      } = {}

      (Optional) Options to derive a Wallet.

        @@ -309,11 +309,11 @@ the serialized Transaction desn't match the original transaction.

    Returns Wallet

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:293

    • Static fromEntropy

      - +

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

      @@ -327,7 +327,7 @@ the serialized Transaction desn't match the original transaction.

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

    • -
      opts: { algorithm?: ECDSA; masterAddress?: string } = {}
      +
      opts: {
          algorithm?: ECDSA;
          masterAddress?: string;
      } = {}

      (Optional) Options to derive a Wallet.

        @@ -341,11 +341,11 @@ the serialized Transaction desn't match the original transaction.

    Returns Wallet

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:185

    • Static fromMnemonic

      - +

    • Derives a wallet from a bip39 or RFC1751 mnemonic (Defaults to bip39).

      @@ -361,7 +361,7 @@ the serialized Transaction desn't match the original transaction.

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

    • -
      opts: { algorithm?: ECDSA; derivationPath?: string; masterAddress?: string; mnemonicEncoding?: "bip39" | "rfc1751" } = {}
      +
      opts: {
          algorithm?: ECDSA;
          derivationPath?: string;
          masterAddress?: string;
          mnemonicEncoding?: "bip39" | "rfc1751";
      } = {}

      (Optional) Options to derive a Wallet.

        @@ -386,11 +386,11 @@ the serialized Transaction desn't match the original transaction.

    Returns Wallet

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:216

    • Static Private fromRFC1751Mnemonic

      - +

    • Derives a wallet from a RFC1751 mnemonic, which is how wallet_propose encodes mnemonics.

      @@ -404,7 +404,7 @@ the serialized Transaction desn't match the original transaction.

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

    • -
      opts: { algorithm?: ECDSA; masterAddress?: string }
      +
      opts: {
          algorithm?: ECDSA;
          masterAddress?: string;
      }

      (Optional) Options to derive a Wallet.

        @@ -418,11 +418,11 @@ the serialized Transaction desn't match the original transaction.

    Returns Wallet

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:265

    • Static fromSeed

      - +

    • Derives a wallet from a seed.

      @@ -436,7 +436,7 @@ the serialized Transaction desn't match the original transaction.

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

    • -
      opts: { algorithm?: ECDSA; masterAddress?: string } = {}
      +
      opts: {
          algorithm?: ECDSA;
          masterAddress?: string;
      } = {}

      (Optional) Options to derive a Wallet.

        @@ -450,7 +450,7 @@ the serialized Transaction desn't match the original transaction.

    Returns Wallet

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:154

    • Static generate

      @@ -469,7 +469,7 @@ the serialized Transaction desn't match the original transaction.

    Returns Wallet

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:140
    • @@ -500,7 +500,7 @@ the serialized Transaction desn't match the original transaction.

  • classicAddress
  • privateKey
  • publicKey
    • -
  • seed
    • +
  • seed?
  • fromSecret
  • address
  • checkTxSerialization
    • diff --git a/docs/classes/XRPLFaucetError.html b/docs/classes/XRPLFaucetError.html index 878a015f..a216b4ec 100644 --- a/docs/classes/XRPLFaucetError.html +++ b/docs/classes/XRPLFaucetError.html @@ -25,7 +25,7 @@ is connected to mainnet).

    • XRPLFaucetError
    +
  • Defined in packages/xrpl/src/errors.ts:129
    • @@ -37,11 +37,11 @@ is connected to mainnet).

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -73,7 +73,7 @@ is connected to mainnet).

    Returns XRPLFaucetError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -81,19 +81,19 @@ is connected to mainnet).

    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:10
    • @@ -43,11 +43,11 @@ XrplErrors.

    Properties

    -
    data +
    data? message name -stack -prepareStackTrace +stack? +prepareStackTrace? stackTraceLimit
    @@ -79,26 +79,26 @@ XrplErrors.

    Returns XrplError

    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    Optional Readonly data

    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:13

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:12

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:54

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:38

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:11
    • @@ -45,28 +45,28 @@ AccountTxnID.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:31

    • asfAuthorizedNFTokenMinter

    asfAuthorizedNFTokenMinter: 10

    Allow another account to mint and burn tokens on behalf of this account.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:46

    • asfDefaultRipple

    asfDefaultRipple: 8

    Enable rippling on this account's trust lines by default.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:40

    • asfDepositAuth

    asfDepositAuth: 9

    Enable Deposit Authorization on this account.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:42

    • asfDisableMaster

    asfDisableMaster: 4
    @@ -75,21 +75,21 @@ has configured another way to sign transactions, such as a Regular Key or a Signer List.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:26

    • asfDisallowXRP

    asfDisallowXRP: 3

    XRP should not be sent to this account.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:20

    • asfGlobalFreeze

    asfGlobalFreeze: 7

    Freeze all assets issued by this account.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:38

    • asfNoFreeze

    asfNoFreeze: 6
    @@ -97,7 +97,7 @@ Signer List.

    disable Global Freeze. This flag can never be disabled after being enabled.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:36

    • asfRequireAuth

    asfRequireAuth: 2
    @@ -105,14 +105,14 @@ disable Global Freeze. This flag can never be disabled after being enabled.

    can only be enabled if the address has no trust lines connected to it.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:18

    • asfRequireDest

    asfRequireDest: 1

    Require a destination tag to send transactions to this account.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:13
    • diff --git a/docs/enums/AccountSetTfFlags.html b/docs/enums/AccountSetTfFlags.html index 49ee001c..d3f30cb4 100644 --- a/docs/enums/AccountSetTfFlags.html +++ b/docs/enums/AccountSetTfFlags.html @@ -17,7 +17,7 @@

    Enum for AccountSet Transaction Flags.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:54
    • @@ -40,42 +40,42 @@

    The same as ClearFlag: asfDisallowXRP.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:66

    • tfDisallowXRP

    tfDisallowXRP: 1048576

    The same as SetFlag: asfDisallowXRP.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:64

    • tfOptionalAuth

    tfOptionalAuth: 524288

    The same as ClearFlag: asfRequireAuth.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:62

    • tfOptionalDestTag

    tfOptionalDestTag: 131072

    The same as ClearFlag: asfRequireDest.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:58

    • tfRequireAuth

    tfRequireAuth: 262144

    The same as SetFlag: asfRequireAuth.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:60

    • tfRequireDestTag

    tfRequireDestTag: 65536

    The same as SetFlag: asfRequireDest.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:56
    • diff --git a/docs/enums/LedgerEntry.AccountRootFlags.html b/docs/enums/LedgerEntry.AccountRootFlags.html index d8543be1..75c623ce 100644 --- a/docs/enums/LedgerEntry.AccountRootFlags.html +++ b/docs/enums/LedgerEntry.AccountRootFlags.html @@ -15,7 +15,7 @@
  • AccountRootFlags

    • Enumeration AccountRootFlags

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:121
    • @@ -38,10 +38,10 @@

    lsfDefaultRipple

    lsfDefaultRipple: 8388608
    -

    Enable rippling on this addresses's trust lines by default. Required for issuing addresses; discouraged for others.

    +

    Enable rippling on this address's trust lines by default. Required for issuing addresses; discouraged for others.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:153

    • lsfDepositAuth

    lsfDepositAuth: 16777216
    @@ -49,56 +49,56 @@ (It has DepositAuth enabled.)

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:158

    • lsfDisableMaster

    lsfDisableMaster: 1048576

    Disallows use of the master key to sign transactions for this account.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:141

    • lsfDisallowXRP

    lsfDisallowXRP: 524288

    Client applications should not send XRP to this account. Not enforced by rippled.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:137

    • lsfGlobalFreeze

    lsfGlobalFreeze: 4194304

    All assets issued by this address are frozen.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:149

    • lsfNoFreeze

    lsfNoFreeze: 2097152

    This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:145

    • lsfPasswordSpent

    lsfPasswordSpent: 65536

    The account has used its free SetRegularKey transaction.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:125

    • lsfRequireAuth

    lsfRequireAuth: 262144

    This account must individually approve other users for those users to hold this account's issued currencies.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:133

    • lsfRequireDestTag

    lsfRequireDestTag: 131072

    Requires incoming payments to specify a Destination Tag.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:129
    • diff --git a/docs/enums/LedgerEntry.OfferFlags.html b/docs/enums/LedgerEntry.OfferFlags.html index 75f99fa1..e4cb5218 100644 --- a/docs/enums/LedgerEntry.OfferFlags.html +++ b/docs/enums/LedgerEntry.OfferFlags.html @@ -15,7 +15,7 @@
  • OfferFlags

    • Enumeration OfferFlags

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:49
    • @@ -32,12 +32,12 @@

    lsfPassive

    lsfPassive: 65536
    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:50

    • lsfSell

    lsfSell: 131072
    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:51
    • diff --git a/docs/enums/LedgerEntry.RippleStateFlags.html b/docs/enums/LedgerEntry.RippleStateFlags.html index 4a5e47a7..22481e3f 100644 --- a/docs/enums/LedgerEntry.RippleStateFlags.html +++ b/docs/enums/LedgerEntry.RippleStateFlags.html @@ -15,7 +15,7 @@
  • RippleStateFlags

    • Enumeration RippleStateFlags

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:76
    • @@ -38,42 +38,42 @@

    lsfHighAuth

    lsfHighAuth: 524288
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:81

    • lsfHighFreeze

    lsfHighFreeze: 8388608
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:87

    • lsfHighNoRipple

    lsfHighNoRipple: 2097152
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:83

    • lsfHighReserve

    lsfHighReserve: 131072
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:79

    • lsfLowAuth

    lsfLowAuth: 262144
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:80

    • lsfLowFreeze

    lsfLowFreeze: 4194304
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:85

    • lsfLowNoRipple

    lsfLowNoRipple: 1048576
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:82

    • lsfLowReserve

    lsfLowReserve: 65536
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:78
    • diff --git a/docs/enums/LedgerEntry.SignerListFlags.html b/docs/enums/LedgerEntry.SignerListFlags.html index 2d12be19..ed385a5f 100644 --- a/docs/enums/LedgerEntry.SignerListFlags.html +++ b/docs/enums/LedgerEntry.SignerListFlags.html @@ -15,7 +15,7 @@
  • SignerListFlags

    • Enumeration SignerListFlags

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:58
    • @@ -31,7 +31,7 @@

    lsfOneOwnerCount

    lsfOneOwnerCount: 65536
    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:60
    • diff --git a/docs/enums/NFTokenCreateOfferFlags.html b/docs/enums/NFTokenCreateOfferFlags.html index f2b2c02c..6228b4f1 100644 --- a/docs/enums/NFTokenCreateOfferFlags.html +++ b/docs/enums/NFTokenCreateOfferFlags.html @@ -17,7 +17,7 @@

    Transaction Flags for an NFTokenCreateOffer Transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:18
    • @@ -36,7 +36,7 @@ Otherwise, it is a buy offer.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:23
    • diff --git a/docs/enums/NFTokenMintFlags.html b/docs/enums/NFTokenMintFlags.html index 1302a645..a83219c8 100644 --- a/docs/enums/NFTokenMintFlags.html +++ b/docs/enums/NFTokenMintFlags.html @@ -17,7 +17,7 @@

    Transaction Flags for an NFTokenMint Transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:11
    • @@ -40,14 +40,14 @@ if the issuer does not currently hold the token. The current holder of the token may always burn it.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:17

    • tfOnlyXRP

    tfOnlyXRP: 2

    If set, indicates that the token may only be offered or sold for XRP.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:21

    • tfTransferable

    tfTransferable: 8
    @@ -56,7 +56,7 @@ effect if the token is being transferred from the issuer or to the issuer.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:32

    • tfTrustLine

    tfTrustLine: 4
    @@ -64,7 +64,7 @@ issuer.

    created.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:26
    • diff --git a/docs/enums/OfferCreateFlags.html b/docs/enums/OfferCreateFlags.html index 62955f8b..593738df 100644 --- a/docs/enums/OfferCreateFlags.html +++ b/docs/enums/OfferCreateFlags.html @@ -17,7 +17,7 @@

    Transaction Flags for an OfferCreate Transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:17
    • @@ -43,7 +43,7 @@ otherwise, the transaction uses the result code tesSUCCESS even when it was killed without trading any currency.

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:40

    • tfImmediateOrCancel

    tfImmediateOrCancel: 131072
    @@ -54,7 +54,7 @@ the ledger. If the offer cannot match any offers immediately, it executes has the result code tesSUCCESS, but creates no Offer objects in the ledger.

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:31

    • tfPassive

    tfPassive: 65536
    @@ -63,7 +63,7 @@ instead becomes an Offer object in the ledger. It still consumes offers that cross it.

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:23

    • tfSell

    tfSell: 524288
    @@ -71,7 +71,7 @@ that cross it.

    the TakerPays amount in exchange.

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:45
    • diff --git a/docs/enums/PaymentChannelClaimFlags.html b/docs/enums/PaymentChannelClaimFlags.html index 31fc58eb..6d61d622 100644 --- a/docs/enums/PaymentChannelClaimFlags.html +++ b/docs/enums/PaymentChannelClaimFlags.html @@ -17,7 +17,7 @@

    Enum representing values for PaymentChannelClaim transaction flags.

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:11
    • @@ -46,7 +46,7 @@ holds XRP, any XRP that remains after processing the claim is returned to the source address.

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:31

    • tfRenew

    tfRenew: 65536
    @@ -55,7 +55,7 @@ channel's immutable CancelAfter time.) Only the source address of the payment channel can use this flag.

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:17
    • diff --git a/docs/enums/PaymentFlags.html b/docs/enums/PaymentFlags.html index 8261e433..62b5cc6c 100644 --- a/docs/enums/PaymentFlags.html +++ b/docs/enums/PaymentFlags.html @@ -17,7 +17,7 @@

    Enum representing values for Payment Transaction Flags.

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:18
    • @@ -39,7 +39,7 @@ is equal or better than the ratio of Amount:SendMax. See Limit Quality for details.

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:36

    • tfNoDirectRipple

    tfNoDirectRipple: 65536
    @@ -48,7 +48,7 @@ This is intended to force the transaction to take arbitrage opportunities. Most clients do not need this.

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:24

    • tfPartialPayment

    tfPartialPayment: 131072
    @@ -57,7 +57,7 @@ reduce the received amount instead of failing outright. See Partial. Payments for more details.

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:30
    • diff --git a/docs/enums/TrustSetFlags.html b/docs/enums/TrustSetFlags.html index 40975e8d..7534d84c 100644 --- a/docs/enums/TrustSetFlags.html +++ b/docs/enums/TrustSetFlags.html @@ -17,7 +17,7 @@

    Enum representing values of TrustSet transaction flags.

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:16
    • @@ -39,21 +39,21 @@

    Unfreeze the trust line.

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:32

    • tfClearNoRipple

    tfClearNoRipple: 262144

    Disable the No Ripple flag, allowing rippling on this trust line.

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:28

    • tfSetFreeze

    tfSetFreeze: 1048576

    Freeze the trust line.

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:30

    • tfSetNoRipple

    tfSetNoRipple: 131072
    @@ -61,7 +61,7 @@ of the same currency if this flag is enabled on both.

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:26

    • tfSetfAuth

    tfSetfAuth: 65536
    @@ -69,7 +69,7 @@ of the same currency if this flag is enabled on both.

    effect unless using the asfRequireAuth AccountSet flag.) Cannot be unset.

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:21
    • diff --git a/docs/functions/authorizeChannel.html b/docs/functions/authorizeChannel.html index fa666661..323fb9e1 100644 --- a/docs/functions/authorizeChannel.html +++ b/docs/functions/authorizeChannel.html @@ -38,7 +38,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/Wallet/signer.ts:76
    • diff --git a/docs/functions/convertHexToString.html b/docs/functions/convertHexToString.html index 94d9c655..b7069433 100644 --- a/docs/functions/convertHexToString.html +++ b/docs/functions/convertHexToString.html @@ -34,7 +34,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/stringConversion.ts:20
    • diff --git a/docs/functions/convertStringToHex.html b/docs/functions/convertStringToHex.html index 88b826b1..9a6a7466 100644 --- a/docs/functions/convertStringToHex.html +++ b/docs/functions/convertStringToHex.html @@ -30,7 +30,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/stringConversion.ts:8
    • diff --git a/docs/functions/createCrossChainPayment.html b/docs/functions/createCrossChainPayment.html index 5fc6e779..515f934b 100644 --- a/docs/functions/createCrossChainPayment.html +++ b/docs/functions/createCrossChainPayment.html @@ -41,7 +41,7 @@ destination must be the sidechain's door account.

    Returns Payment

    +
  • Defined in packages/xrpl/src/utils/createCrossChainPayment.ts:21
    • diff --git a/docs/functions/decimalToQuality.html b/docs/functions/decimalToQuality.html index c1f72032..efcaa21b 100644 --- a/docs/functions/decimalToQuality.html +++ b/docs/functions/decimalToQuality.html @@ -34,7 +34,7 @@ QualityOut

    Returns number

    +
  • Defined in packages/xrpl/src/utils/quality.ts:79
    • diff --git a/docs/functions/decimalToTransferRate.html b/docs/functions/decimalToTransferRate.html index 393a3c07..d42be0b8 100644 --- a/docs/functions/decimalToTransferRate.html +++ b/docs/functions/decimalToTransferRate.html @@ -33,7 +33,7 @@

    Returns number

    +
  • Defined in packages/xrpl/src/utils/quality.ts:32
    • diff --git a/docs/functions/decode.html b/docs/functions/decode.html index 68d49798..39ad56b3 100644 --- a/docs/functions/decode.html +++ b/docs/functions/decode.html @@ -30,7 +30,7 @@

    Returns Record<string, unknown>

    +
  • Defined in packages/xrpl/src/utils/index.ts:125
    • diff --git a/docs/functions/decodeSeed.html b/docs/functions/decodeSeed.html index 95f71a78..37096df0 100644 --- a/docs/functions/decodeSeed.html +++ b/docs/functions/decodeSeed.html @@ -15,7 +15,7 @@

    Function decodeSeed

      - +

    • Parameters

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

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

    +

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

    • bytes: Buffer
      • diff --git a/docs/functions/decodeXAddress.html b/docs/functions/decodeXAddress.html index 8042c5d8..c4ad569a 100644 --- a/docs/functions/decodeXAddress.html +++ b/docs/functions/decodeXAddress.html @@ -15,14 +15,14 @@

      Function decodeXAddress

        - +

      • Parameters

        • xAddress: string
        -

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

        +

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

        • accountId: Buffer
          • diff --git a/docs/functions/deriveXAddress.html b/docs/functions/deriveXAddress.html index 0fead18a..90c56a39 100644 --- a/docs/functions/deriveXAddress.html +++ b/docs/functions/deriveXAddress.html @@ -15,7 +15,7 @@

          Function deriveXAddress

            - +

          • Derive an X-Address from a public key and a destination tag.

            @@ -25,7 +25,7 @@

            Parameters

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

              Public key and destination tag to encode as an X-Address.

                @@ -43,7 +43,7 @@

        Returns string

      +
    • Defined in packages/xrpl/src/utils/derive.ts:14
    diff --git a/docs/functions/dropsToXrp.html b/docs/functions/dropsToXrp.html index fd33297b..64aa6f0c 100644 --- a/docs/functions/dropsToXrp.html +++ b/docs/functions/dropsToXrp.html @@ -32,7 +32,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/xrpConversion.ts:18
    • diff --git a/docs/functions/encode.html b/docs/functions/encode.html index a865d89b..b02758fd 100644 --- a/docs/functions/encode.html +++ b/docs/functions/encode.html @@ -30,7 +30,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/index.ts:84
    • diff --git a/docs/functions/encodeForMultiSigning.html b/docs/functions/encodeForMultiSigning.html index 59458fcf..80b6eac6 100644 --- a/docs/functions/encodeForMultiSigning.html +++ b/docs/functions/encodeForMultiSigning.html @@ -34,7 +34,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/index.ts:115
    • diff --git a/docs/functions/encodeForSigning.html b/docs/functions/encodeForSigning.html index 4bbd01a5..37e4c79c 100644 --- a/docs/functions/encodeForSigning.html +++ b/docs/functions/encodeForSigning.html @@ -30,7 +30,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/index.ts:94
    • diff --git a/docs/functions/encodeForSigningClaim.html b/docs/functions/encodeForSigningClaim.html index ce2e88dc..da3d6569 100644 --- a/docs/functions/encodeForSigningClaim.html +++ b/docs/functions/encodeForSigningClaim.html @@ -30,7 +30,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/index.ts:104
    • diff --git a/docs/functions/getBalanceChanges.html b/docs/functions/getBalanceChanges.html index b463c6d8..0700958e 100644 --- a/docs/functions/getBalanceChanges.html +++ b/docs/functions/getBalanceChanges.html @@ -15,7 +15,7 @@

    Function getBalanceChanges

      - +

    • Computes the complete list of every balance that changed in the ledger as a result of the given transaction.

      @@ -29,9 +29,9 @@ as a result of the given transaction.

      metadata: TransactionMetadata

      Transaction metadata.

    -

    Returns { account: string; balances: { currency: string; issuer?: string; value: string }[] }[]

    diff --git a/docs/functions/hasNextPage.html b/docs/functions/hasNextPage.html index 1c093cad..8963311e 100644 --- a/docs/functions/hasNextPage.html +++ b/docs/functions/hasNextPage.html @@ -33,7 +33,7 @@ includes a marker field.

    Returns boolean

    +
  • Defined in packages/xrpl/src/utils/index.ts:153
    • diff --git a/docs/functions/isValidAddress.html b/docs/functions/isValidAddress.html index a04a3d40..6bd29f20 100644 --- a/docs/functions/isValidAddress.html +++ b/docs/functions/isValidAddress.html @@ -31,7 +31,7 @@ address.

    Returns boolean

    +
  • Defined in packages/xrpl/src/utils/index.ts:137
    • diff --git a/docs/functions/isValidSecret.html b/docs/functions/isValidSecret.html index c5155e0f..9641c1a9 100644 --- a/docs/functions/isValidSecret.html +++ b/docs/functions/isValidSecret.html @@ -30,7 +30,7 @@

    Returns boolean

    +
  • Defined in packages/xrpl/src/utils/index.ts:69
    • diff --git a/docs/functions/isoTimeToRippleTime.html b/docs/functions/isoTimeToRippleTime.html index b3279b9d..733b9e72 100644 --- a/docs/functions/isoTimeToRippleTime.html +++ b/docs/functions/isoTimeToRippleTime.html @@ -30,7 +30,7 @@

    Returns number

    +
  • Defined in packages/xrpl/src/utils/timeConversion.ts:43
    • diff --git a/docs/functions/keyToRFC1751Mnemonic.html b/docs/functions/keyToRFC1751Mnemonic.html index da5f72d4..df4f9a5d 100644 --- a/docs/functions/keyToRFC1751Mnemonic.html +++ b/docs/functions/keyToRFC1751Mnemonic.html @@ -30,7 +30,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/Wallet/rfc1751.ts:60
    • diff --git a/docs/functions/multisign.html b/docs/functions/multisign.html index 0fb24f65..c02a002f 100644 --- a/docs/functions/multisign.html +++ b/docs/functions/multisign.html @@ -38,7 +38,7 @@ single transaction with all Signers that then gets signed and returned.

    Returns string

    +
  • Defined in packages/xrpl/src/Wallet/signer.ts:30
    • diff --git a/docs/functions/parseAccountRootFlags.html b/docs/functions/parseAccountRootFlags.html index d96aa8dc..083530a2 100644 --- a/docs/functions/parseAccountRootFlags.html +++ b/docs/functions/parseAccountRootFlags.html @@ -30,7 +30,7 @@

    Returns AccountRootFlagsInterface

    +
  • Defined in packages/xrpl/src/models/utils/flags.ts:34
    • diff --git a/docs/functions/parseNFTokenID.html b/docs/functions/parseNFTokenID.html index b7ecc62e..1b57edc7 100644 --- a/docs/functions/parseNFTokenID.html +++ b/docs/functions/parseNFTokenID.html @@ -15,7 +15,7 @@

    Function parseNFTokenID

      - +

    • Parses an NFTokenID into the information it is encoding.

      Example decoding:

      @@ -40,7 +40,7 @@
      nftokenID: string

      A hex string which identifies an NFToken on the ledger.

    -

    Returns { Flags: number; Issuer: string; NFTokenID: string; Sequence: number; Taxon: number; TransferFee: number }

    +

    Returns {
        Flags: number;
        Issuer: string;
        NFTokenID: string;
        Sequence: number;
        Taxon: number;
        TransferFee: number;
    }

    • Flags: number
      • @@ -55,7 +55,7 @@
    • TransferFee: number
    +
  • Defined in packages/xrpl/src/utils/parseNFTokenID.ts:54
    • diff --git a/docs/functions/percentToQuality.html b/docs/functions/percentToQuality.html index ae6d1ddc..ac0b23a0 100644 --- a/docs/functions/percentToQuality.html +++ b/docs/functions/percentToQuality.html @@ -34,7 +34,7 @@ QualityOut

    Returns number

    +
  • Defined in packages/xrpl/src/utils/quality.ts:167
    • diff --git a/docs/functions/percentToTransferRate.html b/docs/functions/percentToTransferRate.html index 955d28a4..91d160e8 100644 --- a/docs/functions/percentToTransferRate.html +++ b/docs/functions/percentToTransferRate.html @@ -33,7 +33,7 @@

    Returns number

    +
  • Defined in packages/xrpl/src/utils/quality.ts:65
    • diff --git a/docs/functions/qualityToDecimal.html b/docs/functions/qualityToDecimal.html index e3d1ccad..427034f7 100644 --- a/docs/functions/qualityToDecimal.html +++ b/docs/functions/qualityToDecimal.html @@ -32,7 +32,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/quality.ts:111
    • diff --git a/docs/functions/rfc1751MnemonicToKey.html b/docs/functions/rfc1751MnemonicToKey.html index 621a21e8..7c36f301 100644 --- a/docs/functions/rfc1751MnemonicToKey.html +++ b/docs/functions/rfc1751MnemonicToKey.html @@ -32,7 +32,7 @@

    Returns Buffer

    +
  • Defined in packages/xrpl/src/Wallet/rfc1751.ts:100
    • diff --git a/docs/functions/rippleTimeToISOTime.html b/docs/functions/rippleTimeToISOTime.html index 0d2da9e4..06785070 100644 --- a/docs/functions/rippleTimeToISOTime.html +++ b/docs/functions/rippleTimeToISOTime.html @@ -30,7 +30,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/timeConversion.ts:32
    • diff --git a/docs/functions/rippleTimeToUnixTime.html b/docs/functions/rippleTimeToUnixTime.html index 28b7d68b..e5c1ad54 100644 --- a/docs/functions/rippleTimeToUnixTime.html +++ b/docs/functions/rippleTimeToUnixTime.html @@ -30,7 +30,7 @@

    Returns number

    +
  • Defined in packages/xrpl/src/utils/timeConversion.ts:10
    • diff --git a/docs/functions/setTransactionFlagsToNumber.html b/docs/functions/setTransactionFlagsToNumber.html index fb1f89f9..c18b1350 100644 --- a/docs/functions/setTransactionFlagsToNumber.html +++ b/docs/functions/setTransactionFlagsToNumber.html @@ -28,7 +28,7 @@

    Returns void

    +
  • Defined in packages/xrpl/src/models/utils/flags.ts:53
    • diff --git a/docs/functions/signPaymentChannelClaim.html b/docs/functions/signPaymentChannelClaim.html index 91a0dfd9..12482e65 100644 --- a/docs/functions/signPaymentChannelClaim.html +++ b/docs/functions/signPaymentChannelClaim.html @@ -38,7 +38,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/signPaymentChannelClaim.ts:15
    • diff --git a/docs/functions/transferRateToDecimal.html b/docs/functions/transferRateToDecimal.html index 9e2ae91a..1d086fe5 100644 --- a/docs/functions/transferRateToDecimal.html +++ b/docs/functions/transferRateToDecimal.html @@ -32,7 +32,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/quality.ts:137
    • diff --git a/docs/functions/unixTimeToRippleTime.html b/docs/functions/unixTimeToRippleTime.html index 6510cc8b..cb7d9e70 100644 --- a/docs/functions/unixTimeToRippleTime.html +++ b/docs/functions/unixTimeToRippleTime.html @@ -30,7 +30,7 @@

    Returns number

    +
  • Defined in packages/xrpl/src/utils/timeConversion.ts:21
    • diff --git a/docs/functions/validate.html b/docs/functions/validate.html index 8402a3fb..106df30f 100644 --- a/docs/functions/validate.html +++ b/docs/functions/validate.html @@ -31,7 +31,7 @@ Encode/decode and individual type validation.

    Returns void

    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:99
    • diff --git a/docs/functions/verifyPaymentChannelClaim.html b/docs/functions/verifyPaymentChannelClaim.html index fa711460..aa5cbd4c 100644 --- a/docs/functions/verifyPaymentChannelClaim.html +++ b/docs/functions/verifyPaymentChannelClaim.html @@ -42,7 +42,7 @@

    Returns boolean

    +
  • Defined in packages/xrpl/src/utils/verifyPaymentChannelClaim.ts:17
    • diff --git a/docs/functions/verifySignature.html b/docs/functions/verifySignature.html index 820a2fad..2c325b08 100644 --- a/docs/functions/verifySignature.html +++ b/docs/functions/verifySignature.html @@ -30,7 +30,7 @@

    Returns boolean

    +
  • Defined in packages/xrpl/src/Wallet/signer.ts:96
    • diff --git a/docs/functions/xAddressToClassicAddress.html b/docs/functions/xAddressToClassicAddress.html index 2b0bbbe4..63148235 100644 --- a/docs/functions/xAddressToClassicAddress.html +++ b/docs/functions/xAddressToClassicAddress.html @@ -15,14 +15,14 @@

    Function xAddressToClassicAddress

      - +

    • Parameters

      • xAddress: string
      -

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

      +

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

      • classicAddress: string
        • diff --git a/docs/functions/xrpToDrops.html b/docs/functions/xrpToDrops.html index 09c355b0..165e51bd 100644 --- a/docs/functions/xrpToDrops.html +++ b/docs/functions/xrpToDrops.html @@ -32,7 +32,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/xrpConversion.ts:64
    • diff --git a/docs/index.html b/docs/index.html index b0c22b9a..0a1ea788 100644 --- a/docs/index.html +++ b/docs/index.html @@ -14,11 +14,119 @@

    xrpl.js

     -

    This package includes the xrpl library. This repository uses a monorepo -layout. Please find the README for xrpl here.

    -

    READMEs for other packages in this monorepo are located at the root of their -package, but since newcomers to XRPL are likely to want to use the xrpl -package this README is at the root of the project.

    +

    A JavaScript/TypeScript library for interacting with the XRP Ledger

    +

    NPM +npm bundle size

    +

    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 for all classes, methods, and utilities.

    + + +

    ➡️ Applications and Projects

    + +

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

    + + +

    Features

    +     +
      +
    • Works in Node.js and in web browsers
      • +
    • Helpers for creating requests and parsing responses for the XRP Ledger APIs
      • +
    • 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. We also support v12 and v16. Other versions may work but are not frequently tested.
      • +
    + + +

    Getting Started

    +     +

    In an existing project (with package.json), install xrpl.js:

    +
    $ npm install --save xrpl
+
    +

    Or with yarn:

    +
    $ yarn add xrpl
+
    +

    Example usage:

    +
    const xrpl = require("xrpl")
    async function main() {
      const client = new xrpl.Client("wss://s.altnet.rippletest.net:51233")
      await client.connect()

      const response = await client.request({
        "command": "account_info",
        "account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
        "ledger_index": "validated"
      })
      console.log(response)

      client.disconnect()
    }
    main()
+
    +

    For more examples, see the documentation.

    + + +

    Using xrpl.js with React Native

    +     +

    If you want to use xrpl.js with React Native you will need to install shims for core NodeJS modules. To help with this you can use a module like rn-nodeify.

    +
      +

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

      +
      npm install react-native-crypto
      npm install xrpl
      # install peer deps
      npm install react-native-randombytes
      # install latest rn-nodeify
      npm install rn-nodeify@latest --dev
+
      +
      2. +

    2. 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
+
      +
      3. +

    3. 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')
+
      +
      4. +

    4. Import shim in your project (it must be the first line):

      +
      5. +
    +
    import './shim'
    ...
+
    + + +

    Using xrpl.js with Deno

    +     +

    Until official support for Deno is added, you can use the following work-around to use xrpl.js with Deno:

    +
    import xrpl from 'https://dev.jspm.io/npm:xrpl';

    (async () => {
      const api = new (xrpl as any).Client('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 xrpl.js 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.

    + + + +

    Report an issue

    +     +

    Experienced an issue? Report it here.

    + + +

    More Information

    +     +
    diff --git a/docs/interfaces/AccountChannelsRequest.html b/docs/interfaces/AccountChannelsRequest.html index b89399ef..baa0df03 100644 --- a/docs/interfaces/AccountChannelsRequest.html +++ b/docs/interfaces/AccountChannelsRequest.html @@ -27,7 +27,7 @@ the ledger. Returns an AccountChannelsRes
    • AccountChannelsRequest
     +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:29
    • @@ -36,14 +36,14 @@ the ledger. Returns an AccountChannelsRes

    Properties

    account -api_version +api_version? command -destination_account -id -ledger_hash -ledger_index -limit -marker +destination_account? +id? +ledger_hash? +ledger_index? +limit? +marker?

    Properties

    @@ -54,7 +54,7 @@ the ledger. Returns an AccountChannelsRes request returns channels where this account is the channel's owner/source.

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:36

    • Optional api_version

    api_version?: number
    @@ -62,13 +62,13 @@ request returns channels where this account is the channel's owner/source.
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • command

    command: "account_channels"
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:30

    • Optional destination_account

    destination_account?: string
    @@ -77,7 +77,7 @@ provided, filter results to payment channels whose destination is this account.

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:42

    • Optional id

    id?: string | number
    @@ -87,14 +87,14 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • Optional ledger_hash

    ledger_hash?: string

    20-byte hex string for the ledger version to use.

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:44

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -102,7 +102,7 @@ know which request prompted which response.

    ledger automatically.

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:49

    • Optional limit

    limit?: number
    @@ -110,7 +110,7 @@ ledger automatically.

    more than 400. The default is 200.

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:54

    • Optional marker

    marker?: unknown
    @@ -118,7 +118,7 @@ more than 400. The default is 200.

    that response left off.

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:59
    • @@ -146,14 +146,14 @@ that response left off.

  • AccountChannelsRequest
    • +
  • destination_account?
    • +
  • id?
    • +
  • ledger_hash?
    • +
  • ledger_index?
    • +
  • limit?
    • +
  • marker?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountChannelsResponse.html b/docs/interfaces/AccountChannelsResponse.html index d1a2fa11..289a5211 100644 --- a/docs/interfaces/AccountChannelsResponse.html +++ b/docs/interfaces/AccountChannelsResponse.html @@ -23,7 +23,7 @@
    • AccountChannelsResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:67
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

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

    Type declaration

      @@ -102,31 +102,31 @@ version. Otherwise, the information is subject to change.

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:68

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -153,14 +153,14 @@ version. Otherwise, the information is subject to change.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountCurrenciesRequest.html b/docs/interfaces/AccountCurrenciesRequest.html index 850a2f00..2c1e0ade 100644 --- a/docs/interfaces/AccountCurrenciesRequest.html +++ b/docs/interfaces/AccountCurrenciesRequest.html @@ -25,7 +25,7 @@ account can send or receive, based on its trust lines. Expects an
    • AccountCurrenciesRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:12
    • @@ -34,12 +34,12 @@ account can send or receive, based on its trust lines. Expects an

    Properties

    account -api_version +api_version? command -id -ledger_hash -ledger_index -strict +id? +ledger_hash? +ledger_index? +strict?

    Properties

    @@ -49,7 +49,7 @@ account can send or receive, based on its trust lines. Expects an

    A unique identifier for the account, most commonly the account's address.

    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:15

    • Optional api_version

    api_version?: number
    @@ -57,13 +57,13 @@ account can send or receive, based on its trust lines. Expects an
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • command

    command: "account_currencies"
    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:13

    • Optional id

    id?: string | number
    @@ -73,14 +73,14 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:17

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -88,7 +88,7 @@ know which request prompted which response.

    ledger automatically.

    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:22

    • Optional strict

    strict?: boolean
    @@ -97,7 +97,7 @@ address. Otherwise, account can be a secret or passphrase (not recommended). The default is false.

    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:28
    • @@ -125,12 +125,12 @@ recommended). The default is false.

  • AccountCurrenciesRequest
    • +
  • id?
    • +
  • ledger_hash?
    • +
  • ledger_index?
    • +
  • strict?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountCurrenciesResponse.html b/docs/interfaces/AccountCurrenciesResponse.html index 2f678041..e8cc290c 100644 --- a/docs/interfaces/AccountCurrenciesResponse.html +++ b/docs/interfaces/AccountCurrenciesResponse.html @@ -23,7 +23,7 @@
    • AccountCurrenciesResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:36
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

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

    Type declaration

      @@ -89,31 +89,31 @@ as hex.

    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:37

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -140,14 +140,14 @@ as hex.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountDelete.html b/docs/interfaces/AccountDelete.html index 5c5b3fce..8c28ed9d 100644 --- a/docs/interfaces/AccountDelete.html +++ b/docs/interfaces/AccountDelete.html @@ -25,7 +25,7 @@ specified destination account.

    • AccountDelete
    +
  • Defined in packages/xrpl/src/models/transactions/accountDelete.ts:12
    • @@ -34,20 +34,20 @@ specified destination account.

    Properties

    Account -AccountTxnID +AccountTxnID? Destination -DestinationTag -Fee -Flags -LastLedgerSequence -Memos -Sequence -Signers -SigningPubKey -SourceTag -TicketSequence +DestinationTag? +Fee? +Flags? +LastLedgerSequence? +Memos? +Sequence? +Signers? +SigningPubKey? +SourceTag? +TicketSequence? TransactionType -TxnSignature +TxnSignature?

    Properties

    @@ -58,7 +58,7 @@ specified destination account.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -68,7 +68,7 @@ the provided hash.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Destination

    Destination: string
    @@ -77,7 +77,7 @@ sending account. Must be a funded account in the ledger, and must not be. the sending account.

    +
  • Defined in packages/xrpl/src/models/transactions/accountDelete.ts:19

    • Optional DestinationTag

    DestinationTag?: number
    @@ -85,7 +85,7 @@ the sending account.

    information for the recipient of the deleted account's leftover XRP.

    +
  • Defined in packages/xrpl/src/models/transactions/accountDelete.ts:24

    • Optional Fee

    Fee?: string
    @@ -95,7 +95,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:108

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -103,7 +103,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:123

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -113,7 +113,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:129

    • Optional Memos

    Memos?: Memo[]
    @@ -121,7 +121,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:133

    • Optional Sequence

    Sequence?: number
    @@ -132,7 +132,7 @@ is using a Ticket instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:115

    • Optional Signers

    Signers?: Signer[]
    @@ -141,7 +141,7 @@ transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:138

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -151,7 +151,7 @@ multi-signature is present in the Signers field instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:151

    • Optional SourceTag

    SourceTag?: number
    @@ -162,7 +162,7 @@ DestinationTag.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:145

    • Optional TicketSequence

    TicketSequence?: number
    @@ -171,13 +171,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:156

    • TransactionType

    TransactionType: "AccountDelete"
    +
  • Defined in packages/xrpl/src/models/transactions/accountDelete.ts:13

    • Optional TxnSignature

    TxnSignature?: string
    @@ -186,7 +186,7 @@ account it says it is from.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • @@ -214,20 +214,20 @@ account it says it is from.

  • AccountDelete
    • +
  • TxnSignature?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountInfoRequest.html b/docs/interfaces/AccountInfoRequest.html index 80a889e8..5829b38d 100644 --- a/docs/interfaces/AccountInfoRequest.html +++ b/docs/interfaces/AccountInfoRequest.html @@ -25,7 +25,7 @@ particular version of the ledger. Returns an
    • AccountInfoRequest
     +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:13
    • @@ -34,14 +34,14 @@ particular version of the ledger. Returns an

    Properties

    account -api_version +api_version? command -id -ledger_hash -ledger_index -queue -signer_lists -strict +id? +ledger_hash? +ledger_index? +queue? +signer_lists? +strict?

    Properties

    @@ -51,7 +51,7 @@ particular version of the ledger. Returns an

    A unique identifier for the account, most commonly the account's address.

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:16

    • Optional api_version

    api_version?: number
    @@ -59,13 +59,13 @@ particular version of the ledger. Returns an
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • command

    command: "account_info"
    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:14

    • Optional id

    id?: string | number
    @@ -75,14 +75,14 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:18

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -90,7 +90,7 @@ know which request prompted which response.

    ledger automatically.

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:23

    • Optional queue

    queue?: boolean
    @@ -99,14 +99,14 @@ used when querying for the data from the current open ledger. Not available from servers in Reporting Mode.

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:29

    • Optional signer_lists

    signer_lists?: boolean

    Request SignerList objects associated with this account.

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:33

    • Optional strict

    strict?: boolean
    @@ -115,7 +115,7 @@ address. Otherwise, account can be a secret or passphrase (not recommended). The default is false.

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:39
    • @@ -143,14 +143,14 @@ recommended). The default is false.

  • AccountInfoRequest
    • +
  • id?
    • +
  • ledger_hash?
    • +
  • ledger_index?
    • +
  • queue?
    • +
  • signer_lists?
    • +
  • strict?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountInfoResponse.html b/docs/interfaces/AccountInfoResponse.html index 0da6680d..2ae02887 100644 --- a/docs/interfaces/AccountInfoResponse.html +++ b/docs/interfaces/AccountInfoResponse.html @@ -23,7 +23,7 @@
    • AccountInfoResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:89
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

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

    Type declaration

      @@ -103,31 +103,31 @@ to false, this data is not final.

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:90

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -154,14 +154,14 @@ to false, this data is not final.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountLinesRequest.html b/docs/interfaces/AccountLinesRequest.html index 2fa689b5..137f30f5 100644 --- a/docs/interfaces/AccountLinesRequest.html +++ b/docs/interfaces/AccountLinesRequest.html @@ -26,7 +26,7 @@ retrieved is relative to a particular version of the ledger. Expects an
    • AccountLinesRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:77
    • @@ -35,14 +35,14 @@ retrieved is relative to a particular version of the ledger. Expects an

    Properties

    account -api_version +api_version? command -id -ledger_hash -ledger_index -limit -marker -peer +id? +ledger_hash? +ledger_index? +limit? +marker? +peer?

    Properties

    @@ -52,7 +52,7 @@ retrieved is relative to a particular version of the ledger. Expects an

    A unique identifier for the account, most commonly the account's Address.

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:80

    • Optional api_version

    api_version?: number
    @@ -60,13 +60,13 @@ retrieved is relative to a particular version of the ledger. Expects an
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • command

    command: "account_lines"
    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:78

    • Optional id

    id?: string | number
    @@ -76,14 +76,14 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:82

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -91,7 +91,7 @@ know which request prompted which response.

    ledger automatically.

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:87

    • Optional limit

    limit?: number
    @@ -99,7 +99,7 @@ ledger automatically.

    honor this value. Must be within the inclusive range 10 to 400.

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:97

    • Optional marker

    marker?: unknown
    @@ -107,7 +107,7 @@ honor this value. Must be within the inclusive range 10 to 400.

    that response left off.

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:102

    • Optional peer

    peer?: string
    @@ -115,7 +115,7 @@ that response left off.

    connecting the two accounts.

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:92
    • @@ -143,14 +143,14 @@ connecting the two accounts.

  • AccountLinesRequest
    • +
  • id?
    • +
  • ledger_hash?
    • +
  • ledger_index?
    • +
  • limit?
    • +
  • marker?
    • +
  • peer?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountLinesResponse.html b/docs/interfaces/AccountLinesResponse.html index 86b2d062..394d3aec 100644 --- a/docs/interfaces/AccountLinesResponse.html +++ b/docs/interfaces/AccountLinesResponse.html @@ -23,7 +23,7 @@
    • AccountLinesResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:110
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

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

    Type declaration

      @@ -99,31 +99,31 @@ No additional pages after this one.

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:111

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -150,14 +150,14 @@ No additional pages after this one.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountNFTsRequest.html b/docs/interfaces/AccountNFTsRequest.html index a51d5f3d..908d627b 100644 --- a/docs/interfaces/AccountNFTsRequest.html +++ b/docs/interfaces/AccountNFTsRequest.html @@ -24,7 +24,7 @@ specified account.

    • AccountNFTsRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:9
    • @@ -33,11 +33,11 @@ specified account.

    Properties

    account -api_version +api_version? command -id -limit -marker +id? +limit? +marker?

    Properties

    @@ -48,7 +48,7 @@ specified account.

    request returns NFTs owned by this account.

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:15

    • Optional api_version

    api_version?: number
    @@ -56,13 +56,13 @@ request returns NFTs owned by this account.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • command

    command: "account_nfts"
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:10

    • Optional id

    id?: string | number
    @@ -72,14 +72,14 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • Optional limit

    limit?: number

    Limit the number of NFTokens to retrieve.

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:19

    • Optional marker

    marker?: unknown
    @@ -87,7 +87,7 @@ know which request prompted which response.

    that response left off.

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:24
    • @@ -115,11 +115,11 @@ that response left off.

  • AccountNFTsRequest
    • +
  • id?
    • +
  • limit?
    • +
  • marker?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountNFTsResponse.html b/docs/interfaces/AccountNFTsResponse.html index ef380e83..1370ff81 100644 --- a/docs/interfaces/AccountNFTsResponse.html +++ b/docs/interfaces/AccountNFTsResponse.html @@ -23,7 +23,7 @@
    • AccountNFTsResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:46
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

    -
    result: { account: string; account_nfts: AccountNFToken[]; ledger_current_index: number; limit?: number; marker?: unknown; validated: boolean }
    +
    result: {
        account: string;
        account_nfts: AccountNFToken[];
        ledger_current_index: number;
        limit?: number;
        marker?: unknown;
        validated: boolean;
    }

    Type declaration

      @@ -95,31 +95,31 @@ No additional pages after this one.

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:47

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -146,14 +146,14 @@ No additional pages after this one.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountObjectsRequest.html b/docs/interfaces/AccountObjectsRequest.html index 0892d8e4..3d50f519 100644 --- a/docs/interfaces/AccountObjectsRequest.html +++ b/docs/interfaces/AccountObjectsRequest.html @@ -26,7 +26,7 @@ form of an AccountObjectsResponse.

    • AccountObjectsRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:23
    • @@ -35,15 +35,15 @@ form of an AccountObjectsResponse.

    Properties

    account -api_version +api_version? command -deletion_blockers_only -id -ledger_hash -ledger_index -limit -marker -type +deletion_blockers_only? +id? +ledger_hash? +ledger_index? +limit? +marker? +type?

    Properties

    @@ -53,7 +53,7 @@ form of an AccountObjectsResponse.

    A unique identifier for the account, most commonly the account's address.

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:26

    • Optional api_version

    api_version?: number
    @@ -61,13 +61,13 @@ form of an AccountObjectsResponse.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • command

    command: "account_objects"
    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:24

    • Optional deletion_blockers_only

    deletion_blockers_only?: boolean
    @@ -75,7 +75,7 @@ form of an AccountObjectsResponse.

    from being deleted. The default is false.

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:37

    • Optional id

    id?: string | number
    @@ -85,14 +85,14 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:39

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -100,7 +100,7 @@ know which request prompted which response.

    Ledger automatically.

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:44

    • Optional limit

    limit?: number
    @@ -108,7 +108,7 @@ Ledger automatically.

    the inclusive range 10 to 400 on non-admin connections. The default is 200.

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:49

    • Optional marker

    marker?: unknown
    @@ -116,7 +116,7 @@ the inclusive range 10 to 400 on non-admin connections. The default is 200.

    that response left off.

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:54

    • Optional type

    type?: AccountObjectType
    @@ -125,7 +125,7 @@ The valid types are: Check , DepositPreauth, Escrow, Offer, PayChannel, SignerList, Ticket, and RippleState (trust line).

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:32
    • @@ -153,15 +153,15 @@ SignerList, Ticket, and RippleState (trust line).

  • AccountObjectsRequest
    • +
  • deletion_blockers_only?
    • +
  • id?
    • +
  • ledger_hash?
    • +
  • ledger_index?
    • +
  • limit?
    • +
  • marker?
    • +
  • type?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountObjectsResponse.html b/docs/interfaces/AccountObjectsResponse.html index beff546b..7fc3ddda 100644 --- a/docs/interfaces/AccountObjectsResponse.html +++ b/docs/interfaces/AccountObjectsResponse.html @@ -23,7 +23,7 @@
    • AccountObjectsResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:76
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

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

    Type declaration

      @@ -108,31 +108,31 @@ change.

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:77

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -159,14 +159,14 @@ change.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountOffer.html b/docs/interfaces/AccountOffer.html index 4a7c46ce..a1d7fa8f 100644 --- a/docs/interfaces/AccountOffer.html +++ b/docs/interfaces/AccountOffer.html @@ -18,7 +18,7 @@
    • AccountOffer
    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:41
    • @@ -26,7 +26,7 @@

    Properties

    -
    expiration +
    expiration? flags quality seq @@ -42,14 +42,14 @@ seconds since the Ripple Epoch. See also: Offer Expiration.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:65

    • flags

    flags: number

    Options set for this offer entry as bit-flags.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:43

    • quality

    quality: string
    @@ -59,28 +59,28 @@ the most favorable (lowest) quality is consumed first; offers with the same quality are executed from oldest to newest.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:60

    • seq

    seq: number

    Sequence number of the transaction that created this entry.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:45

    • taker_gets

    taker_gets: Amount

    The amount the account placing this Offer receives.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:49

    • taker_pays

    taker_pays: Amount

    The amount the account placing this Offer pays.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:53
    • @@ -107,7 +107,7 @@ quality are executed from oldest to newest.

    • AccountOffer
        -
      • expiration
        • +
      • expiration?
      • flags
      • quality
      • seq
        • diff --git a/docs/interfaces/AccountOffersRequest.html b/docs/interfaces/AccountOffersRequest.html index 5d765f83..f4512709 100644 --- a/docs/interfaces/AccountOffersRequest.html +++ b/docs/interfaces/AccountOffersRequest.html @@ -25,7 +25,7 @@ the form of a AccountOffersResponse.

      • AccountOffersRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:12
    • @@ -34,14 +34,14 @@ the form of a AccountOffersResponse.

    Properties

    account -api_version +api_version? command -id -ledger_hash -ledger_index -limit -marker -strict +id? +ledger_hash? +ledger_index? +limit? +marker? +strict?

    Properties

    @@ -51,7 +51,7 @@ the form of a AccountOffersResponse.

    A unique identifier for the account, most commonly the account's Address.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:15

    • Optional api_version

    api_version?: number
    @@ -59,13 +59,13 @@ the form of a AccountOffersResponse.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • command

    command: "account_offers"
    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:13

    • Optional id

    id?: string | number
    @@ -75,14 +75,14 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string identifying the ledger version to use.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:17

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -90,7 +90,7 @@ know which request prompted which response.

    "validated" to select a ledger dynamically.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:22

    • Optional limit

    limit?: number
    @@ -98,7 +98,7 @@ know which request prompted which response.

    to honor this value. Must be within the inclusive range 10 to 400.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:27

    • Optional marker

    marker?: unknown
    @@ -106,7 +106,7 @@ to honor this value. Must be within the inclusive range 10 to 400.

    that response left off.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:32

    • Optional strict

    strict?: boolean
    @@ -115,7 +115,7 @@ address. Otherwise, account can be a secret or passphrase (not recommended). The default is false.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:38
    • @@ -143,14 +143,14 @@ recommended). The default is false.

  • AccountOffersRequest
    • +
  • id?
    • +
  • ledger_hash?
    • +
  • ledger_index?
    • +
  • limit?
    • +
  • marker?
    • +
  • strict?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountOffersResponse.html b/docs/interfaces/AccountOffersResponse.html index d233c097..e4518b6c 100644 --- a/docs/interfaces/AccountOffersResponse.html +++ b/docs/interfaces/AccountOffersResponse.html @@ -23,7 +23,7 @@
    • AccountOffersResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:73
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

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

    Type declaration

      @@ -99,31 +99,31 @@ number of offers is large, only returns up to limit at a time.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:74

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -150,14 +150,14 @@ number of offers is large, only returns up to limit at a time.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountSet.html b/docs/interfaces/AccountSet.html index 1563b4e3..62d33eb3 100644 --- a/docs/interfaces/AccountSet.html +++ b/docs/interfaces/AccountSet.html @@ -24,7 +24,7 @@ Ledger.

    • AccountSet
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:114
    • @@ -33,26 +33,26 @@ Ledger.

    Properties

    Account -AccountTxnID -ClearFlag -Domain -EmailHash -Fee -Flags -LastLedgerSequence -Memos -MessageKey -NFTokenMinter -Sequence -SetFlag -Signers -SigningPubKey -SourceTag -TickSize -TicketSequence +AccountTxnID? +ClearFlag? +Domain? +EmailHash? +Fee? +Flags? +LastLedgerSequence? +Memos? +MessageKey? +NFTokenMinter? +Sequence? +SetFlag? +Signers? +SigningPubKey? +SourceTag? +TickSize? +TicketSequence? TransactionType -TransferRate -TxnSignature +TransferRate? +TxnSignature?

    Properties

    @@ -63,7 +63,7 @@ Ledger.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -73,14 +73,14 @@ the provided hash.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional ClearFlag

    ClearFlag?: number

    Unique identifier of a flag to disable for this account.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:118

    • Optional Domain

    Domain?: string
    @@ -88,14 +88,14 @@ the provided hash.

    ASCII for the domain in lowercase.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:123

    • Optional EmailHash

    EmailHash?: string

    Hash of an email address to be used for generating an avatar image.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:125

    • Optional Fee

    Fee?: string
    @@ -105,13 +105,13 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:108

    • Optional Flags

    Flags?: number | AccountSetFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:116

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -121,7 +121,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:129

    • Optional Memos

    Memos?: Memo[]
    @@ -129,14 +129,14 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:133

    • Optional MessageKey

    MessageKey?: string

    Public key for sending encrypted messages to this account.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:127

    • Optional NFTokenMinter

    NFTokenMinter?: string
    @@ -144,7 +144,7 @@ validated or rejected.

    account's behalf using NFTokenMint's Issuer field.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:146

    • Optional Sequence

    Sequence?: number
    @@ -155,14 +155,14 @@ is using a Ticket instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:115

    • Optional SetFlag

    SetFlag?: AccountSetAsfFlags

    Integer flag to enable for this account.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:129

    • Optional Signers

    Signers?: Signer[]
    @@ -171,7 +171,7 @@ transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:138

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -181,7 +181,7 @@ multi-signature is present in the Signers field instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:151

    • Optional SourceTag

    SourceTag?: number
    @@ -192,7 +192,7 @@ DestinationTag.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:145

    • Optional TickSize

    TickSize?: number
    @@ -201,7 +201,7 @@ The exchange rates of those offers is rounded to this many significant digits. Valid values are 3 to 15 inclusive, or 0 to disable.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:141

    • Optional TicketSequence

    TicketSequence?: number
    @@ -210,13 +210,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:156

    • TransactionType

    TransactionType: "AccountSet"
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:115

    • Optional TransferRate

    TransferRate?: number
    @@ -225,7 +225,7 @@ represented as billionths of a unit. Cannot be more than 2000000000 or less than 1000000000, except for the special case 0 meaning no fee.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:135

    • Optional TxnSignature

    TxnSignature?: string
    @@ -234,7 +234,7 @@ account it says it is from.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • @@ -262,26 +262,26 @@ account it says it is from.

  • AccountSet
    • +
  • TransferRate?
    • +
  • TxnSignature?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountSetFlagsInterface.html b/docs/interfaces/AccountSetFlagsInterface.html index 380979e0..d555cea1 100644 --- a/docs/interfaces/AccountSetFlagsInterface.html +++ b/docs/interfaces/AccountSetFlagsInterface.html @@ -17,7 +17,7 @@

    Map of flags to boolean values representing AccountSet transaction flags.

    -

    Example

     const accountSetTx: AccountSet = {
       TransactionType: 'AccountSet',
       Account: 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn',
       Flags: {
         tfOptionalDestTag: true,
         tfRequireAuth: true
       },
     }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(accountSetTx)
    console.log(autofilledTx)
    // {
    //  TransactionType: 'AccountSet',
    //  Account: 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn',
    //  Flags: 393216,
    //  Sequence: 1,
    //  Fee: '12',
    //  LastLedgerSequence: 21971793
    // }
+
    Example
     const accountSetTx: AccountSet = {
       TransactionType: 'AccountSet',
       Account: 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn',
       Flags: {
         tfOptionalDestTag: true,
         tfRequireAuth: true
       },
     }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(accountSetTx)
    console.log(autofilledTx)
    // {
    //  TransactionType: 'AccountSet',
    //  Account: 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn',
    //  Flags: 393216,
    //  Sequence: 1,
    //  Fee: '12',
    //  LastLedgerSequence: 21971793
    // }
    @@ -25,7 +25,7 @@ flags.

    • AccountSetFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:99
    • @@ -33,12 +33,12 @@ flags.

    Properties

    -
    tfAllowXRP -tfDisallowXRP -tfOptionalAuth -tfOptionalDestTag -tfRequireAuth -tfRequireDestTag +
    tfAllowXRP? +tfDisallowXRP? +tfOptionalAuth? +tfOptionalDestTag? +tfRequireAuth? +tfRequireDestTag?

    Properties

    @@ -46,32 +46,32 @@ flags.

    Optional tfAllowXRP

    tfAllowXRP?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:105

    • Optional tfDisallowXRP

    tfDisallowXRP?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:104

    • Optional tfOptionalAuth

    tfOptionalAuth?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:103

    • Optional tfOptionalDestTag

    tfOptionalDestTag?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:101

    • Optional tfRequireAuth

    tfRequireAuth?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:102

    • Optional tfRequireDestTag

    tfRequireDestTag?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:100
    • @@ -98,12 +98,12 @@ flags.

    +
  • tfAllowXRP?
    • +
  • tfDisallowXRP?
    • +
  • tfOptionalAuth?
    • +
  • tfOptionalDestTag?
    • +
  • tfRequireAuth?
    • +
  • tfRequireDestTag?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountTxRequest.html b/docs/interfaces/AccountTxRequest.html index 5a0bf5f8..dbdd187e 100644 --- a/docs/interfaces/AccountTxRequest.html +++ b/docs/interfaces/AccountTxRequest.html @@ -24,7 +24,7 @@ specified account. Expects a response in the form of a
  • AccountTxRequest
    •  +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:13
    • @@ -33,17 +33,17 @@ specified account. Expects a response in the form of a

    Properties

    account -api_version -binary +api_version? +binary? command -forward -id -ledger_hash -ledger_index -ledger_index_max -ledger_index_min -limit -marker +forward? +id? +ledger_hash? +ledger_index? +ledger_index_max? +ledger_index_min? +limit? +marker?

    Properties

    @@ -53,7 +53,7 @@ specified account. Expects a response in the form of a

    A unique identifier for the account, most commonly the account's address.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:16

    • Optional api_version

    api_version?: number
    @@ -61,7 +61,7 @@ specified account. Expects a response in the form of a

    Inherited from BaseRequest.api_version

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • Optional binary

    binary?: boolean
    @@ -69,13 +69,13 @@ specified account. Expects a response in the form of a
    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:37

    • command

    command: "account_tx"
    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:14

    • Optional forward

    forward?: boolean
    @@ -83,7 +83,7 @@ false.

    the results are indexed with the newest ledger first.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:42

    • Optional id

    id?: string | number
    @@ -93,21 +93,21 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • Optional ledger_hash

    ledger_hash?: string

    Use to look for transactions from a single ledger only.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:30

    • Optional ledger_index

    ledger_index?: LedgerIndex

    Use to look for transactions from a single ledger only.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:32

    • Optional ledger_index_max

    ledger_index_max?: number
    @@ -116,7 +116,7 @@ value of -1 instructs the server to use the most recent validated ledger version available.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:28

    • Optional ledger_index_min

    ledger_index_min?: number
    @@ -125,7 +125,7 @@ of -1 instructs the server to use the earliest validated ledger version available.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:22

    • Optional limit

    limit?: number
    @@ -133,7 +133,7 @@ available.

    is not required to honor this value.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:47

    • Optional marker

    marker?: unknown
    @@ -142,7 +142,7 @@ that response left off. This value is stable even if there is a change in the server's range of available ledgers.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:53
    • @@ -170,17 +170,17 @@ the server's range of available ledgers.

  • AccountTxRequest
    • +
  • forward?
    • +
  • id?
    • +
  • ledger_hash?
    • +
  • ledger_index?
    • +
  • ledger_index_max?
    • +
  • ledger_index_min?
    • +
  • limit?
    • +
  • marker?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/AccountTxResponse.html b/docs/interfaces/AccountTxResponse.html index 4f8b85f2..0b659a58 100644 --- a/docs/interfaces/AccountTxResponse.html +++ b/docs/interfaces/AccountTxResponse.html @@ -23,7 +23,7 @@
    • AccountTxResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:80
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

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

    Type declaration

      @@ -102,31 +102,31 @@ change.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:81

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -153,14 +153,14 @@ change.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/BookOffer.html b/docs/interfaces/BookOffer.html index 1e8b21a9..d67b54ca 100644 --- a/docs/interfaces/BookOffer.html +++ b/docs/interfaces/BookOffer.html @@ -20,7 +20,7 @@
    • BookOffer
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:51
    • @@ -31,7 +31,7 @@
    Account BookDirectory BookNode -Expiration +Expiration? Flags LedgerEntryType OwnerNode @@ -41,10 +41,10 @@ TakerGets TakerPays index -owner_funds -quality -taker_gets_funded -taker_pays_funded +owner_funds? +quality? +taker_gets_funded? +taker_pays_funded?

    Properties

    @@ -55,7 +55,7 @@
    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:10

    • BookDirectory

    BookDirectory: string
    @@ -63,7 +63,7 @@
    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:24

    • BookNode

    BookNode: string
    @@ -72,7 +72,7 @@ in case the directory consists of multiple pages.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:29

    • Optional Expiration

    Expiration?: number
    @@ -80,7 +80,7 @@ in case the directory consists of multiple pages.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:46

    • Flags

    Flags: number
    @@ -88,13 +88,13 @@ in case the directory consists of multiple pages.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:8

    • LedgerEntryType

    LedgerEntryType: "Offer"
    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:6

    • OwnerNode

    OwnerNode: string
    @@ -103,7 +103,7 @@ in case the directory consists of multiple pages.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:34

    • PreviousTxnID

    PreviousTxnID: string
    @@ -112,7 +112,7 @@ object.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:39

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -121,7 +121,7 @@ modified this object.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:44

    • Sequence

    Sequence: number
    @@ -130,7 +130,7 @@ object. Used in combination with the Account to identify this Offer.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:15

    • TakerGets

    TakerGets: Amount
    @@ -139,7 +139,7 @@ creator.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:22

    • TakerPays

    TakerPays: Amount
    @@ -147,13 +147,13 @@ creator.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:17

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2

    • Optional owner_funds

    owner_funds?: string
    @@ -163,7 +163,7 @@ represented as a decimal value.) If a trader has multiple offers in the same book, only the highest-ranked offer includes this field.

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:58

    • Optional quality

    quality?: string
    @@ -172,7 +172,7 @@ fairness, offers that have the same quality are automatically taken first-in, first-out.

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:74

    • Optional taker_gets_funded

    taker_gets_funded?: Amount
    @@ -180,7 +180,7 @@ first-in, first-out.

    status of the offer.

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:63

    • Optional taker_pays_funded

    taker_pays_funded?: Amount
    @@ -188,7 +188,7 @@ status of the offer.

    status of the offer.

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:68
    • @@ -218,7 +218,7 @@ status of the offer.

  • Account
  • BookDirectory
  • BookNode
    • -
  • Expiration
    • +
  • Expiration?
  • Flags
  • LedgerEntryType
  • OwnerNode
    • @@ -228,10 +228,10 @@ status of the offer.

  • TakerGets
  • TakerPays
  • index
    • -
  • owner_funds
    • -
  • quality
    • -
  • taker_gets_funded
    • -
  • taker_pays_funded
    • +
  • owner_funds?
    • +
  • quality?
    • +
  • taker_gets_funded?
    • +
  • taker_pays_funded?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/BookOffersRequest.html b/docs/interfaces/BookOffersRequest.html index d84d98a4..e24485c1 100644 --- a/docs/interfaces/BookOffersRequest.html +++ b/docs/interfaces/BookOffersRequest.html @@ -24,7 +24,7 @@ Book, between two currencies. Returns an BookO
    • BookOffersRequest
     +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:17
    • @@ -32,13 +32,13 @@ Book, between two currencies. Returns an BookO

    Properties

    -
    api_version +
    api_version? command -id -ledger_hash -ledger_index -limit -taker +id? +ledger_hash? +ledger_index? +limit? +taker? taker_gets taker_pays
    @@ -51,13 +51,13 @@ Book, between two currencies. Returns an BookO +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • command

    command: "book_offers"
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:18

    • Optional id

    id?: string | number
    @@ -67,14 +67,14 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:20

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -82,7 +82,7 @@ know which request prompted which response.

    ledger automatically.

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:25

    • Optional limit

    limit?: number
    @@ -91,7 +91,7 @@ results. The total number of results returned may be fewer than the limit, because the server omits unfunded offers.

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:31

    • Optional taker

    taker?: string
    @@ -99,7 +99,7 @@ because the server omits unfunded offers.

    by this account are always included in the response.

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:36

    • taker_gets

    taker_gets: TakerAmount
    @@ -108,7 +108,7 @@ receive, as an object with currency and issuer fields (omit issuer for XRP), like currency amounts.

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:42

    • taker_pays

    taker_pays: TakerAmount
    @@ -117,7 +117,7 @@ an object with currency and issuer fields (omit issuer for XRP), like currency amounts.

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:48
    • @@ -144,13 +144,13 @@ currency amounts.

    diff --git a/docs/interfaces/BookOffersResponse.html b/docs/interfaces/BookOffersResponse.html index f403130b..c97a26c5 100644 --- a/docs/interfaces/BookOffersResponse.html +++ b/docs/interfaces/BookOffersResponse.html @@ -23,7 +23,7 @@
    • BookOffersResponse
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:82
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

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

    Type declaration

      @@ -89,31 +89,31 @@ this data, as requested.

      Optional validated?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:83

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -140,14 +140,14 @@ this data, as requested.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ChannelVerifyRequest.html b/docs/interfaces/ChannelVerifyRequest.html index c86986aa..7ff8bd94 100644 --- a/docs/interfaces/ChannelVerifyRequest.html +++ b/docs/interfaces/ChannelVerifyRequest.html @@ -25,7 +25,7 @@ response in the form of a ChannelVerifyResp
    • ChannelVerifyRequest
     +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:10
    • @@ -34,10 +34,10 @@ response in the form of a ChannelVerifyResp

    Properties

    amount -api_version +api_version? channel_id command -id +id? public_key signature
    @@ -49,7 +49,7 @@ response in the form of a ChannelVerifyResp

    The amount of XRP, in drops, the provided signature authorizes.

     +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:13

    • Optional api_version

    api_version?: number
    @@ -57,7 +57,7 @@ response in the form of a ChannelVerifyResp
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • channel_id

    channel_id: string
    @@ -65,13 +65,13 @@ response in the form of a ChannelVerifyResp 64-character hexadecimal string.

    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:18

    • command

    command: "channel_verify"
    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:11

    • Optional id

    id?: string | number
    @@ -81,7 +81,7 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • public_key

    public_key: string
    @@ -89,14 +89,14 @@ know which request prompted which response.

    signature, in hexadecimal or the XRP Ledger's base58 format.

    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:23

    • signature

    signature: string

    The signature to verify, in hexadecimal.

    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:25
    • @@ -124,10 +124,10 @@ signature, in hexadecimal or the XRP Ledger's base58 format.

  • ChannelVerifyRequest
    • diff --git a/docs/interfaces/ChannelVerifyResponse.html b/docs/interfaces/ChannelVerifyResponse.html index 5940c912..4ee324dc 100644 --- a/docs/interfaces/ChannelVerifyResponse.html +++ b/docs/interfaces/ChannelVerifyResponse.html @@ -23,7 +23,7 @@
    • ChannelVerifyResponse
    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:33
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

    -
    result: { signature_verified: boolean }
    +
    result: {
        signature_verified: boolean;
    }

    Type declaration

      @@ -73,31 +73,31 @@ public key.

    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:34

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -124,14 +124,14 @@ public key.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/CheckCancel.html b/docs/interfaces/CheckCancel.html index c098cedf..d4e65a89 100644 --- a/docs/interfaces/CheckCancel.html +++ b/docs/interfaces/CheckCancel.html @@ -26,7 +26,7 @@ cancel it.

    • CheckCancel
    +
  • Defined in packages/xrpl/src/models/transactions/checkCancel.ts:13
    • @@ -35,19 +35,19 @@ cancel it.

    Properties

    Account -AccountTxnID +AccountTxnID? CheckID -Fee -Flags -LastLedgerSequence -Memos -Sequence -Signers -SigningPubKey -SourceTag -TicketSequence +Fee? +Flags? +LastLedgerSequence? +Memos? +Sequence? +Signers? +SigningPubKey? +SourceTag? +TicketSequence? TransactionType -TxnSignature +TxnSignature?

    Properties

    @@ -58,7 +58,7 @@ cancel it.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -68,7 +68,7 @@ the provided hash.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • CheckID

    CheckID: string
    @@ -76,7 +76,7 @@ the provided hash.

    string.

    +
  • Defined in packages/xrpl/src/models/transactions/checkCancel.ts:19

    • Optional Fee

    Fee?: string
    @@ -86,7 +86,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:108

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -94,7 +94,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:123

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -104,7 +104,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:129

    • Optional Memos

    Memos?: Memo[]
    @@ -112,7 +112,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:133

    • Optional Sequence

    Sequence?: number
    @@ -123,7 +123,7 @@ is using a Ticket instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:115

    • Optional Signers

    Signers?: Signer[]
    @@ -132,7 +132,7 @@ transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:138

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -142,7 +142,7 @@ multi-signature is present in the Signers field instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:151

    • Optional SourceTag

    SourceTag?: number
    @@ -153,7 +153,7 @@ DestinationTag.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:145

    • Optional TicketSequence

    TicketSequence?: number
    @@ -162,13 +162,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:156

    • TransactionType

    TransactionType: "CheckCancel"
    +
  • Defined in packages/xrpl/src/models/transactions/checkCancel.ts:14

    • Optional TxnSignature

    TxnSignature?: string
    @@ -177,7 +177,7 @@ account it says it is from.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • @@ -205,19 +205,19 @@ account it says it is from.

  • CheckCancel
    • +
  • TxnSignature?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/CheckCash.html b/docs/interfaces/CheckCash.html index 73e78bf7..12460d0b 100644 --- a/docs/interfaces/CheckCash.html +++ b/docs/interfaces/CheckCash.html @@ -25,7 +25,7 @@ address of a Check can cash it with a CheckCash transaction.

    • CheckCash
    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:14
    • @@ -34,21 +34,21 @@ address of a Check can cash it with a CheckCash transaction.

    Properties

    Account -AccountTxnID -Amount +AccountTxnID? +Amount? CheckID -DeliverMin -Fee -Flags -LastLedgerSequence -Memos -Sequence -Signers -SigningPubKey -SourceTag -TicketSequence +DeliverMin? +Fee? +Flags? +LastLedgerSequence? +Memos? +Sequence? +Signers? +SigningPubKey? +SourceTag? +TicketSequence? TransactionType -TxnSignature +TxnSignature?

    Properties

    @@ -59,7 +59,7 @@ address of a Check can cash it with a CheckCash transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -69,7 +69,7 @@ the provided hash.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional Amount

    Amount?: Amount
    @@ -78,7 +78,7 @@ match that of the SendMax of the corresponding CheckCreate transaction. You. must provide either this field or DeliverMin.

    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:26

    • CheckID

    CheckID: string
    @@ -86,7 +86,7 @@ must provide either this field or DeliverMin.

    string.

    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:20

    • Optional DeliverMin

    DeliverMin?: Amount
    @@ -95,7 +95,7 @@ currency must match that of the SendMax of the corresponding CheckCreate. transaction. You must provide either this field or Amount.

    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:32

    • Optional Fee

    Fee?: string
    @@ -105,7 +105,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:108

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -113,7 +113,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:123

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -123,7 +123,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:129

    • Optional Memos

    Memos?: Memo[]
    @@ -131,7 +131,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:133

    • Optional Sequence

    Sequence?: number
    @@ -142,7 +142,7 @@ is using a Ticket instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:115

    • Optional Signers

    Signers?: Signer[]
    @@ -151,7 +151,7 @@ transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:138

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -161,7 +161,7 @@ multi-signature is present in the Signers field instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:151

    • Optional SourceTag

    SourceTag?: number
    @@ -172,7 +172,7 @@ DestinationTag.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:145

    • Optional TicketSequence

    TicketSequence?: number
    @@ -181,13 +181,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:156

    • TransactionType

    TransactionType: "CheckCash"
    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:15

    • Optional TxnSignature

    TxnSignature?: string
    @@ -196,7 +196,7 @@ account it says it is from.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • @@ -224,21 +224,21 @@ account it says it is from.

  • CheckCash
    • +
  • TxnSignature?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/CheckCreate.html b/docs/interfaces/CheckCreate.html index 44a253c5..a18476af 100644 --- a/docs/interfaces/CheckCreate.html +++ b/docs/interfaces/CheckCreate.html @@ -25,7 +25,7 @@ sender of the Check.

    • CheckCreate
    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:18
    • @@ -34,23 +34,23 @@ sender of the Check.

    Properties

    Account -AccountTxnID +AccountTxnID? Destination -DestinationTag -Expiration -Fee -Flags -InvoiceID -LastLedgerSequence -Memos +DestinationTag? +Expiration? +Fee? +Flags? +InvoiceID? +LastLedgerSequence? +Memos? SendMax -Sequence -Signers -SigningPubKey -SourceTag -TicketSequence +Sequence? +Signers? +SigningPubKey? +SourceTag? +TicketSequence? TransactionType -TxnSignature +TxnSignature?

    Properties

    @@ -61,7 +61,7 @@ sender of the Check.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -71,14 +71,14 @@ the provided hash.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Destination

    Destination: string

    The unique address of the account that can cash the Check.

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:21

    • Optional DestinationTag

    DestinationTag?: number
    @@ -86,7 +86,7 @@ the provided hash.

    recipient to pay.

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:34

    • Optional Expiration

    Expiration?: number
    @@ -94,7 +94,7 @@ recipient to pay.

    Epoch.

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:39

    • Optional Fee

    Fee?: string
    @@ -104,7 +104,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:108

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -112,7 +112,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:123

    • Optional InvoiceID

    InvoiceID?: string
    @@ -120,7 +120,7 @@ different minimum requirements.

    this Check.

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:44

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -130,7 +130,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:129

    • Optional Memos

    Memos?: Memo[]
    @@ -138,7 +138,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:133

    • SendMax

    SendMax: Amount
    @@ -149,7 +149,7 @@ non-XRP currencies). For non-XRP amounts, the nested field names MUST be. lower-case.

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:29

    • Optional Sequence

    Sequence?: number
    @@ -160,7 +160,7 @@ is using a Ticket instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:115

    • Optional Signers

    Signers?: Signer[]
    @@ -169,7 +169,7 @@ transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:138

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -179,7 +179,7 @@ multi-signature is present in the Signers field instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:151

    • Optional SourceTag

    SourceTag?: number
    @@ -190,7 +190,7 @@ DestinationTag.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:145

    • Optional TicketSequence

    TicketSequence?: number
    @@ -199,13 +199,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:156

    • TransactionType

    TransactionType: "CheckCreate"
    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:19

    • Optional TxnSignature

    TxnSignature?: string
    @@ -214,7 +214,7 @@ account it says it is from.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • @@ -242,23 +242,23 @@ account it says it is from.

  • CheckCreate
    • +
  • TxnSignature?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ClientOptions.html b/docs/interfaces/ClientOptions.html index c7a43bcc..6ad7b306 100644 --- a/docs/interfaces/ClientOptions.html +++ b/docs/interfaces/ClientOptions.html @@ -20,7 +20,7 @@
    • ClientOptions
    +
  • Defined in packages/xrpl/src/client/index.ts:116
    • @@ -28,19 +28,19 @@

    Properties

    -
    authorization -certificate -connectionTimeout -feeCushion -headers -key -maxFeeXRP -passphrase -proxy -proxyAuthorization -timeout -trace -trustedCertificates +
    authorization? +certificate? +connectionTimeout? +feeCushion? +headers? +key? +maxFeeXRP? +passphrase? +proxy? +proxyAuthorization? +timeout? +trace? +trustedCertificates?

    Properties

    @@ -49,27 +49,27 @@
    authorization?: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:31

    • Optional certificate

    certificate?: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:35

    • Optional connectionTimeout

    connectionTimeout?: number
    +
  • Defined in packages/xrpl/src/client/connection.ts:38

    • Optional feeCushion

    feeCushion?: number
    +
  • Defined in packages/xrpl/src/client/index.ts:117

    • Optional headers

    -
    headers?: { [key: string]: string }
    +
    headers?: {
        [key: string]: string;
    }

    Type declaration

      @@ -77,54 +77,54 @@
      [key: string]: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:39

    • Optional key

    key?: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:33

    • Optional maxFeeXRP

    maxFeeXRP?: string
    +
  • Defined in packages/xrpl/src/client/index.ts:118

    • Optional passphrase

    passphrase?: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:34

    • Optional proxy

    proxy?: string
    +
  • Defined in packages/xrpl/src/client/index.ts:119

    • Optional proxyAuthorization

    proxyAuthorization?: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:30

    • Optional timeout

    timeout?: number
    +
  • Defined in packages/xrpl/src/client/index.ts:120

    • Optional trace

    trace?: boolean | ((id: string, message: string) => void)
    +
  • Defined in packages/xrpl/src/client/connection.ts:28

    • Optional trustedCertificates

    trustedCertificates?: string[]
    +
  • Defined in packages/xrpl/src/client/connection.ts:32
    • @@ -151,19 +151,19 @@
    +
  • authorization?
    • +
  • certificate?
    • +
  • connectionTimeout?
    • +
  • feeCushion?
    • +
  • headers?
    • +
  • key?
    • +
  • maxFeeXRP?
    • +
  • passphrase?
    • +
  • proxy?
    • +
  • proxyAuthorization?
    • +
  • timeout?
    • +
  • trace?
    • +
  • trustedCertificates?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ConsensusStream.html b/docs/interfaces/ConsensusStream.html index 0ac18c33..bbcf8458 100644 --- a/docs/interfaces/ConsensusStream.html +++ b/docs/interfaces/ConsensusStream.html @@ -25,7 +25,7 @@ server is in.

    • ConsensusStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:366
    • @@ -45,13 +45,13 @@ server is in.

    establish, and accepted.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:372

    • type

    type: "consensusPhase"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:367
    • diff --git a/docs/interfaces/DepositAuthorizedRequest.html b/docs/interfaces/DepositAuthorizedRequest.html index 0eb72708..cab54940 100644 --- a/docs/interfaces/DepositAuthorizedRequest.html +++ b/docs/interfaces/DepositAuthorizedRequest.html @@ -24,7 +24,7 @@ send payments directly to another. Expects a response in the form of a
  • DepositAuthorizedRequest
    •  +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:12
    • @@ -32,12 +32,12 @@ send payments directly to another. Expects a response in the form of a

    Properties

    -
    api_version +
    api_version? command destination_account -id -ledger_hash -ledger_index +id? +ledger_hash? +ledger_index? source_account
    @@ -49,20 +49,20 @@ send payments directly to another. Expects a response in the form of a

    Inherited from BaseRequest.api_version

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • command

    command: "deposit_authorized"
    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:13

    • destination_account

    destination_account: string

    The recipient of a possible payment.

    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:17

    • Optional id

    id?: string | number
    @@ -72,14 +72,14 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10

    • Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:19

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -87,14 +87,14 @@ know which request prompted which response.

    ledger automatically.

    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:24

    • source_account

    source_account: string

    The sender of a possible payment.

    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:15
    • @@ -121,12 +121,12 @@ ledger automatically.

    Generated using TypeDoc

    diff --git a/docs/interfaces/DepositAuthorizedResponse.html b/docs/interfaces/DepositAuthorizedResponse.html index 379c73fb..5164a8b6 100644 --- a/docs/interfaces/DepositAuthorizedResponse.html +++ b/docs/interfaces/DepositAuthorizedResponse.html @@ -23,7 +23,7 @@
    • DepositAuthorizedResponse
    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:32
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,22 +47,22 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

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

    Type declaration

      @@ -102,31 +102,31 @@ Response.

    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:33

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -153,14 +153,14 @@ Response.

    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/DepositPreauth.html b/docs/interfaces/DepositPreauth.html index c3389cea..f56814c4 100644 --- a/docs/interfaces/DepositPreauth.html +++ b/docs/interfaces/DepositPreauth.html @@ -25,7 +25,7 @@ of this transaction is using (or plans to use) Deposit Authorization.

    • DepositPreauth
    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:13
    • @@ -34,20 +34,20 @@ of this transaction is using (or plans to use) Deposit Authorization.

    Properties

    Account -AccountTxnID -Authorize -Fee -Flags -LastLedgerSequence -Memos -Sequence -Signers -SigningPubKey -SourceTag -TicketSequence +AccountTxnID? +Authorize? +Fee? +Flags? +LastLedgerSequence? +Memos? +Sequence? +Signers? +SigningPubKey? +SourceTag? +TicketSequence? TransactionType -TxnSignature -Unauthorize +TxnSignature? +Unauthorize?

    Properties

    @@ -58,7 +58,7 @@ of this transaction is using (or plans to use) Deposit Authorization.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -68,14 +68,14 @@ the provided hash.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional Authorize

    Authorize?: string

    The XRP Ledger address of the sender to preauthorize.

    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:16

    • Optional Fee

    Fee?: string
    @@ -85,7 +85,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:108

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -93,7 +93,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:123

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -103,7 +103,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:129

    • Optional Memos

    Memos?: Memo[]
    @@ -111,7 +111,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:133

    • Optional Sequence

    Sequence?: number
    @@ -122,7 +122,7 @@ is using a Ticket instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:115

    • Optional Signers

    Signers?: Signer[]
    @@ -131,7 +131,7 @@ transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:138

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -141,7 +141,7 @@ multi-signature is present in the Signers field instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:151

    • Optional SourceTag

    SourceTag?: number
    @@ -152,7 +152,7 @@ DestinationTag.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:145

    • Optional TicketSequence

    TicketSequence?: number
    @@ -161,13 +161,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:156

    • TransactionType

    TransactionType: "DepositPreauth"
    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:14

    • Optional TxnSignature

    TxnSignature?: string
    @@ -176,7 +176,7 @@ account it says it is from.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:161

    • Optional Unauthorize

    Unauthorize?: string
    @@ -184,7 +184,7 @@ account it says it is from.

    revoked.

    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:21
    • @@ -212,20 +212,20 @@ revoked.

  • DepositPreauth
    • +
  • TxnSignature?
    • +
  • Unauthorize?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ErrorResponse.html b/docs/interfaces/ErrorResponse.html index 323ce25e..b9881ef2 100644 --- a/docs/interfaces/ErrorResponse.html +++ b/docs/interfaces/ErrorResponse.html @@ -22,7 +22,7 @@ throwing, and allowing the user to handle in the catch block of a promise.

    • ErrorResponse
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40
    • @@ -30,10 +30,10 @@ throwing, and allowing the user to handle in the catch block of a promise.

    Properties

    -
    api_version +
    api_version? error -error_code -error_message +error_code? +error_message? id request status @@ -45,42 +45,42 @@ throwing, and allowing the user to handle in the catch block of a promise.

    Optional api_version

    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:48

    • error

    error: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:44

    • Optional error_code

    error_code?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:45

    • Optional error_message

    error_message?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:46

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:41

    • request

    request: Request
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:47

    • status

    status: "error"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:42

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:43
    • @@ -107,10 +107,10 @@ throwing, and allowing the user to handle in the catch block of a promise.

    @@ -32,20 +32,20 @@

    Properties

    Account -AccountTxnID -Fee -Flags -LastLedgerSequence -Memos +AccountTxnID? +Fee? +Flags? +LastLedgerSequence? +Memos? OfferSequence Owner -Sequence -Signers -SigningPubKey -SourceTag -TicketSequence +Sequence? +Signers? +SigningPubKey? +SourceTag? +TicketSequence? TransactionType -TxnSignature +TxnSignature?

    Properties

    @@ -56,7 +56,7 @@
    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -66,7 +66,7 @@ the provided hash.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional Fee

    Fee?: string
    @@ -76,7 +76,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:108

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -84,7 +84,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:123

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -94,7 +94,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:129

    • Optional Memos

    Memos?: Memo[]
    @@ -102,7 +102,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:133

    • OfferSequence

    OfferSequence: number
    @@ -110,14 +110,14 @@ validated or rejected.

    created the escrow to cancel.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCancel.ts:18

    • Owner

    Owner: string

    Address of the source account that funded the escrow payment.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCancel.ts:13

    • Optional Sequence

    Sequence?: number
    @@ -128,7 +128,7 @@ is using a Ticket instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:115

    • Optional Signers

    Signers?: Signer[]
    @@ -137,7 +137,7 @@ transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:138

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -147,7 +147,7 @@ multi-signature is present in the Signers field instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:151

    • Optional SourceTag

    SourceTag?: number
    @@ -158,7 +158,7 @@ DestinationTag.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:145

    • Optional TicketSequence

    TicketSequence?: number
    @@ -167,13 +167,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:156

    • TransactionType

    TransactionType: "EscrowCancel"
    +
  • Defined in packages/xrpl/src/models/transactions/escrowCancel.ts:11

    • Optional TxnSignature

    TxnSignature?: string
    @@ -182,7 +182,7 @@ account it says it is from.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • @@ -210,20 +210,20 @@ account it says it is from.

  • EscrowCancel
    • +
  • TxnSignature?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/EscrowCreate.html b/docs/interfaces/EscrowCreate.html index ae9aa99a..959e0181 100644 --- a/docs/interfaces/EscrowCreate.html +++ b/docs/interfaces/EscrowCreate.html @@ -23,7 +23,7 @@
    • EscrowCreate
    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:11
    • @@ -32,24 +32,24 @@

    Properties

    Account -AccountTxnID +AccountTxnID? Amount -CancelAfter -Condition +CancelAfter? +Condition? Destination -DestinationTag -Fee -FinishAfter -Flags -LastLedgerSequence -Memos -Sequence -Signers -SigningPubKey -SourceTag -TicketSequence +DestinationTag? +Fee? +FinishAfter? +Flags? +LastLedgerSequence? +Memos? +Sequence? +Signers? +SigningPubKey? +SourceTag? +TicketSequence? TransactionType -TxnSignature +TxnSignature?

    Properties

    @@ -60,7 +60,7 @@
    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -70,7 +70,7 @@ the provided hash.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Amount

    Amount: string
    @@ -79,7 +79,7 @@ Once escrowed, the XRP can either go to the Destination address (after the. FinishAfter time) or returned to the sender (after the CancelAfter time).

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:18

    • Optional CancelAfter

    CancelAfter?: number
    @@ -88,7 +88,7 @@ This value is immutable; the funds can only be returned the sender after. this time.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:26

    • Optional Condition

    Condition?: string
    @@ -96,14 +96,14 @@ this time.

    only be delivered to the recipient if this condition is fulfilled.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:37

    • Destination

    Destination: string

    Address to receive escrowed XRP.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:20

    • Optional DestinationTag

    DestinationTag?: number
    @@ -111,7 +111,7 @@ only be delivered to the recipient if this condition is fulfilled.

    payment, such as a hosted recipient at the destination address.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:42

    • Optional Fee

    Fee?: string
    @@ -121,7 +121,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:108

    • Optional FinishAfter

    FinishAfter?: number
    @@ -130,7 +130,7 @@ released to the recipient. This value is immutable; the funds cannot move. until this time is reached.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:32

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -138,7 +138,7 @@ until this time is reached.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:123

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -148,7 +148,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:129

    • Optional Memos

    Memos?: Memo[]
    @@ -156,7 +156,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:133

    • Optional Sequence

    Sequence?: number
    @@ -167,7 +167,7 @@ is using a Ticket instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:115

    • Optional Signers

    Signers?: Signer[]
    @@ -176,7 +176,7 @@ transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:138

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -186,7 +186,7 @@ multi-signature is present in the Signers field instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:151

    • Optional SourceTag

    SourceTag?: number
    @@ -197,7 +197,7 @@ DestinationTag.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:145

    • Optional TicketSequence

    TicketSequence?: number
    @@ -206,13 +206,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:156

    • TransactionType

    TransactionType: "EscrowCreate"
    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:12

    • Optional TxnSignature

    TxnSignature?: string
    @@ -221,7 +221,7 @@ account it says it is from.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • @@ -249,24 +249,24 @@ account it says it is from.

  • EscrowCreate
    • +
  • TxnSignature?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/EscrowFinish.html b/docs/interfaces/EscrowFinish.html index bf637f93..c3c9904a 100644 --- a/docs/interfaces/EscrowFinish.html +++ b/docs/interfaces/EscrowFinish.html @@ -23,7 +23,7 @@
    • EscrowFinish
    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:10
    • @@ -32,22 +32,22 @@

    Properties

    Account -AccountTxnID -Condition -Fee -Flags -Fulfillment -LastLedgerSequence -Memos +AccountTxnID? +Condition? +Fee? +Flags? +Fulfillment? +LastLedgerSequence? +Memos? OfferSequence Owner -Sequence -Signers -SigningPubKey -SourceTag -TicketSequence +Sequence? +Signers? +SigningPubKey? +SourceTag? +TicketSequence? TransactionType -TxnSignature +TxnSignature?

    Properties

    @@ -58,7 +58,7 @@
    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -68,7 +68,7 @@ the provided hash.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional Condition

    Condition?: string
    @@ -76,7 +76,7 @@ the provided hash.

    crypto-condition of the held payment.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:23

    • Optional Fee

    Fee?: string
    @@ -86,7 +86,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:108

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -94,7 +94,7 @@ different minimum requirements.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:123

    • Optional Fulfillment

    Fulfillment?: string
    @@ -102,7 +102,7 @@ different minimum requirements.

    the held payment's Condition.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:28

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -112,7 +112,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:129

    • Optional Memos

    Memos?: Memo[]
    @@ -120,7 +120,7 @@ validated or rejected.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:133

    • OfferSequence

    OfferSequence: number
    @@ -128,14 +128,14 @@ validated or rejected.

    payment to finish.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:18

    • Owner

    Owner: string

    Address of the source account that funded the held payment.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:13

    • Optional Sequence

    Sequence?: number
    @@ -146,7 +146,7 @@ is using a Ticket instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:115

    • Optional Signers

    Signers?: Signer[]
    @@ -155,7 +155,7 @@ transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:138

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -165,7 +165,7 @@ multi-signature is present in the Signers field instead.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:151

    • Optional SourceTag

    SourceTag?: number
    @@ -176,7 +176,7 @@ DestinationTag.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:145

    • Optional TicketSequence

    TicketSequence?: number
    @@ -185,13 +185,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:156

    • TransactionType

    TransactionType: "EscrowFinish"
    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:11

    • Optional TxnSignature

    TxnSignature?: string
    @@ -200,7 +200,7 @@ account it says it is from.

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • @@ -228,22 +228,22 @@ account it says it is from.

  • EscrowFinish
    • +
  • TxnSignature?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/FederatorInfoRequest.html b/docs/interfaces/FederatorInfoRequest.html index 2faee025..1c336884 100644 --- a/docs/interfaces/FederatorInfoRequest.html +++ b/docs/interfaces/FederatorInfoRequest.html @@ -26,7 +26,7 @@ the form of a FederatorInfoResponse.

  • FederatorInfoRequest
    • +
  • Defined in packages/xrpl/src/models/methods/federatorInfo.ts:11
    • @@ -34,9 +34,9 @@ the form of a FederatorInfoResponse.

    Properties

    -
    api_version +
    api_version? command -id +id?

    Properties

    @@ -47,13 +47,13 @@ the form of a FederatorInfoResponse.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • command

    command: "federator_info"
    +
  • Defined in packages/xrpl/src/models/methods/federatorInfo.ts:12

    • Optional id

    id?: string | number
    @@ -63,7 +63,7 @@ know which request prompted which response.

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • @@ -90,9 +90,9 @@ know which request prompted which response.

    +
  • id?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/FederatorInfoResponse.html b/docs/interfaces/FederatorInfoResponse.html index 984b74d5..5ed2bd83 100644 --- a/docs/interfaces/FederatorInfoResponse.html +++ b/docs/interfaces/FederatorInfoResponse.html @@ -23,7 +23,7 @@
    • FederatorInfoResponse
    +
  • Defined in packages/xrpl/src/models/methods/federatorInfo.ts:20
    • @@ -31,14 +31,14 @@

    Properties

    -
    api_version -forwarded +
    api_version? +forwarded? id result -status +status? type -warning -warnings +warning? +warnings?

    Properties

    @@ -47,33 +47,33 @@
    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24

    • result

    -
    result: { info: { mainchain: { door_status: { initialized: boolean; status: "closed" | "open" | "opening" | "closing" }; last_transaction_sent_seq: number; listener_info: { state: "syncing" | "normal" }; pending_transactions: { amount: string; destination_account: string; signatures: { public_key: string; seq: number }[] }[]; sequence: number; tickets: { initialized: boolean; tickets: { status: "taken" | "available"; ticket_seq: number }[] } }; public_key: string; sidechain: { door_status: { initialized: boolean; status: "closed" | "open" | "opening" | "closing" }; last_transaction_sent_seq: number; listener_info: { state: "syncing" | "normal" }; pending_transactions: { amount: string; destination_account: string; signatures: { public_key: string; seq: number }[] }[]; sequence: number; tickets: { initialized: boolean; tickets: { status: "taken" | "available"; ticket_seq: number }[] } } } }
    +
    result: {
        info: {
            mainchain: {
                door_status: {
                    initialized: boolean;
                    status: "closed" | "open" | "opening" | "closing";
                };
                last_transaction_sent_seq: number;
                listener_info: {
                    state: "syncing" | "normal";
                };
                pending_transactions: {
                    amount: string;
                    destination_account: string;
                    signatures: {
                        public_key: string;
                        seq: number;
                    }[];
                }[];
                sequence: number;
                tickets: {
                    initialized: boolean;
                    tickets: {
                        status: "taken" | "available";
                        ticket_seq: number;
                    }[];
                };
            };
            public_key: string;
            sidechain: {
                door_status: {
                    initialized: boolean;
                    status: "closed" | "open" | "opening" | "closing";
                };
                last_transaction_sent_seq: number;
                listener_info: {
                    state: "syncing" | "normal";
                };
                pending_transactions: {
                    amount: string;
                    destination_account: string;
                    signatures: {
                        public_key: string;
                        seq: number;
                    }[];
                }[];
                sequence: number;
                tickets: {
                    initialized: boolean;
                    tickets: {
                        status: "taken" | "available";
                        ticket_seq: number;
                    }[];
                };
            };
        };
    }

    Type declaration

    • -
      info: { mainchain: { door_status: { initialized: boolean; status: "closed" | "open" | "opening" | "closing" }; last_transaction_sent_seq: number; listener_info: { state: "syncing" | "normal" }; pending_transactions: { amount: string; destination_account: string; signatures: { public_key: string; seq: number }[] }[]; sequence: number; tickets: { initialized: boolean; tickets: { status: "taken" | "available"; ticket_seq: number }[] } }; public_key: string; sidechain: { door_status: { initialized: boolean; status: "closed" | "open" | "opening" | "closing" }; last_transaction_sent_seq: number; listener_info: { state: "syncing" | "normal" }; pending_transactions: { amount: string; destination_account: string; signatures: { public_key: string; seq: number }[] }[]; sequence: number; tickets: { initialized: boolean; tickets: { status: "taken" | "available"; ticket_seq: number }[] } } }
      +
      info: {
          mainchain: {
              door_status: {
                  initialized: boolean;
                  status: "closed" | "open" | "opening" | "closing";
              };
              last_transaction_sent_seq: number;
              listener_info: {
                  state: "syncing" | "normal";
              };
              pending_transactions: {
                  amount: string;
                  destination_account: string;
                  signatures: {
                      public_key: string;
                      seq: number;
                  }[];
              }[];
              sequence: number;
              tickets: {
                  initialized: boolean;
                  tickets: {
                      status: "taken" | "available";
                      ticket_seq: number;
                  }[];
              };
          };
          public_key: string;
          sidechain: {
              door_status: {
                  initialized: boolean;
                  status: "closed" | "open" | "opening" | "closing";
              };
              last_transaction_sent_seq: number;
              listener_info: {
                  state: "syncing" | "normal";
              };
              pending_transactions: {
                  amount: string;
                  destination_account: string;
                  signatures: {
                      public_key: string;
                      seq: number;
                  }[];
              }[];
              sequence: number;
              tickets: {
                  initialized: boolean;
                  tickets: {
                      status: "taken" | "available";
                      ticket_seq: number;
                  }[];
              };
          };
      }
      • -
        mainchain: { door_status: { initialized: boolean; status: "closed" | "open" | "opening" | "closing" }; last_transaction_sent_seq: number; listener_info: { state: "syncing" | "normal" }; pending_transactions: { amount: string; destination_account: string; signatures: { public_key: string; seq: number }[] }[]; sequence: number; tickets: { initialized: boolean; tickets: { status: "taken" | "available"; ticket_seq: number }[] } }
        +
        mainchain: {
            door_status: {
                initialized: boolean;
                status: "closed" | "open" | "opening" | "closing";
            };
            last_transaction_sent_seq: number;
            listener_info: {
                state: "syncing" | "normal";
            };
            pending_transactions: {
                amount: string;
                destination_account: string;
                signatures: {
                    public_key: string;
                    seq: number;
                }[];
            }[];
            sequence: number;
            tickets: {
                initialized: boolean;
                tickets: {
                    status: "taken" | "available";
                    ticket_seq: number;
                }[];
            };
        }
        • -
          door_status: { initialized: boolean; status: "closed" | "open" | "opening" | "closing" }
          +
          door_status: {
              initialized: boolean;
              status: "closed" | "open" | "opening" | "closing";
          }
          • initialized: boolean
            • @@ -82,28 +82,28 @@
          • last_transaction_sent_seq: number
          • -
            listener_info: { state: "syncing" | "normal" }
            +
            listener_info: {
                state: "syncing" | "normal";
            }
            • state: "syncing" | "normal"
          • -
            pending_transactions: { amount: string; destination_account: string; signatures: { public_key: string; seq: number }[] }[]
            • +
            pending_transactions: {
                amount: string;
                destination_account: string;
                signatures: {
                    public_key: string;
                    seq: number;
                }[];
            }[]
          • sequence: number
          • -
            tickets: { initialized: boolean; tickets: { status: "taken" | "available"; ticket_seq: number }[] }
            +
            tickets: {
                initialized: boolean;
                tickets: {
                    status: "taken" | "available";
                    ticket_seq: number;
                }[];
            }
            • initialized: boolean
            • -
              tickets: { status: "taken" | "available"; ticket_seq: number }[]
          • +
          tickets: {
              status: "taken" | "available";
              ticket_seq: number;
          }[]
    • public_key: string
    • -
      sidechain: { door_status: { initialized: boolean; status: "closed" | "open" | "opening" | "closing" }; last_transaction_sent_seq: number; listener_info: { state: "syncing" | "normal" }; pending_transactions: { amount: string; destination_account: string; signatures: { public_key: string; seq: number }[] }[]; sequence: number; tickets: { initialized: boolean; tickets: { status: "taken" | "available"; ticket_seq: number }[] } }
      +
      sidechain: {
          door_status: {
              initialized: boolean;
              status: "closed" | "open" | "opening" | "closing";
          };
          last_transaction_sent_seq: number;
          listener_info: {
              state: "syncing" | "normal";
          };
          pending_transactions: {
              amount: string;
              destination_account: string;
              signatures: {
                  public_key: string;
                  seq: number;
              }[];
          }[];
          sequence: number;
          tickets: {
              initialized: boolean;
              tickets: {
                  status: "taken" | "available";
                  ticket_seq: number;
              }[];
          };
      }
      • -
        door_status: { initialized: boolean; status: "closed" | "open" | "opening" | "closing" }
        +
        door_status: {
            initialized: boolean;
            status: "closed" | "open" | "opening" | "closing";
        }
        • initialized: boolean
          • @@ -112,48 +112,48 @@
        • last_transaction_sent_seq: number
        • -
          listener_info: { state: "syncing" | "normal" }
          +
          listener_info: {
              state: "syncing" | "normal";
          }
          • state: "syncing" | "normal"
        • -
          pending_transactions: { amount: string; destination_account: string; signatures: { public_key: string; seq: number }[] }[]
          • +
          pending_transactions: {
              amount: string;
              destination_account: string;
              signatures: {
                  public_key: string;
                  seq: number;
              }[];
          }[]
        • sequence: number
        • -
          tickets: { initialized: boolean; tickets: { status: "taken" | "available"; ticket_seq: number }[] }
          +
          tickets: {
              initialized: boolean;
              tickets: {
                  status: "taken" | "available";
                  ticket_seq: number;
              }[];
          }
          • initialized: boolean
          • -
            tickets: { status: "taken" | "available"; ticket_seq: number }[]
    +
  • Defined in packages/xrpl/src/models/methods/federatorInfo.ts:21

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28

    • Optional warnings

    warnings?: Warning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • @@ -180,14 +180,14 @@
    +
  • warning?
    • +
  • warnings?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/FeeRequest.html b/docs/interfaces/FeeRequest.html index ff3b9b07..6fea3d2c 100644 --- a/docs/interfaces/FeeRequest.html +++ b/docs/interfaces/FeeRequest.html @@ -18,7 +18,7 @@ for the transaction cost. This requires the FeeEscalation amendment to be enabled. Expects a response in the form of a FeeResponse.

    -

    Example

    const feeRequest: FeeRequest = {
     command: 'fee'
    }
+
    Example
    const feeRequest: FeeRequest = {
     command: 'fee'
    }
 
    
 
 
    
@@ -28,7 +28,7 @@ enabled. Expects a response in the form of a FeeRespo
 
      
 
    • FeeRequest
    
+
  • Defined in packages/xrpl/src/models/methods/fee.ts:17
    • 
 
    
 
    
 
    
@@ -36,9 +36,9 @@ enabled. Expects a response in the form of a FeeRespo
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 
    
 
    
 
    Properties
    
@@ -49,13 +49,13 @@ enabled. Expects a response in the form of a FeeRespo
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "fee"
    
+
  • Defined in packages/xrpl/src/models/methods/fee.ts:18
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -65,7 +65,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    
 
    
@@ -92,9 +92,9 @@ know which request prompted which response.
    
 
    
+
  • id?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/FeeResponse.html b/docs/interfaces/FeeResponse.html
index 7cacf805..6bbf7b43 100644
--- a/docs/interfaces/FeeResponse.html
+++ b/docs/interfaces/FeeResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • FeeResponse
    
+
  • Defined in packages/xrpl/src/models/methods/fee.ts:26
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    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 }
    
+
    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
    
 
      
@@ -75,7 +75,7 @@
 
      Number of transactions currently queued for the next ledger.
      
 
      
 
    • 
-
      drops: { base_fee: string; median_fee: string; minimum_fee: string; open_ledger_fee: string }
      
+
      drops: { 
          base_fee: string; 
          median_fee: string; 
          minimum_fee: string; 
          open_ledger_fee: string; 
      }
      
 
        
 
      • 
 
        base_fee: string
        
@@ -109,7 +109,7 @@ previous ledger.
        
 
        The Ledger Index of the current open ledger these stats describe.
        
 
        • 
 
      • 
-
        levels: { median_level: string; minimum_level: string; open_ledger_level: string; reference_level: string }
        
+
        levels: { 
            median_level: string; 
            minimum_level: string; 
            open_ledger_level: string; 
            reference_level: string; 
        }
        
 
          
 
        • 
 
          median_level: string
          
@@ -138,31 +138,31 @@ currently hold.
          
 
    
+
  • Defined in packages/xrpl/src/models/methods/fee.ts:27
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -189,14 +189,14 @@ currently hold.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/GatewayBalancesRequest.html b/docs/interfaces/GatewayBalancesRequest.html
index 802acbfd..8bd8a08e 100644
--- a/docs/interfaces/GatewayBalancesRequest.html
+++ b/docs/interfaces/GatewayBalancesRequest.html
@@ -18,7 +18,7 @@
 account, optionally excluding amounts held by operational addresses. Expects
 a response in the form of a GatewayBalancesResponse.
    
 
-
    Example
    const gatewayBalances: GatewayBalanceRequest = {
      "id": "example_gateway_balances_1",
      "command": "gateway_balances",
      "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
      "strict": true,
      "hotwallet": ["rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ","ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"],
      "ledger_index": "validated"
    }
+
    Example
    const gatewayBalances: GatewayBalanceRequest = {
      "id": "example_gateway_balances_1",
      "command": "gateway_balances",
      "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
      "strict": true,
      "hotwallet": ["rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ","ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"],
      "ledger_index": "validated"
    }
 
    
 
 
    
@@ -28,7 +28,7 @@ a response in the form of a GatewayBalanc
 
      
 
    • GatewayBalancesRequest
    
+
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:24
    • 
 
    
 
    
 
    
@@ -37,13 +37,13 @@ a response in the form of a GatewayBalanc
 
    
 
    Properties
    
 
    account
-api_version
+api_version?
 command
-hotwallet
-id
-ledger_hash
-ledger_index
-strict
+hotwallet?
+id?
+ledger_hash?
+ledger_index?
+strict?
 
    
 
    
 
    Properties
    
@@ -53,7 +53,7 @@ a response in the form of a GatewayBalanc
 
    The Address to check. This should be the issuing address.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:27
    • 
 
    
 
    Optional api_version
    
 
    api_version?: number
    
@@ -61,13 +61,13 @@ a response in the form of a GatewayBalanc
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "gateway_balances"
    
+
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:25
    • 
 
    
 
    Optional hotwallet
    
 
    hotwallet?: string | string[]
    
@@ -75,7 +75,7 @@ a response in the form of a GatewayBalanc
 Such addresses.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:37
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -85,14 +85,14 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional ledger_hash
    
 
    ledger_hash?: string
    
 
    A 20-byte hex string for the ledger version to use.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:39
    • 
 
    
 
    Optional ledger_index
    
 
    ledger_index?: LedgerIndex
    
@@ -100,7 +100,7 @@ know which request prompted which response.
    
 choose a ledger automatically.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:44
    • 
 
    
 
    Optional strict
    
 
    strict?: boolean
    
@@ -108,7 +108,7 @@ choose a ledger automatically.
    
 Defaults to false.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:32
    • 
 
    
 
    
 
    
@@ -136,13 +136,13 @@ Defaults to false.
    
 
  • GatewayBalancesRequest
 
    • 
+
  • hotwallet?
    • 
+
  • id?
    • 
+
  • ledger_hash?
    • 
+
  • ledger_index?
    • 
+
  • strict?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/GatewayBalancesResponse.html b/docs/interfaces/GatewayBalancesResponse.html
index 13e78a71..4813b4af 100644
--- a/docs/interfaces/GatewayBalancesResponse.html
+++ b/docs/interfaces/GatewayBalancesResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • GatewayBalancesResponse
    
+
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:57
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { account: string; assets?: { [address: string]: Balance[] }; balances?: { [address: string]: Balance[] }; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; obligations?: { [currency: string]: string } }
    
+
    result: { 
        account: string; 
        assets?: { 
            [address: string]: Balance[]; 
        }; 
        balances?: { 
            [address: string]: Balance[]; 
        }; 
        ledger_current_index?: number; 
        ledger_hash?: string; 
        ledger_index?: number; 
        obligations?: { 
            [currency: string]: string; 
        }; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -71,7 +71,7 @@
 
      The address of the account that issued the balances.
      
 
      
 
    • 
-
      Optional assets?: { [address: string]: Balance[] }
      
+
      Optional assets?: { 
          [address: string]: Balance[]; 
      }
      
 
      Total amounts held that are issued by others. In the recommended
 configuration, the issuing address should have none.
      
 
      
@@ -79,7 +79,7 @@ configuration, the issuing address should have none.
      
 
    • 
 
      [address: string]: Balance[]
    
 
  • 
-
    Optional balances?: { [address: string]: Balance[] }
    
+
    Optional balances?: { 
        [address: string]: Balance[]; 
    }
    
 
    Amounts issued to the hotwallet addresses from the request. The keys are
 addresses and the values are arrays of currency amounts they hold.
    
 
    
@@ -102,7 +102,7 @@ this response.
    
 used to retrieve this information.
    
 
    • 
 
  • 
-
    Optional obligations?: { [currency: string]: string }
    
+
    Optional obligations?: { 
        [currency: string]: string; 
    }
    
 
    Total amounts issued to addresses not excluded, as a map of currencies
 to the total value issued.
    
 
    
@@ -111,31 +111,31 @@ to the total value issued.
    
 
    [currency: string]: string
    • 
+
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:58
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -162,14 +162,14 @@ to the total value issued.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerClosedRequest.html b/docs/interfaces/LedgerClosedRequest.html
index e3473d56..ecbd9a66 100644
--- a/docs/interfaces/LedgerClosedRequest.html
+++ b/docs/interfaces/LedgerClosedRequest.html
@@ -20,7 +20,7 @@ closed ledger. Expects a response in the form of a const ledgerClosed: LedgerClosedRequest = {
      "command": "ledger_closed"
    }
+
    const ledgerClosed: LedgerClosedRequest = {
      "command": "ledger_closed"
    }
 
    
 
 
    
@@ -30,7 +30,7 @@ closed ledger. Expects a response in the form of a 
 
  • LedgerClosedRequest
    • 
+
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:18
    • 
 
    
 
    
 
    
@@ -38,9 +38,9 @@ closed ledger. Expects a response in the form of a 
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 
    
 
    
 
    Properties
    
@@ -51,13 +51,13 @@ closed ledger. Expects a response in the form of a 
 
    Inherited from BaseRequest.api_version
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "ledger_closed"
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:19
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -67,7 +67,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    
 
    
@@ -94,9 +94,9 @@ know which request prompted which response.
    
 
    
+
  • id?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerClosedResponse.html b/docs/interfaces/LedgerClosedResponse.html
index c0d5380f..589d64b1 100644
--- a/docs/interfaces/LedgerClosedResponse.html
+++ b/docs/interfaces/LedgerClosedResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • LedgerClosedResponse
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:27
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { ledger_hash: string; ledger_index: number }
    
+
    result: { 
        ledger_hash: string; 
        ledger_index: number; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -72,31 +72,31 @@
 
      ledger_index: number
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:28
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -123,14 +123,14 @@
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerCurrentRequest.html b/docs/interfaces/LedgerCurrentRequest.html
index b98dc7f3..034f620d 100644
--- a/docs/interfaces/LedgerCurrentRequest.html
+++ b/docs/interfaces/LedgerCurrentRequest.html
@@ -17,7 +17,7 @@
 
    The ledger_current method returns the unique identifiers of the current
 in-progress ledger. Expects a response in the form of a LedgerCurrentResponse.
    
 
-
    Example
    const ledgerCurrent: LedgerCurrentRequest = {
      "command": "ledger_current"
    }
+
    Example
    const ledgerCurrent: LedgerCurrentRequest = {
      "command": "ledger_current"
    }
 
    
 
    
 
    
@@ -27,7 +27,7 @@ in-progress ledger. Expects a response in the form of a 
 
  • LedgerCurrentRequest
    • 
+
  • Defined in packages/xrpl/src/models/methods/ledgerCurrent.ts:17
    • 
 
    
 
    
 
    
@@ -35,9 +35,9 @@ in-progress ledger. Expects a response in the form of a 
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 
    
 
    
 
    Properties
    
@@ -48,13 +48,13 @@ in-progress ledger. Expects a response in the form of a 
 
    Inherited from BaseRequest.api_version
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "ledger_current"
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerCurrent.ts:18
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -64,7 +64,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    
 
    
@@ -91,9 +91,9 @@ know which request prompted which response.
    
 
    
+
  • id?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerCurrentResponse.html b/docs/interfaces/LedgerCurrentResponse.html
index 60389923..18e3166c 100644
--- a/docs/interfaces/LedgerCurrentResponse.html
+++ b/docs/interfaces/LedgerCurrentResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • LedgerCurrentResponse
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerCurrent.ts:26
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { ledger_current_index: number }
    
+
    result: { 
        ledger_current_index: number; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -72,31 +72,31 @@
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerCurrent.ts:27
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -123,14 +123,14 @@
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerDataRequest.html b/docs/interfaces/LedgerDataRequest.html
index 89ecf033..df68eaec 100644
--- a/docs/interfaces/LedgerDataRequest.html
+++ b/docs/interfaces/LedgerDataRequest.html
@@ -18,7 +18,7 @@
 iterate through several calls to retrieve the entire contents of a single
 ledger version.
    
 
-
    Example
    const ledgerData: LedgerDataRequest = {
      "id": 2,
      "ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
      "command": "ledger_data",
      "limit": 5,
      "binary": true
    }
+
    Example
    const ledgerData: LedgerDataRequest = {
      "id": 2,
      "ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
      "command": "ledger_data",
      "limit": 5,
      "binary": true
    }
 
    
 
 
    
@@ -28,7 +28,7 @@ ledger version.
    
 
      
 
    • LedgerDataRequest
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:24
    • 
 
    
 
    
 
    
@@ -36,14 +36,14 @@ ledger version.
    
 
    
 
    
 
    Properties
    
-
    api_version
-binary
+
    api_version?
+binary?
 command
-id
-ledger_hash
-ledger_index
-limit
-marker
+id?
+ledger_hash?
+ledger_index?
+limit?
+marker?
 
    
 
    
 
    Properties
    
@@ -54,7 +54,7 @@ ledger version.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    Optional binary
    
 
    binary?: boolean
    
@@ -62,13 +62,13 @@ ledger version.
    
 JSON.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:37
    • 
 
    
 
    command
    
 
    command: "ledger_data"
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:25
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -78,14 +78,14 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional ledger_hash
    
 
    ledger_hash?: string
    
 
    A 20-byte hex string for the ledger version to use.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:27
    • 
 
    
 
    Optional ledger_index
    
 
    ledger_index?: LedgerIndex
    
@@ -93,7 +93,7 @@ know which request prompted which response.
    
 ledger automatically.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:32
    • 
 
    
 
    Optional limit
    
 
    limit?: number
    
@@ -101,7 +101,7 @@ ledger automatically.
    
 to honor this value.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:42
    • 
 
    
 
    Optional marker
    
 
    marker?: unknown
    
@@ -109,7 +109,7 @@ to honor this value.
    
 that response left off.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:47
    • 
 
    
 
    
 
    
@@ -136,14 +136,14 @@ that response left off.
    
 
    
+
  • id?
    • 
+
  • ledger_hash?
    • 
+
  • ledger_index?
    • 
+
  • limit?
    • 
+
  • marker?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerDataResponse.html b/docs/interfaces/LedgerDataResponse.html
index 7c880522..5a073e92 100644
--- a/docs/interfaces/LedgerDataResponse.html
+++ b/docs/interfaces/LedgerDataResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • LedgerDataResponse
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:63
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { ledger_hash: string; ledger_index: number; marker?: unknown; state: State[]; validated?: boolean }
    
+
    result: { 
        ledger_hash: string; 
        ledger_index: number; 
        marker?: unknown; 
        state: State[]; 
        validated?: boolean; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -88,31 +88,31 @@ as defined below.
      
 
      Optional validated?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:64
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -139,14 +139,14 @@ as defined below.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerEntry.AccountRoot.html b/docs/interfaces/LedgerEntry.AccountRoot.html
index c75f67c9..b9a8698a 100644
--- a/docs/interfaces/LedgerEntry.AccountRoot.html
+++ b/docs/interfaces/LedgerEntry.AccountRoot.html
@@ -25,7 +25,7 @@ XRP balance.
    
 
      
 
    • AccountRoot
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:9
    • 
 
    
 
    
 
    
@@ -34,21 +34,21 @@ XRP balance.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
+AccountTxnID?
 Balance
-Domain
-EmailHash
+Domain?
+EmailHash?
 Flags
 LedgerEntryType
-MessageKey
+MessageKey?
 OwnerCount
 PreviousTxnID
 PreviousTxnLgrSeq
-RegularKey
+RegularKey?
 Sequence
-TickSize
-TicketCount
-TransferRate
+TickSize?
+TicketCount?
+TransferRate?
 index
 
    
 
    
@@ -59,7 +59,7 @@ XRP balance.
    
 
    The identifying (classic) address of this account.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:12
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -69,14 +69,14 @@ field. To enable it, send an AccountSet transaction with the.
 asfAccountTxnID flag enabled.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:40
    • 
 
    
 
    Balance
    
 
    Balance: string
    
 
    The account's current XRP balance in drops, represented as a string.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:14
    • 
 
    
 
    Optional Domain
    
 
    Domain?: string
    
@@ -84,26 +84,26 @@ field. To enable it, send an AccountSet transaction with the.
 for the ASCII representation of the domain.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:45
    • 
 
    
 
    Optional EmailHash
    
 
    EmailHash?: string
    
 
    The md5 hash of an email address.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:47
    • 
 
    
 
    Flags
    
 
    Flags: number
    
 
    A bit-map of boolean flags enabled for this account.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:16
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "AccountRoot"
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:10
    • 
 
    
 
    Optional MessageKey
    
 
    MessageKey?: string
    
@@ -111,7 +111,7 @@ for the ASCII representation of the domain.
    
 in JSON, uses hexadecimal.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:52
    • 
 
    
 
    OwnerCount
    
 
    OwnerCount: number
    
@@ -119,7 +119,7 @@ in JSON, uses hexadecimal.
    
 to its owner reserve.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:21
    • 
 
    
 
    PreviousTxnID
    
 
    PreviousTxnID: string
    
@@ -127,7 +127,7 @@ to its owner reserve.
    
 object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:26
    • 
 
    
 
    PreviousTxnLgrSeq
    
 
    PreviousTxnLgrSeq: number
    
@@ -135,7 +135,7 @@ object.
    
 modified this object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:31
    • 
 
    
 
    Optional RegularKey
    
 
    RegularKey?: string
    
@@ -144,14 +144,14 @@ account instead of the master key. Use a SetRegularKey transaction to
 change this value.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:58
    • 
 
    
 
    Sequence
    
 
    Sequence: number
    
 
    The sequence number of the next valid transaction for this account.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:33
    • 
 
    
 
    Optional TickSize
    
 
    TickSize?: number
    
@@ -159,7 +159,7 @@ change this value.
    
 currencies issued by this address. Valid values are 3 to 15, inclusive.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:69
    • 
 
    
 
    Optional TicketCount
    
 
    TicketCount?: number
    
@@ -168,7 +168,7 @@ automatically to ensure that the account stays within the hard limit of 250.
 Tickets at a time.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:64
    • 
 
    
 
    Optional TransferRate
    
 
    TransferRate?: number
    
@@ -176,13 +176,13 @@ Tickets at a time.
    
 account to each other.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:74
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
@@ -210,21 +210,21 @@ account to each other.
    
 
  • AccountRoot
 
    • 
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html b/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html
index a9eacc21..61848700 100644
--- a/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html
+++ b/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html
@@ -23,7 +23,7 @@ For submitting settings flags to the ledger, use AccountRootFlags instead.
    
 
      
 
    • AccountRootFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:81
    • 
 
    
 
    
 
    
@@ -31,25 +31,25 @@ For submitting settings flags to the ledger, use AccountRootFlags instead.
    
 
    
 
    
 
    Properties
    
-
    lsfDefaultRipple
-lsfDepositAuth
-lsfDisableMaster
-lsfDisallowXRP
-lsfGlobalFreeze
-lsfNoFreeze
-lsfPasswordSpent
-lsfRequireAuth
-lsfRequireDestTag
+
    lsfDefaultRipple?
+lsfDepositAuth?
+lsfDisableMaster?
+lsfDisallowXRP?
+lsfGlobalFreeze?
+lsfNoFreeze?
+lsfPasswordSpent?
+lsfRequireAuth?
+lsfRequireDestTag?
 
    
 
    
 
    Properties
    
 
    
 
    Optional lsfDefaultRipple
    
 
    lsfDefaultRipple?: boolean
    
-
    Enable rippling on this addresses's trust lines by default. Required for issuing addresses; discouraged for others.
    
+
    Enable rippling on this address's trust lines by default. Required for issuing addresses; discouraged for others.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:113
    • 
 
    
 
    Optional lsfDepositAuth
    
 
    lsfDepositAuth?: boolean
    
@@ -57,56 +57,56 @@ For submitting settings flags to the ledger, use AccountRootFlags instead.
    
 (It has DepositAuth enabled.)
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:118
    • 
 
    
 
    Optional lsfDisableMaster
    
 
    lsfDisableMaster?: boolean
    
 
    Disallows use of the master key to sign transactions for this account.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:101
    • 
 
    
 
    Optional lsfDisallowXRP
    
 
    lsfDisallowXRP?: boolean
    
 
    Client applications should not send XRP to this account. Not enforced by rippled.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:97
    • 
 
    
 
    Optional lsfGlobalFreeze
    
 
    lsfGlobalFreeze?: boolean
    
 
    All assets issued by this address are frozen.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:109
    • 
 
    
 
    Optional lsfNoFreeze
    
 
    lsfNoFreeze?: boolean
    
 
    This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:105
    • 
 
    
 
    Optional lsfPasswordSpent
    
 
    lsfPasswordSpent?: boolean
    
 
    The account has used its free SetRegularKey transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:85
    • 
 
    
 
    Optional lsfRequireAuth
    
 
    lsfRequireAuth?: boolean
    
 
    This account must individually approve other users for those users to hold this account's issued currencies.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:93
    • 
 
    
 
    Optional lsfRequireDestTag
    
 
    lsfRequireDestTag?: boolean
    
 
    Requires incoming payments to specify a Destination Tag.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:89
    • 
 
    
 
    
 
    
@@ -133,15 +133,15 @@ For submitting settings flags to the ledger, use AccountRootFlags instead.
    
 
    
+
  • lsfDefaultRipple?
    • 
+
  • lsfDepositAuth?
    • 
+
  • lsfDisableMaster?
    • 
+
  • lsfDisallowXRP?
    • 
+
  • lsfGlobalFreeze?
    • 
+
  • lsfNoFreeze?
    • 
+
  • lsfPasswordSpent?
    • 
+
  • lsfRequireAuth?
    • 
+
  • lsfRequireDestTag?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerEntry.Amendments.html b/docs/interfaces/LedgerEntry.Amendments.html
index 75883bda..aaffa4cf 100644
--- a/docs/interfaces/LedgerEntry.Amendments.html
+++ b/docs/interfaces/LedgerEntry.Amendments.html
@@ -25,7 +25,7 @@ active.
    
 
      
 
    • Amendments
    
+
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:21
    • 
 
    
 
    
 
    
@@ -33,10 +33,10 @@ active.
    
 
    
 
    
 
    Properties
    
-
    Amendments
+
    Amendments?
 Flags
 LedgerEntryType
-Majorities
+Majorities?
 index
 
    
 
    
@@ -48,7 +48,7 @@ active.
    
 omitted, there are no enabled amendments.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:27
    • 
 
    
 
    Flags
    
 
    Flags: 0
    
@@ -56,12 +56,12 @@ omitted, there are no enabled amendments.
    
 type, so this value is always 0.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:38
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "Amendments"
    
+
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:22
    • 
 
    
 
    Optional Majorities
    
 
    Majorities?: Majority[]
    
@@ -70,13 +70,13 @@ support but are not yet enabled. If omitted, there are no pending
 amendments with majority support.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:33
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
@@ -103,10 +103,10 @@ amendments with majority support.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/LedgerEntry.Check.html b/docs/interfaces/LedgerEntry.Check.html
index b2fe4d67..92f5f6a4 100644
--- a/docs/interfaces/LedgerEntry.Check.html
+++ b/docs/interfaces/LedgerEntry.Check.html
@@ -25,7 +25,7 @@ can be cashed by its destination to get money from its sender.
    
 
      
 
    • Check
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:11
    • 
 
    
 
    
 
    
@@ -35,18 +35,18 @@ can be cashed by its destination to get money from its sender.
    
 
    Properties
    
 
    Account
 Destination
-DestinationNode
-DestinationTag
-Expiration
+DestinationNode?
+DestinationTag?
+Expiration?
 Flags
-InvoiceID
+InvoiceID?
 LedgerEntryType
 OwnerNode
 PreviousTxnID
 PreviousTxnLgrSeq
 SendMax
 Sequence
-SourceTag
+SourceTag?
 index
 
    
 
    
@@ -57,7 +57,7 @@ can be cashed by its destination to get money from its sender.
    
 
    The sender of the Check. Cashing the Check debits this address's balance.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:14
    • 
 
    
 
    Destination
    
 
    Destination: string
    
@@ -65,7 +65,7 @@ can be cashed by its destination to get money from its sender.
    
 using a CheckCash transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:19
    • 
 
    
 
    Optional DestinationNode
    
 
    DestinationNode?: string
    
@@ -73,7 +73,7 @@ using a CheckCash transaction.
    
 this object, in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:52
    • 
 
    
 
    Optional DestinationTag
    
 
    DestinationTag?: number
    
@@ -81,14 +81,14 @@ this object, in case the directory consists of multiple pages.
    
 as a hosted recipient at the destination address.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:57
    • 
 
    
 
    Optional Expiration
    
 
    Expiration?: number
    
 
    Indicates the time after which this Check is considered expired.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:59
    • 
 
    
 
    Flags
    
 
    Flags: 0
    
@@ -96,7 +96,7 @@ as a hosted recipient at the destination address.
    
 is always 0.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:24
    • 
 
    
 
    Optional InvoiceID
    
 
    InvoiceID?: string
    
@@ -104,12 +104,12 @@ is always 0.
    
 identifier for this Check.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:64
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "Check"
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:12
    • 
 
    
 
    OwnerNode
    
 
    OwnerNode: string
    
@@ -117,7 +117,7 @@ identifier for this Check.
    
 object, in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:29
    • 
 
    
 
    PreviousTxnID
    
 
    PreviousTxnID: string
    
@@ -125,7 +125,7 @@ object, in case the directory consists of multiple pages.
    
 object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:34
    • 
 
    
 
    PreviousTxnLgrSeq
    
 
    PreviousTxnLgrSeq: number
    
@@ -133,7 +133,7 @@ object.
    
 modified this object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:39
    • 
 
    
 
    SendMax
    
 
    SendMax: Amount
    
@@ -142,14 +142,14 @@ Check is successfully cashed, the destination is credited in the same
 currency for up to this amount.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:45
    • 
 
    
 
    Sequence
    
 
    Sequence: number
    
 
    The sequence number of the CheckCreate transaction that created this check.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:47
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -157,13 +157,13 @@ currency for up to this amount.
    
 hosted recipient at the sender's address.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Check.ts:69
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
@@ -192,18 +192,18 @@ hosted recipient at the sender's address.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/LedgerEntry.DepositPreauth.html b/docs/interfaces/LedgerEntry.DepositPreauth.html
index 5a7936f4..809ddd96 100644
--- a/docs/interfaces/LedgerEntry.DepositPreauth.html
+++ b/docs/interfaces/LedgerEntry.DepositPreauth.html
@@ -25,7 +25,7 @@ another. DepositPreauth transactions create these objects.
    
 
      
 
    • DepositPreauth
    
+
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:9
    • 
 
    
 
    
 
    
@@ -50,14 +50,14 @@ another. DepositPreauth transactions create these objects.
    
 
    The account that granted the preauthorization.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:12
    • 
 
    
 
    Authorize
    
 
    Authorize: string
    
 
    The account that received the preauthorization.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:14
    • 
 
    
 
    Flags
    
 
    Flags: 0
    
@@ -65,12 +65,12 @@ another. DepositPreauth transactions create these objects.
    
 objects, so this value is always 0.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:19
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "DepositPreauth"
    
+
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:10
    • 
 
    
 
    OwnerNode
    
 
    OwnerNode: string
    
@@ -78,7 +78,7 @@ objects, so this value is always 0.
    
 object, in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:24
    • 
 
    
 
    PreviousTxnID
    
 
    PreviousTxnID: string
    
@@ -86,7 +86,7 @@ object, in case the directory consists of multiple pages.
    
 object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:29
    • 
 
    
 
    PreviousTxnLgrSeq
    
 
    PreviousTxnLgrSeq: number
    
@@ -94,13 +94,13 @@ object.
    
 modified this object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:34
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
diff --git a/docs/interfaces/LedgerEntry.DirectoryNode.html b/docs/interfaces/LedgerEntry.DirectoryNode.html
index ed9a506d..678f0145 100644
--- a/docs/interfaces/LedgerEntry.DirectoryNode.html
+++ b/docs/interfaces/LedgerEntry.DirectoryNode.html
@@ -25,7 +25,7 @@ the ledger's state tree.
    
 
      
 
    • DirectoryNode
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:9
    • 
 
    
 
    
 
    
@@ -34,16 +34,16 @@ the ledger's state tree.
    
 
    
 
    Properties
    
 
    Flags
-IndexNext
-IndexPrevious
+IndexNext?
+IndexPrevious?
 Indexes
 LedgerEntryType
-Owner
+Owner?
 RootIndex
-TakerGetsCurrency
-TakerGetsIssuer
-TakerPaysCurrency
-TakerPaysIssuer
+TakerGetsCurrency?
+TakerGetsIssuer?
+TakerPaysCurrency?
+TakerPaysIssuer?
 index
 
    
 
    
@@ -55,7 +55,7 @@ the ledger's state tree.
    
 protocol defines no flags for DirectoryNode objects.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:15
    • 
 
    
 
    Optional IndexNext
    
 
    IndexNext?: number
    
@@ -63,7 +63,7 @@ protocol defines no flags for DirectoryNode objects.
    
 object in the chain, wrapping around at the end.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:24
    • 
 
    
 
    Optional IndexPrevious
    
 
    IndexPrevious?: number
    
@@ -71,33 +71,33 @@ object in the chain, wrapping around at the end.
    
 previous object in the chain, wrapping around at the beginning.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:29
    • 
 
    
 
    Indexes
    
 
    Indexes: string[]
    
 
    The contents of this Directory: an array of IDs of other objects.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:19
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "DirectoryNode"
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:10
    • 
 
    
 
    Optional Owner
    
 
    Owner?: string
    
 
    The address of the account that owns the objects in this directory.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:31
    • 
 
    
 
    RootIndex
    
 
    RootIndex: string
    
 
    The ID of root object for this directory.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:17
    • 
 
    
 
    Optional TakerGetsCurrency
    
 
    TakerGetsCurrency?: string
    
@@ -105,14 +105,14 @@ previous object in the chain, wrapping around at the beginning.
    
 directory.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:43
    • 
 
    
 
    Optional TakerGetsIssuer
    
 
    TakerGetsIssuer?: string
    
 
    The issuer of the TakerGets amount from the offers in this directory.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:45
    • 
 
    
 
    Optional TakerPaysCurrency
    
 
    TakerPaysCurrency?: string
    
@@ -120,20 +120,20 @@ directory.
    
 directory.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:36
    • 
 
    
 
    Optional TakerPaysIssuer
    
 
    TakerPaysIssuer?: string
    
 
    The issuer of the TakerPays amount from the offers in this directory.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:38
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
@@ -161,16 +161,16 @@ directory.
    
 
  • DirectoryNode
 
    • 
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/LedgerEntry.Escrow.html b/docs/interfaces/LedgerEntry.Escrow.html
index 8bad4853..6caf35e4 100644
--- a/docs/interfaces/LedgerEntry.Escrow.html
+++ b/docs/interfaces/LedgerEntry.Escrow.html
@@ -25,7 +25,7 @@ executed or canceled.
    
 
      
 
    • Escrow
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:9
    • 
 
    
 
    
 
    
@@ -35,18 +35,18 @@ executed or canceled.
    
 
    Properties
    
 
    Account
 Amount
-CancelAfter
-Condition
+CancelAfter?
+Condition?
 Destination
-DestinationNode
-DestinationTag
-FinishAfter
+DestinationNode?
+DestinationTag?
+FinishAfter?
 Flags
 LedgerEntryType
 OwnerNode
 PreviousTxnID
 PreviousTxnLgrSeq
-SourceTag
+SourceTag?
 index
 
    
 
    
@@ -59,21 +59,21 @@ account that provided the XRP, and gets it back if the held payment is
 canceled.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:16
    • 
 
    
 
    Amount
    
 
    Amount: string
    
 
    The amount of XRP, in drops, to be delivered by the held payment.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:23
    • 
 
    
 
    Optional CancelAfter
    
 
    CancelAfter?: number
    
 
    The time after which this Escrow is considered expired.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:33
    • 
 
    
 
    Optional Condition
    
 
    Condition?: string
    
@@ -82,7 +82,7 @@ EscrowFinish transaction must contain a fulfillment that satisfies this
 condition.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:29
    • 
 
    
 
    Destination
    
 
    Destination: string
    
@@ -90,7 +90,7 @@ condition.
    
 successful.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:21
    • 
 
    
 
    Optional DestinationNode
    
 
    DestinationNode?: string
    
@@ -98,7 +98,7 @@ successful.
    
 this object, in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:63
    • 
 
    
 
    Optional DestinationTag
    
 
    DestinationTag?: number
    
@@ -106,7 +106,7 @@ this object, in case the directory consists of multiple pages.
    
 such as a hosted recipient at the destination address.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:53
    • 
 
    
 
    Optional FinishAfter
    
 
    FinishAfter?: number
    
@@ -114,7 +114,7 @@ such as a hosted recipient at the destination address.
    
 can be finished. Any EscrowFinish transaction before this time fails.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:38
    • 
 
    
 
    Flags
    
 
    Flags: number
    
@@ -122,12 +122,12 @@ can be finished. Any EscrowFinish transaction before this time fails.
    
 this value is always 0.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:43
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "Escrow"
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:10
    • 
 
    
 
    OwnerNode
    
 
    OwnerNode: string
    
@@ -135,7 +135,7 @@ this value is always 0.
    
 in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:58
    • 
 
    
 
    PreviousTxnID
    
 
    PreviousTxnID: string
    
@@ -143,7 +143,7 @@ in case the directory consists of multiple pages.
    
 object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:68
    • 
 
    
 
    PreviousTxnLgrSeq
    
 
    PreviousTxnLgrSeq: number
    
@@ -151,7 +151,7 @@ object.
    
 modified this object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:73
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -159,13 +159,13 @@ modified this object.
    
 as a hosted recipient at the owner's address.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:48
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
@@ -194,18 +194,18 @@ as a hosted recipient at the owner's address.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/LedgerEntry.FeeSettings.html b/docs/interfaces/LedgerEntry.FeeSettings.html
index 1a400f32..a0e6f372 100644
--- a/docs/interfaces/LedgerEntry.FeeSettings.html
+++ b/docs/interfaces/LedgerEntry.FeeSettings.html
@@ -25,7 +25,7 @@ reserve amounts as determined by fee voting.
    
 
      
 
    • FeeSettings
    
+
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:9
    • 
 
    
 
    
 
    
@@ -50,7 +50,7 @@ reserve amounts as determined by fee voting.
    
 hexadecimal.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:15
    • 
 
    
 
    Flags
    
 
    Flags: number
    
@@ -58,39 +58,39 @@ hexadecimal.
    
 type.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:26
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "FeeSettings"
    
+
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:10
    • 
 
    
 
    ReferenceFeeUnits
    
 
    ReferenceFeeUnits: number
    
 
    The BaseFee translated into "fee units".
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:17
    • 
 
    
 
    ReserveBase
    
 
    ReserveBase: number
    
 
    The base reserve for an account in the XRP Ledger, as drops of XRP.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:19
    • 
 
    
 
    ReserveIncrement
    
 
    ReserveIncrement: number
    
 
    The incremental owner reserve for owning objects, as drops of XRP.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:21
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
diff --git a/docs/interfaces/LedgerEntry.Ledger.html b/docs/interfaces/LedgerEntry.Ledger.html
index 5103a9ed..5be7754c 100644
--- a/docs/interfaces/LedgerEntry.Ledger.html
+++ b/docs/interfaces/LedgerEntry.Ledger.html
@@ -23,7 +23,7 @@ header that describes its contents using cryptographic hashes.
    
 
      
 
    • Ledger
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:11
    • 
 
    
 
    
 
    
@@ -31,7 +31,7 @@ header that describes its contents using cryptographic hashes.
    
 
    
 
    
 
    Properties
    
-
    accountState
+
    accountState?
 account_hash
 close_flags
 close_time
@@ -44,7 +44,7 @@ header that describes its contents using cryptographic hashes.
    
 parent_hash
 total_coins
 transaction_hash
-transactions
+transactions?
 
    
 
    
 
    Properties
    
@@ -54,21 +54,21 @@ header that describes its contents using cryptographic hashes.
    
 
    All the state information in this ledger.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:15
    • 
 
    
 
    account_hash
    
 
    account_hash: string
    
 
    The SHA-512Half of this ledger's state tree information.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:13
    • 
 
    
 
    close_flags
    
 
    close_flags: number
    
 
    A bit-map of flags relating to the closing of this ledger.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:17
    • 
 
    
 
    close_time
    
 
    close_time: number
    
@@ -77,7 +77,7 @@ since the Ripple Epoch of 2000-01-01 00:00:00. This value is rounded based
 on the close_time_resolution.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:23
    • 
 
    
 
    close_time_human
    
 
    close_time_human: string
    
@@ -85,7 +85,7 @@ on the close_time_resolution.
    
 Always uses the UTC time zone.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:28
    • 
 
    
 
    close_time_resolution
    
 
    close_time_resolution: number
    
@@ -93,14 +93,14 @@ Always uses the UTC time zone.
    
 by which the close_time could be rounded.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:33
    • 
 
    
 
    closed
    
 
    closed: boolean
    
 
    Whether or not this ledger has been closed.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:35
    • 
 
    
 
    ledger_hash
    
 
    ledger_hash: string
    
@@ -108,7 +108,7 @@ by which the close_time could be rounded.
    
 for this ledger and all its contents.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:40
    • 
 
    
 
    ledger_index
    
 
    ledger_index: string
    
@@ -116,14 +116,14 @@ for this ledger and all its contents.
    
 integer; some display it as a native JSON number.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:45
    • 
 
    
 
    parent_close_time
    
 
    parent_close_time: number
    
 
    The approximate time at which the previous ledger was closed.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:47
    • 
 
    
 
    parent_hash
    
 
    parent_hash: string
    
@@ -131,24 +131,24 @@ integer; some display it as a native JSON number.
    
 one.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:52
    • 
 
    
 
    total_coins
    
 
    total_coins: string
    
 
    Total number of XRP drops in the network, as a quoted integer.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:54
    • 
 
    
 
    transaction_hash
    
 
    transaction_hash: string
    
 
    Hash of the transaction information included in this ledger, as hex.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:56
    • 
 
    
 
    Optional transactions
    
-
    transactions?: (AccountDelete & { metaData?: TransactionMetadata } & AccountSet & { metaData?: TransactionMetadata } & CheckCancel & { metaData?: TransactionMetadata } & CheckCash & { metaData?: TransactionMetadata } & CheckCreate & { metaData?: TransactionMetadata } & DepositPreauth & { metaData?: TransactionMetadata } & EscrowCancel & { metaData?: TransactionMetadata } & EscrowCreate & { metaData?: TransactionMetadata } & EscrowFinish & { metaData?: TransactionMetadata } & NFTokenAcceptOffer & { metaData?: TransactionMetadata } & NFTokenBurn & { metaData?: TransactionMetadata } & NFTokenCancelOffer & { metaData?: TransactionMetadata } & NFTokenCreateOffer & { metaData?: TransactionMetadata } & NFTokenMint & { metaData?: TransactionMetadata } & OfferCancel & { metaData?: TransactionMetadata } & OfferCreate & { metaData?: TransactionMetadata } & Payment & { metaData?: TransactionMetadata } & PaymentChannelClaim & { metaData?: TransactionMetadata } & PaymentChannelCreate & { metaData?: TransactionMetadata } & PaymentChannelFund & { metaData?: TransactionMetadata } & SetRegularKey & { metaData?: TransactionMetadata } & SignerListSet & { metaData?: TransactionMetadata } & TicketCreate & { metaData?: TransactionMetadata } & TrustSet & { metaData?: TransactionMetadata })[]
    
+
    transactions?: Object[]
    
 
    Transactions applied in this ledger version. By default, members are the
 transactions' identifying Hash strings. If the request specified expand as
 true, members are full representations of the transactions instead, in
@@ -156,7 +156,7 @@ either JSON or binary depending on whether the request specified binary
 as true.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:64
    • 
 
    
 
    
 
    
@@ -183,7 +183,7 @@ as true.
    
 
    
+
  • transactions?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerEntry.LedgerHashes.html b/docs/interfaces/LedgerEntry.LedgerHashes.html
index c2de588a..8bcaeffc 100644
--- a/docs/interfaces/LedgerEntry.LedgerHashes.html
+++ b/docs/interfaces/LedgerEntry.LedgerHashes.html
@@ -26,7 +26,7 @@ a previous ledger version.
    
 
      
 
    • LedgerHashes
    
+
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:10
    • 
 
    
 
    
 
    
@@ -36,7 +36,7 @@ a previous ledger version.
    
 
    Properties
    
 
    Flags
 Hashes
-LastLedgerSequence
+LastLedgerSequence?
 LedgerEntryType
 index
 
    
@@ -49,7 +49,7 @@ a previous ledger version.
    
 type.
    
 
+
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:23
    • 
 
    
 
    Hashes
    
 
    Hashes: string[]
    
@@ -57,25 +57,25 @@ type.
    
 of LedgerHashes object this is.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:18
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
 
    The Ledger Index of the last entry in this object's Hashes array.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:13
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "LedgerHashes"
    
+
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:11
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
@@ -104,7 +104,7 @@ of LedgerHashes object this is.
    
 
    
 
    
diff --git a/docs/interfaces/LedgerEntry.NegativeUNL.html b/docs/interfaces/LedgerEntry.NegativeUNL.html
index 425c5724..1e18889e 100644
--- a/docs/interfaces/LedgerEntry.NegativeUNL.html
+++ b/docs/interfaces/LedgerEntry.NegativeUNL.html
@@ -25,7 +25,7 @@ a list of trusted validators currently believed to be offline.
    
 
      
 
    • NegativeUNL
    
+
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:14
    • 
 
    
 
    
 
    
@@ -33,10 +33,10 @@ a list of trusted validators currently believed to be offline.
    
 
    
 
    
 
    Properties
    
-
    DisabledValidators
+
    DisabledValidators?
 LedgerEntryType
-ValidatorToDisable
-ValidatorToReEnable
+ValidatorToDisable?
+ValidatorToReEnable?
 index
 
    
 
    
@@ -47,12 +47,12 @@ a list of trusted validators currently believed to be offline.
    
 
    A list of trusted validators that are currently disabled.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:19
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "NegativeUNL"
    
+
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:15
    • 
 
    
 
    Optional ValidatorToDisable
    
 
    ValidatorToDisable?: string
    
@@ -60,7 +60,7 @@ a list of trusted validators currently believed to be offline.
    
 the next flag ledger.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:24
    • 
 
    
 
    Optional ValidatorToReEnable
    
 
    ValidatorToReEnable?: string
    
@@ -68,13 +68,13 @@ the next flag ledger.
    
 scheduled to be re-enabled in the next flag ledger.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:29
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
@@ -101,10 +101,10 @@ scheduled to be re-enabled in the next flag ledger.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/LedgerEntry.Offer.html b/docs/interfaces/LedgerEntry.Offer.html
index 38271ba4..4ac8f683 100644
--- a/docs/interfaces/LedgerEntry.Offer.html
+++ b/docs/interfaces/LedgerEntry.Offer.html
@@ -23,7 +23,7 @@
 
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:5
    • 
 
    
 
    
 
    
@@ -34,7 +34,7 @@
 
    Account
 BookDirectory
 BookNode
-Expiration
+Expiration?
 Flags
 LedgerEntryType
 OwnerNode
@@ -53,14 +53,14 @@
 
    The address of the account that placed this Offer.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:10
    • 
 
    
 
    BookDirectory
    
 
    BookDirectory: string
    
 
    The ID of the Offer Directory that links to this Offer.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:24
    • 
 
    
 
    BookNode
    
 
    BookNode: string
    
@@ -68,26 +68,26 @@
 in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:29
    • 
 
    
 
    Optional Expiration
    
 
    Expiration?: number
    
 
    The time this Offer expires, in seconds since the Ripple Epoch.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:46
    • 
 
    
 
    Flags
    
 
    Flags: number
    
 
    A bit-map of boolean flags enabled for this Offer.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:8
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "Offer"
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:6
    • 
 
    
 
    OwnerNode
    
 
    OwnerNode: string
    
@@ -95,7 +95,7 @@ in case the directory consists of multiple pages.
    
 in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:34
    • 
 
    
 
    PreviousTxnID
    
 
    PreviousTxnID: string
    
@@ -103,7 +103,7 @@ in case the directory consists of multiple pages.
    
 object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:39
    • 
 
    
 
    PreviousTxnLgrSeq
    
 
    PreviousTxnLgrSeq: number
    
@@ -111,7 +111,7 @@ object.
    
 modified this object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:44
    • 
 
    
 
    Sequence
    
 
    Sequence: number
    
@@ -119,7 +119,7 @@ modified this object.
    
 object. Used in combination with the Account to identify this Offer.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:15
    • 
 
    
 
    TakerGets
    
 
    TakerGets: Amount
    
@@ -127,20 +127,20 @@ object. Used in combination with the Account to identify this Offer.
    
 creator.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:22
    • 
 
    
 
    TakerPays
    
 
    TakerPays: Amount
    
 
    The remaining amount and type of currency requested by the Offer creator.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:17
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
@@ -170,7 +170,7 @@ creator.
    
 
  • Account
    • 
 
  • BookDirectory
    • 
 
  • BookNode
    • 
-
  • Expiration
    • 
+
  • Expiration?
    • 
 
  • Flags
    • 
 
  • LedgerEntryType
    • 
 
  • OwnerNode
    • 
diff --git a/docs/interfaces/LedgerEntry.PayChannel.html b/docs/interfaces/LedgerEntry.PayChannel.html
index 2696bb8a..1fb9545c 100644
--- a/docs/interfaces/LedgerEntry.PayChannel.html
+++ b/docs/interfaces/LedgerEntry.PayChannel.html
@@ -28,7 +28,7 @@ closed.
    
 
      
 
    • PayChannel
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:12
    • 
 
    
 
    
 
    
@@ -39,11 +39,11 @@ closed.
    
 
    Account
 Amount
 Balance
-CancelAfter
+CancelAfter?
 Destination
-DestinationNode
-DestinationTag
-Expiration
+DestinationNode?
+DestinationTag?
+Expiration?
 Flags
 LedgerEntryType
 OwnerNode
@@ -51,7 +51,7 @@ closed.
    
 PreviousTxnLgrSeq
 PublicKey
 SettleDelay
-SourceTag
+SourceTag?
 index
 
    
 
    
@@ -63,7 +63,7 @@ closed.
    
 sending address of the transaction that created the channel.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:18
    • 
 
    
 
    Amount
    
 
    Amount: string
    
@@ -73,7 +73,7 @@ initially set by the transaction that created the channel and can be
 increased if the source address sends a PaymentChannelFund transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:32
    • 
 
    
 
    Balance
    
 
    Balance: string
    
@@ -83,7 +83,7 @@ to the destination address with PaymentChannelClaim transactions. If the
 channel closes, the remaining difference is returned to the source address.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:39
    • 
 
    
 
    Optional CancelAfter
    
 
    CancelAfter?: number
    
@@ -93,7 +93,7 @@ smaller than the previous ledger's close_time field. This is optionally
 set by the transaction that created the channel, and cannot be changed.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:91
    • 
 
    
 
    Destination
    
 
    Destination: string
    
@@ -103,7 +103,7 @@ channel. This comes from the Destination field of the transaction that
 created the channel.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:25
    • 
 
    
 
    Optional DestinationNode
    
 
    DestinationNode?: string
    
@@ -111,7 +111,7 @@ created the channel.
    
 this object, in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:106
    • 
 
    
 
    Optional DestinationTag
    
 
    DestinationTag?: number
    
@@ -119,7 +119,7 @@ this object, in case the directory consists of multiple pages.
    
 channel, such as a hosted recipient at the destination address.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:101
    • 
 
    
 
    Optional Expiration
    
 
    Expiration?: number
    
@@ -129,7 +129,7 @@ than the previous ledger's close_time field. See Setting Channel Expiration
 for more details.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:84
    • 
 
    
 
    Flags
    
 
    Flags: number
    
@@ -137,12 +137,12 @@ for more details.
    
 the protocol defines no flags for PayChannel objects.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:77
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "PayChannel"
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:13
    • 
 
    
 
    OwnerNode
    
 
    OwnerNode: string
    
@@ -150,7 +150,7 @@ the protocol defines no flags for PayChannel objects.
    
 to this object, in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:62
    • 
 
    
 
    PreviousTxnID
    
 
    PreviousTxnID: string
    
@@ -158,7 +158,7 @@ to this object, in case the directory consists of multiple pages.
    
 object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:67
    • 
 
    
 
    PreviousTxnLgrSeq
    
 
    PreviousTxnLgrSeq: number
    
@@ -166,7 +166,7 @@ object.
    
 modified this object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:72
    • 
 
    
 
    PublicKey
    
 
    PublicKey: string
    
@@ -178,7 +178,7 @@ source address can also send XRP from this channel to the destination
 without signed claims.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:48
    • 
 
    
 
    SettleDelay
    
 
    SettleDelay: number
    
@@ -190,7 +190,7 @@ address requests to close the channel. Can be any value that fits in a
 creates the channel.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:57
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -198,13 +198,13 @@ creates the channel.
    
 useful for specifying a hosted recipient at the owner's address.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:96
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
@@ -234,11 +234,11 @@ useful for specifying a hosted recipient at the owner's address.
    
 
  • Account
    • 
 
  • Amount
    • 
 
  • Balance
    • 
-
  • CancelAfter
    • 
+
  • CancelAfter?
    • 
 
  • Destination
    • 
-
  • DestinationNode
    • 
-
  • DestinationTag
    • 
-
  • Expiration
    • 
+
  • DestinationNode?
    • 
+
  • DestinationTag?
    • 
+
  • Expiration?
    • 
 
  • Flags
    • 
 
  • LedgerEntryType
    • 
 
  • OwnerNode
    • 
@@ -246,7 +246,7 @@ useful for specifying a hosted recipient at the owner's address.
    
 
  • PreviousTxnLgrSeq
    • 
 
  • PublicKey
    • 
 
  • SettleDelay
    • 
-
  • SourceTag
    • 
+
  • SourceTag?
    • 
 
  • index
    • 
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/LedgerEntry.RippleState.html b/docs/interfaces/LedgerEntry.RippleState.html
index 23709e5e..469fc8ef 100644
--- a/docs/interfaces/LedgerEntry.RippleState.html
+++ b/docs/interfaces/LedgerEntry.RippleState.html
@@ -24,7 +24,7 @@
 
      
 
    • RippleState
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:10
    • 
 
    
 
    
 
    
@@ -35,14 +35,14 @@
 
    Balance
 Flags
 HighLimit
-HighNode
-HighQualityIn
-HighQualityOut
+HighNode?
+HighQualityIn?
+HighQualityOut?
 LedgerEntryType
 LowLimit
-LowNode
-LowQualityIn
-LowQualityOut
+LowNode?
+LowQualityIn?
+LowQualityOut?
 PreviousTxnID
 PreviousTxnLgrSeq
 index
@@ -57,14 +57,14 @@ negative balance indicates that the low account has issued currency to the
 high account. The issuer is always the neutral value ACCOUNT_ONE.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:19
    • 
 
    
 
    Flags
    
 
    Flags: number
    
 
    A bit-map of boolean options enabled for this object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:13
    • 
 
    
 
    HighLimit
    
 
    HighLimit: IssuedCurrencyAmount
    
@@ -72,7 +72,7 @@ high account. The issuer is always the neutral value ACCOUNT_ONE.
    
 the address of the high account that set this limit.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:29
    • 
 
    
 
    Optional HighNode
    
 
    HighNode?: string
    
@@ -80,7 +80,7 @@ the address of the high account that set this limit.
    
 to this object, in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:49
    • 
 
    
 
    Optional HighQualityIn
    
 
    HighQualityIn?: number
    
@@ -89,7 +89,7 @@ ratio HighQualityIn:1,000,000,000. As a special case, the value 0 is
 equivalent to 1 billion, or face value.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:67
    • 
 
    
 
    Optional HighQualityOut
    
 
    HighQualityOut?: number
    
@@ -98,12 +98,12 @@ ratio HighQualityOut:1,000,000,000. As a special case, the value 0 is
 equivalent to 1 billion, or face value.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:73
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "RippleState"
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:11
    • 
 
    
 
    LowLimit
    
 
    LowLimit: IssuedCurrencyAmount
    
@@ -111,7 +111,7 @@ equivalent to 1 billion, or face value.
    
 the address of the low account that set this limit.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:24
    • 
 
    
 
    Optional LowNode
    
 
    LowNode?: string
    
@@ -119,7 +119,7 @@ the address of the low account that set this limit.
    
 this object, in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:44
    • 
 
    
 
    Optional LowQualityIn
    
 
    LowQualityIn?: number
    
@@ -128,7 +128,7 @@ ratio LowQualityIn:1,000,000,000. As a special case, the value 0 is
 equivalent to 1 billion, or face value.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:55
    • 
 
    
 
    Optional LowQualityOut
    
 
    LowQualityOut?: number
    
@@ -137,7 +137,7 @@ ratio LowQualityOut:1,000,000,000. As a special case, the value 0 is
 equivalent to 1 billion, or face value.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:61
    • 
 
    
 
    PreviousTxnID
    
 
    PreviousTxnID: string
    
@@ -145,7 +145,7 @@ equivalent to 1 billion, or face value.
    
 object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:34
    • 
 
    
 
    PreviousTxnLgrSeq
    
 
    PreviousTxnLgrSeq: number
    
@@ -153,13 +153,13 @@ object.
    
 modified this object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:39
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
@@ -189,14 +189,14 @@ modified this object.
    
 
  • Balance
    • 
 
  • Flags
    • 
 
  • HighLimit
    • 
-
  • HighNode
    • 
-
  • HighQualityIn
    • 
-
  • HighQualityOut
    • 
+
  • HighNode?
    • 
+
  • HighQualityIn?
    • 
+
  • HighQualityOut?
    • 
 
  • LedgerEntryType
    • 
 
  • LowLimit
    • 
-
  • LowNode
    • 
-
  • LowQualityIn
    • 
-
  • LowQualityOut
    • 
+
  • LowNode?
    • 
+
  • LowQualityIn?
    • 
+
  • LowQualityOut?
    • 
 
  • PreviousTxnID
    • 
 
  • PreviousTxnLgrSeq
    • 
 
  • index
    • 
diff --git a/docs/interfaces/LedgerEntry.SignerList.html b/docs/interfaces/LedgerEntry.SignerList.html
index e1271b88..3e15fb4d 100644
--- a/docs/interfaces/LedgerEntry.SignerList.html
+++ b/docs/interfaces/LedgerEntry.SignerList.html
@@ -27,7 +27,7 @@ transaction.
    
 
      
 
    • SignerList
    
+
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:18
    • 
 
    
 
    
 
    
@@ -54,12 +54,12 @@ transaction.
    
 information, see SignerList Flags.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:24
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "SignerList"
    
+
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:19
    • 
 
    
 
    OwnerNode
    
 
    OwnerNode: string
    
@@ -67,7 +67,7 @@ information, see SignerList Flags.
    
 in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:39
    • 
 
    
 
    PreviousTxnID
    
 
    PreviousTxnID: string
    
@@ -75,7 +75,7 @@ in case the directory consists of multiple pages.
    
 object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:29
    • 
 
    
 
    PreviousTxnLgrSeq
    
 
    PreviousTxnLgrSeq: number
    
@@ -83,7 +83,7 @@ object.
    
 modified this object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:34
    • 
 
    
 
    SignerEntries
    
 
    SignerEntries: SignerEntry[]
    
@@ -91,7 +91,7 @@ modified this object.
    
 this signer list.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:44
    • 
 
    
 
    SignerListID
    
 
    SignerListID: number
    
@@ -99,7 +99,7 @@ this signer list.
    
 amendment allows multiple signer lists for an account, this may change.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:49
    • 
 
    
 
    SignerQuorum
    
 
    SignerQuorum: number
    
@@ -108,13 +108,13 @@ owner of this SignerList, the signers must provide valid signatures whose
 weights sum to this value or more.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:55
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
diff --git a/docs/interfaces/LedgerEntry.Ticket.html b/docs/interfaces/LedgerEntry.Ticket.html
index f2087577..50b721a2 100644
--- a/docs/interfaces/LedgerEntry.Ticket.html
+++ b/docs/interfaces/LedgerEntry.Ticket.html
@@ -26,7 +26,7 @@ with a TicketCreate transaction.
    
 
      
 
    • Ticket
    
+
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:10
    • 
 
    
 
    
 
    
@@ -51,7 +51,7 @@ with a TicketCreate transaction.
    
 
    The account that owns this Ticket.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:13
    • 
 
    
 
    Flags
    
 
    Flags: number
    
@@ -59,12 +59,12 @@ with a TicketCreate transaction.
    
 no flags defined for Tickets.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:18
    • 
 
    
 
    LedgerEntryType
    
 
    LedgerEntryType: "Ticket"
    
+
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:11
    • 
 
    
 
    OwnerNode
    
 
    OwnerNode: string
    
@@ -72,7 +72,7 @@ no flags defined for Tickets.
    
 in case the directory consists of multiple pages.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:23
    • 
 
    
 
    PreviousTxnID
    
 
    PreviousTxnID: string
    
@@ -80,7 +80,7 @@ in case the directory consists of multiple pages.
    
 object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:28
    • 
 
    
 
    PreviousTxnLgrSeq
    
 
    PreviousTxnLgrSeq: number
    
@@ -88,20 +88,20 @@ object.
    
 modified this object.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:33
    • 
 
    
 
    TicketSequence
    
 
    TicketSequence: number
    
 
    The Sequence Number this Ticket sets aside.
    
 
    
+
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:35
    • 
 
    
 
    index
    
 
    index: string
    
+
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • 
 
    
 
    
 
    
diff --git a/docs/interfaces/LedgerEntryRequest.html b/docs/interfaces/LedgerEntryRequest.html
index 8a3a55dc..445b9a9a 100644
--- a/docs/interfaces/LedgerEntryRequest.html
+++ b/docs/interfaces/LedgerEntryRequest.html
@@ -17,7 +17,7 @@
 
    The ledger_entry method returns a single ledger object from the XRP Ledger
 in its raw format. Expects a response in the form of a LedgerEntryResponse.
    
 
-
    Example
    const ledgerEntry: LedgerEntryRequest = {
      command: "ledger_entry",
      ledger_index: 60102302,
      index: "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4"
    }
+
    Example
    const ledgerEntry: LedgerEntryRequest = {
      command: "ledger_entry",
      ledger_index: 60102302,
      index: "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4"
    }
 
    
 
    
 
    
@@ -27,7 +27,7 @@ in its raw format. Expects a response in the form of a 
 
  • LedgerEntryRequest
    • 
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:22
    • 
 
    
 
    
 
    
@@ -35,22 +35,22 @@ in its raw format. Expects a response in the form of a 
 
    
 
    Properties
    
-
    account_root
-api_version
-binary
-check
+
    account_root?
+api_version?
+binary?
+check?
 command
-deposit_preauth
-directory
-escrow
-id
-index
-ledger_hash
-ledger_index
-offer
-payment_channel
-ripple_state
-ticket
+deposit_preauth?
+directory?
+escrow?
+id?
+index?
+ledger_hash?
+ledger_index?
+offer?
+payment_channel?
+ripple_state?
+ticket?
 
    
 
    
 
    Properties
    
@@ -61,7 +61,7 @@ in its raw format. Expects a response in the form of a AccountInfoRequest.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:47
    • 
 
    
 
    Optional api_version
    
 
    api_version?: number
    
@@ -69,7 +69,7 @@ to the an AccountInfoRequest.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    Optional binary
    
 
    binary?: boolean
    
@@ -78,46 +78,46 @@ the XRP Ledger's binary format. Otherwise, return data in JSON format. The
 default is false.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:29
    • 
 
    
 
    Optional check
    
 
    check?: string
    
 
    The object ID of a Check object to retrieve.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:95
    • 
 
    
 
    command
    
 
    command: "ledger_entry"
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:23
    • 
 
    
 
    Optional deposit_preauth
    
-
    deposit_preauth?: string | { authorized: string; owner: string }
    
+
    deposit_preauth?: string | { 
        authorized: string; 
        owner: string; 
    }
    
 
    Specify a DepositPreauth object to retrieve. If a string, must be the
 object ID of the DepositPreauth object, as hexadecimal. If an object,
 requires owner and authorized sub-fields.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:118
    • 
 
    
 
    Optional directory
    
-
    directory?: string | { dir_root?: string; owner?: string; sub_index?: number }
    
+
    directory?: string | { 
        dir_root?: string; 
        owner?: string; 
        sub_index?: number; 
    }
    
 
    The DirectoryNode to retrieve. If a string, must be the object ID of the
 directory, as hexadecimal. If an object, requires either dir_root o
 Owner as a sub-field, plus optionally a sub_index sub-field.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:54
    • 
 
    
 
    Optional escrow
    
-
    escrow?: string | { owner: string; seq: number }
    
+
    escrow?: string | { 
        owner: string; 
        seq: number; 
    }
    
 
    The Escrow object to retrieve. If a string, must be the object ID of the
 escrow, as hexadecimal. If an object, requires owner and seq sub-fields.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:101
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -127,45 +127,45 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional index
    
 
    index?: string
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:41
    • 
 
    
 
    Optional ledger_hash
    
 
    ledger_hash?: string
    
 
    A 20-byte hex string for the ledger version to use.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:31
    • 
 
    
 
    Optional ledger_index
    
 
    ledger_index?: LedgerIndex
    
 
    The ledger index of the ledger to use, or a shortcut string.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:33
    • 
 
    
 
    Optional offer
    
-
    offer?: string | { account: string; seq: number }
    
+
    offer?: string | { 
        account: string; 
        seq: number; 
    }
    
 
    The Offer object to retrieve. If a string, interpret as the unique object
 ID to the Offer. If an object, requires the sub-fields account and seq
 to uniquely identify the offer.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:70
    • 
 
    
 
    Optional payment_channel
    
 
    payment_channel?: string
    
 
    The object ID of a PayChannel object to retrieve.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:111
    • 
 
    
 
    Optional ripple_state
    
-
    ripple_state?: { accounts: string[]; currency: string }
    
+
    ripple_state?: { 
        accounts: string[]; 
        currency: string; 
    }
    
 
    Object specifying the RippleState (trust line) object to retrieve. The
 accounts and currency sub-fields are required to uniquely specify the
 rippleState entry to retrieve.
    
@@ -183,16 +183,16 @@ this RippleState object.
    
 
    Currency Code of the RippleState object to retrieve.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:84
    • 
 
    
 
    Optional ticket
    
-
    ticket?: string | { owner: string; ticket_sequence: number }
    
+
    ticket?: string | { 
        owner: string; 
        ticket_sequence: number; 
    }
    
 
    The Ticket object to retrieve. If a string, must be the object ID of the
 Ticket, as hexadecimal. If an object, the owner and ticket_sequence
 sub-fields are required to uniquely specify the Ticket entry.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:132
    • 
 
    
 
    
 
    
@@ -219,22 +219,22 @@ sub-fields are required to uniquely specify the Ticket entry.
    
 
    
+
  • deposit_preauth?
    • 
+
  • directory?
    • 
+
  • escrow?
    • 
+
  • id?
    • 
+
  • index?
    • 
+
  • ledger_hash?
    • 
+
  • ledger_index?
    • 
+
  • offer?
    • 
+
  • payment_channel?
    • 
+
  • ripple_state?
    • 
+
  • ticket?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerEntryResponse.html b/docs/interfaces/LedgerEntryResponse.html
index 487c8135..e252e038 100644
--- a/docs/interfaces/LedgerEntryResponse.html
+++ b/docs/interfaces/LedgerEntryResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • LedgerEntryResponse
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:147
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { index: string; ledger_current_index: number; node?: LedgerEntry; node_binary?: string; validated?: boolean }
    
+
    result: { 
        index: string; 
        ledger_current_index: number; 
        node?: LedgerEntry; 
        node_binary?: string; 
        validated?: boolean; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -87,31 +87,31 @@ ledger format.
      
 
      Optional validated?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:148
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -138,14 +138,14 @@ ledger format.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerRequest.html b/docs/interfaces/LedgerRequest.html
index cfc01c57..93a1dec9 100644
--- a/docs/interfaces/LedgerRequest.html
+++ b/docs/interfaces/LedgerRequest.html
@@ -17,7 +17,7 @@
 
    Retrieve information about the public ledger. Expects a response in the form
 of a LedgerResponse.
    
 
-
    Example
    const ledger: LedgerRequest = {
     "id": 14,
     "command": "ledger",
     "ledger_index": "validated",
     "full": false,
     "accounts": false,
     "transactions": false,
     "expand": false,
     "owner_funds": false
    }
+
    Example
    const ledger: LedgerRequest = {
     "id": 14,
     "command": "ledger",
     "ledger_index": "validated",
     "full": false,
     "accounts": false,
     "transactions": false,
     "expand": false,
     "owner_funds": false
    }
 
    
 
    
 
    
@@ -27,7 +27,7 @@ of a LedgerResponse.
    
 
      
 
    • LedgerRequest
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:28
    • 
 
    
 
    
 
    
@@ -35,18 +35,18 @@ of a LedgerResponse.
    
 
    
 
    
 
    Properties
    
-
    accounts
-api_version
-binary
+
    accounts?
+api_version?
+binary?
 command
-expand
-full
-id
-ledger_hash
-ledger_index
-owner_funds
-queue
-transactions
+expand?
+full?
+id?
+ledger_hash?
+ledger_index?
+owner_funds?
+queue?
+transactions?
 
    
 
    
 
    Properties
    
@@ -57,7 +57,7 @@ of a LedgerResponse.
    
 Ignored if you did not specify a ledger version. Defaults to false.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:46
    • 
 
    
 
    Optional api_version
    
 
    api_version?: number
    
@@ -65,7 +65,7 @@ Ignored if you did not specify a ledger version. Defaults to false.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    Optional binary
    
 
    binary?: boolean
    
@@ -74,13 +74,13 @@ transaction information in binary format (hexadecimal string) instead of
 JSON format.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:70
    • 
 
    
 
    command
    
 
    command: "ledger"
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:29
    • 
 
    
 
    Optional expand
    
 
    expand?: boolean
    
@@ -89,7 +89,7 @@ information instead of only hashes. Defaults to false. Ignored unless you
 request transactions, accounts, or both.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:58
    • 
 
    
 
    Optional full
    
 
    full?: boolean
    
@@ -97,7 +97,7 @@ request transactions, accounts, or both.
    
 Ignored if you did not specify a ledger version. Defaults to false.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:41
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -107,14 +107,14 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional ledger_hash
    
 
    ledger_hash?: string
    
 
    A 20-byte hex string for the ledger version to use.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:31
    • 
 
    
 
    Optional ledger_index
    
 
    ledger_index?: LedgerIndex
    
@@ -122,7 +122,7 @@ know which request prompted which response.
    
 ledger automatically.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:36
    • 
 
    
 
    Optional owner_funds
    
 
    owner_funds?: boolean
    
@@ -131,7 +131,7 @@ transactions in the response. Defaults to false. Ignored unless
 transactions are included and expand is true.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:64
    • 
 
    
 
    Optional queue
    
 
    queue?: boolean
    
@@ -139,7 +139,7 @@ transactions are included and expand is true.
    
 array of queued transactions in the results.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:75
    • 
 
    
 
    Optional transactions
    
 
    transactions?: boolean
    
@@ -148,7 +148,7 @@ version. Defaults to false. Ignored if you did not specify a ledger
 version.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:52
    • 
 
    
 
    
 
    
@@ -175,18 +175,18 @@ version.
    
 
    
+
  • expand?
    • 
+
  • full?
    • 
+
  • id?
    • 
+
  • ledger_hash?
    • 
+
  • ledger_index?
    • 
+
  • owner_funds?
    • 
+
  • queue?
    • 
+
  • transactions?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerResponse.html b/docs/interfaces/LedgerResponse.html
index 8be28986..9d517ab6 100644
--- a/docs/interfaces/LedgerResponse.html
+++ b/docs/interfaces/LedgerResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • LedgerResponse
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:113
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { ledger: Ledger | BinaryLedger; ledger_hash: string; ledger_index: number; queue_data?: (string | LedgerQueueData)[]; validated?: boolean }
    
+
    result: { 
        ledger: Ledger | BinaryLedger; 
        ledger_hash: string; 
        ledger_index: number; 
        queue_data?: (string | LedgerQueueData)[]; 
        validated?: boolean; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -92,31 +92,31 @@ on whether the request specified binary as true.
      
 
    
+
  • Defined in packages/xrpl/src/models/methods/ledger.ts:114
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -143,14 +143,14 @@ on whether the request specified binary as true.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/LedgerStream.html b/docs/interfaces/LedgerStream.html
index 672d6b39..a23a0e3d 100644
--- a/docs/interfaces/LedgerStream.html
+++ b/docs/interfaces/LedgerStream.html
@@ -25,7 +25,7 @@ And provides some information about its contents.
    
 
      
 
    • LedgerStream
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:97
    • 
 
    
 
    
 
    
@@ -42,7 +42,7 @@ And provides some information about its contents.
    
 reserve_inc
 txn_count
 type
-validated_ledgers
+validated_ledgers?
 
    
 
    
 
    Properties
    
@@ -54,35 +54,35 @@ If this ledger version includes a SetFee pseudo-transaction the new.
 Transaction cost applies starting with the following ledger version.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:104
    • 
 
    
 
    fee_ref
    
 
    fee_ref: number
    
 
    The reference transaction cost in "fee units".
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:106
    • 
 
    
 
    ledger_hash
    
 
    ledger_hash: string
    
 
    The identifying hash of the ledger version that was closed.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:108
    • 
 
    
 
    ledger_index
    
 
    ledger_index: number
    
 
    The ledger index of the ledger that was closed.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:110
    • 
 
    
 
    ledger_time
    
 
    ledger_time: number
    
 
    The time this ledger was closed, in seconds since the Ripple Epoch.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:112
    • 
 
    
 
    reserve_base
    
 
    reserve_base: number
    
@@ -91,7 +91,7 @@ this ledger version includes a SetFee pseudo-transaction the new base reserve
 applies starting with the following ledger version.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:118
    • 
 
    
 
    reserve_inc
    
 
    reserve_inc: number
    
@@ -100,20 +100,20 @@ of XRP. If the ledger includes a SetFee pseudo-transaction the new owner
 reserve applies after this ledger.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:124
    • 
 
    
 
    txn_count
    
 
    txn_count: number
    
 
    Number of new transactions included in this ledger version.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:126
    • 
 
    
 
    type
    
 
    type: "ledgerClosed"
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:98
    • 
 
    
 
    Optional validated_ledgers
    
 
    validated_ledgers?: string
    
@@ -123,7 +123,7 @@ returned if the server is not connected to the network, or if it is
 connected but has not yet obtained a ledger from the network.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:133
    • 
 
    
 
    
 
    
@@ -159,7 +159,7 @@ connected but has not yet obtained a ledger from the network.
    
 
  • reserve_inc
    • 
 
  • txn_count
    • 
 
  • type
    • 
-
  • validated_ledgers
    • 
+
  • validated_ledgers?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/ManifestRequest.html b/docs/interfaces/ManifestRequest.html
index 6333bbee..fd0f24e5 100644
--- a/docs/interfaces/ManifestRequest.html
+++ b/docs/interfaces/ManifestRequest.html
@@ -18,7 +18,7 @@
 validator public key. The "manifest" is the public portion of that
 validator's configured token. Expects a response in the form of a ManifestResponse.
    
 
-
    Example
    const manifest: ManifestRequest = {
     "command": "manifest",
     "public_key": "nHUFE9prPXPrHcG3SkwP1UzAQbSphqyQkQK9ATXLZsfkezhhda3p"
    }
+
    Example
    const manifest: ManifestRequest = {
     "command": "manifest",
     "public_key": "nHUFE9prPXPrHcG3SkwP1UzAQbSphqyQkQK9ATXLZsfkezhhda3p"
    }
 
    
 
 
    
@@ -28,7 +28,7 @@ validator's configured token. Expects a response in the form of a 
 
  • ManifestRequest
    • 
+
  • Defined in packages/xrpl/src/models/methods/manifest.ts:19
    • 
 
    
 
    
 
    
@@ -36,9 +36,9 @@ validator's configured token. Expects a response in the form of a 
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 public_key
 
    
 
    
@@ -50,13 +50,13 @@ validator's configured token. Expects a response in the form of a 
 
    Inherited from BaseRequest.api_version
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "manifest"
    
+
  • Defined in packages/xrpl/src/models/methods/manifest.ts:20
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -66,7 +66,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    public_key
    
 
    public_key: string
    
@@ -74,7 +74,7 @@ know which request prompted which response.
    
 master public key or ephemeral public key.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/manifest.ts:25
    • 
 
    
 
    
 
    
@@ -101,9 +101,9 @@ master public key or ephemeral public key.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/ManifestResponse.html b/docs/interfaces/ManifestResponse.html
index 9e371d95..5e1bc385 100644
--- a/docs/interfaces/ManifestResponse.html
+++ b/docs/interfaces/ManifestResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • ManifestResponse
    
+
  • Defined in packages/xrpl/src/models/methods/manifest.ts:33
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,27 +47,27 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { details?: { domain: string; ephemeral_key: string; master_key: string; seq: number }; manifest?: string; requested: string }
    
+
    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 }
      
+
      Optional details?: { 
          domain: string; 
          ephemeral_key: string; 
          master_key: string; 
          seq: number; 
      }
      
 
      The data contained in this manifest. Omitted if the server does not have
  A manifest for the public_key from the request.
      
 
      
@@ -92,31 +92,31 @@ manifest for the public_key from the request.
      
 
    
+
  • Defined in packages/xrpl/src/models/methods/manifest.ts:34
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -143,14 +143,14 @@ manifest for the public_key from the request.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NFTBuyOffersRequest.html b/docs/interfaces/NFTBuyOffersRequest.html
index f7aedc47..f957b1c4 100644
--- a/docs/interfaces/NFTBuyOffersRequest.html
+++ b/docs/interfaces/NFTBuyOffersRequest.html
@@ -24,7 +24,7 @@ NFToken.
    
 
      
 
    • NFTBuyOffersRequest
    
+
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:11
    • 
 
    
 
    
 
    
@@ -32,9 +32,9 @@ NFToken.
    
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 nft_id
 
    
 
    
@@ -46,13 +46,13 @@ NFToken.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "nft_buy_offers"
    
+
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:12
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -62,14 +62,14 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    nft_id
    
 
    nft_id: string
    
 
    The unique identifier of an NFToken. The request returns buy offers for this NFToken.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:16
    • 
 
    
 
    
 
    
@@ -96,9 +96,9 @@ know which request prompted which response.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/NFTBuyOffersResponse.html b/docs/interfaces/NFTBuyOffersResponse.html
index ffbb38d0..7c8780b9 100644
--- a/docs/interfaces/NFTBuyOffersResponse.html
+++ b/docs/interfaces/NFTBuyOffersResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • NFTBuyOffersResponse
    
+
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:24
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { nft_id: string; offers: NFTOffer[] }
    
+
    result: { 
        nft_id: string; 
        offers: NFTOffer[]; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -76,31 +76,31 @@
 
    
+
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:25
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -127,14 +127,14 @@
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NFTSellOffersRequest.html b/docs/interfaces/NFTSellOffersRequest.html
index de04837a..a27d07d9 100644
--- a/docs/interfaces/NFTSellOffersRequest.html
+++ b/docs/interfaces/NFTSellOffersRequest.html
@@ -24,7 +24,7 @@ NFToken.
    
 
      
 
    • NFTSellOffersRequest
    
+
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:11
    • 
 
    
 
    
 
    
@@ -32,9 +32,9 @@ NFToken.
    
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 nft_id
 
    
 
    
@@ -46,13 +46,13 @@ NFToken.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "nft_sell_offers"
    
+
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:12
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -62,14 +62,14 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    nft_id
    
 
    nft_id: string
    
 
    The unique identifier of an NFToken. The request returns sell offers for this NFToken.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:16
    • 
 
    
 
    
 
    
@@ -96,9 +96,9 @@ know which request prompted which response.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/NFTSellOffersResponse.html b/docs/interfaces/NFTSellOffersResponse.html
index 77494635..097e5dc7 100644
--- a/docs/interfaces/NFTSellOffersResponse.html
+++ b/docs/interfaces/NFTSellOffersResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • NFTSellOffersResponse
    
+
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:24
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { nft_id: string; offers: NFTOffer[] }
    
+
    result: { 
        nft_id: string; 
        offers: NFTOffer[]; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -76,31 +76,31 @@
 
    
+
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:25
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -127,14 +127,14 @@
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NFTokenAcceptOffer.html b/docs/interfaces/NFTokenAcceptOffer.html
index 339c48a7..993f7175 100644
--- a/docs/interfaces/NFTokenAcceptOffer.html
+++ b/docs/interfaces/NFTokenAcceptOffer.html
@@ -36,7 +36,7 @@ called brokered mode.
 
      
 
    • NFTokenAcceptOffer
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:26
    • 
 
    
 
    
 
    
@@ -45,21 +45,21 @@ called brokered mode.
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Fee
-Flags
-LastLedgerSequence
-Memos
-NFTokenBrokerFee
-NFTokenBuyOffer
-NFTokenSellOffer
-Sequence
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+AccountTxnID?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
+NFTokenBrokerFee?
+NFTokenBuyOffer?
+NFTokenSellOffer?
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -70,7 +70,7 @@ called brokered mode.
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -80,7 +80,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -90,7 +90,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | GlobalFlags
    
@@ -98,7 +98,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:123
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -108,7 +108,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -116,7 +116,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    Optional NFTokenBrokerFee
    
 
    NFTokenBrokerFee?: Amount
    
@@ -138,7 +138,7 @@ and NFTokenSellOffer must both specify the same NFTokenID; that is,
 both must be for the same NFToken.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:64
    • 
 
    
 
    Optional NFTokenBuyOffer
    
 
    NFTokenBuyOffer?: string
    
@@ -148,7 +148,7 @@ NFTokenBuyOffer must be specified. In brokered mode, both NFTokenSellOffer
 and NFTokenBuyOffer must be specified.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:43
    • 
 
    
 
    Optional NFTokenSellOffer
    
 
    NFTokenSellOffer?: string
    
@@ -158,7 +158,7 @@ and NFTokenBuyOffer must be specified.
    
  and NFTokenBuyOffer must be specified.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:35
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -169,7 +169,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -178,7 +178,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -188,7 +188,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -199,7 +199,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -208,13 +208,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "NFTokenAcceptOffer"
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:27
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -223,7 +223,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -251,21 +251,21 @@ account it says it is from.
    
 
  • NFTokenAcceptOffer
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NFTokenBurn.html b/docs/interfaces/NFTokenBurn.html
index 21ba286b..3d376e7b 100644
--- a/docs/interfaces/NFTokenBurn.html
+++ b/docs/interfaces/NFTokenBurn.html
@@ -29,7 +29,7 @@ is reduced by one.
    
 
      
 
    • NFTokenBurn
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:15
    • 
 
    
 
    
 
    
@@ -38,20 +38,20 @@ is reduced by one.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Fee
-Flags
-LastLedgerSequence
-Memos
+AccountTxnID?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
 NFTokenID
-Owner
-Sequence
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+Owner?
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -65,7 +65,7 @@ issuer, i.e. MintAccount.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:23
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -75,7 +75,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -85,7 +85,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | GlobalFlags
    
@@ -93,7 +93,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:123
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -103,7 +103,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -111,14 +111,14 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    NFTokenID
    
 
    NFTokenID: string
    
 
    Identifies the NFToken object to be removed by the transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:27
    • 
 
    
 
    Optional Owner
    
 
    Owner?: string
    
@@ -127,7 +127,7 @@ Account. Only used to burn tokens which have the lsfBurnable flag enabled
 and are not owned by the signing account.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:33
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -138,7 +138,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -147,7 +147,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -157,7 +157,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -168,7 +168,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -177,13 +177,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "NFTokenBurn"
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:16
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -192,7 +192,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -220,20 +220,20 @@ account it says it is from.
    
 
  • NFTokenBurn
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NFTokenCancelOffer.html b/docs/interfaces/NFTokenCancelOffer.html
index 8526cfca..3eb7d93b 100644
--- a/docs/interfaces/NFTokenCancelOffer.html
+++ b/docs/interfaces/NFTokenCancelOffer.html
@@ -29,7 +29,7 @@ the NFTokenOffer has already expired.
    
 
      
 
    • NFTokenCancelOffer
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCancelOffer.ts:15
    • 
 
    
 
    
 
    
@@ -38,19 +38,19 @@ the NFTokenOffer has already expired.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Fee
-Flags
-LastLedgerSequence
-Memos
+AccountTxnID?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
 NFTokenOffers
-Sequence
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -61,7 +61,7 @@ the NFTokenOffer has already expired.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -71,7 +71,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -81,7 +81,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | GlobalFlags
    
@@ -89,7 +89,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:123
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -99,7 +99,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -107,7 +107,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    NFTokenOffers
    
 
    NFTokenOffers: string[]
    
@@ -119,7 +119,7 @@ error if an entry in this list points to an object that
 does not exist. This field is required.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCancelOffer.ts:26
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -130,7 +130,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -139,7 +139,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -149,7 +149,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -160,7 +160,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -169,13 +169,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "NFTokenCancelOffer"
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCancelOffer.ts:16
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -184,7 +184,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -212,19 +212,19 @@ account it says it is from.
    
 
  • NFTokenCancelOffer
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NFTokenCreateOffer.html b/docs/interfaces/NFTokenCreateOffer.html
index 3671c363..9f1acb7c 100644
--- a/docs/interfaces/NFTokenCreateOffer.html
+++ b/docs/interfaces/NFTokenCreateOffer.html
@@ -25,7 +25,7 @@ the submitting account does own.
    
 
      
 
    • NFTokenCreateOffer
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:41
    • 
 
    
 
    
 
    
@@ -34,23 +34,23 @@ the submitting account does own.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
+AccountTxnID?
 Amount
-Destination
-Expiration
-Fee
-Flags
-LastLedgerSequence
-Memos
+Destination?
+Expiration?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
 NFTokenID
-Owner
-Sequence
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+Owner?
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -61,7 +61,7 @@ the submitting account does own.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -71,7 +71,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Amount
    
 
    Amount: Amount
    
@@ -82,7 +82,7 @@ owner of the token is giving it away free, either to anyone at all,
 or to the account identified by the Destination field.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:56
    • 
 
    
 
    Optional Destination
    
 
    Destination?: string
    
@@ -91,7 +91,7 @@ accepted by the specified account. Attempts by other
 accounts to accept this offer MUST fail.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:82
    • 
 
    
 
    Optional Expiration
    
 
    Expiration?: number
    
@@ -100,7 +100,7 @@ be valid. The value is the number of seconds since the
 Ripple Epoch.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:76
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -110,13 +110,13 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | NFTokenCreateOfferFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:83
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -126,7 +126,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -134,7 +134,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    NFTokenID
    
 
    NFTokenID: string
    
@@ -142,7 +142,7 @@ validated or rejected.
    
 offer references.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:47
    • 
 
    
 
    Optional Owner
    
 
    Owner?: string
    
@@ -157,7 +157,7 @@ present, as the owner is, implicitly, the same as Account
 is meaningless).
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:70
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -168,7 +168,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -177,7 +177,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -187,7 +187,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -198,7 +198,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -207,13 +207,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "NFTokenCreateOffer"
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:42
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -222,7 +222,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -250,23 +250,23 @@ account it says it is from.
    
 
  • NFTokenCreateOffer
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NFTokenCreateOfferFlagsInterface.html b/docs/interfaces/NFTokenCreateOfferFlagsInterface.html
index 571e1a28..a6406430 100644
--- a/docs/interfaces/NFTokenCreateOfferFlagsInterface.html
+++ b/docs/interfaces/NFTokenCreateOfferFlagsInterface.html
@@ -24,7 +24,7 @@ flags.
    
 
      
 
    • NFTokenCreateOfferFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:32
    • 
 
    
 
    
 
    
@@ -32,7 +32,7 @@ flags.
    
 
    
 
    
 
    Properties
    
-
    tfSellNFToken
+
    tfSellNFToken?
 
    
 
    
 
    Properties
    
@@ -40,7 +40,7 @@ flags.
    
 
    Optional tfSellNFToken
    
 
    tfSellNFToken?: boolean
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:33
    • 
 
    
 
    
 
    
@@ -67,7 +67,7 @@ flags.
    
 
    
+
  • tfSellNFToken?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NFTokenMint.html b/docs/interfaces/NFTokenMint.html
index 25a50139..a9b9365f 100644
--- a/docs/interfaces/NFTokenMint.html
+++ b/docs/interfaces/NFTokenMint.html
@@ -26,7 +26,7 @@ specified by the transaction.
    
 
      
 
    • NFTokenMint
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:54
    • 
 
    
 
    
 
    
@@ -35,22 +35,22 @@ specified by the transaction.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Fee
-Flags
-Issuer
-LastLedgerSequence
-Memos
+AccountTxnID?
+Fee?
+Flags?
+Issuer?
+LastLedgerSequence?
+Memos?
 NFTokenTaxon
-Sequence
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TransferFee
-TxnSignature
-URI
+TransferFee?
+TxnSignature?
+URI?
 
    
 
    
 
    Properties
    
@@ -61,7 +61,7 @@ specified by the transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -71,7 +71,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -81,13 +81,13 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | NFTokenMintFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:91
    • 
 
    
 
    Optional Issuer
    
 
    Issuer?: string
    
@@ -98,7 +98,7 @@ present, the MintAccount field in the AccountRoot of t
 field must match the Account, otherwise the transaction will fail.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:71
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -108,7 +108,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -116,7 +116,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    NFTokenTaxon
    
 
    NFTokenTaxon: number
    
@@ -127,7 +127,7 @@ than or equal to 2147483648 (0x80000000). If you have no use for this
 field, set it to 0.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:63
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -138,7 +138,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -147,7 +147,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -157,7 +157,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -168,7 +168,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -177,13 +177,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "NFTokenMint"
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:55
    • 
 
    
 
    Optional TransferFee
    
 
    TransferFee?: number
    
@@ -194,7 +194,7 @@ increments of 0.001%. This field must NOT be present if the
 tfTransferable flag is not set.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:79
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -203,7 +203,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    Optional URI
    
 
    URI?: string
    
@@ -216,7 +216,7 @@ the field is limited to a maximum length of 256 bytes.
    
 convert this field to the proper encoding.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:90
    • 
 
    
 
    
 
    
@@ -244,22 +244,22 @@ convert this field to the proper encoding.
    
 
  • NFTokenMint
 
    • 
+
  • TransferFee?
    • 
+
  • TxnSignature?
    • 
+
  • URI?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NFTokenMintFlagsInterface.html b/docs/interfaces/NFTokenMintFlagsInterface.html
index dabe1a18..b5d16112 100644
--- a/docs/interfaces/NFTokenMintFlagsInterface.html
+++ b/docs/interfaces/NFTokenMintFlagsInterface.html
@@ -24,7 +24,7 @@ flags.
    
 
      
 
    • NFTokenMintFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:41
    • 
 
    
 
    
 
    
@@ -32,10 +32,10 @@ flags.
    
 
    
 
    
 
    Properties
    
-
    tfBurnable
-tfOnlyXRP
-tfTransferable
-tfTrustLine
+
    tfBurnable?
+tfOnlyXRP?
+tfTransferable?
+tfTrustLine?
 
    
 
    
 
    Properties
    
@@ -43,22 +43,22 @@ flags.
    
 
    Optional tfBurnable
    
 
    tfBurnable?: boolean
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:42
    • 
 
    
 
    Optional tfOnlyXRP
    
 
    tfOnlyXRP?: boolean
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:43
    • 
 
    
 
    Optional tfTransferable
    
 
    tfTransferable?: boolean
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:45
    • 
 
    
 
    Optional tfTrustLine
    
 
    tfTrustLine?: boolean
    
+
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:44
    • 
 
    
 
    
 
    
@@ -85,10 +85,10 @@ flags.
    
 
    
+
  • tfBurnable?
    • 
+
  • tfOnlyXRP?
    • 
+
  • tfTransferable?
    • 
+
  • tfTrustLine?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NoRippleCheckRequest.html b/docs/interfaces/NoRippleCheckRequest.html
index 89537758..d46a60c5 100644
--- a/docs/interfaces/NoRippleCheckRequest.html
+++ b/docs/interfaces/NoRippleCheckRequest.html
@@ -19,7 +19,7 @@ default ripple field for an account and the No Ripple flag of its trust
 lines, compared with the recommended settings. Expects a response in the form
 of an NoRippleCheckResponse.
    
 
-
    Example
    const noRipple: NoRippleCheckRequest = {
      "id": 0,
      "command": "noripple_check",
      "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
       "role": "gateway",
      "ledger_index": "current",
      "limit": 2,
      "transactions": true
    }
+
    Example
    const noRipple: NoRippleCheckRequest = {
      "id": 0,
      "command": "noripple_check",
      "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
       "role": "gateway",
      "ledger_index": "current",
      "limit": 2,
      "transactions": true
    }
 
    
 
 
    
@@ -29,7 +29,7 @@ of an NoRippleCheckResponse.
    
 
      
 
    • NoRippleCheckRequest
    
+
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:27
    • 
 
    
 
    
 
    
@@ -38,14 +38,14 @@ of an NoRippleCheckResponse.
    
 
    
 
    Properties
    
 
    account
-api_version
+api_version?
 command
-id
-ledger_hash
-ledger_index
-limit
+id?
+ledger_hash?
+ledger_index?
+limit?
 role
-transactions
+transactions?
 
    
 
    
 
    Properties
    
@@ -55,7 +55,7 @@ of an NoRippleCheckResponse.
    
 
    A unique identifier for the account, most commonly the account's address.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:30
    • 
 
    
 
    Optional api_version
    
 
    api_version?: number
    
@@ -63,13 +63,13 @@ of an NoRippleCheckResponse.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "noripple_check"
    
+
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:28
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -79,14 +79,14 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional ledger_hash
    
 
    ledger_hash?: string
    
 
    A 20-byte hex string for the ledger version to use.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:49
    • 
 
    
 
    Optional ledger_index
    
 
    ledger_index?: LedgerIndex
    
@@ -94,7 +94,7 @@ know which request prompted which response.
    
 ledger automatically.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:54
    • 
 
    
 
    Optional limit
    
 
    limit?: number
    
@@ -102,7 +102,7 @@ ledger automatically.
    
 Defaults to 300.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:47
    • 
 
    
 
    role
    
 
    role: "gateway" | "user"
    
@@ -112,7 +112,7 @@ disable No Ripple on all trust lines. Users should have Default Ripple
 disabled, and should enable No Ripple on all trust lines.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:37
    • 
 
    
 
    Optional transactions
    
 
    transactions?: boolean
    
@@ -120,7 +120,7 @@ disabled, and should enable No Ripple on all trust lines.
    
 that you can sign and submit to fix the problems. Defaults to false.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:42
    • 
 
    
 
    
 
    
@@ -148,14 +148,14 @@ that you can sign and submit to fix the problems. Defaults to false.
    
 
  • NoRippleCheckRequest
 
    • 
+
  • transactions?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/NoRippleCheckResponse.html b/docs/interfaces/NoRippleCheckResponse.html
index 60e3c821..eb44d5ff 100644
--- a/docs/interfaces/NoRippleCheckResponse.html
+++ b/docs/interfaces/NoRippleCheckResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • NoRippleCheckResponse
    
+
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:62
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { ledger_current_index: number; problems: string[]; transactions: (AccountDelete & ResponseOnlyTxInfo & AccountSet & ResponseOnlyTxInfo & CheckCancel & ResponseOnlyTxInfo & CheckCash & ResponseOnlyTxInfo & CheckCreate & ResponseOnlyTxInfo & DepositPreauth & ResponseOnlyTxInfo & EscrowCancel & ResponseOnlyTxInfo & EscrowCreate & ResponseOnlyTxInfo & EscrowFinish & ResponseOnlyTxInfo & NFTokenAcceptOffer & ResponseOnlyTxInfo & NFTokenBurn & ResponseOnlyTxInfo & NFTokenCancelOffer & ResponseOnlyTxInfo & NFTokenCreateOffer & ResponseOnlyTxInfo & NFTokenMint & ResponseOnlyTxInfo & OfferCancel & ResponseOnlyTxInfo & OfferCreate & ResponseOnlyTxInfo & Payment & ResponseOnlyTxInfo & PaymentChannelClaim & ResponseOnlyTxInfo & PaymentChannelCreate & ResponseOnlyTxInfo & PaymentChannelFund & ResponseOnlyTxInfo & SetRegularKey & ResponseOnlyTxInfo & SignerListSet & ResponseOnlyTxInfo & TicketCreate & ResponseOnlyTxInfo & TrustSet & ResponseOnlyTxInfo)[] }
    
+
    result: { 
        ledger_current_index: number; 
        problems: string[]; 
        transactions: Object[]; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -78,7 +78,7 @@ not as recommended, plus up to limit entries for trust lines whose no
 ripple setting is not as recommended.
      
 
    
 
  • 
-
    transactions: (AccountDelete & ResponseOnlyTxInfo & AccountSet & ResponseOnlyTxInfo & CheckCancel & ResponseOnlyTxInfo & CheckCash & ResponseOnlyTxInfo & CheckCreate & ResponseOnlyTxInfo & DepositPreauth & ResponseOnlyTxInfo & EscrowCancel & ResponseOnlyTxInfo & EscrowCreate & ResponseOnlyTxInfo & EscrowFinish & ResponseOnlyTxInfo & NFTokenAcceptOffer & ResponseOnlyTxInfo & NFTokenBurn & ResponseOnlyTxInfo & NFTokenCancelOffer & ResponseOnlyTxInfo & NFTokenCreateOffer & ResponseOnlyTxInfo & NFTokenMint & ResponseOnlyTxInfo & OfferCancel & ResponseOnlyTxInfo & OfferCreate & ResponseOnlyTxInfo & Payment & ResponseOnlyTxInfo & PaymentChannelClaim & ResponseOnlyTxInfo & PaymentChannelCreate & ResponseOnlyTxInfo & PaymentChannelFund & ResponseOnlyTxInfo & SetRegularKey & ResponseOnlyTxInfo & SignerListSet & ResponseOnlyTxInfo & TicketCreate & ResponseOnlyTxInfo & TrustSet & ResponseOnlyTxInfo)[]
    
+
    transactions: Object[]
    
 
    If the request specified transactions as true, this is an array of JSON
 objects, each of which is the JSON form of a transaction that should fix
 one of the described problems. The length of this array is the same as
@@ -87,31 +87,31 @@ described at the same index into that array.
    
 
    • 
+
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:63
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -138,14 +138,14 @@ described at the same index into that array.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/OfferCancel.html b/docs/interfaces/OfferCancel.html
index 24976e99..99e9b9a8 100644
--- a/docs/interfaces/OfferCancel.html
+++ b/docs/interfaces/OfferCancel.html
@@ -23,7 +23,7 @@
 
      
 
    • OfferCancel
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCancel.ts:10
    • 
 
    
 
    
 
    
@@ -32,19 +32,19 @@
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Fee
-Flags
-LastLedgerSequence
-Memos
+AccountTxnID?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
 OfferSequence
-Sequence
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -55,7 +55,7 @@
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -65,7 +65,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -75,7 +75,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | GlobalFlags
    
@@ -83,7 +83,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:123
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -93,7 +93,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -101,7 +101,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    OfferSequence
    
 
    OfferSequence: number
    
@@ -111,7 +111,7 @@ created by that transaction. It is not considered an error if the offer.
 specified does not exist.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCancel.ts:18
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -122,7 +122,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -131,7 +131,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -141,7 +141,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -152,7 +152,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -161,13 +161,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "OfferCancel"
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCancel.ts:11
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -176,7 +176,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -204,19 +204,19 @@ account it says it is from.
    
 
  • OfferCancel
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/OfferCreate.html b/docs/interfaces/OfferCreate.html
index 5296832c..772dea04 100644
--- a/docs/interfaces/OfferCreate.html
+++ b/docs/interfaces/OfferCreate.html
@@ -25,7 +25,7 @@ Fulfilled when placed. Offers can be partially fulfilled.
    
 
      
 
    • OfferCreate
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:96
    • 
 
    
 
    
 
    
@@ -34,22 +34,22 @@ Fulfilled when placed. Offers can be partially fulfilled.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Expiration
-Fee
-Flags
-LastLedgerSequence
-Memos
-OfferSequence
-Sequence
-Signers
-SigningPubKey
-SourceTag
+AccountTxnID?
+Expiration?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
+OfferSequence?
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
 TakerGets
 TakerPays
-TicketSequence
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -60,7 +60,7 @@ Fulfilled when placed. Offers can be partially fulfilled.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -70,7 +70,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Expiration
    
 
    Expiration?: number
    
@@ -78,7 +78,7 @@ the provided hash.
    
 Ripple Epoch.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:103
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -88,13 +88,13 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | OfferCreateFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:98
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -104,7 +104,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -112,14 +112,14 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    Optional OfferSequence
    
 
    OfferSequence?: number
    
 
    An offer to delete first, specified in the same way as OfferCancel.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:105
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -130,7 +130,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -139,7 +139,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -149,7 +149,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -160,21 +160,21 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    TakerGets
    
 
    TakerGets: Amount
    
 
    The amount and type of currency being provided by the offer creator.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:107
    • 
 
    
 
    TakerPays
    
 
    TakerPays: Amount
    
 
    The amount and type of currency being requested by the offer creator.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:109
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -183,13 +183,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "OfferCreate"
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:97
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -198,7 +198,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -226,22 +226,22 @@ account it says it is from.
    
 
  • OfferCreate
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/OfferCreateFlagsInterface.html b/docs/interfaces/OfferCreateFlagsInterface.html
index d6d24b7a..41ef2d8c 100644
--- a/docs/interfaces/OfferCreateFlagsInterface.html
+++ b/docs/interfaces/OfferCreateFlagsInterface.html
@@ -17,7 +17,7 @@
 
    Map of flags to boolean values representing OfferCreate transaction
 flags.
    
 
-
    Example
    const tx: OfferCreate = {
    Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
    TakerGets: '43000.51',
    TakerPays: '12928290425',
    TransactionType: 'OfferCreate',
    Flags: {
      tfPassive: true,
      tfFillOrKill: true,
     },
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(tx)
    console.log(autofilledTx)
    // {
    // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
    // TakerGets: '43000.51',
    // TakerPays: '12928290425',
    // TransactionType: 'OfferCreate',
    // Flags: 327680,
    // Sequence: 21970384,
    // Fee: '12',
    // LastLedgerSequence: 21970404
    // }
+
    Example
    const tx: OfferCreate = {
    Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
    TakerGets: '43000.51',
    TakerPays: '12928290425',
    TransactionType: 'OfferCreate',
    Flags: {
      tfPassive: true,
      tfFillOrKill: true,
     },
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(tx)
    console.log(autofilledTx)
    // {
    // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
    // TakerGets: '43000.51',
    // TakerPays: '12928290425',
    // TransactionType: 'OfferCreate',
    // Flags: 327680,
    // Sequence: 21970384,
    // Fee: '12',
    // LastLedgerSequence: 21970404
    // }
 
    
 
    
 
    
@@ -27,7 +27,7 @@ flags.
    
 
      
 
    • OfferCreateFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:82
    • 
 
    
 
    
 
    
@@ -35,10 +35,10 @@ flags.
    
 
    
 
    
 
    Properties
    
-
    tfFillOrKill
-tfImmediateOrCancel
-tfPassive
-tfSell
+
    tfFillOrKill?
+tfImmediateOrCancel?
+tfPassive?
+tfSell?
 
    
 
    
 
    Properties
    
@@ -46,22 +46,22 @@ flags.
    
 
    Optional tfFillOrKill
    
 
    tfFillOrKill?: boolean
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:85
    • 
 
    
 
    Optional tfImmediateOrCancel
    
 
    tfImmediateOrCancel?: boolean
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:84
    • 
 
    
 
    Optional tfPassive
    
 
    tfPassive?: boolean
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:83
    • 
 
    
 
    Optional tfSell
    
 
    tfSell?: boolean
    
+
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:86
    • 
 
    
 
    
 
    
@@ -88,10 +88,10 @@ flags.
    
 
    
+
  • tfFillOrKill?
    • 
+
  • tfImmediateOrCancel?
    • 
+
  • tfPassive?
    • 
+
  • tfSell?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/OrderBookStream.html b/docs/interfaces/OrderBookStream.html
index 175ed145..2ae6187b 100644
--- a/docs/interfaces/OrderBookStream.html
+++ b/docs/interfaces/OrderBookStream.html
@@ -26,7 +26,7 @@ field.
    
 
      
 
    • OrderBookStream
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:335
    • 
 
    
 
    
 
    
@@ -37,9 +37,9 @@ field.
    
 
    engine_result
 engine_result_code
 engine_result_message
-ledger_current_index
-ledger_hash
-ledger_index
+ledger_current_index?
+ledger_hash?
+ledger_index?
 meta
 status
 transaction
@@ -52,58 +52,58 @@ field.
    
 
    engine_result
    
 
    engine_result: string
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:338
    • 
 
    
 
    engine_result_code
    
 
    engine_result_code: number
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:339
    • 
 
    
 
    engine_result_message
    
 
    engine_result_message: string
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:340
    • 
 
    
 
    Optional ledger_current_index
    
 
    ledger_current_index?: number
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:341
    • 
 
    
 
    Optional ledger_hash
    
 
    ledger_hash?: string
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:342
    • 
 
    
 
    Optional ledger_index
    
 
    ledger_index?: number
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:343
    • 
 
    
 
    meta
    
 
    meta: TransactionMetadata
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:344
    • 
 
    
 
    status
    
 
    status: string
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:336
    • 
 
    
 
    transaction
    
-
    transaction: AccountDelete & { date?: number; hash?: string } & AccountSet & { date?: number; hash?: string } & CheckCancel & { date?: number; hash?: string } & CheckCash & { date?: number; hash?: string } & CheckCreate & { date?: number; hash?: string } & DepositPreauth & { date?: number; hash?: string } & EscrowCancel & { date?: number; hash?: string } & EscrowCreate & { date?: number; hash?: string } & EscrowFinish & { date?: number; hash?: string } & NFTokenAcceptOffer & { date?: number; hash?: string } & NFTokenBurn & { date?: number; hash?: string } & NFTokenCancelOffer & { date?: number; hash?: string } & NFTokenCreateOffer & { date?: number; hash?: string } & NFTokenMint & { date?: number; hash?: string } & OfferCancel & { date?: number; hash?: string } & OfferCreate & { date?: number; hash?: string } & Payment & { date?: number; hash?: string } & PaymentChannelClaim & { date?: number; hash?: string } & PaymentChannelCreate & { date?: number; hash?: string } & PaymentChannelFund & { date?: number; hash?: string } & SetRegularKey & { date?: number; hash?: string } & SignerListSet & { date?: number; hash?: string } & TicketCreate & { date?: number; hash?: string } & TrustSet & { date?: number; hash?: string } & ModifiedOfferCreateTransaction & { date?: number; hash?: string }
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:345
    • 
 
    
 
    type
    
 
    type: "transaction"
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:337
    • 
 
    
 
    validated
    
 
    validated: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:356
    • 
 
    
 
    
 
    
@@ -133,9 +133,9 @@ field.
    
 
  • engine_result
    • 
 
  • engine_result_code
    • 
 
  • engine_result_message
    • 
-
  • ledger_current_index
    • 
-
  • ledger_hash
    • 
-
  • ledger_index
    • 
+
  • ledger_current_index?
    • 
+
  • ledger_hash?
    • 
+
  • ledger_index?
    • 
 
  • meta
    • 
 
  • status
    • 
 
  • transaction
    • 
diff --git a/docs/interfaces/PathFindCloseRequest.html b/docs/interfaces/PathFindCloseRequest.html
index 11964853..18f731d9 100644
--- a/docs/interfaces/PathFindCloseRequest.html
+++ b/docs/interfaces/PathFindCloseRequest.html
@@ -23,7 +23,7 @@
 
      
 
    • PathFindCloseRequest
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:36
    • 
 
    
 
    
 
    
@@ -31,9 +31,9 @@
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 subcommand
 
    
 
    
@@ -45,13 +45,13 @@
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "path_find"
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:6
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -61,13 +61,13 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    subcommand
    
 
    subcommand: "close"
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:37
    • 
 
    
 
    
 
    
@@ -94,9 +94,9 @@ know which request prompted which response.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/PathFindCreateRequest.html b/docs/interfaces/PathFindCreateRequest.html
index 7f8087e0..0a86e6fd 100644
--- a/docs/interfaces/PathFindCreateRequest.html
+++ b/docs/interfaces/PathFindCreateRequest.html
@@ -23,7 +23,7 @@
 
      
 
    • PathFindCreateRequest
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:11
    • 
 
    
 
    
 
    
@@ -31,13 +31,13 @@
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
 destination_account
 destination_amount
-id
-paths
-send_max
+id?
+paths?
+send_max?
 source_account
 subcommand
 
    
@@ -50,20 +50,20 @@
 
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "path_find"
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:6
    • 
 
    
 
    destination_account
    
 
    destination_account: string
    
 
    Unique address of the account to find a path to.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:19
    • 
 
    
 
    destination_amount
    
 
    destination_amount: Amount
    
@@ -71,7 +71,7 @@
 transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:24
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -81,7 +81,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional paths
    
 
    paths?: Path[]
    
@@ -90,14 +90,14 @@ use this to keep updated on changes to particular paths you already know
 about, or to check the overall cost to make a payment along a certain path.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:32
    • 
 
    
 
    Optional send_max
    
 
    send_max?: Amount
    
 
    Currency amount that would be spent in the transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:26
    • 
 
    
 
    source_account
    
 
    source_account: string
    
@@ -105,13 +105,13 @@ about, or to check the overall cost to make a payment along a certain path.
    
 Account that would be sending a payment.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:17
    • 
 
    
 
    subcommand
    
 
    subcommand: "create"
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:12
    • 
 
    
 
    
 
    
@@ -138,13 +138,13 @@ Account that would be sending a payment.
    
 
    
 
    
diff --git a/docs/interfaces/PathFindResponse.html b/docs/interfaces/PathFindResponse.html
index 1768182e..3e5b5e99 100644
--- a/docs/interfaces/PathFindResponse.html
+++ b/docs/interfaces/PathFindResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • PathFindResponse
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:73
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { alternatives: PathOption[]; closed?: true; destination_account: string; destination_amount: Amount; full_reply: boolean; id?: string | number; source_account: string; status?: true }
    
+
    result: { 
        alternatives: PathOption[]; 
        closed?: true; 
        destination_account: string; 
        destination_amount: Amount; 
        full_reply: boolean; 
        id?: string | number; 
        source_account: string; 
        status?: true; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -109,31 +109,31 @@ status command.
      
 
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:74
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -160,14 +160,14 @@ status command.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/PathFindStatusRequest.html b/docs/interfaces/PathFindStatusRequest.html
index 30331731..7019b75a 100644
--- a/docs/interfaces/PathFindStatusRequest.html
+++ b/docs/interfaces/PathFindStatusRequest.html
@@ -23,7 +23,7 @@
 
      
 
    • PathFindStatusRequest
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:41
    • 
 
    
 
    
 
    
@@ -31,9 +31,9 @@
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 subcommand
 
    
 
    
@@ -45,13 +45,13 @@
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "path_find"
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:6
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -61,13 +61,13 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    subcommand
    
 
    subcommand: "status"
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:42
    • 
 
    
 
    
 
    
@@ -94,9 +94,9 @@ know which request prompted which response.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/PathFindStream.html b/docs/interfaces/PathFindStream.html
index b774d721..ebbd5ff9 100644
--- a/docs/interfaces/PathFindStream.html
+++ b/docs/interfaces/PathFindStream.html
@@ -25,7 +25,7 @@ time.
    
 
      
 
    • PathFindStream
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:382
    • 
 
    
 
    
 
    
@@ -38,7 +38,7 @@ time.
    
 destination_amount
 full_reply
 id
-send_max
+send_max?
 source_account
 type
 
    
@@ -46,26 +46,26 @@ time.
    
 
    Properties
    
 
    
 
    alternatives
    
-
    alternatives: [] | { paths_computed: Path[]; source_amount: Amount }
    
+
    alternatives: [] | { 
        paths_computed: Path[]; 
        source_amount: Amount; 
    }
    
 
    Array of objects with suggested paths to take. If empty, then no paths
 were found connecting the source and destination accounts.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:406
    • 
 
    
 
    destination_account
    
 
    destination_account: string
    
 
    Unique address of the account that would receive a transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:387
    • 
 
    
 
    destination_amount
    
 
    destination_amount: Amount
    
 
    Currency Amount that the destination would receive in a transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:389
    • 
 
    
 
    full_reply
    
 
    full_reply: boolean
    
@@ -76,34 +76,34 @@ find it.) Until you close the pathfinding request, rippled continues to
 send updates each time a new ledger closes.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:397
    • 
 
    
 
    id
    
 
    id: string | number
    
 
    The ID provided in the WebSocket request is included again at this level.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:399
    • 
 
    
 
    Optional send_max
    
 
    send_max?: Amount
    
 
    Currency Amount that would be spent in the transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:401
    • 
 
    
 
    source_account
    
 
    source_account: string
    
 
    Unique address that would send a transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:385
    • 
 
    
 
    type
    
 
    type: "path_find"
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:383
    • 
 
    
 
    
 
    
@@ -135,7 +135,7 @@ send updates each time a new ledger closes.
    
 
  • destination_amount
    • 
 
  • full_reply
    • 
 
  • id
    • 
-
  • send_max
    • 
+
  • send_max?
    • 
 
  • source_account
    • 
 
  • type
    • 
 
    
diff --git a/docs/interfaces/Payment.html b/docs/interfaces/Payment.html
index 0fc011af..662fe88f 100644
--- a/docs/interfaces/Payment.html
+++ b/docs/interfaces/Payment.html
@@ -24,7 +24,7 @@ another.
    
 
      
 
    • Payment
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:107
    • 
 
    
 
    
 
    
@@ -33,25 +33,25 @@ another.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
+AccountTxnID?
 Amount
-DeliverMin
+DeliverMin?
 Destination
-DestinationTag
-Fee
-Flags
-InvoiceID
-LastLedgerSequence
-Memos
-Paths
-SendMax
-Sequence
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+DestinationTag?
+Fee?
+Flags?
+InvoiceID?
+LastLedgerSequence?
+Memos?
+Paths?
+SendMax?
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -62,7 +62,7 @@ another.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -72,7 +72,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Amount
    
 
    Amount: Amount
    
@@ -81,7 +81,7 @@ names MUST be lower-case. If the tfPartialPayment flag is set, deliver up
 to this amount instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:114
    • 
 
    
 
    Optional DeliverMin
    
 
    DeliverMin?: Amount
    
@@ -90,14 +90,14 @@ Only valid if this is a partial payment. For non-XRP amounts, the nested
 field names are lower-case.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:146
    • 
 
    
 
    Destination
    
 
    Destination: string
    
 
    The unique address of the account receiving the payment.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:116
    • 
 
    
 
    Optional DestinationTag
    
 
    DestinationTag?: number
    
@@ -105,7 +105,7 @@ field names are lower-case.
    
 destination, or a hosted recipient to pay.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:121
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -115,13 +115,13 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | PaymentFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:147
    • 
 
    
 
    Optional InvoiceID
    
 
    InvoiceID?: string
    
@@ -129,7 +129,7 @@ different minimum requirements.
    
 this payment.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:126
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -139,7 +139,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -147,7 +147,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    Optional Paths
    
 
    Paths?: Path[]
    
@@ -155,7 +155,7 @@ validated or rejected.
    
 for XRP-to-XRP transactions.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:131
    • 
 
    
 
    Optional SendMax
    
 
    SendMax?: Amount
    
@@ -167,7 +167,7 @@ cross-currency/cross-issue payments. Must be omitted for XRP-to-XRP
 Payments.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:140
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -178,7 +178,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -187,7 +187,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -197,7 +197,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -208,7 +208,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -217,13 +217,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "Payment"
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:108
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -232,7 +232,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -260,25 +260,25 @@ account it says it is from.
    
 
  • Payment
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/PaymentChannelClaim.html b/docs/interfaces/PaymentChannelClaim.html
index 405dd5bc..576dd25a 100644
--- a/docs/interfaces/PaymentChannelClaim.html
+++ b/docs/interfaces/PaymentChannelClaim.html
@@ -24,7 +24,7 @@ or both.
    
 
      
 
    • PaymentChannelClaim
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:100
    • 
 
    
 
    
 
    
@@ -33,23 +33,23 @@ or both.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Amount
-Balance
+AccountTxnID?
+Amount?
+Balance?
 Channel
-Fee
-Flags
-LastLedgerSequence
-Memos
-PublicKey
-Sequence
-Signature
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
+PublicKey?
+Sequence?
+Signature?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -60,7 +60,7 @@ or both.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -70,7 +70,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Amount
    
 
    Amount?: string
    
@@ -79,7 +79,7 @@ the amount in the signed message. This is the cumulative amount of XRP that
 can be dispensed by the channel, including XRP previously redeemed.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:117
    • 
 
    
 
    Optional Balance
    
 
    Balance?: string
    
@@ -89,14 +89,14 @@ delivered by the channel so far, but not greater than the Amount of the
 signed claim. Must be provided except when closing the channel.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:111
    • 
 
    
 
    Channel
    
 
    Channel: string
    
 
    The unique ID of the channel as a 64-character hexadecimal string.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:104
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -106,13 +106,13 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | PaymentChannelClaimFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:102
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -122,7 +122,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -130,7 +130,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    Optional PublicKey
    
 
    PublicKey?: string
    
@@ -140,7 +140,7 @@ of the transaction is the source address of the channel and the Signature
 field is omitted.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:130
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -151,7 +151,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signature
    
 
    Signature?: string
    
@@ -160,7 +160,7 @@ the channel ID and the amount of the claim. Required unless the sender of
 the transaction is the source address of the channel.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:123
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -169,7 +169,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -179,7 +179,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -190,7 +190,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -199,13 +199,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "PaymentChannelClaim"
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:101
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -214,7 +214,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -242,23 +242,23 @@ account it says it is from.
    
 
  • PaymentChannelClaim
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/PaymentChannelClaimFlagsInterface.html b/docs/interfaces/PaymentChannelClaimFlagsInterface.html
index a48c8aaa..c2c277cb 100644
--- a/docs/interfaces/PaymentChannelClaimFlagsInterface.html
+++ b/docs/interfaces/PaymentChannelClaimFlagsInterface.html
@@ -17,7 +17,7 @@
 
    Map of flags to boolean values representing PaymentChannelClaim
 transaction flags.
    
 
-
    Example
    const paymentChannelClaim: PaymentChannelClaim = {
     Account: 'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj,
     TransactionType: 'PaymentChannelClaim',
     Channel: hashes.hashPaymentChannel(
       'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj',
       'rQGYqiyH5Ue9J96p4E6Qt6AvqxK4sDhnS5',
       21970712,
     ),
     Amount: '100',
     Flags: {
       tfClose: true
     }
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(paymentChannelClaim)
    console.log(autofilledTx)
    // {
    //  Account: 'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj',
    //  TransactionType: 'PaymentChannelClaim',
    //  Channel: 'FC14BF9245D731DC1749EE0F070765E4EB4E993F8ECEE3D00F7E6E26D6EF98CF',
    //  Amount: '100',
    //  Flags: 131072,
    //  Sequence: 21970713,
    //  Fee: '12',
    //  LastLedgerSequence: 21970658
    // }
+
    Example
    const paymentChannelClaim: PaymentChannelClaim = {
     Account: 'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj,
     TransactionType: 'PaymentChannelClaim',
     Channel: hashes.hashPaymentChannel(
       'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj',
       'rQGYqiyH5Ue9J96p4E6Qt6AvqxK4sDhnS5',
       21970712,
     ),
     Amount: '100',
     Flags: {
       tfClose: true
     }
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(paymentChannelClaim)
    console.log(autofilledTx)
    // {
    //  Account: 'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj',
    //  TransactionType: 'PaymentChannelClaim',
    //  Channel: 'FC14BF9245D731DC1749EE0F070765E4EB4E993F8ECEE3D00F7E6E26D6EF98CF',
    //  Amount: '100',
    //  Flags: 131072,
    //  Sequence: 21970713,
    //  Fee: '12',
    //  LastLedgerSequence: 21970658
    // }
 
    
 
    
 
    
@@ -27,7 +27,7 @@ transaction flags.
    
 
      
 
    • PaymentChannelClaimFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:71
    • 
 
    
 
    
 
    
@@ -35,8 +35,8 @@ transaction flags.
    
 
    
 
    
 
    Properties
    
-
    tfClose
-tfRenew
+
    tfClose?
+tfRenew?
 
    
 
    
 
    Properties
    
@@ -56,7 +56,7 @@ holds XRP, any XRP that remains after processing the claim is returned to
 the source address.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:91
    • 
 
    
 
    Optional tfRenew
    
 
    tfRenew?: boolean
    
@@ -65,7 +65,7 @@ channel's immutable CancelAfter time.) Only the source address of the
 payment channel can use this flag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:77
    • 
 
    
 
    
 
    
@@ -92,8 +92,8 @@ payment channel can use this flag.
    
 
    
+
  • tfClose?
    • 
+
  • tfRenew?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/PaymentChannelCreate.html b/docs/interfaces/PaymentChannelCreate.html
index d3b141f2..039b47bf 100644
--- a/docs/interfaces/PaymentChannelCreate.html
+++ b/docs/interfaces/PaymentChannelCreate.html
@@ -24,7 +24,7 @@ this transaction becomes the "source address" of the payment channel.<
 
      
 
    • PaymentChannelCreate
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:12
    • 
 
    
 
    
 
    
@@ -33,24 +33,24 @@ this transaction becomes the "source address" of the payment channel.<
 
    
 
    Properties
    
 
    Account
-AccountTxnID
+AccountTxnID?
 Amount
-CancelAfter
+CancelAfter?
 Destination
-DestinationTag
-Fee
-Flags
-LastLedgerSequence
-Memos
+DestinationTag?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
 PublicKey
-Sequence
+Sequence?
 SettleDelay
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -61,7 +61,7 @@ this transaction becomes the "source address" of the payment channel.<
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -71,7 +71,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Amount
    
 
    Amount: string
    
@@ -81,7 +81,7 @@ Destination address. When the channel closes, any unclaimed XRP is returned
 to the source address's balance.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:20
    • 
 
    
 
    Optional CancelAfter
    
 
    CancelAfter?: number
    
@@ -92,7 +92,7 @@ channel can be closed earlier than this time but cannot remain open after
 this time.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:44
    • 
 
    
 
    Destination
    
 
    Destination: string
    
@@ -100,7 +100,7 @@ this time.
    
 the "destination address" for the channel.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:25
    • 
 
    
 
    Optional DestinationTag
    
 
    DestinationTag?: number
    
@@ -108,7 +108,7 @@ the "destination address" for the channel.
    
 such as a hosted recipient at the destination address.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:49
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -118,7 +118,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | GlobalFlags
    
@@ -126,7 +126,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:123
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -136,7 +136,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -144,7 +144,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    PublicKey
    
 
    PublicKey: string
    
@@ -153,7 +153,7 @@ this channel in hexadecimal. This can be any secp256k1 or ed25519 public
 key.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:36
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -164,7 +164,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    SettleDelay
    
 
    SettleDelay: number
    
@@ -172,7 +172,7 @@ is using a Ticket instead.
    
 it has unclaimed XRP.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:30
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -181,7 +181,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -191,7 +191,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -202,7 +202,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -211,13 +211,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "PaymentChannelCreate"
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:13
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -226,7 +226,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -254,24 +254,24 @@ account it says it is from.
    
 
  • PaymentChannelCreate
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/PaymentChannelFund.html b/docs/interfaces/PaymentChannelFund.html
index df7e4e01..aa27bafd 100644
--- a/docs/interfaces/PaymentChannelFund.html
+++ b/docs/interfaces/PaymentChannelFund.html
@@ -25,7 +25,7 @@ use this transaction.
    
 
      
 
    • PaymentChannelFund
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:12
    • 
 
    
 
    
 
    
@@ -34,21 +34,21 @@ use this transaction.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
+AccountTxnID?
 Amount
 Channel
-Expiration
-Fee
-Flags
-LastLedgerSequence
-Memos
-Sequence
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+Expiration?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -59,7 +59,7 @@ use this transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -69,7 +69,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Amount
    
 
    Amount: string
    
@@ -77,7 +77,7 @@ the provided hash.
    
 of XRP.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:23
    • 
 
    
 
    Channel
    
 
    Channel: string
    
@@ -85,7 +85,7 @@ of XRP.
    
 string.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:18
    • 
 
    
 
    Optional Expiration
    
 
    Expiration?: number
    
@@ -99,7 +99,7 @@ the channel's immutable CancelAfter time.) For more information, see the
 PayChannel ledger object type.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:34
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -109,7 +109,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | GlobalFlags
    
@@ -117,7 +117,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:123
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -127,7 +127,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -135,7 +135,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -146,7 +146,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -155,7 +155,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -165,7 +165,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -176,7 +176,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -185,13 +185,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "PaymentChannelFund"
    
+
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:13
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -200,7 +200,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -228,21 +228,21 @@ account it says it is from.
    
 
  • PaymentChannelFund
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/PaymentFlagsInterface.html b/docs/interfaces/PaymentFlagsInterface.html
index 5696a635..c8f42c08 100644
--- a/docs/interfaces/PaymentFlagsInterface.html
+++ b/docs/interfaces/PaymentFlagsInterface.html
@@ -17,7 +17,7 @@
 
    Map of flags to boolean values representing Payment transaction
 flags.
    
 
-
    Example
    const partialPayment: Payment = {
     TransactionType: 'Payment',
     Account: 'rM9WCfJU6udpFkvKThRaFHDMsp7L8rpgN',
     Amount: {
       currency: 'FOO',
       value: '4000',
       issuer: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
     },
     Destination: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
     Flags: {
       tfPartialPayment: true
     }
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(partialPayment)
    console.log(autofilledTx)
    // {
    //  TransactionType: 'Payment',
    //  Account: 'rM9WCfJU6udpFkvKThRaFHDMsp7L8rpgN',
    //  Amount: {
    //   currency: 'FOO',
    //   value: '4000',
    //   issuer: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz'
    //  },
    //  Destination: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
    //  Flags: 131072,
    //  Sequence: 21970996,
    //  Fee: '12',
    //  LastLedgerSequence: 21971016
    // }
+
    Example
    const partialPayment: Payment = {
     TransactionType: 'Payment',
     Account: 'rM9WCfJU6udpFkvKThRaFHDMsp7L8rpgN',
     Amount: {
       currency: 'FOO',
       value: '4000',
       issuer: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
     },
     Destination: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
     Flags: {
       tfPartialPayment: true
     }
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(partialPayment)
    console.log(autofilledTx)
    // {
    //  TransactionType: 'Payment',
    //  Account: 'rM9WCfJU6udpFkvKThRaFHDMsp7L8rpgN',
    //  Amount: {
    //   currency: 'FOO',
    //   value: '4000',
    //   issuer: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz'
    //  },
    //  Destination: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
    //  Flags: 131072,
    //  Sequence: 21970996,
    //  Fee: '12',
    //  LastLedgerSequence: 21971016
    // }
 
    
 
    
 
    
@@ -27,7 +27,7 @@ flags.
    
 
      
 
    • PaymentFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:80
    • 
 
    
 
    
 
    
@@ -35,9 +35,9 @@ flags.
    
 
    
 
    
 
    Properties
    
-
    tfLimitQuality
-tfNoDirectRipple
-tfPartialPayment
+
    tfLimitQuality?
+tfNoDirectRipple?
+tfPartialPayment?
 
    
 
    
 
    Properties
    
@@ -49,7 +49,7 @@ is equal or better than the ratio of Amount:SendMax. See Limit Quality for
 details.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:98
    • 
 
    
 
    Optional tfNoDirectRipple
    
 
    tfNoDirectRipple?: boolean
    
@@ -58,7 +58,7 @@ This is intended to force the transaction to take arbitrage opportunities.
 Most clients do not need this.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:86
    • 
 
    
 
    Optional tfPartialPayment
    
 
    tfPartialPayment?: boolean
    
@@ -67,7 +67,7 @@ reduce the received amount instead of failing outright. See Partial.
 Payments for more details.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/payment.ts:92
    • 
 
    
 
    
 
    
@@ -94,9 +94,9 @@ Payments for more details.
    
 
    
+
  • tfLimitQuality?
    • 
+
  • tfNoDirectRipple?
    • 
+
  • tfPartialPayment?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/PeerStatusStream.html b/docs/interfaces/PeerStatusStream.html
index b4b1c1a2..3c7be048 100644
--- a/docs/interfaces/PeerStatusStream.html
+++ b/docs/interfaces/PeerStatusStream.html
@@ -25,7 +25,7 @@ particular their status in the consensus process.
    
 
      
 
    • PeerStatusStream
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:294
    • 
 
    
 
    
 
    
@@ -35,10 +35,10 @@ particular their status in the consensus process.
    
 
    Properties
    
 
    action
 date
-ledger_hash
-ledger_index
-ledger_index_max
-ledger_index_min
+ledger_hash?
+ledger_index?
+ledger_index_max?
+ledger_index_min?
 type
 
    
 
    
@@ -50,48 +50,48 @@ particular their status in the consensus process.
    
 possible values.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:300
    • 
 
    
 
    date
    
 
    date: number
    
 
    The time this event occurred, in seconds since the Ripple Epoch.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:302
    • 
 
    
 
    Optional ledger_hash
    
 
    ledger_hash?: string
    
 
    The identifying Hash of a ledger version to which this message pertains.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:304
    • 
 
    
 
    Optional ledger_index
    
 
    ledger_index?: number
    
 
    The Ledger Index of a ledger version to which this message pertains.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:306
    • 
 
    
 
    Optional ledger_index_max
    
 
    ledger_index_max?: number
    
 
    The largest Ledger Index the peer has currently available.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:308
    • 
 
    
 
    Optional ledger_index_min
    
 
    ledger_index_min?: number
    
 
    The smallest Ledger Index the peer has currently available.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:310
    • 
 
    
 
    type
    
 
    type: "peerStatusChange"
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:295
    • 
 
    
 
    
 
    
@@ -120,10 +120,10 @@ possible values.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/PingRequest.html b/docs/interfaces/PingRequest.html
index b37a9843..696e1154 100644
--- a/docs/interfaces/PingRequest.html
+++ b/docs/interfaces/PingRequest.html
@@ -24,7 +24,7 @@ connection status and latency. Expects a response in the form of a 
 
  • PingRequest
    • 
+
  • Defined in packages/xrpl/src/models/methods/ping.ts:10
    • 
 
    
 
    
 
    
@@ -32,9 +32,9 @@ connection status and latency. Expects a response in the form of a 
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 
    
 
    
 
    Properties
    
@@ -45,13 +45,13 @@ connection status and latency. Expects a response in the form of a 
 
    Inherited from BaseRequest.api_version
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "ping"
    
+
  • Defined in packages/xrpl/src/models/methods/ping.ts:11
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -61,7 +61,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    
 
    
@@ -88,9 +88,9 @@ know which request prompted which response.
    
 
    
+
  • id?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/PingResponse.html b/docs/interfaces/PingResponse.html
index 7ddf3727..9049fd6b 100644
--- a/docs/interfaces/PingResponse.html
+++ b/docs/interfaces/PingResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • PingResponse
    
+
  • Defined in packages/xrpl/src/models/methods/ping.ts:19
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { role?: string; unlimited?: boolean }
    
+
    result: { 
        role?: string; 
        unlimited?: boolean; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -72,31 +72,31 @@
 
      Optional unlimited?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/ping.ts:20
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -123,14 +123,14 @@
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/RandomRequest.html b/docs/interfaces/RandomRequest.html
index 56814227..1b80baa8 100644
--- a/docs/interfaces/RandomRequest.html
+++ b/docs/interfaces/RandomRequest.html
@@ -25,7 +25,7 @@ form of a RandomResponse.
    
 
      
 
    • RandomRequest
    
+
  • Defined in packages/xrpl/src/models/methods/random.ts:10
    • 
 
    
 
    
 
    
@@ -33,9 +33,9 @@ form of a RandomResponse.
    
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 
    
 
    
 
    Properties
    
@@ -46,13 +46,13 @@ form of a RandomResponse.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "random"
    
+
  • Defined in packages/xrpl/src/models/methods/random.ts:11
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -62,7 +62,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    
 
    
@@ -89,9 +89,9 @@ know which request prompted which response.
    
 
    
+
  • id?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/RandomResponse.html b/docs/interfaces/RandomResponse.html
index 78c778f2..757c8c5e 100644
--- a/docs/interfaces/RandomResponse.html
+++ b/docs/interfaces/RandomResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • RandomResponse
    
+
  • Defined in packages/xrpl/src/models/methods/random.ts:19
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { random: string }
    
+
    result: { 
        random: string; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -70,31 +70,31 @@
 
      random: string
    
+
  • Defined in packages/xrpl/src/models/methods/random.ts:20
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -121,14 +121,14 @@
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/RipplePathFindRequest.html b/docs/interfaces/RipplePathFindRequest.html
index 39c04988..6e045387 100644
--- a/docs/interfaces/RipplePathFindRequest.html
+++ b/docs/interfaces/RipplePathFindRequest.html
@@ -25,7 +25,7 @@ Expects a response in the form of a Ripple
 
      
 
    • RipplePathFindRequest
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:17
    • 
 
    
 
    
 
    
@@ -33,16 +33,16 @@ Expects a response in the form of a Ripple
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
 destination_account
 destination_amount
-id
-ledger_hash
-ledger_index
-send_max
+id?
+ledger_hash?
+ledger_index?
+send_max?
 source_account
-source_currencies
+source_currencies?
 
    
 
    
 
    Properties
    
@@ -53,20 +53,20 @@ Expects a response in the form of a Ripple
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "ripple_path_find"
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:18
    • 
 
    
 
    destination_account
    
 
    destination_account: string
    
 
    Unique address of the account that would receive funds in a transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:22
    • 
 
    
 
    destination_amount
    
 
    destination_amount: Amount
    
@@ -74,7 +74,7 @@ Expects a response in the form of a Ripple
 transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:27
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -84,14 +84,14 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional ledger_hash
    
 
    ledger_hash?: string
    
 
    A 20-byte hex string for the ledger version to use.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:40
    • 
 
    
 
    Optional ledger_index
    
 
    ledger_index?: LedgerIndex
    
@@ -99,7 +99,7 @@ know which request prompted which response.
    
 ledger automatically.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:45
    • 
 
    
 
    Optional send_max
    
 
    send_max?: Amount
    
@@ -107,14 +107,14 @@ ledger automatically.
    
 with source_currencies.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:32
    • 
 
    
 
    source_account
    
 
    source_account: string
    
 
    Unique address of the account that would send funds in a transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:20
    • 
 
    
 
    Optional source_currencies
    
 
    source_currencies?: SourceCurrencyAmount
    
@@ -123,7 +123,7 @@ entry in the array should be a JSON object with a mandatory currency field
 and optional issuer field, like how currency amounts are specified.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:38
    • 
 
    
 
    
 
    
@@ -150,16 +150,16 @@ and optional issuer field, like how currency amounts are specified.
    
 
    
+
  • source_currencies?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/RipplePathFindResponse.html b/docs/interfaces/RipplePathFindResponse.html
index 42de56de..6da27480 100644
--- a/docs/interfaces/RipplePathFindResponse.html
+++ b/docs/interfaces/RipplePathFindResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • RipplePathFindResponse
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:63
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { alternatives: PathOption[]; destination_account: string; destination_amount: Amount; destination_currencies: string[]; full_reply?: boolean; id?: string | number; ledger_current_index?: number; source_account: string; validated: boolean }
    
+
    result: { 
        alternatives: PathOption[]; 
        destination_account: string; 
        destination_amount: Amount; 
        destination_currencies: string[]; 
        full_reply?: boolean; 
        id?: string | number; 
        ledger_current_index?: number; 
        source_account: string; 
        validated: boolean; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -96,31 +96,31 @@ accepts, as 3-letter codes like "USD" or as 40-character hex like
 
      validated: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:64
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -147,14 +147,14 @@ accepts, as 3-letter codes like "USD" or as 40-character hex like
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/ServerInfoRequest.html b/docs/interfaces/ServerInfoRequest.html
index 54b05e0f..b02eae73 100644
--- a/docs/interfaces/ServerInfoRequest.html
+++ b/docs/interfaces/ServerInfoRequest.html
@@ -25,7 +25,7 @@ response in the form of a ServerInfoResponse
 
  • ServerInfoRequest
    • 
+
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:10
    • 
 
    
 
    
 
    
@@ -33,9 +33,9 @@ response in the form of a ServerInfoResponse
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 
    
 
    
 
    Properties
    
@@ -46,13 +46,13 @@ response in the form of a ServerInfoResponse
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "server_info"
    
+
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:11
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -62,7 +62,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    
 
    
@@ -89,9 +89,9 @@ know which request prompted which response.
    
 
    
+
  • id?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/ServerInfoResponse.html b/docs/interfaces/ServerInfoResponse.html
index f5374bff..929c76d9 100644
--- a/docs/interfaces/ServerInfoResponse.html
+++ b/docs/interfaces/ServerInfoResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • ServerInfoResponse
    
+
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:41
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,27 +47,27 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    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 } }
    
+
    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 }
      
+
      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
        
@@ -79,7 +79,7 @@ amendment blocked, the response omits this field.
        
 
        The version number of the running rippled version.
        
 
        • 
 
      • 
-
        Optional closed_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }
        
+
        Optional closed_ledger?: { 
            age: number; 
            base_fee_xrp: number; 
            hash: string; 
            reserve_base_xrp: number; 
            reserve_inc_xrp: number; 
            seq: number; 
        }
        
 
        Information on the most recently closed ledger that has not been
 validated by consensus. If the most recently validated ledger is
 available, the response omits this field and includes
@@ -124,7 +124,7 @@ may mean that your server is unable to handle the transaction load of
 the XRP Ledger network.
        
 
        • 
 
      • 
-
        last_close: { converge_time_s: number; proposers: number }
        
+
        last_close: { 
            converge_time_s: number; 
            proposers: number; 
        }
        
 
        Information about the last time the server closed a ledger, including
 the amount of time it took to reach a consensus and the number of
 trusted validators participating.
        
@@ -142,7 +142,7 @@ if configured as a validator) in the consensus process for the most
 recently validated ledger version.
        
 
      • 
 
    • 
-
      Optional load?: { job_types: JobType[]; threads: number }
      
+
      Optional load?: { 
          job_types: JobType[]; 
          threads: number; 
      }
      
 
      (Admin only) Detailed information about the current load state of the
 server.
      
 
      
@@ -238,7 +238,7 @@ health of your server's connectivity to the network.
      
 
      Number of consecutive seconds that the server has been operational.
      
 
      • 
 
    • 
-
      Optional validated_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }
      
+
      Optional validated_ledger?: { 
          age: number; 
          base_fee_xrp: number; 
          hash: string; 
          reserve_base_xrp: number; 
          reserve_inc_xrp: number; 
          seq: number; 
      }
      
 
      Information about the most recent fully-validated ledger.
      
 
      
 
        
@@ -284,31 +284,31 @@ static validator list.
        
 
    
+
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:42
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -335,14 +335,14 @@ static validator list.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/ServerStateRequest.html b/docs/interfaces/ServerStateRequest.html
index d19cbda9..9424e824 100644
--- a/docs/interfaces/ServerStateRequest.html
+++ b/docs/interfaces/ServerStateRequest.html
@@ -26,7 +26,7 @@ instead of easier to read.
    
 
      
 
    • ServerStateRequest
    
+
  • Defined in packages/xrpl/src/models/methods/serverState.ts:12
    • 
 
    
 
    
 
    
@@ -34,9 +34,9 @@ instead of easier to read.
    
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
+id?
 
    
 
    
 
    Properties
    
@@ -47,13 +47,13 @@ instead of easier to read.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "server_state"
    
+
  • Defined in packages/xrpl/src/models/methods/serverState.ts:13
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -63,7 +63,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    
 
    
@@ -90,9 +90,9 @@ know which request prompted which response.
    
 
    
+
  • id?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/ServerStateResponse.html b/docs/interfaces/ServerStateResponse.html
index 285bb3e0..5f41bff7 100644
--- a/docs/interfaces/ServerStateResponse.html
+++ b/docs/interfaces/ServerStateResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • ServerStateResponse
    
+
  • Defined in packages/xrpl/src/models/methods/serverState.ts:21
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,34 +47,34 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    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 } }
    
+
    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 }
      
+
      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 }
        
+
        Optional closed_ledger?: { 
            age: number; 
            base_fee: number; 
            hash: string; 
            reserve_base: number; 
            reserve_inc: number; 
            seq: number; 
        }
        
 
          
 
        • 
 
          age: number
          • 
@@ -95,14 +95,14 @@
 
        • 
 
          jq_trans_overflow: string
          • 
 
        • 
-
          last_close: { converge_time_s: number; proposers: number }
          
+
          last_close: { 
              converge_time_s: number; 
              proposers: number; 
          }
          
 
            
 
          • 
 
            converge_time_s: number
            • 
 
          • 
 
            proposers: number
          • 
 
        • 
-
          Optional load?: { job_types: JobType[]; threads: number }
          
+
          Optional load?: { 
              job_types: JobType[]; 
              threads: number; 
          }
          
 
            
 
          • 
 
            job_types: JobType[]
            • 
@@ -137,7 +137,7 @@
 
          • 
 
            uptime: number
            • 
 
          • 
-
            Optional validated_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }
            
+
            Optional validated_ledger?: { 
                age: number; 
                base_fee: number; 
                hash: string; 
                reserve_base: number; 
                reserve_inc: number; 
                seq: number; 
            }
            
 
              
 
            • 
 
              age: number
              • 
@@ -157,31 +157,31 @@
 
              Optional validator_list_expires?: string
    
+
  • Defined in packages/xrpl/src/models/methods/serverState.ts:22
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -208,14 +208,14 @@
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/SetRegularKey.html b/docs/interfaces/SetRegularKey.html
index af1a3ce4..7b78ad2a 100644
--- a/docs/interfaces/SetRegularKey.html
+++ b/docs/interfaces/SetRegularKey.html
@@ -24,7 +24,7 @@ pair associated with an account.
    
 
      
 
    • SetRegularKey
    
+
  • Defined in packages/xrpl/src/models/transactions/setRegularKey.ts:11
    • 
 
    
 
    
 
    
@@ -33,19 +33,19 @@ pair associated with an account.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Fee
-Flags
-LastLedgerSequence
-Memos
-RegularKey
-Sequence
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+AccountTxnID?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
+RegularKey?
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -56,7 +56,7 @@ pair associated with an account.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -66,7 +66,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -76,7 +76,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | GlobalFlags
    
@@ -84,7 +84,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:123
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -94,7 +94,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -102,7 +102,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    Optional RegularKey
    
 
    RegularKey?: string
    
@@ -111,7 +111,7 @@ assigned to the account. If omitted, removes any existing regular key pair.
 from the account. Must not match the master key pair for the address.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/setRegularKey.ts:18
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -122,7 +122,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -131,7 +131,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -141,7 +141,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -152,7 +152,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -161,13 +161,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "SetRegularKey"
    
+
  • Defined in packages/xrpl/src/models/transactions/setRegularKey.ts:12
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -176,7 +176,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -204,19 +204,19 @@ account it says it is from.
    
 
  • SetRegularKey
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/SignerListSet.html b/docs/interfaces/SignerListSet.html
index e8d99171..6f89b64a 100644
--- a/docs/interfaces/SignerListSet.html
+++ b/docs/interfaces/SignerListSet.html
@@ -24,7 +24,7 @@ signers that can be used to multi-sign a transaction.
    
 
      
 
    • SignerListSet
    
+
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:12
    • 
 
    
 
    
 
    
@@ -33,20 +33,20 @@ signers that can be used to multi-sign a transaction.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Fee
-Flags
-LastLedgerSequence
-Memos
-Sequence
+AccountTxnID?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
+Sequence?
 SignerEntries
 SignerQuorum
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -57,7 +57,7 @@ signers that can be used to multi-sign a transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -67,7 +67,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -77,7 +77,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | GlobalFlags
    
@@ -85,7 +85,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:123
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -95,7 +95,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -103,7 +103,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -114,17 +114,17 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    SignerEntries
    
 
    SignerEntries: SignerEntry[]
    
 
    Array of SignerEntry objects, indicating the addresses and weights of
 signers in this list. This signer list must have at least 1 member and no
-more than 8 members. No address may appear more than once in the list, nor
+more than 32 members. No address may appear more than once in the list, nor
 may the Account submitting the transaction appear in the list.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:26
    • 
 
    
 
    SignerQuorum
    
 
    SignerQuorum: number
    
@@ -133,7 +133,7 @@ is valid only if the sum weights of the signatures provided is greater than
 or equal to this value. To delete a signer list, use the value 0.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:19
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -142,7 +142,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -152,7 +152,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -163,7 +163,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -172,13 +172,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "SignerListSet"
    
+
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:13
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -187,7 +187,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -215,20 +215,20 @@ account it says it is from.
    
 
  • SignerListSet
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/SubmitMultisignedRequest.html b/docs/interfaces/SubmitMultisignedRequest.html
index d57e0063..80565a91 100644
--- a/docs/interfaces/SubmitMultisignedRequest.html
+++ b/docs/interfaces/SubmitMultisignedRequest.html
@@ -25,7 +25,7 @@ form of a SubmitMultisignedRequest.<
 
      
 
    • SubmitMultisignedRequest
    
+
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:12
    • 
 
    
 
    
 
    
@@ -33,10 +33,10 @@ form of a SubmitMultisignedRequest.<
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-fail_hard
-id
+fail_hard?
+id?
 tx_json
 
    
 
    
@@ -48,13 +48,13 @@ form of a SubmitMultisignedRequest.<
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "submit_multisigned"
    
+
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:13
    • 
 
    
 
    Optional fail_hard
    
 
    fail_hard?: boolean
    
@@ -62,7 +62,7 @@ form of a SubmitMultisignedRequest.<
 transaction to other servers.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:24
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -72,7 +72,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    tx_json
    
 
    tx_json: Transaction
    
@@ -81,7 +81,7 @@ weights of the signatures must be equal or higher than the quorum of the.
 SignerList.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:19
    • 
 
    
 
    
 
    
@@ -108,10 +108,10 @@ SignerList.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/SubmitMultisignedResponse.html b/docs/interfaces/SubmitMultisignedResponse.html
index 771ce9c9..0815809c 100644
--- a/docs/interfaces/SubmitMultisignedResponse.html
+++ b/docs/interfaces/SubmitMultisignedResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • SubmitMultisignedResponse
    
+
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:32
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { engine_result: string; engine_result_code: number; engine_result_message: string; tx_blob: string; tx_json: AccountDelete & { hash?: string } & AccountSet & { hash?: string } & CheckCancel & { hash?: string } & CheckCash & { hash?: string } & CheckCreate & { hash?: string } & DepositPreauth & { hash?: string } & EscrowCancel & { hash?: string } & EscrowCreate & { hash?: string } & EscrowFinish & { hash?: string } & NFTokenAcceptOffer & { hash?: string } & NFTokenBurn & { hash?: string } & NFTokenCancelOffer & { hash?: string } & NFTokenCreateOffer & { hash?: string } & NFTokenMint & { hash?: string } & OfferCancel & { hash?: string } & OfferCreate & { hash?: string } & Payment & { hash?: string } & PaymentChannelClaim & { hash?: string } & PaymentChannelCreate & { hash?: string } & PaymentChannelFund & { hash?: string } & SetRegularKey & { hash?: string } & SignerListSet & { hash?: string } & TicketCreate & { hash?: string } & TrustSet & { hash?: string } }
    
+
    result: { 
        engine_result: string; 
        engine_result_code: number; 
        engine_result_message: string; 
        tx_blob: string; 
        tx_json: Object; 
    }
    
 
    
 
    Type declaration
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:33
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -141,14 +141,14 @@ directly correlated to engine_result.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/SubmitRequest.html b/docs/interfaces/SubmitRequest.html
index 871c5b81..3b375604 100644
--- a/docs/interfaces/SubmitRequest.html
+++ b/docs/interfaces/SubmitRequest.html
@@ -25,7 +25,7 @@ confirmed and included in future ledgers. Expects a response in the form of a
 
      
 
    • SubmitRequest
    
+
  • Defined in packages/xrpl/src/models/methods/submit.ts:12
    • 
 
    
 
    
 
    
@@ -33,10 +33,10 @@ confirmed and included in future ledgers. Expects a response in the form of a
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-fail_hard
-id
+fail_hard?
+id?
 tx_blob
 
    
 
    
@@ -48,13 +48,13 @@ confirmed and included in future ledgers. Expects a response in the form of a
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "submit"
    
+
  • Defined in packages/xrpl/src/models/methods/submit.ts:13
    • 
 
    
 
    Optional fail_hard
    
 
    fail_hard?: boolean
    
@@ -62,7 +62,7 @@ confirmed and included in future ledgers. Expects a response in the form of a
 transaction to other servers. The default is false.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/submit.ts:20
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -72,14 +72,14 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    tx_blob
    
 
    tx_blob: string
    
 
    The complete transaction in hex string format.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/submit.ts:15
    • 
 
    
 
    
 
    
@@ -106,10 +106,10 @@ know which request prompted which response.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/SubmitResponse.html b/docs/interfaces/SubmitResponse.html
index a28bbbcd..a0ec086d 100644
--- a/docs/interfaces/SubmitResponse.html
+++ b/docs/interfaces/SubmitResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • SubmitResponse
    
+
  • Defined in packages/xrpl/src/models/methods/submit.ts:28
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    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: AccountDelete & { hash?: string } & AccountSet & { hash?: string } & CheckCancel & { hash?: string } & CheckCash & { hash?: string } & CheckCreate & { hash?: string } & DepositPreauth & { hash?: string } & EscrowCancel & { hash?: string } & EscrowCreate & { hash?: string } & EscrowFinish & { hash?: string } & NFTokenAcceptOffer & { hash?: string } & NFTokenBurn & { hash?: string } & NFTokenCancelOffer & { hash?: string } & NFTokenCreateOffer & { hash?: string } & NFTokenMint & { hash?: string } & OfferCancel & { hash?: string } & OfferCreate & { hash?: string } & Payment & { hash?: string } & PaymentChannelClaim & { hash?: string } & PaymentChannelCreate & { hash?: string } & PaymentChannelFund & { hash?: string } & SetRegularKey & { hash?: string } & SignerListSet & { hash?: string } & TicketCreate & { hash?: string } & TrustSet & { hash?: string }; validated_ledger_index: number }
    
+
    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: Object; 
        validated_ledger_index: number; 
    }
    
 
    
 
    Type declaration
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/submit.ts:29
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -190,14 +190,14 @@ transaction can appear in as a result of this request.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/SubscribeRequest.html b/docs/interfaces/SubscribeRequest.html
index 303b72b0..c62f5467 100644
--- a/docs/interfaces/SubscribeRequest.html
+++ b/docs/interfaces/SubscribeRequest.html
@@ -25,7 +25,7 @@ certain events happen. Expects a response in the form of a.
 
      
 
    • SubscribeRequest
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:46
    • 
 
    
 
    
 
    
@@ -33,16 +33,16 @@ certain events happen. Expects a response in the form of a.
 
    
 
    
 
    Properties
    
-
    accounts
-accounts_proposed
-api_version
-books
+
    accounts?
+accounts_proposed?
+api_version?
+books?
 command
-id
-streams
-url
-url_password
-url_username
+id?
+streams?
+url?
+url_password?
+url_username?
 
    
 
    
 
    Properties
    
@@ -55,14 +55,14 @@ The server sends a notification for any transaction that affects at least
 one of these accounts.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:56
    • 
 
    
 
    Optional accounts_proposed
    
 
    accounts_proposed?: string[]
    
 
    Like accounts, but include transactions that are not yet finalized.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:58
    • 
 
    
 
    Optional api_version
    
 
    api_version?: number
    
@@ -70,7 +70,7 @@ one of these accounts.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    Optional books
    
 
    books?: Book[]
    
@@ -78,13 +78,13 @@ one of these accounts.
    
 Below.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:63
    • 
 
    
 
    command
    
 
    command: "subscribe"
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:47
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -94,14 +94,14 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional streams
    
 
    streams?: StreamType[]
    
 
    Array of string names of generic streams to subscribe to.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:49
    • 
 
    
 
    Optional url
    
 
    url?: string
    
@@ -109,21 +109,21 @@ know which request prompted which response.
    
 Admin-only.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:68
    • 
 
    
 
    Optional url_password
    
 
    url_password?: string
    
 
    Password to provide for basic authentication at the callback URL.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:72
    • 
 
    
 
    Optional url_username
    
 
    url_username?: string
    
 
    Username to provide for basic authentication at the callback URL.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:70
    • 
 
    
 
    
 
    
@@ -150,16 +150,16 @@ Admin-only.
    
 
    
+
  • id?
    • 
+
  • streams?
    • 
+
  • url?
    • 
+
  • url_password?
    • 
+
  • url_username?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/SubscribeResponse.html b/docs/interfaces/SubscribeResponse.html
index 4c22df5f..4a8e7b62 100644
--- a/docs/interfaces/SubscribeResponse.html
+++ b/docs/interfaces/SubscribeResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • SubscribeResponse
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:82
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,49 +47,49 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
 
    result: Record<string, never> | LedgerStreamResponse | BooksSnapshot
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:83
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -116,14 +116,14 @@
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/TicketCreate.html b/docs/interfaces/TicketCreate.html
index 33737855..6f573ae7 100644
--- a/docs/interfaces/TicketCreate.html
+++ b/docs/interfaces/TicketCreate.html
@@ -24,7 +24,7 @@ Tickets.
    
 
      
 
    • TicketCreate
    
+
  • Defined in packages/xrpl/src/models/transactions/ticketCreate.ts:11
    • 
 
    
 
    
 
    
@@ -33,19 +33,19 @@ Tickets.
    
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Fee
-Flags
-LastLedgerSequence
-Memos
-Sequence
-Signers
-SigningPubKey
-SourceTag
+AccountTxnID?
+Fee?
+Flags?
+LastLedgerSequence?
+Memos?
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
 TicketCount
-TicketSequence
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -56,7 +56,7 @@ Tickets.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -66,7 +66,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -76,7 +76,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | GlobalFlags
    
@@ -84,7 +84,7 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:123
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -94,7 +94,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -102,7 +102,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -113,7 +113,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -122,7 +122,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -132,7 +132,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -143,7 +143,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    TicketCount
    
 
    TicketCount: number
    
@@ -152,7 +152,7 @@ cause the account to own more than 250 Tickets after executing this
 transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/ticketCreate.ts:18
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -161,13 +161,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "TicketCreate"
    
+
  • Defined in packages/xrpl/src/models/transactions/ticketCreate.ts:12
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -176,7 +176,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -204,19 +204,19 @@ account it says it is from.
    
 
  • TicketCreate
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/TransactionAndMetadata.html b/docs/interfaces/TransactionAndMetadata.html
index 8f4752d7..862103ae 100644
--- a/docs/interfaces/TransactionAndMetadata.html
+++ b/docs/interfaces/TransactionAndMetadata.html
@@ -18,7 +18,7 @@
 
      
 
    • TransactionAndMetadata
    
+
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:86
    • 
 
    
 
    
 
    
@@ -35,12 +35,12 @@
 
    metadata
    
 
    metadata: TransactionMetadata
    
+
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:88
    • 
 
    
 
    transaction
    
 
    transaction: Transaction
    
+
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:87
    • 
 
    
 
    
 
    
diff --git a/docs/interfaces/TransactionEntryRequest.html b/docs/interfaces/TransactionEntryRequest.html
index a640faf4..8b806ad2 100644
--- a/docs/interfaces/TransactionEntryRequest.html
+++ b/docs/interfaces/TransactionEntryRequest.html
@@ -25,7 +25,7 @@ from a specific ledger version. Expects a response in the form of a
 
      
 
    • TransactionEntryRequest
    
+
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:13
    • 
 
    
 
    
 
    
@@ -33,11 +33,11 @@ from a specific ledger version. Expects a response in the form of a
 
    
 
    
 
    Properties
    
-
    api_version
+
    api_version?
 command
-id
-ledger_hash
-ledger_index
+id?
+ledger_hash?
+ledger_index?
 tx_hash
 
    
 
    
@@ -49,13 +49,13 @@ from a specific ledger version. Expects a response in the form of a
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    command
    
 
    command: "transaction_entry"
    
+
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:14
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -65,14 +65,14 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional ledger_hash
    
 
    ledger_hash?: string
    
 
    A 20-byte hex string for the ledger version to use.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:16
    • 
 
    
 
    Optional ledger_index
    
 
    ledger_index?: LedgerIndex
    
@@ -80,14 +80,14 @@ know which request prompted which response.
    
 ledger automatically.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:21
    • 
 
    
 
    tx_hash
    
 
    tx_hash: string
    
 
    Unique hash of the transaction you are looking up.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:23
    • 
 
    
 
    
 
    
@@ -114,11 +114,11 @@ ledger automatically.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/TransactionEntryResponse.html b/docs/interfaces/TransactionEntryResponse.html
index ddb7decb..c99aef3f 100644
--- a/docs/interfaces/TransactionEntryResponse.html
+++ b/docs/interfaces/TransactionEntryResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • TransactionEntryResponse
    
+
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:31
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,22 +47,22 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { ledger_hash: string; ledger_index: number; metadata: TransactionMetadata; tx_json: AccountDelete & ResponseOnlyTxInfo & AccountSet & ResponseOnlyTxInfo & CheckCancel & ResponseOnlyTxInfo & CheckCash & ResponseOnlyTxInfo & CheckCreate & ResponseOnlyTxInfo & DepositPreauth & ResponseOnlyTxInfo & EscrowCancel & ResponseOnlyTxInfo & EscrowCreate & ResponseOnlyTxInfo & EscrowFinish & ResponseOnlyTxInfo & NFTokenAcceptOffer & ResponseOnlyTxInfo & NFTokenBurn & ResponseOnlyTxInfo & NFTokenCancelOffer & ResponseOnlyTxInfo & NFTokenCreateOffer & ResponseOnlyTxInfo & NFTokenMint & ResponseOnlyTxInfo & OfferCancel & ResponseOnlyTxInfo & OfferCreate & ResponseOnlyTxInfo & Payment & ResponseOnlyTxInfo & PaymentChannelClaim & ResponseOnlyTxInfo & PaymentChannelCreate & ResponseOnlyTxInfo & PaymentChannelFund & ResponseOnlyTxInfo & SetRegularKey & ResponseOnlyTxInfo & SignerListSet & ResponseOnlyTxInfo & TicketCreate & ResponseOnlyTxInfo & TrustSet & ResponseOnlyTxInfo }
    
+
    result: { 
        ledger_hash: string; 
        ledger_index: number; 
        metadata: TransactionMetadata; 
        tx_json: Object; 
    }
    
 
    
 
    Type declaration
    
 
      
@@ -82,36 +82,36 @@ this is the same as the one from the request.
      
 transaction in detail.
      
 
    
 
  • 
-
    tx_json: AccountDelete & ResponseOnlyTxInfo & AccountSet & ResponseOnlyTxInfo & CheckCancel & ResponseOnlyTxInfo & CheckCash & ResponseOnlyTxInfo & CheckCreate & ResponseOnlyTxInfo & DepositPreauth & ResponseOnlyTxInfo & EscrowCancel & ResponseOnlyTxInfo & EscrowCreate & ResponseOnlyTxInfo & EscrowFinish & ResponseOnlyTxInfo & NFTokenAcceptOffer & ResponseOnlyTxInfo & NFTokenBurn & ResponseOnlyTxInfo & NFTokenCancelOffer & ResponseOnlyTxInfo & NFTokenCreateOffer & ResponseOnlyTxInfo & NFTokenMint & ResponseOnlyTxInfo & OfferCancel & ResponseOnlyTxInfo & OfferCreate & ResponseOnlyTxInfo & Payment & ResponseOnlyTxInfo & PaymentChannelClaim & ResponseOnlyTxInfo & PaymentChannelCreate & ResponseOnlyTxInfo & PaymentChannelFund & ResponseOnlyTxInfo & SetRegularKey & ResponseOnlyTxInfo & SignerListSet & ResponseOnlyTxInfo & TicketCreate & ResponseOnlyTxInfo & TrustSet & ResponseOnlyTxInfo
    
+
    tx_json: Object
    
 
    JSON representation of the Transaction object.
    
 
    • 
+
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:32
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -138,14 +138,14 @@ transaction in detail.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/TransactionMetadata.html b/docs/interfaces/TransactionMetadata.html
index 2ce09543..7f21273c 100644
--- a/docs/interfaces/TransactionMetadata.html
+++ b/docs/interfaces/TransactionMetadata.html
@@ -18,7 +18,7 @@
 
      
 
    • TransactionMetadata
    
+
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:32
    • 
 
    
 
    
 
    
@@ -27,10 +27,10 @@
 
    
 
    Properties
    
 
    AffectedNodes
-DeliveredAmount
+DeliveredAmount?
 TransactionIndex
 TransactionResult
-delivered_amount
+delivered_amount?
 
    
 
    
 
    Properties
    
@@ -38,27 +38,27 @@
 
    AffectedNodes
    
 
    AffectedNodes: Node[]
    
+
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:33
    • 
 
    
 
    Optional DeliveredAmount
    
 
    DeliveredAmount?: Amount
    
+
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:34
    • 
 
    
 
    TransactionIndex
    
 
    TransactionIndex: number
    
+
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:37
    • 
 
    
 
    TransactionResult
    
 
    TransactionResult: string
    
+
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:38
    • 
 
    
 
    Optional delivered_amount
    
 
    delivered_amount?: Amount
    
+
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:36
    • 
 
    
 
    
 
    
@@ -86,10 +86,10 @@
 
  • TransactionMetadata
 
    • 
+
  • delivered_amount?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/TransactionStream.html b/docs/interfaces/TransactionStream.html
index 2c021cda..c5f4ec24 100644
--- a/docs/interfaces/TransactionStream.html
+++ b/docs/interfaces/TransactionStream.html
@@ -23,7 +23,7 @@
 
      
 
    • TransactionStream
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:253
    • 
 
    
 
    
 
    
@@ -34,15 +34,15 @@
 
    engine_result
 engine_result_code
 engine_result_message
-ledger_current_index
-ledger_hash
-ledger_index
-meta
+ledger_current_index?
+ledger_hash?
+ledger_index?
+meta?
 status
 transaction
 type
-validated
-warnings
+validated?
+warnings?
 
    
 
    
 
    Properties
    
@@ -52,21 +52,21 @@
 
    String Transaction result code.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:257
    • 
 
    
 
    engine_result_code
    
 
    engine_result_code: number
    
 
    Numeric transaction response code, if applicable.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:259
    • 
 
    
 
    engine_result_message
    
 
    engine_result_message: string
    
 
    Human-readable explanation for the transaction response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:261
    • 
 
    
 
    Optional ledger_current_index
    
 
    ledger_current_index?: number
    
@@ -74,21 +74,21 @@
 transaction is currently proposed.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:266
    • 
 
    
 
    Optional ledger_hash
    
 
    ledger_hash?: string
    
 
    The identifying hash of the ledger version that includes this transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:268
    • 
 
    
 
    Optional ledger_index
    
 
    ledger_index?: number
    
 
    The ledger index of the ledger version that includes this transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:270
    • 
 
    
 
    Optional meta
    
 
    meta?: TransactionMetadata
    
@@ -96,25 +96,25 @@ transaction is currently proposed.
    
 in detail.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:275
    • 
 
    
 
    status
    
 
    status: string
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:254
    • 
 
    
 
    transaction
    
-
    transaction: AccountDelete & ResponseOnlyTxInfo & AccountSet & ResponseOnlyTxInfo & CheckCancel & ResponseOnlyTxInfo & CheckCash & ResponseOnlyTxInfo & CheckCreate & ResponseOnlyTxInfo & DepositPreauth & ResponseOnlyTxInfo & EscrowCancel & ResponseOnlyTxInfo & EscrowCreate & ResponseOnlyTxInfo & EscrowFinish & ResponseOnlyTxInfo & NFTokenAcceptOffer & ResponseOnlyTxInfo & NFTokenBurn & ResponseOnlyTxInfo & NFTokenCancelOffer & ResponseOnlyTxInfo & NFTokenCreateOffer & ResponseOnlyTxInfo & NFTokenMint & ResponseOnlyTxInfo & OfferCancel & ResponseOnlyTxInfo & OfferCreate & ResponseOnlyTxInfo & Payment & ResponseOnlyTxInfo & PaymentChannelClaim & ResponseOnlyTxInfo & PaymentChannelCreate & ResponseOnlyTxInfo & PaymentChannelFund & ResponseOnlyTxInfo & SetRegularKey & ResponseOnlyTxInfo & SignerListSet & ResponseOnlyTxInfo & TicketCreate & ResponseOnlyTxInfo & TrustSet & ResponseOnlyTxInfo
    
+
    transaction: Object
    
 
    The definition of the transaction in JSON format.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:277
    • 
 
    
 
    type
    
 
    type: "transaction"
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:255
    • 
 
    
 
    Optional validated
    
 
    validated?: boolean
    
@@ -123,12 +123,12 @@ outcome is final. Responses from the transaction stream should always be
 validated.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:283
    • 
 
    
 
    Optional warnings
    
-
    warnings?: { id: number; message: string }[]
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:284
    • 
 
    
 
    
 
    
@@ -158,15 +158,15 @@ validated.
    
 
  • engine_result
    • 
 
  • engine_result_code
    • 
 
  • engine_result_message
    • 
-
  • ledger_current_index
    • 
-
  • ledger_hash
    • 
-
  • ledger_index
    • 
-
  • meta
    • 
+
  • ledger_current_index?
    • 
+
  • ledger_hash?
    • 
+
  • ledger_index?
    • 
+
  • meta?
    • 
 
  • status
    • 
 
  • transaction
    • 
 
  • type
    • 
-
  • validated
    • 
-
  • warnings
    • 
+
  • validated?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/TrustSet.html b/docs/interfaces/TrustSet.html
index c6ea9a6e..6ba06603 100644
--- a/docs/interfaces/TrustSet.html
+++ b/docs/interfaces/TrustSet.html
@@ -23,7 +23,7 @@
 
      
 
    • TrustSet
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:99
    • 
 
    
 
    
 
    
@@ -32,21 +32,21 @@
 
    
 
    Properties
    
 
    Account
-AccountTxnID
-Fee
-Flags
-LastLedgerSequence
+AccountTxnID?
+Fee?
+Flags?
+LastLedgerSequence?
 LimitAmount
-Memos
-QualityIn
-QualityOut
-Sequence
-Signers
-SigningPubKey
-SourceTag
-TicketSequence
+Memos?
+QualityIn?
+QualityOut?
+Sequence?
+Signers?
+SigningPubKey?
+SourceTag?
+TicketSequence?
 TransactionType
-TxnSignature
+TxnSignature?
 
    
 
    
 
    Properties
    
@@ -57,7 +57,7 @@
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:95
    • 
 
    
 
    Optional AccountTxnID
    
 
    AccountTxnID?: string
    
@@ -67,7 +67,7 @@ the provided hash.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:121
    • 
 
    
 
    Optional Fee
    
 
    Fee?: string
    
@@ -77,13 +77,13 @@ different minimum requirements.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:108
    • 
 
    
 
    Optional Flags
    
 
    Flags?: number | TrustSetFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:118
    • 
 
    
 
    Optional LastLedgerSequence
    
 
    LastLedgerSequence?: number
    
@@ -93,7 +93,7 @@ validated or rejected.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:129
    • 
 
    
 
    LimitAmount
    
 
    LimitAmount: IssuedCurrencyAmount
    
@@ -101,7 +101,7 @@ validated or rejected.
    
 Currency Amount.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:105
    • 
 
    
 
    Optional Memos
    
 
    Memos?: Memo[]
    
@@ -109,7 +109,7 @@ Currency Amount.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:133
    • 
 
    
 
    Optional QualityIn
    
 
    QualityIn?: number
    
@@ -118,7 +118,7 @@ Currency Amount.
    
 face value.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:111
    • 
 
    
 
    Optional QualityOut
    
 
    QualityOut?: number
    
@@ -127,7 +127,7 @@ face value.
    
 face value.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:117
    • 
 
    
 
    Optional Sequence
    
 
    Sequence?: number
    
@@ -138,7 +138,7 @@ is using a Ticket instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:115
    • 
 
    
 
    Optional Signers
    
 
    Signers?: Signer[]
    
@@ -147,7 +147,7 @@ transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:138
    • 
 
    
 
    Optional SigningPubKey
    
 
    SigningPubKey?: string
    
@@ -157,7 +157,7 @@ multi-signature is present in the Signers field instead.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:151
    • 
 
    
 
    Optional SourceTag
    
 
    SourceTag?: number
    
@@ -168,7 +168,7 @@ DestinationTag.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:145
    • 
 
    
 
    Optional TicketSequence
    
 
    TicketSequence?: number
    
@@ -177,13 +177,13 @@ this is provided, Sequence must be 0. Cannot be used with AccountTxnID.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:156
    • 
 
    
 
    TransactionType
    
 
    TransactionType: "TrustSet"
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:100
    • 
 
    
 
    Optional TxnSignature
    
 
    TxnSignature?: string
    
@@ -192,7 +192,7 @@ account it says it is from.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/common.ts:161
    • 
 
    
 
    
 
    
@@ -220,21 +220,21 @@ account it says it is from.
    
 
  • TrustSet
 
    • 
+
  • TxnSignature?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/TrustSetFlagsInterface.html b/docs/interfaces/TrustSetFlagsInterface.html
index 6d08611a..0584c17a 100644
--- a/docs/interfaces/TrustSetFlagsInterface.html
+++ b/docs/interfaces/TrustSetFlagsInterface.html
@@ -17,7 +17,7 @@
 
    Map of flags to boolean values representing TrustSet transaction
 flags.
    
 
-
    Example

    const trustSetTx: TrustSet = {
     TransactionType: 'TrustSet',
     Account: wallet2.getClassicAddress(),
     LimitAmount: {
       currency: 'FOO',
       issuer: wallet1.getClassicAddress(),
       value: '10000000000',
     },
     Flags: {
       tfSetNoRipple: true
     }
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(trustSetTx)
    console.log(autofilledTx)
    // {
    //  TransactionType: 'TrustSet',
    //  Account: 'r9dAdQQCBcGajVSeC9CqW3LCugjPDnAkEb',
    //  LimitAmount: {
    //   currency: 'FOO',
    //   issuer: 'rWZzUjo5xGiAoRBqzsndyzonXz47UV8u1',
    //   value: '10000000000'
    //  },
    //  Flags: 131072,
    //  Sequence: 21971483,
    //  Fee: '12',
    //  LastLedgerSequence: 21971503
    // }
+
    Example

    const trustSetTx: TrustSet = {
     TransactionType: 'TrustSet',
     Account: wallet2.getClassicAddress(),
     LimitAmount: {
       currency: 'FOO',
       issuer: wallet1.getClassicAddress(),
       value: '10000000000',
     },
     Flags: {
       tfSetNoRipple: true
     }
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(trustSetTx)
    console.log(autofilledTx)
    // {
    //  TransactionType: 'TrustSet',
    //  Account: 'r9dAdQQCBcGajVSeC9CqW3LCugjPDnAkEb',
    //  LimitAmount: {
    //   currency: 'FOO',
    //   issuer: 'rWZzUjo5xGiAoRBqzsndyzonXz47UV8u1',
    //   value: '10000000000'
    //  },
    //  Flags: 131072,
    //  Sequence: 21971483,
    //  Fee: '12',
    //  LastLedgerSequence: 21971503
    // }
 
    
 
    
 
    
@@ -27,7 +27,7 @@ flags.
    
 
      
 
    • TrustSetFlagsInterface
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:75
    • 
 
    
 
    
 
    
@@ -35,11 +35,11 @@ flags.
    
 
    
 
    
 
    Properties
    
-
    tfClearFreeze
-tfClearNoRipple
-tfSetFreeze
-tfSetNoRipple
-tfSetfAuth
+
    tfClearFreeze?
+tfClearNoRipple?
+tfSetFreeze?
+tfSetNoRipple?
+tfSetfAuth?
 
    
 
    
 
    Properties
    
@@ -49,21 +49,21 @@ flags.
    
 
    Unfreeze the trust line.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:91
    • 
 
    
 
    Optional tfClearNoRipple
    
 
    tfClearNoRipple?: boolean
    
 
    Disable the No Ripple flag, allowing rippling on this trust line.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:87
    • 
 
    
 
    Optional tfSetFreeze
    
 
    tfSetFreeze?: boolean
    
 
    Freeze the trust line.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:89
    • 
 
    
 
    Optional tfSetNoRipple
    
 
    tfSetNoRipple?: boolean
    
@@ -71,7 +71,7 @@ flags.
    
 of the same currency if this flag is enabled on both.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:85
    • 
 
    
 
    Optional tfSetfAuth
    
 
    tfSetfAuth?: boolean
    
@@ -79,7 +79,7 @@ of the same currency if this flag is enabled on both.
    
 effect unless using the asfRequireAuth AccountSet flag.) Cannot be unset.
    
 
    
+
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:80
    • 
 
    
 
    
 
    
@@ -106,11 +106,11 @@ effect unless using the asfRequireAuth AccountSet flag.) Cannot be unset.
    
 
    
+
  • tfClearFreeze?
    • 
+
  • tfClearNoRipple?
    • 
+
  • tfSetFreeze?
    • 
+
  • tfSetNoRipple?
    • 
+
  • tfSetfAuth?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/TxRequest.html b/docs/interfaces/TxRequest.html
index 2f857a53..a14db1af 100644
--- a/docs/interfaces/TxRequest.html
+++ b/docs/interfaces/TxRequest.html
@@ -24,7 +24,7 @@ identifying hash. Expects a response in the form of a 
 
      
 
    • TxRequest
    
+
  • Defined in packages/xrpl/src/models/methods/tx.ts:11
    • 
 
    
 
    
 
    
@@ -32,12 +32,12 @@ identifying hash. Expects a response in the form of a 
 
    
 
    
 
    Properties
    
-
    api_version
-binary
+
    api_version?
+binary?
 command
-id
-max_ledger
-min_ledger
+id?
+max_ledger?
+min_ledger?
 transaction
 
    
 
    
@@ -49,7 +49,7 @@ identifying hash. Expects a response in the form of a 
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    Optional binary
    
 
    binary?: boolean
    
@@ -58,13 +58,13 @@ hexadecimal strings. If false, return transaction data and metadata as.
 JSON. The default is false.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/tx.ts:19
    • 
 
    
 
    command
    
 
    command: "tx"
    
+
  • Defined in packages/xrpl/src/models/methods/tx.ts:12
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -74,7 +74,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional max_ledger
    
 
    max_ledger?: number
    
@@ -84,7 +84,7 @@ transaction, it confirms whether it was able to search all the ledgers in
 the requested range.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/tx.ts:33
    • 
 
    
 
    Optional min_ledger
    
 
    min_ledger?: number
    
@@ -94,12 +94,12 @@ transaction, it confirms whether it was able to search all the ledgers in
 this range.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/tx.ts:26
    • 
 
    
 
    transaction
    
 
    transaction: string
    
+
  • Defined in packages/xrpl/src/models/methods/tx.ts:13
    • 
 
    
 
    
 
    
@@ -126,12 +126,12 @@ this range.
    
 
    
 
    
 
    Generated using TypeDoc
    
diff --git a/docs/interfaces/TxResponse.html b/docs/interfaces/TxResponse.html
index 5380f26b..23305492 100644
--- a/docs/interfaces/TxResponse.html
+++ b/docs/interfaces/TxResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • TxResponse
    
+
  • Defined in packages/xrpl/src/models/methods/tx.ts:41
    • 
 
    
 
    
 
    
@@ -31,15 +31,15 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-searched_all
-status
+searched_all?
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -48,25 +48,25 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
-
    result: { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & AccountDelete & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & AccountSet & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & CheckCancel & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & CheckCash & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & CheckCreate & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & DepositPreauth & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & EscrowCancel & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & EscrowCreate & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & EscrowFinish & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenAcceptOffer & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenBurn & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenCancelOffer & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenCreateOffer & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenMint & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & OfferCancel & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & OfferCreate & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & Payment & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & PaymentChannelClaim & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & PaymentChannelCreate & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & PaymentChannelFund & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & SetRegularKey & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & SignerListSet & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & TicketCreate & { date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & TrustSet
    
+
  • Defined in packages/xrpl/src/models/methods/tx.ts:42
    • 
 
    
 
    Optional searched_all
    
 
    searched_all?: boolean
    
@@ -76,31 +76,31 @@ not have all of the specified ledger versions available, so it is not sure.
 If one of them might contain the transaction.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/tx.ts:65
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -127,15 +127,15 @@ If one of them might contain the transaction.
    
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/UnsubscribeRequest.html b/docs/interfaces/UnsubscribeRequest.html
index 4f7a5608..082cceeb 100644
--- a/docs/interfaces/UnsubscribeRequest.html
+++ b/docs/interfaces/UnsubscribeRequest.html
@@ -25,7 +25,7 @@ form of an UnsubscribeResponse.
    
 
      
 
    • UnsubscribeRequest
    
+
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:18
    • 
 
    
 
    
 
    
@@ -33,13 +33,13 @@ form of an UnsubscribeResponse.
    
 
    
 
    
 
    Properties
    
-
    accounts
-accounts_proposed
-api_version
-books
+
    accounts?
+accounts_proposed?
+api_version?
+books?
 command
-id
-streams
+id?
+streams?
 
    
 
    
 
    Properties
    
@@ -50,7 +50,7 @@ form of an UnsubscribeResponse.
    
 XRP Ledger's base58 format.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:29
    • 
 
    
 
    Optional accounts_proposed
    
 
    accounts_proposed?: string[]
    
@@ -58,7 +58,7 @@ XRP Ledger's base58 format.
    
 not-yet-validated transactions.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:34
    • 
 
    
 
    Optional api_version
    
 
    api_version?: number
    
@@ -66,7 +66,7 @@ not-yet-validated transactions.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14
    • 
 
    
 
    Optional books
    
 
    books?: Book[]
    
@@ -74,13 +74,13 @@ not-yet-validated transactions.
    
 below.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:39
    • 
 
    
 
    command
    
 
    command: "unsubscribe"
    
+
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:19
    • 
 
    
 
    Optional id
    
 
    id?: string | number
    
@@ -90,7 +90,7 @@ know which request prompted which response.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:10
    • 
 
    
 
    Optional streams
    
 
    streams?: StreamType[]
    
@@ -98,7 +98,7 @@ know which request prompted which response.
    
 Ledger, server, transactions, and transactions_proposed.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:24
    • 
 
    
 
    
 
    
@@ -125,13 +125,13 @@ Ledger, server, transactions, and transactions_proposed.
    
 
    
+
  • id?
    • 
+
  • streams?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/UnsubscribeResponse.html b/docs/interfaces/UnsubscribeResponse.html
index b6697d95..21ca3e4d 100644
--- a/docs/interfaces/UnsubscribeResponse.html
+++ b/docs/interfaces/UnsubscribeResponse.html
@@ -23,7 +23,7 @@
 
      
 
    • UnsubscribeResponse
    
+
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:47
    • 
 
    
 
    
 
    
@@ -31,14 +31,14 @@
 
    
 
    
 
    Properties
    
-
    api_version
-forwarded
+
    api_version?
+forwarded?
 id
 result
-status
+status?
 type
-warning
-warnings
+warning?
+warnings?
 
    
 
    
 
    Properties
    
@@ -47,49 +47,49 @@
 
    api_version?: number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:31
    • 
 
    
 
    Optional forwarded
    
 
    forwarded?: boolean
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:30
    • 
 
    
 
    id
    
 
    id: string | number
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:24
    • 
 
    
 
    result
    
 
    result: Record<string, never>
    
+
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:48
    • 
 
    
 
    Optional status
    
 
    status?: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:25
    • 
 
    
 
    type
    
 
    type: string
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • 
 
    
 
    Optional warning
    
 
    warning?: "load"
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • 
 
    
 
    Optional warnings
    
 
    warnings?: Warning[]
    
+
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29
    • 
 
    
 
    
 
    
@@ -116,14 +116,14 @@
 
    
+
  • warning?
    • 
+
  • warnings?
    • 
 
    
 
    Generated using TypeDoc
    
 
    
\ No newline at end of file
diff --git a/docs/interfaces/ValidationStream.html b/docs/interfaces/ValidationStream.html
index c6bd878f..65478ee3 100644
--- a/docs/interfaces/ValidationStream.html
+++ b/docs/interfaces/ValidationStream.html
@@ -25,7 +25,7 @@ validation message is from a trusted validator.
    
 
      
 
    • ValidationStream
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:183
    • 
 
    
 
    
 
    
@@ -33,16 +33,16 @@ validation message is from a trusted validator.
    
 
    
 
    
 
    Properties
    
-
    amendments
-base_fee
+
    amendments?
+base_fee?
 flags
 full
 ledger_hash
 ledger_index
-load_fee
-master_key
-reserve_base
-reserve_inc
+load_fee?
+master_key?
+reserve_base?
+reserve_inc?
 signature
 signing_time
 type
@@ -57,14 +57,14 @@ validation message is from a trusted validator.
    
 Stream.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:189
    • 
 
    
 
    Optional base_fee
    
 
    base_fee?: number
    
 
    The amendments this server wants to be added to the protocol.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:191
    • 
 
    
 
    flags
    
 
    flags: number
    
@@ -72,7 +72,7 @@ Stream.
    
 set by Fee voting.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:196
    • 
 
    
 
    full
    
 
    full: boolean
    
@@ -84,7 +84,7 @@ particular ledger. A partial validation indicates that the validator is
 still online but not keeping up with consensus.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:205
    • 
 
    
 
    ledger_hash
    
 
    ledger_hash: string
    
@@ -94,14 +94,14 @@ ledger. A partial validation indicates that the validator is still online
 but not keeping up with consensus.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:212
    • 
 
    
 
    ledger_index
    
 
    ledger_index: string
    
 
    The ledger index of the proposed ledger.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:214
    • 
 
    
 
    Optional load_fee
    
 
    load_fee?: number
    
@@ -109,7 +109,7 @@ but not keeping up with consensus.
    
 enforcing, in fee units.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:219
    • 
 
    
 
    Optional master_key
    
 
    master_key?: string
    
@@ -117,7 +117,7 @@ enforcing, in fee units.
    
 token, in the XRP Ledger's base58 format.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:224
    • 
 
    
 
    Optional reserve_base
    
 
    reserve_base?: number
    
@@ -125,7 +125,7 @@ token, in the XRP Ledger's base58 format.
    
 wants to set by fee voting.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:229
    • 
 
    
 
    Optional reserve_inc
    
 
    reserve_inc?: number
    
@@ -133,27 +133,27 @@ wants to set by fee voting.
    
 validator wants to set by fee voting.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:234
    • 
 
    
 
    signature
    
 
    signature: string
    
 
    The signature that the validator used to sign its vote for this ledger.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:236
    • 
 
    
 
    signing_time
    
 
    signing_time: number
    
 
    When this validation vote was signed, in seconds since the Ripple Epoch.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:238
    • 
 
    
 
    type
    
 
    type: "validationReceived"
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:184
    • 
 
    
 
    validation_public_key
    
 
    validation_public_key: string
    
@@ -163,7 +163,7 @@ sending the message and can also be used to verify the signature. If the
 validator is using a token, this is an ephemeral public key.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:245
    • 
 
    
 
    
 
    
@@ -190,16 +190,16 @@ validator is using a token, this is an ephemeral public key.
    
 
      
 
    • ValidationStream
 
 
      
 
      deriveKeypair
      
-
      deriveKeypair: ((seed: string, options?: object) => { privateKey: string; publicKey: string })
      
+
      deriveKeypair: ((seed: string, options?: object) => { 
          privateKey: string; 
          publicKey: string; 
      })
      
 
      
 
      Type declaration
      
 
        
 
      • 
 
          
-
        • (seed: string, options?: object): { privateKey: string; publicKey: string }
          • 
+
        • (seed: string, options?: object): { 
              privateKey: string; 
              publicKey: string; 
          }
          • 
 
        • 
 
          
 
          Parameters
          
@@ -281,7 +281,7 @@
 
          seed: string
          • 
 
        • 
 
          Optional options: object
      
-
      Returns { privateKey: string; publicKey: string }
      
+
      Returns { 
          privateKey: string; 
          publicKey: string; 
      }
      
 
        
 
      • 
 
        privateKey: string
        • 
diff --git a/docs/modules/LedgerEntry.html b/docs/modules/LedgerEntry.html
index 48ce9cec..a6bcad12 100644
--- a/docs/modules/LedgerEntry.html
+++ b/docs/modules/LedgerEntry.html
@@ -22,7 +22,7 @@ a Ledger Entry, import LedgerEntry, and access individual ledger en
 types on the LedgerEntry namespace.
        
 
    
+
  • Defined in packages/xrpl/src/models/ledger/index.ts:1
    • 
 
    
 
    
 
    Index
    
diff --git a/docs/types/LedgerEntry.LedgerEntry.html b/docs/types/LedgerEntry.LedgerEntry.html
index bb59cee4..f5cbe00c 100644
--- a/docs/types/LedgerEntry.LedgerEntry.html
+++ b/docs/types/LedgerEntry.LedgerEntry.html
@@ -16,7 +16,7 @@
 
    Type alias LedgerEntry
    
 
    LedgerEntry: AccountRoot | Amendments | Check | LedgerEntry.DepositPreauth | DirectoryNode | Escrow | FeeSettings | LedgerHashes | NegativeUNL | Offer | PayChannel | RippleState | SignerList | Ticket
    
+
  • Defined in packages/xrpl/src/models/ledger/LedgerEntry.ts:16
    • 
 
    
 
    
 
    
diff --git a/docs/types/PathFindRequest.html b/docs/types/PathFindRequest.html
index 38bf4eef..012f6d14 100644
--- a/docs/types/PathFindRequest.html
+++ b/docs/types/PathFindRequest.html
@@ -20,7 +20,7 @@ time. For a simpler version that is supported by JSON-RPC, see the
 ripple_path_find method.
    
 
    
+
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:53
    • 
 
    
 
    
 
    
diff --git a/docs/types/Request.html b/docs/types/Request.html
index 20cf416c..553addef 100644
--- a/docs/types/Request.html
+++ b/docs/types/Request.html
@@ -15,7 +15,7 @@
 
    Type alias Request
    
 
    Request: AccountChannelsRequest | AccountCurrenciesRequest | AccountInfoRequest | AccountLinesRequest | AccountNFTsRequest | AccountObjectsRequest | AccountOffersRequest | AccountTxRequest | GatewayBalancesRequest | NoRippleCheckRequest | LedgerRequest | LedgerClosedRequest | LedgerCurrentRequest | LedgerDataRequest | LedgerEntryRequest | SubmitRequest | SubmitMultisignedRequest | TransactionEntryRequest | TxRequest | BookOffersRequest | DepositAuthorizedRequest | PathFindRequest | RipplePathFindRequest | ChannelVerifyRequest | SubscribeRequest | UnsubscribeRequest | FeeRequest | ManifestRequest | ServerInfoRequest | ServerStateRequest | PingRequest | RandomRequest | NFTBuyOffersRequest | NFTSellOffersRequest | FederatorInfoRequest
    
+
  • Defined in packages/xrpl/src/models/methods/index.ts:80
    • 
 
    
 
    
 
    
diff --git a/docs/types/Response.html b/docs/types/Response.html
index 0fd20ca7..f2d3b2cf 100644
--- a/docs/types/Response.html
+++ b/docs/types/Response.html
@@ -15,7 +15,7 @@
 
    Type alias Response
    
 
    Response: AccountChannelsResponse | AccountCurrenciesResponse | AccountInfoResponse | AccountLinesResponse | AccountNFTsResponse | AccountObjectsResponse | AccountOffersResponse | AccountTxResponse | GatewayBalancesResponse | NoRippleCheckResponse | LedgerResponse | LedgerClosedResponse | LedgerCurrentResponse | LedgerDataResponse | LedgerEntryResponse | SubmitResponse | SubmitMultisignedResponse | TransactionEntryResponse | TxResponse | BookOffersResponse | DepositAuthorizedResponse | PathFindResponse | RipplePathFindResponse | ChannelVerifyResponse | SubscribeResponse | UnsubscribeResponse | FeeResponse | ManifestResponse | ServerInfoResponse | ServerStateResponse | PingResponse | RandomResponse | NFTBuyOffersResponse | NFTSellOffersResponse | FederatorInfoResponse
    
+
  • Defined in packages/xrpl/src/models/methods/index.ts:130
    • 
 
    
 
    
 
    
diff --git a/docs/types/Stream.html b/docs/types/Stream.html
index 7077a76d..a253c053 100644
--- a/docs/types/Stream.html
+++ b/docs/types/Stream.html
@@ -15,7 +15,7 @@
 
    Type alias Stream
    
 
    Stream: LedgerStream | ValidationStream | TransactionStream | PathFindStream | PeerStatusStream | OrderBookStream | ConsensusStream
    
+
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:417
    • 
 
    
 
    
 
    
diff --git a/docs/types/Transaction.html b/docs/types/Transaction.html
index 6e0a8389..a0af6791 100644
--- a/docs/types/Transaction.html
+++ b/docs/types/Transaction.html
@@ -15,7 +15,7 @@
 
    Type alias Transaction
    
 
    Transaction: AccountDelete | AccountSet | CheckCancel | CheckCash | CheckCreate | DepositPreauth | EscrowCancel | EscrowCreate | EscrowFinish | NFTokenAcceptOffer | NFTokenBurn | NFTokenCancelOffer | NFTokenCreateOffer | NFTokenMint | OfferCancel | OfferCreate | Payment | PaymentChannelClaim | PaymentChannelCreate | PaymentChannelFund | SetRegularKey | SignerListSet | TicketCreate | TrustSet
    
+
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:57
    • 
 
    
 
    
 
    
diff --git a/docs/variables/hashes.html b/docs/variables/hashes.html
index 22b2aaa4..72510f71 100644
--- a/docs/variables/hashes.html
+++ b/docs/variables/hashes.html
@@ -13,7 +13,7 @@
 
  • xrpl
    • 
 
  • hashes
    • 
 
    Variable hashesConst 
    
-
    hashes: { hashAccountRoot: ((address: string) => string); hashEscrow: ((address: string, sequence: number) => string); hashLedger: ((ledger: Ledger, options?: { computeTreeHashes?: boolean }) => string); hashLedgerHeader: ((ledgerHeader: Ledger) => string); hashOfferId: ((address: string, sequence: number) => string); hashPaymentChannel: ((address: string, dstAddress: string, sequence: number) => string); hashSignedTx: ((tx: string | Transaction) => string); hashSignerListId: ((address: string) => string); hashStateTree: ((entries: LedgerEntry[]) => string); hashTrustline: ((address1: string, address2: string, currency: string) => string); hashTx: ((txBlobHex: string) => string); hashTxTree: ((transactions: (AccountDelete & { metaData?: TransactionMetadata } & AccountSet & { metaData?: TransactionMetadata } & CheckCancel & { metaData?: TransactionMetadata } & CheckCash & { metaData?: TransactionMetadata } & CheckCreate & { metaData?: TransactionMetadata } & DepositPreauth & { metaData?: TransactionMetadata } & EscrowCancel & { metaData?: TransactionMetadata } & EscrowCreate & { metaData?: TransactionMetadata } & EscrowFinish & { metaData?: TransactionMetadata } & NFTokenAcceptOffer & { metaData?: TransactionMetadata } & NFTokenBurn & { metaData?: TransactionMetadata } & NFTokenCancelOffer & { metaData?: TransactionMetadata } & NFTokenCreateOffer & { metaData?: TransactionMetadata } & NFTokenMint & { metaData?: TransactionMetadata } & OfferCancel & { metaData?: TransactionMetadata } & OfferCreate & { metaData?: TransactionMetadata } & Payment & { metaData?: TransactionMetadata } & PaymentChannelClaim & { metaData?: TransactionMetadata } & PaymentChannelCreate & { metaData?: TransactionMetadata } & PaymentChannelFund & { metaData?: TransactionMetadata } & SetRegularKey & { metaData?: TransactionMetadata } & SignerListSet & { metaData?: TransactionMetadata } & TicketCreate & { metaData?: TransactionMetadata } & TrustSet & { metaData?: TransactionMetadata })[]) => string) } = ...
    
+
    hashes: { 
        hashAccountRoot: ((address: string) => string); 
        hashEscrow: ((address: string, sequence: number) => string); 
        hashLedger: ((ledger: Ledger, options?: { 
            computeTreeHashes?: boolean; 
        }) => string); 
        hashLedgerHeader: ((ledgerHeader: Ledger) => string); 
        hashOfferId: ((address: string, sequence: number) => string); 
        hashPaymentChannel: ((address: string, dstAddress: string, sequence: number) => string); 
        hashSignedTx: ((tx: string | Transaction) => string); 
        hashSignerListId: ((address: string) => string); 
        hashStateTree: ((entries: LedgerEntry[]) => string); 
        hashTrustline: ((address1: string, address2: string, currency: string) => string); 
        hashTx: ((txBlobHex: string) => string); 
        hashTxTree: ((transactions: Object[]) => string); 
    } = ...
    
 
    
 
    Type declaration
    
 
      
@@ -65,11 +65,11 @@ Index is unique.
      
 
    
 
    Returns string
    
 
  • 
-
    hashLedger: ((ledger: Ledger, options?: { computeTreeHashes?: boolean }) => string)
    
+
    hashLedger: ((ledger: Ledger, options?: { 
        computeTreeHashes?: boolean; 
    }) => string)
    
 
      
 
    • 
 
        
-
      • (ledger: Ledger, options?: { computeTreeHashes?: boolean }): string
        • 
+
      • (ledger: Ledger, options?: { 
            computeTreeHashes?: boolean; 
        }): string
        • 
 
      • 
 
        Compute the hash of a ledger.
        
 
@@ -83,7 +83,7 @@ Index is unique.
        
 
        Ledger to compute the hash for.
        
 
        • 
 
      • 
-
        options: { computeTreeHashes?: boolean } = {}
        
+
        options: { 
            computeTreeHashes?: boolean; 
        } = {}
        
 
        Allow client to recompute Transaction and State Hashes.
        
 
        
 
          
@@ -282,11 +282,11 @@ Index is unique.
          
 
        
 
        Returns string
    • 
 
  • 
-
    hashTxTree: ((transactions: (AccountDelete & { metaData?: TransactionMetadata } & AccountSet & { metaData?: TransactionMetadata } & CheckCancel & { metaData?: TransactionMetadata } & CheckCash & { metaData?: TransactionMetadata } & CheckCreate & { metaData?: TransactionMetadata } & DepositPreauth & { metaData?: TransactionMetadata } & EscrowCancel & { metaData?: TransactionMetadata } & EscrowCreate & { metaData?: TransactionMetadata } & EscrowFinish & { metaData?: TransactionMetadata } & NFTokenAcceptOffer & { metaData?: TransactionMetadata } & NFTokenBurn & { metaData?: TransactionMetadata } & NFTokenCancelOffer & { metaData?: TransactionMetadata } & NFTokenCreateOffer & { metaData?: TransactionMetadata } & NFTokenMint & { metaData?: TransactionMetadata } & OfferCancel & { metaData?: TransactionMetadata } & OfferCreate & { metaData?: TransactionMetadata } & Payment & { metaData?: TransactionMetadata } & PaymentChannelClaim & { metaData?: TransactionMetadata } & PaymentChannelCreate & { metaData?: TransactionMetadata } & PaymentChannelFund & { metaData?: TransactionMetadata } & SetRegularKey & { metaData?: TransactionMetadata } & SignerListSet & { metaData?: TransactionMetadata } & TicketCreate & { metaData?: TransactionMetadata } & TrustSet & { metaData?: TransactionMetadata })[]) => string)
    
+
    hashTxTree: ((transactions: Object[]) => string)
    
 
    • 
+
  • Defined in packages/xrpl/src/utils/index.ts:161
    • 
 
    
 
    
 
    
diff --git a/package-lock.json b/package-lock.json
index 4a5f8e12..34eb6f0d 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -29,6 +29,7 @@
         "assert": "^2.0.0",
         "buffer": "^6.0.2",
         "chai": "^4.3.4",
+        "copyfiles": "^2.4.1",
         "crypto-browserify": "^3.12.0",
         "ejs": "^3.0.1",
         "eslint": "^7.5.0",
@@ -52,7 +53,6 @@
         "prettier": "^2.3.2",
         "process": "^0.11.10",
         "puppeteer": "^13.7.0",
-        "run-script-os": "^1.1.6",
         "source-map-loader": "^3.0.1",
         "source-map-support": "^0.5.16",
         "stream-browserify": "^3.0.0",
@@ -68,7 +68,7 @@
         "webpack-cli": "^4.2.0"
       },
       "engines": {
-        "node": ">=10.0.0",
+        "node": ">=12.0.0",
         "npm": ">=7.0.0 < 8.0.0"
       }
     },
@@ -5217,6 +5217,77 @@
         "node": ">=0.10.0"
       }
     },
+    "node_modules/copyfiles": {
+      "version": "2.4.1",
+      "resolved": "https://registry.npmjs.org/copyfiles/-/copyfiles-2.4.1.tgz",
+      "integrity": "sha512-fereAvAvxDrQDOXybk3Qu3dPbOoKoysFMWtkY3mv5BsL8//OSZVL5DCLYqgRfY5cWirgRzlC+WSrxp6Bo3eNZg==",
+      "dev": true,
+      "dependencies": {
+        "glob": "^7.0.5",
+        "minimatch": "^3.0.3",
+        "mkdirp": "^1.0.4",
+        "noms": "0.0.0",
+        "through2": "^2.0.1",
+        "untildify": "^4.0.0",
+        "yargs": "^16.1.0"
+      },
+      "bin": {
+        "copyfiles": "copyfiles",
+        "copyup": "copyfiles"
+      }
+    },
+    "node_modules/copyfiles/node_modules/mkdirp": {
+      "version": "1.0.4",
+      "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
+      "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
+      "dev": true,
+      "bin": {
+        "mkdirp": "bin/cmd.js"
+      },
+      "engines": {
+        "node": ">=10"
+      }
+    },
+    "node_modules/copyfiles/node_modules/readable-stream": {
+      "version": "2.3.7",
+      "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.7.tgz",
+      "integrity": "sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw==",
+      "dev": true,
+      "dependencies": {
+        "core-util-is": "~1.0.0",
+        "inherits": "~2.0.3",
+        "isarray": "~1.0.0",
+        "process-nextick-args": "~2.0.0",
+        "safe-buffer": "~5.1.1",
+        "string_decoder": "~1.1.1",
+        "util-deprecate": "~1.0.1"
+      }
+    },
+    "node_modules/copyfiles/node_modules/safe-buffer": {
+      "version": "5.1.2",
+      "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
+      "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==",
+      "dev": true
+    },
+    "node_modules/copyfiles/node_modules/string_decoder": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz",
+      "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==",
+      "dev": true,
+      "dependencies": {
+        "safe-buffer": "~5.1.0"
+      }
+    },
+    "node_modules/copyfiles/node_modules/through2": {
+      "version": "2.0.5",
+      "resolved": "https://registry.npmjs.org/through2/-/through2-2.0.5.tgz",
+      "integrity": "sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ==",
+      "dev": true,
+      "dependencies": {
+        "readable-stream": "~2.3.6",
+        "xtend": "~4.0.1"
+      }
+    },
     "node_modules/core-js-pure": {
       "version": "3.19.1",
       "integrity": "sha512-Q0Knr8Es84vtv62ei6/6jXH/7izKmOrtrxH9WJTHLCMAVeU+8TF8z8Nr08CsH4Ot0oJKzBzJJL9SJBYIv7WlfQ==",
@@ -11564,6 +11635,40 @@
       "integrity": "sha512-CqyzN6z7Q6aMeF/ktcMVTzhAHCEpf8SOarwpzpf8pNBY2k5/oM34UHldUwp8VKI7uxct2HxSRdJjBaZeESzcxA==",
       "dev": true
     },
+    "node_modules/noms": {
+      "version": "0.0.0",
+      "resolved": "https://registry.npmjs.org/noms/-/noms-0.0.0.tgz",
+      "integrity": "sha512-lNDU9VJaOPxUmXcLb+HQFeUgQQPtMI24Gt6hgfuMHRJgMRHMF/qZ4HJD3GDru4sSw9IQl2jPjAYnQrdIeLbwow==",
+      "dev": true,
+      "dependencies": {
+        "inherits": "^2.0.1",
+        "readable-stream": "~1.0.31"
+      }
+    },
+    "node_modules/noms/node_modules/isarray": {
+      "version": "0.0.1",
+      "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz",
+      "integrity": "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==",
+      "dev": true
+    },
+    "node_modules/noms/node_modules/readable-stream": {
+      "version": "1.0.34",
+      "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.0.34.tgz",
+      "integrity": "sha512-ok1qVCJuRkNmvebYikljxJA/UEsKwLl2nI1OmaqAu4/UE+h0wKCHok4XkL/gvi39OacXvw59RJUOFUkDib2rHg==",
+      "dev": true,
+      "dependencies": {
+        "core-util-is": "~1.0.0",
+        "inherits": "~2.0.1",
+        "isarray": "0.0.1",
+        "string_decoder": "~0.10.x"
+      }
+    },
+    "node_modules/noms/node_modules/string_decoder": {
+      "version": "0.10.31",
+      "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz",
+      "integrity": "sha512-ev2QzSzWPYmy9GuqfIVildA4OdcGLeFZQrq5ys6RtiuF+RQQiZWr8TZNyAcuVXyQRYfEO+MsoB/1BuQVhOJuoQ==",
+      "dev": true
+    },
     "node_modules/nopt": {
       "version": "4.0.3",
       "integrity": "sha512-CvaGwVMztSMJLOeXPrez7fyfObdZqNUK1cPAEzLHrTybIua9pMdmmPR5YwtfNftIOMv3DPUhFaxsZMNTQO20Kg==",
@@ -13746,15 +13851,6 @@
         "queue-microtask": "^1.2.2"
       }
     },
-    "node_modules/run-script-os": {
-      "version": "1.1.6",
-      "integrity": "sha512-ql6P2LzhBTTDfzKts+Qo4H94VUKpxKDFz6QxxwaUZN0mwvi7L3lpOI7BqPCq7lgDh3XLl0dpeXwfcVIitlrYrw==",
-      "dev": true,
-      "bin": {
-        "run-os": "index.js",
-        "run-script-os": "index.js"
-      }
-    },
     "node_modules/rxjs": {
       "version": "6.6.7",
       "integrity": "sha512-hTdwr+7yYNIT5n4AMYp85KA6yw2Va0FLa3Rguvbpa4W3I5xynaBZo41cM3XM+4Q6fRMj3sBYIR1VAmZMXYJvRQ==",
@@ -15938,6 +16034,15 @@
         "node": ">=0.10.0"
       }
     },
+    "node_modules/untildify": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/untildify/-/untildify-4.0.0.tgz",
+      "integrity": "sha512-KK8xQ1mkzZeg9inewmFVDNkg3l5LUhoq9kN6iWYB/CC9YMG8HA+c1Q8HwDe6dEX7kErrEVNVBO3fWsVq5iDgtw==",
+      "dev": true,
+      "engines": {
+        "node": ">=8"
+      }
+    },
     "node_modules/upath": {
       "version": "2.0.1",
       "integrity": "sha512-1uEe95xksV1O0CYKXo8vQvN1JEbtJp7lb7C5U9HMsIp6IVwntkH/oNUzyVNQSd4S1sYk2FpSSW44FqMc8qee5w==",
@@ -16818,7 +16923,7 @@
       }
     },
     "packages/xrpl": {
-      "version": "2.4.0",
+      "version": "2.5.0",
       "integrity": "sha512-NmrSYpXym7NzGABeXU1H8g4ZtCxRhr/3wu0lguxzcIYpcKPgWLYimg+s9NLLNbPWTZdxXu9SeSWu5zh4gyqAeA==",
       "license": "ISC",
       "dependencies": {
@@ -20908,6 +21013,69 @@
       "integrity": "sha1-Z29us8OZl8LuGsOpJP1hJHSPV40=",
       "dev": true
     },
+    "copyfiles": {
+      "version": "2.4.1",
+      "resolved": "https://registry.npmjs.org/copyfiles/-/copyfiles-2.4.1.tgz",
+      "integrity": "sha512-fereAvAvxDrQDOXybk3Qu3dPbOoKoysFMWtkY3mv5BsL8//OSZVL5DCLYqgRfY5cWirgRzlC+WSrxp6Bo3eNZg==",
+      "dev": true,
+      "requires": {
+        "glob": "^7.0.5",
+        "minimatch": "^3.0.3",
+        "mkdirp": "^1.0.4",
+        "noms": "0.0.0",
+        "through2": "^2.0.1",
+        "untildify": "^4.0.0",
+        "yargs": "^16.1.0"
+      },
+      "dependencies": {
+        "mkdirp": {
+          "version": "1.0.4",
+          "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
+          "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
+          "dev": true
+        },
+        "readable-stream": {
+          "version": "2.3.7",
+          "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.7.tgz",
+          "integrity": "sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw==",
+          "dev": true,
+          "requires": {
+            "core-util-is": "~1.0.0",
+            "inherits": "~2.0.3",
+            "isarray": "~1.0.0",
+            "process-nextick-args": "~2.0.0",
+            "safe-buffer": "~5.1.1",
+            "string_decoder": "~1.1.1",
+            "util-deprecate": "~1.0.1"
+          }
+        },
+        "safe-buffer": {
+          "version": "5.1.2",
+          "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
+          "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==",
+          "dev": true
+        },
+        "string_decoder": {
+          "version": "1.1.1",
+          "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz",
+          "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==",
+          "dev": true,
+          "requires": {
+            "safe-buffer": "~5.1.0"
+          }
+        },
+        "through2": {
+          "version": "2.0.5",
+          "resolved": "https://registry.npmjs.org/through2/-/through2-2.0.5.tgz",
+          "integrity": "sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ==",
+          "dev": true,
+          "requires": {
+            "readable-stream": "~2.3.6",
+            "xtend": "~4.0.1"
+          }
+        }
+      }
+    },
     "core-js-pure": {
       "version": "3.19.1",
       "integrity": "sha512-Q0Knr8Es84vtv62ei6/6jXH/7izKmOrtrxH9WJTHLCMAVeU+8TF8z8Nr08CsH4Ot0oJKzBzJJL9SJBYIv7WlfQ==",
@@ -25722,6 +25890,42 @@
       "integrity": "sha512-CqyzN6z7Q6aMeF/ktcMVTzhAHCEpf8SOarwpzpf8pNBY2k5/oM34UHldUwp8VKI7uxct2HxSRdJjBaZeESzcxA==",
       "dev": true
     },
+    "noms": {
+      "version": "0.0.0",
+      "resolved": "https://registry.npmjs.org/noms/-/noms-0.0.0.tgz",
+      "integrity": "sha512-lNDU9VJaOPxUmXcLb+HQFeUgQQPtMI24Gt6hgfuMHRJgMRHMF/qZ4HJD3GDru4sSw9IQl2jPjAYnQrdIeLbwow==",
+      "dev": true,
+      "requires": {
+        "inherits": "^2.0.1",
+        "readable-stream": "~1.0.31"
+      },
+      "dependencies": {
+        "isarray": {
+          "version": "0.0.1",
+          "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz",
+          "integrity": "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==",
+          "dev": true
+        },
+        "readable-stream": {
+          "version": "1.0.34",
+          "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.0.34.tgz",
+          "integrity": "sha512-ok1qVCJuRkNmvebYikljxJA/UEsKwLl2nI1OmaqAu4/UE+h0wKCHok4XkL/gvi39OacXvw59RJUOFUkDib2rHg==",
+          "dev": true,
+          "requires": {
+            "core-util-is": "~1.0.0",
+            "inherits": "~2.0.1",
+            "isarray": "0.0.1",
+            "string_decoder": "~0.10.x"
+          }
+        },
+        "string_decoder": {
+          "version": "0.10.31",
+          "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz",
+          "integrity": "sha512-ev2QzSzWPYmy9GuqfIVildA4OdcGLeFZQrq5ys6RtiuF+RQQiZWr8TZNyAcuVXyQRYfEO+MsoB/1BuQVhOJuoQ==",
+          "dev": true
+        }
+      }
+    },
     "nopt": {
       "version": "4.0.3",
       "integrity": "sha512-CvaGwVMztSMJLOeXPrez7fyfObdZqNUK1cPAEzLHrTybIua9pMdmmPR5YwtfNftIOMv3DPUhFaxsZMNTQO20Kg==",
@@ -27381,11 +27585,6 @@
         "queue-microtask": "^1.2.2"
       }
     },
-    "run-script-os": {
-      "version": "1.1.6",
-      "integrity": "sha512-ql6P2LzhBTTDfzKts+Qo4H94VUKpxKDFz6QxxwaUZN0mwvi7L3lpOI7BqPCq7lgDh3XLl0dpeXwfcVIitlrYrw==",
-      "dev": true
-    },
     "rxjs": {
       "version": "6.6.7",
       "integrity": "sha512-hTdwr+7yYNIT5n4AMYp85KA6yw2Va0FLa3Rguvbpa4W3I5xynaBZo41cM3XM+4Q6fRMj3sBYIR1VAmZMXYJvRQ==",
@@ -29023,6 +29222,12 @@
         }
       }
     },
+    "untildify": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/untildify/-/untildify-4.0.0.tgz",
+      "integrity": "sha512-KK8xQ1mkzZeg9inewmFVDNkg3l5LUhoq9kN6iWYB/CC9YMG8HA+c1Q8HwDe6dEX7kErrEVNVBO3fWsVq5iDgtw==",
+      "dev": true
+    },
     "upath": {
       "version": "2.0.1",
       "integrity": "sha512-1uEe95xksV1O0CYKXo8vQvN1JEbtJp7lb7C5U9HMsIp6IVwntkH/oNUzyVNQSd4S1sYk2FpSSW44FqMc8qee5w==",
diff --git a/package.json b/package.json
index 194109c0..b44fc1e8 100644
--- a/package.json
+++ b/package.json
@@ -31,6 +31,7 @@
     "assert": "^2.0.0",
     "buffer": "^6.0.2",
     "chai": "^4.3.4",
+    "copyfiles": "^2.4.1",
     "crypto-browserify": "^3.12.0",
     "ejs": "^3.0.1",
     "eslint": "^7.5.0",
@@ -54,7 +55,6 @@
     "prettier": "^2.3.2",
     "process": "^0.11.10",
     "puppeteer": "^13.7.0",
-    "run-script-os": "^1.1.6",
     "source-map-loader": "^3.0.1",
     "source-map-support": "^0.5.16",
     "stream-browserify": "^3.0.0",
diff --git a/packages/ripple-binary-codec/package.json b/packages/ripple-binary-codec/package.json
index 95ad7eb5..0d656a39 100644
--- a/packages/ripple-binary-codec/package.json
+++ b/packages/ripple-binary-codec/package.json
@@ -20,9 +20,7 @@
     "ripple-address-codec": "^4.2.4"
   },
   "scripts": {
-    "build": "run-script-os",
-    "build:default": "tsc -b && copy .\\src\\enums\\definitions.json .\\dist\\enums",
-    "build:nix": "tsc -b && cp ./src/enums/definitions.json ./dist/enums",
+    "build": "tsc -b && copyfiles ./src/enums/definitions.json ./dist/enums/",
     "clean": "rm -rf ./dist && rm -rf tsconfig.tsbuildinfo",
     "prepare": "npm run build && npm test",
     "test": "jest",
diff --git a/packages/xrpl/HISTORY.md b/packages/xrpl/HISTORY.md
index bc35b6d1..fbfdd9b8 100644
--- a/packages/xrpl/HISTORY.md
+++ b/packages/xrpl/HISTORY.md
@@ -3,10 +3,15 @@
 Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xrpl-announce) for release announcements. We recommend that xrpl.js (ripple-lib) users stay up-to-date with the latest stable release.
 ## Unreleased
 
+## 2.5.0 (2022-10-13)
+### Added
+* Support for ExpandedSignerList amendment that expands the maximum signer list to 32 entries.
+* Add `cookie` and `data` to `ValidationStream` interface
+* Addtional check for memos field format, provide more detailed error messages.
+
 ## 2.4.0 (2022-09-01)
 ### Added
-
-- Export `verify` from ripple-keypairs as `verifyKeypairSignature` for use in web-apps.
+* Export `verify` from ripple-keypairs as `verifyKeypairSignature` for use in web-apps.
 
 ### Fixed
 * `Wallet.fromMnemonic` now allows lowercase for RFC1751 mnemonics (#2046)
diff --git a/packages/xrpl/package-lock.json b/packages/xrpl/package-lock.json
index c9ebb088..63fb3726 100644
--- a/packages/xrpl/package-lock.json
+++ b/packages/xrpl/package-lock.json
@@ -1,6 +1,6 @@
 {
   "name": "xrpl",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
diff --git a/packages/xrpl/package.json b/packages/xrpl/package.json
index d0927b9e..c0f701af 100644
--- a/packages/xrpl/package.json
+++ b/packages/xrpl/package.json
@@ -1,6 +1,6 @@
 {
   "name": "xrpl",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "license": "ISC",
   "description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
   "files": [
diff --git a/packages/xrpl/snippets/src/setRegularKey.ts b/packages/xrpl/snippets/src/setRegularKey.ts
index f0a8ae0c..db59937d 100644
--- a/packages/xrpl/snippets/src/setRegularKey.ts
+++ b/packages/xrpl/snippets/src/setRegularKey.ts
@@ -41,7 +41,7 @@ async function setRegularKey(): Promise {
   }
 
   const submitTx = await client.submit(payment, {
-    wallet: wallet1,
+    wallet: regularKeyWallet,
   })
   console.log('Response for tx signed using Regular Key:')
   console.log(submitTx)
diff --git a/packages/xrpl/src/Wallet/index.ts b/packages/xrpl/src/Wallet/index.ts
index c5f77182..a1b2ea88 100644
--- a/packages/xrpl/src/Wallet/index.ts
+++ b/packages/xrpl/src/Wallet/index.ts
@@ -439,14 +439,23 @@ class Wallet {
     txCopy.Memos?.map((memo) => {
       const memoCopy = { ...memo }
       if (memo.Memo.MemoData) {
+        if (!isHex(memo.Memo.MemoData)) {
+          throw new ValidationError('MemoData field must be a hex value')
+        }
         memoCopy.Memo.MemoData = memo.Memo.MemoData.toUpperCase()
       }
 
       if (memo.Memo.MemoType) {
+        if (!isHex(memo.Memo.MemoType)) {
+          throw new ValidationError('MemoType field must be a hex value')
+        }
         memoCopy.Memo.MemoType = memo.Memo.MemoType.toUpperCase()
       }
 
       if (memo.Memo.MemoFormat) {
+        if (!isHex(memo.Memo.MemoFormat)) {
+          throw new ValidationError('MemoFormat field must be a hex value')
+        }
         memoCopy.Memo.MemoFormat = memo.Memo.MemoFormat.toUpperCase()
       }
 
diff --git a/packages/xrpl/src/models/common/index.ts b/packages/xrpl/src/models/common/index.ts
index 7881af45..26625c74 100644
--- a/packages/xrpl/src/models/common/index.ts
+++ b/packages/xrpl/src/models/common/index.ts
@@ -4,6 +4,7 @@ export type AccountObjectType =
   | 'check'
   | 'deposit_preauth'
   | 'escrow'
+  | 'nft_offer'
   | 'offer'
   | 'payment_channel'
   | 'signer_list'
@@ -61,10 +62,31 @@ interface PathStep {
 
 export type Path = PathStep[]
 
+/**
+ * The object that describes the signer in SignerEntries.
+ */
 export interface SignerEntry {
+  /**
+   * The object that describes the signer in SignerEntries.
+   */
   SignerEntry: {
+    /**
+     * An XRP Ledger address whose signature contributes to the multi-signature.
+     * It does not need to be a funded address in the ledger.
+     */
     Account: string
+    /**
+     * The weight of a signature from this signer.
+     * A multi-signature is only valid if the sum weight of the signatures provided meets
+     * or exceeds the signer list's SignerQuorum value.
+     */
     SignerWeight: number
+    /**
+     * An arbitrary 256-bit (32-byte) field that can be used to identify the signer, which
+     * may be useful for smart contracts, or for identifying who controls a key in a large
+     * organization.
+     */
+    WalletLocator?: string
   }
 }
 
diff --git a/packages/xrpl/src/models/ledger/AccountRoot.ts b/packages/xrpl/src/models/ledger/AccountRoot.ts
index 72c039ef..cb26bcdb 100644
--- a/packages/xrpl/src/models/ledger/AccountRoot.ts
+++ b/packages/xrpl/src/models/ledger/AccountRoot.ts
@@ -108,7 +108,7 @@ export interface AccountRootFlagsInterface {
    */
   lsfGlobalFreeze?: boolean
   /**
-   * Enable rippling on this addresses's trust lines by default. Required for issuing addresses; discouraged for others.
+   * Enable rippling on this address's trust lines by default. Required for issuing addresses; discouraged for others.
    */
   lsfDefaultRipple?: boolean
   /**
@@ -148,7 +148,7 @@ export enum AccountRootFlags {
    */
   lsfGlobalFreeze = 0x00400000,
   /**
-   * Enable rippling on this addresses's trust lines by default. Required for issuing addresses; discouraged for others.
+   * Enable rippling on this address's trust lines by default. Required for issuing addresses; discouraged for others.
    */
   lsfDefaultRipple = 0x00800000,
   /**
diff --git a/packages/xrpl/src/models/methods/subscribe.ts b/packages/xrpl/src/models/methods/subscribe.ts
index 5f0ed891..346b9153 100644
--- a/packages/xrpl/src/models/methods/subscribe.ts
+++ b/packages/xrpl/src/models/methods/subscribe.ts
@@ -189,6 +189,18 @@ export interface ValidationStream extends BaseStream {
   amendments?: string[]
   /** The amendments this server wants to be added to the protocol. */
   base_fee?: number
+  /**
+   * An arbitrary value chosen by the server at startup.
+   *
+   * If the same validation key pair signs validations with different cookies
+   * concurrently, that usually indicates that multiple servers are incorrectly
+   * configured to use the same validation key pair.
+   */
+  cookie?: string
+  /**
+   * The contents of the validation message in its canonical binary form
+   */
+  data?: string
   /**
    * The unscaled transaction cost (reference_fee value) this server wants to
    * set by Fee voting.
diff --git a/packages/xrpl/src/models/transactions/metadata.ts b/packages/xrpl/src/models/transactions/metadata.ts
index af077745..ce9b680a 100644
--- a/packages/xrpl/src/models/transactions/metadata.ts
+++ b/packages/xrpl/src/models/transactions/metadata.ts
@@ -15,7 +15,7 @@ interface ModifiedNode {
     FinalFields?: { [field: string]: unknown }
     PreviousFields?: { [field: string]: unknown }
     PreviousTxnID?: string
-    PreviouTxnLgrSeq?: number
+    PreviousTxnLgrSeq?: number
   }
 }
 
diff --git a/packages/xrpl/src/models/transactions/signerListSet.ts b/packages/xrpl/src/models/transactions/signerListSet.ts
index c7dd3c3b..407aaecd 100644
--- a/packages/xrpl/src/models/transactions/signerListSet.ts
+++ b/packages/xrpl/src/models/transactions/signerListSet.ts
@@ -20,13 +20,15 @@ export interface SignerListSet extends BaseTransaction {
   /**
    * Array of SignerEntry objects, indicating the addresses and weights of
    * signers in this list. This signer list must have at least 1 member and no
-   * more than 8 members. No address may appear more than once in the list, nor
+   * more than 32 members. No address may appear more than once in the list, nor
    * may the Account submitting the transaction appear in the list.
    */
   SignerEntries: SignerEntry[]
 }
 
-const MAX_SIGNERS = 8
+const MAX_SIGNERS = 32
+
+const HEX_WALLET_LOCATOR_REGEX = /^[0-9A-Fa-f]{64}$/u
 
 /**
  * Verify the form and type of an SignerListSet at runtime.
@@ -55,13 +57,27 @@ export function validateSignerListSet(tx: Record): void {
 
   if (tx.SignerEntries.length === 0) {
     throw new ValidationError(
-      'SignerListSet: need atleast 1 member in SignerEntries',
+      'SignerListSet: need at least 1 member in SignerEntries',
     )
   }
 
   if (tx.SignerEntries.length > MAX_SIGNERS) {
     throw new ValidationError(
-      'SignerListSet: maximum of 8 members allowed in SignerEntries',
+      `SignerListSet: maximum of ${MAX_SIGNERS} members allowed in SignerEntries`,
     )
   }
+
+  for (const entry of tx.SignerEntries) {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Should be a SignerEntry
+    const signerEntry = entry as SignerEntry
+    const { WalletLocator } = signerEntry.SignerEntry
+    if (
+      WalletLocator !== undefined &&
+      !HEX_WALLET_LOCATOR_REGEX.test(WalletLocator)
+    ) {
+      throw new ValidationError(
+        `SignerListSet: WalletLocator in SignerEntry must be a 256-bit (32-byte) hexadecimal value`,
+      )
+    }
+  }
 }
diff --git a/packages/xrpl/src/sugar/submit.ts b/packages/xrpl/src/sugar/submit.ts
index fc3fb38e..2ba0c1bd 100644
--- a/packages/xrpl/src/sugar/submit.ts
+++ b/packages/xrpl/src/sugar/submit.ts
@@ -7,7 +7,7 @@ import { Transaction } from '../models/transactions'
 import { hashes } from '../utils'
 
 /** Approximate time for a ledger to close, in milliseconds */
-const LEDGER_CLOSE_TIME = 4000
+const LEDGER_CLOSE_TIME = 1000
 
 async function sleep(ms: number): Promise {
   return new Promise((resolve) => {
diff --git a/packages/xrpl/src/utils/getBalanceChanges.ts b/packages/xrpl/src/utils/getBalanceChanges.ts
index 1fcd9bf9..ab03e9b4 100644
--- a/packages/xrpl/src/utils/getBalanceChanges.ts
+++ b/packages/xrpl/src/utils/getBalanceChanges.ts
@@ -34,7 +34,7 @@ interface NormalizedNode {
   FinalFields?: Fields
   PreviousFields?: Fields
   PreviousTxnID?: string
-  PreviouTxnLgrSeq?: number
+  PreviousTxnLgrSeq?: number
 }
 
 function normalizeNode(affectedNode: Node): NormalizedNode {
diff --git a/packages/xrpl/test/models/signerListSet.ts b/packages/xrpl/test/models/signerListSet.ts
index 18d6563d..0b035347 100644
--- a/packages/xrpl/test/models/signerListSet.ts
+++ b/packages/xrpl/test/models/signerListSet.ts
@@ -66,12 +66,12 @@ describe('SignerListSet', function () {
     assert.throws(
       () => validateSignerListSet(signerListSetTx),
       ValidationError,
-      'SignerListSet: need atleast 1 member in SignerEntries',
+      'SignerListSet: need at least 1 member in SignerEntries',
     )
     assert.throws(
       () => validate(signerListSetTx),
       ValidationError,
-      'SignerListSet: need atleast 1 member in SignerEntries',
+      'SignerListSet: need at least 1 member in SignerEntries',
     )
   })
 
@@ -89,4 +89,127 @@ describe('SignerListSet', function () {
       'SignerListSet: invalid SignerEntries',
     )
   })
+
+  it(`throws w/ maximum of 32 members allowed in SignerEntries`, function () {
+    signerListSetTx.SignerEntries = []
+    const accounts = [
+      'rBFBipte4nAQCTsRxd2czwvSurhCpAf4X6',
+      'r3ijUH32iiy9tYNj3rD7hKWYjy1BFUxngm',
+      'rpwq8vi4Mn3L5kDJmb8Mg59CanPFPzMCnj',
+      'rB72Gzqfejai46nkA4HaKYBHwAnn2yUoT4',
+      'rGqsJSAW71pCfUwDD5m52bLw69RzFg6kMW',
+      'rs8smPRA31Ym4mGxb1wzgwxtU5eVK82Gyk',
+      'rLrugpGxzezUQLDh7Jv1tZpouuV4MQLbU9',
+      'rUQ6zLXQdh1jJLGwMXp9P8rgi42kwuafzs',
+      'rMjY8sPdfxsyRrnVKQcutxr4mTHNXy9dEF',
+      'rUaxYLeFGm6SmMoa2WCqLKSyHwJyvaQmeG',
+      'r9wUfeVtqMfqrcDTfCpNYbNZvs5q9M9Rpo',
+      'rQncVNak5kvJGPUFa6fuKH7t8Usjs7Np1c',
+      'rnwbSSnPbVbUzuBa4etkeYrfy5v7SyhtPu',
+      'rDXh5D3t48MdBJyXByXq47k5P8Kuf1758B',
+      'rh1D4jd2mAiqUPHfAZ2cY9Nbfa3kAkaQXP',
+      'r9T129tXgtnyfGoLeS35c2HctaZAZSQoCH',
+      'rUd2uKsyCWfJP7Ve36mKoJbNCA7RYThnYk',
+      'r326x8PaAFtnaH7uoxaKrcDWuwpeHn4wDa',
+      'rpN3mkXkYhfNadcXPrY4LniM1KpM3egyQM',
+      'rsPKbR155hz1zrA4pSJp5Y2fxasZAatcHb',
+      'rsyWFLaEKTpaoSJusjpcDvGexuHCwMnqss',
+      'rUbc5RXfyF81oLDMgd3d7jpY9YMNMZG4XN',
+      'rGpYHM88BZe1iVKFHm5xiWYYxR74oxJEXf',
+      'rPsetWAtR1KxDtxzgHjRMD7Rc87rvXk5nD',
+      'rwSeNhL6Hi34igr12mCr61jY42psfTkWTq',
+      'r46Mygy98qjkDhVB6qs4sBnqaf7FPiA2vU',
+      'r4s8GmeYN4CiwVate1nMUvwMQbundqf5cW',
+      'rKAr4dQWDYG8cG2hSwJUVp4ry4WNaWiNgp',
+      'rPWXRLp1vqeUHEH3WiSKuyo9GM9XhaENQU',
+      'rPgmdBdRKGmndxNEYxUrrsYCZaS6go9RvW',
+      'rPDJZ9irzgwKRKScfEmuJMvUgrqZAJNCbL',
+      'rDuU2uSXMfEaoxN1qW8sj7aUNFLGEn3Hr2',
+      'rsbjSjA4TCB9gtm7x7SrWbZHB6g4tt9CGU',
+    ]
+    signerListSetTx.SignerQuorum = accounts.length
+    for (const acc of accounts) {
+      signerListSetTx.SignerEntries.push({
+        SignerEntry: {
+          Account: acc,
+          SignerWeight: 1,
+        },
+      })
+    }
+
+    const errorMessage =
+      'SignerListSet: maximum of 32 members allowed in SignerEntries'
+    assert.throws(
+      () => validateSignerListSet(signerListSetTx),
+      ValidationError,
+      errorMessage,
+    )
+    assert.throws(
+      () => validate(signerListSetTx),
+      ValidationError,
+      errorMessage,
+    )
+  })
+
+  it(`verifies valid WalletLocator in SignerEntries`, function () {
+    signerListSetTx.SignerQuorum = 3
+    signerListSetTx.SignerEntries = [
+      {
+        SignerEntry: {
+          Account: 'rBFBipte4nAQCTsRxd2czwvSurhCpAf4X6',
+          SignerWeight: 1,
+          WalletLocator:
+            'CAFECAFECAFECAFECAFECAFECAFECAFECAFECAFECAFECAFECAFECAFECAFECAFE',
+        },
+      },
+      {
+        SignerEntry: {
+          Account: 'r3ijUH32iiy9tYNj3rD7hKWYjy1BFUxngm',
+          SignerWeight: 1,
+        },
+      },
+      {
+        SignerEntry: {
+          Account: 'rpwq8vi4Mn3L5kDJmb8Mg59CanPFPzMCnj',
+          SignerWeight: 1,
+          WalletLocator:
+            '00000000000000000000000000000000000000000000000000000000DEADBEEF',
+        },
+      },
+    ]
+
+    assert.doesNotThrow(() => validateSignerListSet(signerListSetTx))
+    assert.doesNotThrow(() => validate(signerListSetTx))
+  })
+
+  it(`throws w/ invalid WalletLocator in SignerEntries`, function () {
+    signerListSetTx.SignerQuorum = 2
+    signerListSetTx.SignerEntries = [
+      {
+        SignerEntry: {
+          Account: 'rBFBipte4nAQCTsRxd2czwvSurhCpAf4X6',
+          SignerWeight: 1,
+          WalletLocator: 'not_valid',
+        },
+      },
+      {
+        SignerEntry: {
+          Account: 'r3ijUH32iiy9tYNj3rD7hKWYjy1BFUxngm',
+          SignerWeight: 1,
+        },
+      },
+    ]
+    const errorMessage =
+      'SignerListSet: WalletLocator in SignerEntry must be a 256-bit (32-byte) hexadecimal value'
+    assert.throws(
+      () => validateSignerListSet(signerListSetTx),
+      ValidationError,
+      errorMessage,
+    )
+    assert.throws(
+      () => validate(signerListSetTx),
+      ValidationError,
+      errorMessage,
+    )
+  })
 })
diff --git a/packages/xrpl/test/wallet/index.ts b/packages/xrpl/test/wallet/index.ts
index a34c3324..38de31bb 100644
--- a/packages/xrpl/test/wallet/index.ts
+++ b/packages/xrpl/test/wallet/index.ts
@@ -385,6 +385,83 @@ describe('Wallet', function () {
       })
     })
 
+    it('sign throws when MemoType is not a hex value', async function () {
+      const secret = 'shd2nxpFD6iBRKWsRss2P4tKMWyy9'
+      const lowercaseMemoTx: Transaction = {
+        TransactionType: 'Payment',
+        Flags: 2147483648,
+        Account: 'rwiZ3q3D3QuG4Ga2HyGdq3kPKJRGctVG8a',
+        Amount: '10000000',
+        LastLedgerSequence: 14000999,
+        Destination: 'rUeEBYXHo8vF86Rqir3zWGRQ84W9efdAQd',
+        Fee: '12',
+        Sequence: 12,
+        SourceTag: 8888,
+        DestinationTag: 9999,
+        Memos: [
+          {
+            Memo: {
+              MemoType: 'not hex value',
+              MemoData: '72656e74',
+            },
+          },
+        ],
+      }
+      assert.throws(() => {
+        Wallet.fromSeed(secret).sign(lowercaseMemoTx)
+      }, /MemoType field must be a hex value/u)
+    })
+    it('sign throws when MemoData is not a hex value', async function () {
+      const secret = 'shd2nxpFD6iBRKWsRss2P4tKMWyy9'
+      const lowercaseMemoTx: Transaction = {
+        TransactionType: 'Payment',
+        Flags: 2147483648,
+        Account: 'rwiZ3q3D3QuG4Ga2HyGdq3kPKJRGctVG8a',
+        Amount: '10000000',
+        LastLedgerSequence: 14000999,
+        Destination: 'rUeEBYXHo8vF86Rqir3zWGRQ84W9efdAQd',
+        Fee: '12',
+        Sequence: 12,
+        SourceTag: 8888,
+        DestinationTag: 9999,
+        Memos: [
+          {
+            Memo: {
+              MemoData: 'not hex value',
+            },
+          },
+        ],
+      }
+      assert.throws(() => {
+        Wallet.fromSeed(secret).sign(lowercaseMemoTx)
+      }, /MemoData field must be a hex value/u)
+    })
+    it('sign throws when MemoFormat is not a hex value', async function () {
+      const secret = 'shd2nxpFD6iBRKWsRss2P4tKMWyy9'
+      const lowercaseMemoTx: Transaction = {
+        TransactionType: 'Payment',
+        Flags: 2147483648,
+        Account: 'rwiZ3q3D3QuG4Ga2HyGdq3kPKJRGctVG8a',
+        Amount: '10000000',
+        LastLedgerSequence: 14000999,
+        Destination: 'rUeEBYXHo8vF86Rqir3zWGRQ84W9efdAQd',
+        Fee: '12',
+        Sequence: 12,
+        SourceTag: 8888,
+        DestinationTag: 9999,
+        Memos: [
+          {
+            Memo: {
+              MemoFormat: 'not hex value',
+            },
+          },
+        ],
+      }
+      assert.throws(() => {
+        Wallet.fromSeed(secret).sign(lowercaseMemoTx)
+      }, /MemoFormat field must be a hex value/u)
+    })
+
     it('sign with EscrowFinish', async function () {
       const result = wallet.sign(REQUEST_FIXTURES.escrow as Transaction)
       assert.deepEqual(result, {
diff --git a/packages/xrpl/typedoc.json b/packages/xrpl/typedoc.json
index 3c8f0072..7a69ea7e 100644
--- a/packages/xrpl/typedoc.json
+++ b/packages/xrpl/typedoc.json
@@ -15,5 +15,6 @@
     "Streams",
     "Errors"
   ],
-  "categorizeByGroup": false
+  "categorizeByGroup": false,
+  "readme": "../../README.md"
 }