diff --git a/docs/assets/main.js b/docs/assets/main.js index 4c8fa615..d0aa8d5f 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,7 +1,8 @@ "use strict"; -"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.slice(a,o),d))}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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},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),r=1,n=0;r0){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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=n}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-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 r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(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 d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}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(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+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),l=0;l1?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 se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(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"?ue(e,-1):s.key==="ArrowDown"?ue(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 Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(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 ce(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(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{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){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){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 te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{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()),ve.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),this.app.filterChanged(),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 Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 00000000..4b51b023 --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE42Tb2vCMBCHv0tey5wy3ea7/XEw2NgQXwxERkivNqxNSu4KyvC7L9NamzS2fdf2Hp78cndd/TKCLbEZe0AEWhquMAbzkEs2YDmnxFYyHRUp4NAnrhLKUov9SBWx2XjARCLTyIBis1UPrUi5rQW07eeMxnf79X5QHSC0QjKFIEt+Gp1JhGb0ANQvfS5fVazPQqkITMzFBWfJe+7JtG/euFCCpCWC9s5bTG+c1oAx2uDwkSPM/x+bfTkS3xXRqykVjXNVZGcp2LeA0sXdE9xR0i4HbIY8fO6V7FkaOPTPD3VUVGU/xDlCtXZmgx85YXDyR5uPtg19uV0AFim16UqkTeP/GW7Cg6e0hUjPfH1/O5qMa/an03pB9KJNximsbmBd3jZZP8ObFjw93Wbpbknd1uS6zO9AiY4u6Mpil2MBG2k7smsJ5iBdvi+RBRa5rqsTYdt6v/4DUimcANsFAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 087b0bd5..192f4e49 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":2,\"name\":\"AssetTransferApi\",\"url\":\"modules/AssetTransferApi.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"AssetTransferApi\",\"url\":\"classes/AssetTransferApi.AssetTransferApi.html\",\"classes\":\"\",\"parent\":\"AssetTransferApi\"},{\"kind\":2048,\"name\":\"createTransferTransaction\",\"url\":\"classes/AssetTransferApi.AssetTransferApi.html#createTransferTransaction\",\"classes\":\"\",\"parent\":\"AssetTransferApi.AssetTransferApi\"},{\"kind\":2048,\"name\":\"initializeRegistry\",\"url\":\"classes/AssetTransferApi.AssetTransferApi.html#initializeRegistry\",\"classes\":\"\",\"parent\":\"AssetTransferApi.AssetTransferApi\"},{\"kind\":2048,\"name\":\"fetchFeeInfo\",\"url\":\"classes/AssetTransferApi.AssetTransferApi.html#fetchFeeInfo\",\"classes\":\"\",\"parent\":\"AssetTransferApi.AssetTransferApi\"},{\"kind\":2048,\"name\":\"decodeExtrinsic\",\"url\":\"classes/AssetTransferApi.AssetTransferApi.html#decodeExtrinsic\",\"classes\":\"\",\"parent\":\"AssetTransferApi.AssetTransferApi\"},{\"kind\":2,\"name\":\"constructApiPromise\",\"url\":\"modules/constructApiPromise.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"ApiInfo\",\"url\":\"interfaces/constructApiPromise.ApiInfo.html\",\"classes\":\"\",\"parent\":\"constructApiPromise\"},{\"kind\":1024,\"name\":\"api\",\"url\":\"interfaces/constructApiPromise.ApiInfo.html#api\",\"classes\":\"\",\"parent\":\"constructApiPromise.ApiInfo\"},{\"kind\":1024,\"name\":\"specName\",\"url\":\"interfaces/constructApiPromise.ApiInfo.html#specName\",\"classes\":\"\",\"parent\":\"constructApiPromise.ApiInfo\"},{\"kind\":1024,\"name\":\"safeXcmVersion\",\"url\":\"interfaces/constructApiPromise.ApiInfo.html#safeXcmVersion\",\"classes\":\"\",\"parent\":\"constructApiPromise.ApiInfo\"},{\"kind\":64,\"name\":\"constructApiPromise\",\"url\":\"functions/constructApiPromise.constructApiPromise.html\",\"classes\":\"\",\"parent\":\"constructApiPromise\"},{\"kind\":2,\"name\":\"types\",\"url\":\"modules/types.html\",\"classes\":\"\"},{\"kind\":8,\"name\":\"Direction\",\"url\":\"enums/types.Direction.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":16,\"name\":\"Local\",\"url\":\"enums/types.Direction.html#Local\",\"classes\":\"\",\"parent\":\"types.Direction\"},{\"kind\":16,\"name\":\"SystemToPara\",\"url\":\"enums/types.Direction.html#SystemToPara\",\"classes\":\"\",\"parent\":\"types.Direction\"},{\"kind\":16,\"name\":\"SystemToRelay\",\"url\":\"enums/types.Direction.html#SystemToRelay\",\"classes\":\"\",\"parent\":\"types.Direction\"},{\"kind\":16,\"name\":\"SystemToSystem\",\"url\":\"enums/types.Direction.html#SystemToSystem\",\"classes\":\"\",\"parent\":\"types.Direction\"},{\"kind\":16,\"name\":\"ParaToPara\",\"url\":\"enums/types.Direction.html#ParaToPara\",\"classes\":\"\",\"parent\":\"types.Direction\"},{\"kind\":16,\"name\":\"ParaToRelay\",\"url\":\"enums/types.Direction.html#ParaToRelay\",\"classes\":\"\",\"parent\":\"types.Direction\"},{\"kind\":16,\"name\":\"ParaToSystem\",\"url\":\"enums/types.Direction.html#ParaToSystem\",\"classes\":\"\",\"parent\":\"types.Direction\"},{\"kind\":16,\"name\":\"RelayToSystem\",\"url\":\"enums/types.Direction.html#RelayToSystem\",\"classes\":\"\",\"parent\":\"types.Direction\"},{\"kind\":16,\"name\":\"RelayToPara\",\"url\":\"enums/types.Direction.html#RelayToPara\",\"classes\":\"\",\"parent\":\"types.Direction\"},{\"kind\":4194304,\"name\":\"XcmDirection\",\"url\":\"types/types.XcmDirection.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":4194304,\"name\":\"Format\",\"url\":\"types/types.Format.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":4194304,\"name\":\"ConstructedFormat\",\"url\":\"types/types.ConstructedFormat.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":4194304,\"name\":\"LocalTransferTypes\",\"url\":\"types/types.LocalTransferTypes.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":4194304,\"name\":\"Methods\",\"url\":\"types/types.Methods.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":4194304,\"name\":\"AssetTransferApiOpts\",\"url\":\"types/types.AssetTransferApiOpts.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/types.AssetTransferApiOpts.html#__type\",\"classes\":\"\",\"parent\":\"types.AssetTransferApiOpts\"},{\"kind\":1024,\"name\":\"injectedRegistry\",\"url\":\"types/types.AssetTransferApiOpts.html#__type.injectedRegistry\",\"classes\":\"\",\"parent\":\"types.AssetTransferApiOpts.__type\"},{\"kind\":1024,\"name\":\"registryType\",\"url\":\"types/types.AssetTransferApiOpts.html#__type.registryType\",\"classes\":\"\",\"parent\":\"types.AssetTransferApiOpts.__type\"},{\"kind\":4194304,\"name\":\"RegistryTypes\",\"url\":\"types/types.RegistryTypes.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":256,\"name\":\"TxResult\",\"url\":\"interfaces/types.TxResult.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":1024,\"name\":\"dest\",\"url\":\"interfaces/types.TxResult.html#dest\",\"classes\":\"\",\"parent\":\"types.TxResult\"},{\"kind\":1024,\"name\":\"origin\",\"url\":\"interfaces/types.TxResult.html#origin\",\"classes\":\"\",\"parent\":\"types.TxResult\"},{\"kind\":1024,\"name\":\"format\",\"url\":\"interfaces/types.TxResult.html#format\",\"classes\":\"\",\"parent\":\"types.TxResult\"},{\"kind\":1024,\"name\":\"xcmVersion\",\"url\":\"interfaces/types.TxResult.html#xcmVersion\",\"classes\":\"\",\"parent\":\"types.TxResult\"},{\"kind\":1024,\"name\":\"direction\",\"url\":\"interfaces/types.TxResult.html#direction\",\"classes\":\"\",\"parent\":\"types.TxResult\"},{\"kind\":1024,\"name\":\"method\",\"url\":\"interfaces/types.TxResult.html#method\",\"classes\":\"\",\"parent\":\"types.TxResult\"},{\"kind\":1024,\"name\":\"tx\",\"url\":\"interfaces/types.TxResult.html#tx\",\"classes\":\"\",\"parent\":\"types.TxResult\"},{\"kind\":256,\"name\":\"TransferArgsOpts\",\"url\":\"interfaces/types.TransferArgsOpts.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":1024,\"name\":\"format\",\"url\":\"interfaces/types.TransferArgsOpts.html#format\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts\"},{\"kind\":1024,\"name\":\"paysWithFeeOrigin\",\"url\":\"interfaces/types.TransferArgsOpts.html#paysWithFeeOrigin\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts\"},{\"kind\":1024,\"name\":\"paysWithFeeDest\",\"url\":\"interfaces/types.TransferArgsOpts.html#paysWithFeeDest\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts\"},{\"kind\":1024,\"name\":\"sendersAddr\",\"url\":\"interfaces/types.TransferArgsOpts.html#sendersAddr\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts\"},{\"kind\":1024,\"name\":\"isLimited\",\"url\":\"interfaces/types.TransferArgsOpts.html#isLimited\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts\"},{\"kind\":1024,\"name\":\"weightLimit\",\"url\":\"interfaces/types.TransferArgsOpts.html#weightLimit\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/types.TransferArgsOpts.html#weightLimit.__type\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts.weightLimit\"},{\"kind\":1024,\"name\":\"refTime\",\"url\":\"interfaces/types.TransferArgsOpts.html#weightLimit.__type.refTime\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts.weightLimit.__type\"},{\"kind\":1024,\"name\":\"proofSize\",\"url\":\"interfaces/types.TransferArgsOpts.html#weightLimit.__type.proofSize\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts.weightLimit.__type\"},{\"kind\":1024,\"name\":\"xcmVersion\",\"url\":\"interfaces/types.TransferArgsOpts.html#xcmVersion\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts\"},{\"kind\":1024,\"name\":\"keepAlive\",\"url\":\"interfaces/types.TransferArgsOpts.html#keepAlive\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts\"},{\"kind\":1024,\"name\":\"transferLiquidToken\",\"url\":\"interfaces/types.TransferArgsOpts.html#transferLiquidToken\",\"classes\":\"\",\"parent\":\"types.TransferArgsOpts\"},{\"kind\":2,\"name\":\"errors/BaseError\",\"url\":\"modules/errors_BaseError.html\",\"classes\":\"\"},{\"kind\":8,\"name\":\"BaseErrorsEnum\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html\",\"classes\":\"\",\"parent\":\"errors/BaseError\"},{\"kind\":16,\"name\":\"InvalidInput\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#InvalidInput\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"InvalidAsset\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#InvalidAsset\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"AssetNotFound\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#AssetNotFound\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"InvalidPallet\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#InvalidPallet\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"PalletNotFound\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#PalletNotFound\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"InvalidDirection\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#InvalidDirection\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"InvalidMultiLocationAsset\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#InvalidMultiLocationAsset\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"MultipleNonUniqueAssetsFound\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#MultipleNonUniqueAssetsFound\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"RegistryNotFound\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#RegistryNotFound\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"InvalidXcmVersion\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#InvalidXcmVersion\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"NotImplemented\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#NotImplemented\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"InternalError\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#InternalError\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"InvalidAddress\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#InvalidAddress\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"},{\"kind\":16,\"name\":\"DisabledOption\",\"url\":\"enums/errors_BaseError.BaseErrorsEnum.html#DisabledOption\",\"classes\":\"\",\"parent\":\"errors/BaseError.BaseErrorsEnum\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,33.464]],[\"comment/0\",[]],[\"name/1\",[0,33.464]],[\"comment/1\",[]],[\"name/2\",[1,38.572]],[\"comment/2\",[]],[\"name/3\",[2,38.572]],[\"comment/3\",[]],[\"name/4\",[3,38.572]],[\"comment/4\",[]],[\"name/5\",[4,38.572]],[\"comment/5\",[]],[\"name/6\",[5,33.464]],[\"comment/6\",[]],[\"name/7\",[6,38.572]],[\"comment/7\",[]],[\"name/8\",[7,38.572]],[\"comment/8\",[]],[\"name/9\",[8,38.572]],[\"comment/9\",[]],[\"name/10\",[9,38.572]],[\"comment/10\",[]],[\"name/11\",[5,33.464]],[\"comment/11\",[]],[\"name/12\",[10,38.572]],[\"comment/12\",[]],[\"name/13\",[11,33.464]],[\"comment/13\",[]],[\"name/14\",[12,38.572]],[\"comment/14\",[]],[\"name/15\",[13,38.572]],[\"comment/15\",[]],[\"name/16\",[14,38.572]],[\"comment/16\",[]],[\"name/17\",[15,38.572]],[\"comment/17\",[]],[\"name/18\",[16,38.572]],[\"comment/18\",[]],[\"name/19\",[17,38.572]],[\"comment/19\",[]],[\"name/20\",[18,38.572]],[\"comment/20\",[]],[\"name/21\",[19,38.572]],[\"comment/21\",[]],[\"name/22\",[20,38.572]],[\"comment/22\",[]],[\"name/23\",[21,38.572]],[\"comment/23\",[]],[\"name/24\",[22,30.099]],[\"comment/24\",[]],[\"name/25\",[23,38.572]],[\"comment/25\",[]],[\"name/26\",[24,38.572]],[\"comment/26\",[]],[\"name/27\",[25,38.572]],[\"comment/27\",[]],[\"name/28\",[26,38.572]],[\"comment/28\",[]],[\"name/29\",[27,33.464]],[\"comment/29\",[]],[\"name/30\",[28,38.572]],[\"comment/30\",[]],[\"name/31\",[29,38.572]],[\"comment/31\",[]],[\"name/32\",[30,38.572]],[\"comment/32\",[]],[\"name/33\",[31,38.572]],[\"comment/33\",[]],[\"name/34\",[32,38.572]],[\"comment/34\",[]],[\"name/35\",[33,38.572]],[\"comment/35\",[]],[\"name/36\",[22,30.099]],[\"comment/36\",[]],[\"name/37\",[34,33.464]],[\"comment/37\",[]],[\"name/38\",[11,33.464]],[\"comment/38\",[]],[\"name/39\",[35,38.572]],[\"comment/39\",[]],[\"name/40\",[36,38.572]],[\"comment/40\",[]],[\"name/41\",[37,38.572]],[\"comment/41\",[]],[\"name/42\",[22,30.099]],[\"comment/42\",[]],[\"name/43\",[38,38.572]],[\"comment/43\",[]],[\"name/44\",[39,38.572]],[\"comment/44\",[]],[\"name/45\",[40,38.572]],[\"comment/45\",[]],[\"name/46\",[41,38.572]],[\"comment/46\",[]],[\"name/47\",[42,38.572]],[\"comment/47\",[]],[\"name/48\",[27,33.464]],[\"comment/48\",[]],[\"name/49\",[43,38.572]],[\"comment/49\",[]],[\"name/50\",[44,38.572]],[\"comment/50\",[]],[\"name/51\",[34,33.464]],[\"comment/51\",[]],[\"name/52\",[45,38.572]],[\"comment/52\",[]],[\"name/53\",[46,38.572]],[\"comment/53\",[]],[\"name/54\",[47,38.572]],[\"comment/54\",[]],[\"name/55\",[48,38.572]],[\"comment/55\",[]],[\"name/56\",[49,38.572]],[\"comment/56\",[]],[\"name/57\",[50,38.572]],[\"comment/57\",[]],[\"name/58\",[51,38.572]],[\"comment/58\",[]],[\"name/59\",[52,38.572]],[\"comment/59\",[]],[\"name/60\",[53,38.572]],[\"comment/60\",[]],[\"name/61\",[54,38.572]],[\"comment/61\",[]],[\"name/62\",[55,38.572]],[\"comment/62\",[]],[\"name/63\",[56,38.572]],[\"comment/63\",[]],[\"name/64\",[57,38.572]],[\"comment/64\",[]],[\"name/65\",[58,38.572]],[\"comment/65\",[]],[\"name/66\",[59,38.572]],[\"comment/66\",[]],[\"name/67\",[60,38.572]],[\"comment/67\",[]],[\"name/68\",[61,38.572]],[\"comment/68\",[]],[\"name/69\",[62,38.572]],[\"comment/69\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":27,\"name\":{\"29\":{},\"48\":{}},\"comment\":{}}],[\"api\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"apiinfo\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"assetnotfound\",{\"_index\":51,\"name\":{\"58\":{}},\"comment\":{}}],[\"assettransferapi\",{\"_index\":0,\"name\":{\"0\":{},\"1\":{}},\"comment\":{}}],[\"assettransferapiopts\",{\"_index\":26,\"name\":{\"28\":{}},\"comment\":{}}],[\"baseerrorsenum\",{\"_index\":48,\"name\":{\"55\":{}},\"comment\":{}}],[\"constructapipromise\",{\"_index\":5,\"name\":{\"6\":{},\"11\":{}},\"comment\":{}}],[\"constructedformat\",{\"_index\":23,\"name\":{\"25\":{}},\"comment\":{}}],[\"createtransfertransaction\",{\"_index\":1,\"name\":{\"2\":{}},\"comment\":{}}],[\"decodeextrinsic\",{\"_index\":4,\"name\":{\"5\":{}},\"comment\":{}}],[\"dest\",{\"_index\":32,\"name\":{\"34\":{}},\"comment\":{}}],[\"direction\",{\"_index\":11,\"name\":{\"13\":{},\"38\":{}},\"comment\":{}}],[\"disabledoption\",{\"_index\":62,\"name\":{\"69\":{}},\"comment\":{}}],[\"errors/baseerror\",{\"_index\":47,\"name\":{\"54\":{}},\"comment\":{}}],[\"fetchfeeinfo\",{\"_index\":3,\"name\":{\"4\":{}},\"comment\":{}}],[\"format\",{\"_index\":22,\"name\":{\"24\":{},\"36\":{},\"42\":{}},\"comment\":{}}],[\"initializeregistry\",{\"_index\":2,\"name\":{\"3\":{}},\"comment\":{}}],[\"injectedregistry\",{\"_index\":28,\"name\":{\"30\":{}},\"comment\":{}}],[\"internalerror\",{\"_index\":60,\"name\":{\"67\":{}},\"comment\":{}}],[\"invalidaddress\",{\"_index\":61,\"name\":{\"68\":{}},\"comment\":{}}],[\"invalidasset\",{\"_index\":50,\"name\":{\"57\":{}},\"comment\":{}}],[\"invaliddirection\",{\"_index\":54,\"name\":{\"61\":{}},\"comment\":{}}],[\"invalidinput\",{\"_index\":49,\"name\":{\"56\":{}},\"comment\":{}}],[\"invalidmultilocationasset\",{\"_index\":55,\"name\":{\"62\":{}},\"comment\":{}}],[\"invalidpallet\",{\"_index\":52,\"name\":{\"59\":{}},\"comment\":{}}],[\"invalidxcmversion\",{\"_index\":58,\"name\":{\"65\":{}},\"comment\":{}}],[\"islimited\",{\"_index\":41,\"name\":{\"46\":{}},\"comment\":{}}],[\"keepalive\",{\"_index\":45,\"name\":{\"52\":{}},\"comment\":{}}],[\"local\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"localtransfertypes\",{\"_index\":24,\"name\":{\"26\":{}},\"comment\":{}}],[\"method\",{\"_index\":35,\"name\":{\"39\":{}},\"comment\":{}}],[\"methods\",{\"_index\":25,\"name\":{\"27\":{}},\"comment\":{}}],[\"multiplenonuniqueassetsfound\",{\"_index\":56,\"name\":{\"63\":{}},\"comment\":{}}],[\"notimplemented\",{\"_index\":59,\"name\":{\"66\":{}},\"comment\":{}}],[\"origin\",{\"_index\":33,\"name\":{\"35\":{}},\"comment\":{}}],[\"palletnotfound\",{\"_index\":53,\"name\":{\"60\":{}},\"comment\":{}}],[\"paratopara\",{\"_index\":16,\"name\":{\"18\":{}},\"comment\":{}}],[\"paratorelay\",{\"_index\":17,\"name\":{\"19\":{}},\"comment\":{}}],[\"paratosystem\",{\"_index\":18,\"name\":{\"20\":{}},\"comment\":{}}],[\"payswithfeedest\",{\"_index\":39,\"name\":{\"44\":{}},\"comment\":{}}],[\"payswithfeeorigin\",{\"_index\":38,\"name\":{\"43\":{}},\"comment\":{}}],[\"proofsize\",{\"_index\":44,\"name\":{\"50\":{}},\"comment\":{}}],[\"reftime\",{\"_index\":43,\"name\":{\"49\":{}},\"comment\":{}}],[\"registrynotfound\",{\"_index\":57,\"name\":{\"64\":{}},\"comment\":{}}],[\"registrytype\",{\"_index\":29,\"name\":{\"31\":{}},\"comment\":{}}],[\"registrytypes\",{\"_index\":30,\"name\":{\"32\":{}},\"comment\":{}}],[\"relaytopara\",{\"_index\":20,\"name\":{\"22\":{}},\"comment\":{}}],[\"relaytosystem\",{\"_index\":19,\"name\":{\"21\":{}},\"comment\":{}}],[\"safexcmversion\",{\"_index\":9,\"name\":{\"10\":{}},\"comment\":{}}],[\"sendersaddr\",{\"_index\":40,\"name\":{\"45\":{}},\"comment\":{}}],[\"specname\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"systemtopara\",{\"_index\":13,\"name\":{\"15\":{}},\"comment\":{}}],[\"systemtorelay\",{\"_index\":14,\"name\":{\"16\":{}},\"comment\":{}}],[\"systemtosystem\",{\"_index\":15,\"name\":{\"17\":{}},\"comment\":{}}],[\"transferargsopts\",{\"_index\":37,\"name\":{\"41\":{}},\"comment\":{}}],[\"transferliquidtoken\",{\"_index\":46,\"name\":{\"53\":{}},\"comment\":{}}],[\"tx\",{\"_index\":36,\"name\":{\"40\":{}},\"comment\":{}}],[\"txresult\",{\"_index\":31,\"name\":{\"33\":{}},\"comment\":{}}],[\"types\",{\"_index\":10,\"name\":{\"12\":{}},\"comment\":{}}],[\"weightlimit\",{\"_index\":42,\"name\":{\"47\":{}},\"comment\":{}}],[\"xcmdirection\",{\"_index\":21,\"name\":{\"23\":{}},\"comment\":{}}],[\"xcmversion\",{\"_index\":34,\"name\":{\"37\":{},\"51\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7WbW5ObuBKA/wvz6nIsCWkub9lNUpWqbDaVnbPnVKVSKdaWE04w+ABOZnZq/vuRBJhuaNlg2KeJ476pv25dQH4K8uxnEdx9egq+x+kmuOOLII12OrgLXhaFLu/zKC22On+5j4NFcMgT88Uu2xwSXbzoCiy/lbvESK2TyHxjjAbB86Kxy/jNecu1Zt/yAFeLYB/lOi0p+20YfBW2caxzHZW6EXR/o3UZZ+mFAV2dMjgs1J5hX+xxGpdxlMR/64/6a1yU+eOlQZOWZo52q8v1tzdav0232aVxdmzMHOFGr7ONfv1Q5nFaxOtLg+ybmSHOtmCz1PA5rEsj8CHPdnGhe11JyJxsTC5V25j7GBGK01Ln22jtMVuLn25GKmYwLax4eHQfgalghOurSm+w+0bZF0ax1+v39p+XxAKU5wso2ur/rHd/6ryAk9OosLompgSnwkEVuT2kbvKjwxtWp4MLqW2S8nFvdLtt4f73ZCO0c8GrONd4HdDpYdfYOH57OtwqDEC0bbN32TpKBti+agRPeGhVaF9/PBal3t1nH6I8GuKyIz+D5486iR7HuG4UZvBd/R3j/KgxwbvN3fCMI+nJXgdnG4tP9js80x35CZ5d8GNcdxWm+x4KGYuP9ctXt9dMtlOcmcn7c5RTr71DgXHTVNfVmyzfRSXppPpqmvlfm0ldb0546klNc+qm1eMuHS0X0GtfbJrb33T5LdvQvurvpjno7iF/35e0N0pwnGslpWib4csX+/04V1dHpVPdQA7Js02K0/9qWyK9A9GYeJaElbEBLuuheeLMa8v3l+Zs2bEwPb5uJX0EDugSQhIjyxacOO4fPurikLRtDza1laNGYuRuCyZ8o4uhDq5q2VMpPcbscZfl8deY3KZTDo/SU1xu8dx5xuVReorLh5MHEsrtw/nzxzDXm97adw4qUJjieOdm6aFej9JTXJYPQ905yZGuUCs2k0T+tUArR99vR3JCa54tXMrVwALujscTwj56LP4dl/bR0u/nOpeMhjIwc2CvTs9g58J6NWBSGxhUodONaeKXm00+NiCsOkcwcfEu3sVmsR4bClScI5CfOv76rXQ2x4aCVS8M5uR2bHwgy0F7s54ZOBTv3md7H9OP1sbFtmwtXRrjmW3aPs+y7R/x33MEC239Q+EOWo/JeIevywO74bvW+5dJ/GN05qDiHIGUtdy7+H+HeHOffdejk0ObuDC4doOt8zzLixe/RIV+bf/Ze15ZCXw5Cgx8dHmUL16nh+4zkZ5NLH16Ge9FTD4WeZv+iJJ48zbdH8oLvF919IeF0rF0MjJ3HpoQWaM/Y2TO5PusfJMd0s0loXUNzJ+1D1GSTErb0cCMsVU2pySuZ2H+zPneJYxJ3quzx5cpEf5mjgSxfdZlPUxtD9LYjDE7+/tEv8/Sf6VmStbOR3FxBZyxN2PkzQOTKfVK2Ji/Hog3jePrYMC7xotiNCN/uzO8dsaGviiHPQuzZtDsKdIowUv6qOxhA//A+mdOX7ooJqBtLcwY3au4iP5K9MZsmC4svJ6FWavOHKLdzPBuf3HzUkYujPHzwmxfN/ohuHsKftRtdhfwpVjeGjvbWCcbe6erCt94yXa22oPP9Xd/mtXE2DISlciLVbD4tFoIsVSr8PPnxadGw33h/sOJMZ8YQ2LcfGILcbO8ZhyJcSQmzCdOiQkkFppPghILkZg0n0JKTCIxZT5JaggKiV2bT4qydo3Ebsyna0rsBokZKJ9uKLFbnF6b7VtKjnU4MN8oGCbBHIoVaRLDYDbpjJE2MQ9m885IcAwjYTb1jGTHMBVms89IfAyDYRYAk6QkZsMsA0ZCZBgPsxgYyZFhQtxyYCRKjhFxC4KRMHmnWywITjLimBF3HUN3FmbELQhuGK2WXNxiScyIWxCcZMQxI25BcJIRx4y4BcFJRhwz4hYEJxlxzIhbEPyaqk+OGQkLgpOMBGYkLAhOMhKYkbAgBMlIdCY1C0KQjARmJNzERk+AmJGwIATJSGBGQnm5C8xIWBAipPIpMCNx450ZBGYkLAhBcheYUWhBCJJ7iBmFFoQgezPEjELuHXuIGYWOEVkhYWftcYzICgkxo9CtP2SFhJhRaEGEZIWEmFFoQYRkhYSYUXjj7Y4QMwotiJBeTzEjaUGE9JKKGUnmrSWJGUkLIiQrRGJG0oIIyQqRmJG0IEKyQmRni+AYkdwlZiQdI5K7xIykBSFJ7hIzkhaEJLlLzEhaEJLkLjEjZUFIkqbCjJTbMpA0FWakLAhJMlKYkbIgJMlIYUbKgpAkI4UZKQtCkoxUZyfntnIkI4UZKbebIxkpzEhZEIpkpDAjZUEokpHCjK4tCEUyuq4Yud282cab4+jbaldv9uXNG5in4Eu91Tf9XZ9HngKz5t09PS8C093m73O7xbefrAt3JbrVBaonNGJ397vVUq3WtU/LnmfSrNxWB5pW11T6UVl6fVrt5gl7J+RVq7+qBssGWsncy2uQODAO7gvlL3PEqs5d2j04b9XbHwmYkUiP+vFysvG/b+5Bg2y0JlQ9GN9o1u1dt+Y1NxiKAEPxxuJ+hdIkpIS/QmktATzcY6f6LYNuf8sAcgJS4tUuUOiCtzpmg+NRap90glBBrOYw4tInfBw39WOAbN81o0AA6tajXh+9j9WABg26SPpG4H6lstW620sAnFe1jxuEzMN65HUBhT5s7e958uMVNmASUPAaqG7AkeqgGcTKa6B6itXLoAJNrXxTSlw9Zoqax0xAHRSC8hVAo149ewYtCHzLM77JMpSg6JWve2sDcfX+CtTOLfCuTivv7DPppH6G3h8HnEv8NeAs7eu3LkAb8Je+Jqi1H9a75uEStAAqQPmaPy6S5n4FyAHAF/pyYF8BR9UrYKAJxix9Y06qH0uAeQOMlfmazmkd58rquiMod8Cc+0Ju7nmBZgfxCl+Wd811YOAO6HFfje7qVxZplh7cKwtXIkV/BQbLnvL1epqZucoZSPY9CwpMWte+ZjeLfwyfp4MAQM0rX/Ka648gecCr8BVYVdnkxgOoK1/Q+yiPymzvbuODggEZY775pVLNq99NAF2wODAf8kq3qH9+AJRBT3F/zI/Fz7i0i0tvbQWZDn2VDvSJpIMIQl+xuFsshbvFAnoT7gV8sed6W7rLOkAProi+hDVLEAkaZFz5Bt0Y6G2mQcaEbzKHyqhPBVhLhG8+ciXSLzIOdPkZXaJSQNzcF7f9sR89eQNt5mNVX9OL3DU9wAvEHfra0v76sXrp0CqCyvJhrsZJNCSoEeb1WSv3WxJUJvPNP402kWowGTPfZHw8duRfi+65Q4ACDX2sGgOJu19UVveLQNbBlCR9fWlv/gK3QCX0QS4f8vrePVAE67Pw+ur2AgN1wXz1XF1jS6pLjmB0YIUOfSk2lUzuxzg8wvjCpdtAgMoQzu8ikCQhczY3BzqdxKkR/vT5+fn/t2FkJDFBAAA="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 18b4f8fe..07a385b7 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -11,6 +11,7 @@ --light-color-text-aside: #6e6e6e; --light-color-link: #1f70c2; + --light-color-ts-keyword: #056bd6; --light-color-ts-project: #b111c9; --light-color-ts-module: var(--light-color-ts-project); --light-color-ts-namespace: var(--light-color-ts-project); @@ -32,7 +33,6 @@ --light-color-ts-accessor: var(--light-color-ts-property); --light-color-ts-get-signature: var(--light-color-ts-accessor); --light-color-ts-set-signature: var(--light-color-ts-accessor); - /* object literal not included as it is not used and will be removed in 0.25 */ --light-color-ts-type-alias: #d51270; /* reference not included as links will be colored with the kind that it points to */ @@ -51,6 +51,7 @@ --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; + --dark-color-ts-keyword: #3399ff; --dark-color-ts-project: #e358ff; --dark-color-ts-module: var(--dark-color-ts-project); --dark-color-ts-namespace: var(--dark-color-ts-project); @@ -72,7 +73,6 @@ --dark-color-ts-accessor: var(--dark-color-ts-property); --dark-color-ts-get-signature: var(--dark-color-ts-accessor); --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - /* object literal not included as it is not used and will be removed in 0.25 */ --dark-color-ts-type-alias: #ff6492; /* reference not included as links will be colored with the kind that it points to */ @@ -93,6 +93,7 @@ --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -134,6 +135,7 @@ --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -182,6 +184,7 @@ body { --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -221,6 +224,7 @@ body { --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -468,13 +472,12 @@ blockquote { padding: 0 0 0 20px; margin: 0; } -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, +.tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; - margin: 0; } .tsd-typography h5, .tsd-typography h6 { @@ -485,6 +488,19 @@ blockquote { .tsd-typography ol { margin: 1em 0; } +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} .tsd-breadcrumb { margin: 0; @@ -900,8 +916,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -909,12 +926,15 @@ a.tsd-index-link { #tsd-search .results li.state { display: none; } -#tsd-search .results li.current, -#tsd-search .results li:hover { +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { background-color: var(--color-accent); } #tsd-search .results a { - display: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -970,6 +990,11 @@ a.tsd-index-link { overflow-x: auto; } +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + .tsd-signature-symbol { color: var(--color-text-aside); font-weight: normal; @@ -1070,7 +1095,9 @@ ul.tsd-type-parameter-list h5 { overflow: hidden; opacity: 0.8; height: 40px; - transition: opacity 0.1s, background-color 0.2s; + transition: + opacity 0.1s, + background-color 0.2s; vertical-align: bottom; cursor: pointer; } @@ -1122,7 +1149,7 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; } .warning { diff --git a/docs/classes/AssetTransferApi.AssetTransferApi.html b/docs/classes/AssetTransferApi.AssetTransferApi.html index 4590a77a..6a3493bc 100644 --- a/docs/classes/AssetTransferApi.AssetTransferApi.html +++ b/docs/classes/AssetTransferApi.AssetTransferApi.html @@ -1,200 +1,31 @@ -AssetTransferApi | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Class AssetTransferApi

-
-

Holds open an api connection to a specified chain within the ApiPromise in order to help +AssetTransferApi | @substrate/asset-transfer-api - v0.1.4

Class AssetTransferApi

Holds open an api connection to a specified chain within the ApiPromise in order to help construct transactions for assets and estimating fees.

import { AssetTransferApi, constructApiPromise } from '@substrate/asset-transfer-api'

const main = () => {
  const { api, specName, safeXcmVersion } = await constructApiPromise('wss://some_ws_url');
  const assetsApi = new AssetTransferApi(api, specName, safeXcmVersion);
}
-
-
-
-

Hierarchy

-
    -
  • AssetTransferApi
-
-
-
- -
-
-

Methods

-
createTransferTransaction +

Methods

createTransferTransaction decodeExtrinsic fetchFeeInfo initializeRegistry -
-
-

Methods

-
-

createTransferTransaction

-
    - -
  • -

    Create an asset transfer transaction. This can be either locally on a systems parachain or relay chain, +

Methods

createTransferTransaction

  • createTransferTransaction<T>(destChainId, destAddr, assetIds, amounts, opts?): Promise<TxResult<T>>

  • Create an asset transfer transaction. This can be either locally on a systems parachain or relay chain, or between chains using xcm.

    import { TxResult } from '@substrate/asset-transfer-api'

    let callInfo: TxResult<'call'>;
    try {
      callInfo = await assetsApi.createTransferTransaction(
        '1000',
        '5EWNeodpcQ6iYibJ3jmWVe85nsok1EDG8Kk3aFg8ZzpfY1qX',
        ['WND'],
        ['1000000000000'],
        {
          format: 'call',
          isLimited: true,
          xcmVersion: 2,
        }
      )
    } catch (e) {
      console.error(e);
      throw Error(e);
    }
    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      destChainId: string
      -

      ID of the destination (para) chain (‘0’ for Relaychain)

      -
      -
      • -
    • -
      destAddr: string
      -

      Address of destination account

      -
      -
      • -
    • -
      assetIds: string[]
      -

      Array of assetId's to be transferred

      -
      -
      • -
    • -
      amounts: string[]
      -

      Array of the amounts of each token to transfer

      -
      -
      • -
    • -
      opts: TransferArgsOpts<T> = {}
      -

      Options

      -
      -
    -

    Returns Promise<TxResult<T>>

    -
-
-

decodeExtrinsic

-
    - -
  • -

    Decodes the hex of an extrinsic into a string readable format.

    +

    Type Parameters

    Parameters

    • destChainId: string

      ID of the destination (para) chain (‘0’ for Relaychain)

      +
    • destAddr: string

      Address of destination account

      +
    • assetIds: string[]

      Array of assetId's to be transferred

      +
    • amounts: string[]

      Array of the amounts of each token to transfer

      +
    • opts: TransferArgsOpts<T> = {}

      Options

      +

    Returns Promise<TxResult<T>>

decodeExtrinsic

  • decodeExtrinsic<T>(encodedTransaction, format): string

  • Decodes the hex of an extrinsic into a string readable format.

    const decodedExt = assetsApi.decodeExtrinsic(tx, 'call');
    console.log(JSON.parse(decodedExt));
    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      encodedTransaction: string
      -

      the hex of an extrinsic tx

      -
      -
      • -
    • -
      format: T
      -

      The format the tx is in

      -
      -
    -

    Returns string

    -
-
-

fetchFeeInfo

-
    - -
  • -

    Fetch estimated fee information for an extrinsic

    +

    Type Parameters

    Parameters

    • encodedTransaction: string

      the hex of an extrinsic tx

      +
    • format: T

      The format the tx is in

      +

    Returns string

fetchFeeInfo

  • fetchFeeInfo<T>(tx, format): Promise<null | RuntimeDispatchInfo | RuntimeDispatchInfoV1>

  • Fetch estimated fee information for an extrinsic

    const feeInfo = assetApi.fetchFeeInfo(tx, 'call');
    console.log(feeInfo.toJSON());
    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      tx: ConstructedFormat<T>
      -

      a payload, call or submittable

      -
      -
      • -
    • -
      format: T
      -

      The format the tx is in

      -
      -
    -

    Returns Promise<null | RuntimeDispatchInfo | RuntimeDispatchInfoV1>

    -
-
-

initializeRegistry

-
    - -
  • -

    Initialize the registry. This will only activate the registry for the CDN. +

    Type Parameters

    Parameters

    • tx: ConstructedFormat<T>

      a payload, call or submittable

      +
    • format: T

      The format the tx is in

      +

    Returns Promise<null | RuntimeDispatchInfo | RuntimeDispatchInfoV1>

initializeRegistry

  • initializeRegistry(): Promise<void>

  • Initialize the registry. This will only activate the registry for the CDN. If the registryType is NPM the initalization will exit since the AssetTransferApi initializes with the reigstry from the NPM package.

    -
    -

    Returns Promise<void>

    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/enums/errors_BaseError.BaseErrorsEnum.html b/docs/enums/errors_BaseError.BaseErrorsEnum.html index 27261517..c12b7974 100644 --- a/docs/enums/errors_BaseError.BaseErrorsEnum.html +++ b/docs/enums/errors_BaseError.BaseErrorsEnum.html @@ -1,205 +1,34 @@ -BaseErrorsEnum | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Enumeration BaseErrorsEnum

-
-

Errors that may be returned by the API.

-
-
-
-
-
- -
-
-

Enumeration Members

-
AssetNotFound -DisabledOption -InternalError -InvalidAddress -InvalidAsset -InvalidDirection -InvalidInput -InvalidMultiLocationAsset -InvalidPallet -InvalidXcmVersion -MultipleNonUniqueAssetsFound -NotImplemented -PalletNotFound -RegistryNotFound -
-
-

Enumeration Members

-
-

AssetNotFound

-
AssetNotFound: "AssetNotFound"
-

Not able to find the asset.

-
-
-
-

DisabledOption

-
DisabledOption: "DisabledOption"
-

The following option is disabled given the inputs.

-
-
-
-

InternalError

-
InternalError: "InternalError"
-

An issue has happened internally.

-
-
-
-

InvalidAddress

-
InvalidAddress: "InvalidAddress"
-

The inputted address is invalid.

-
-
-
-

InvalidAsset

-
InvalidAsset: "InvalidAsset"
-

The inputted asset is incorrect or invalid, and does not exist given the surrounding specs. +BaseErrorsEnum | @substrate/asset-transfer-api - v0.1.4

Enumeration BaseErrorsEnum

Errors that may be returned by the API.

+

Enumeration Members

AssetNotFound +DisabledOption +InternalError +InvalidAddress +InvalidAsset +InvalidDirection +InvalidInput +InvalidMultiLocationAsset +InvalidPallet +InvalidXcmVersion +MultipleNonUniqueAssetsFound +NoFeeAssetLpFound +NotImplemented +PalletNotFound +RegistryNotFound +

Enumeration Members

AssetNotFound

AssetNotFound: "AssetNotFound"

Not able to find the asset.

+

DisabledOption

DisabledOption: "DisabledOption"

The following option is disabled given the inputs.

+

InternalError

InternalError: "InternalError"

An issue has happened internally.

+

InvalidAddress

InvalidAddress: "InvalidAddress"

The inputted address is invalid.

+

InvalidAsset

InvalidAsset: "InvalidAsset"

The inputted asset is incorrect or invalid, and does not exist given the surrounding specs. This exlcudes MultiLocation assets which are handled using InvalidMultiLocationAsset.

-
-
-
-

InvalidDirection

-
InvalidDirection: "InvalidDirection"
-

The direction in which these assets are going to be sent is incorrect.

-
-
-
-

InvalidInput

-
InvalidInput: "InvalidInput"
-

An input or lack of input to any public facing function by the user is incorrect, and or invalid. +

InvalidDirection

InvalidDirection: "InvalidDirection"

The direction in which these assets are going to be sent is incorrect.

+

InvalidInput

InvalidInput: "InvalidInput"

An input or lack of input to any public facing function by the user is incorrect, and or invalid. This may include using options incorrectly.

-
-
-
-

InvalidMultiLocationAsset

-
InvalidMultiLocationAsset: "InvalidMultiLocationAsset"
-

The inputted multilocation is incorrect.

-
-
-
-

InvalidPallet

-
InvalidPallet: "InvalidPallet"
-

The following pallet does not support the method to be used.

-
-
-
-

InvalidXcmVersion

-
InvalidXcmVersion: "InvalidXcmVersion"
-

The xcm version is invalid.

-
-
-
-

MultipleNonUniqueAssetsFound

-
MultipleNonUniqueAssetsFound: "MultipleNonUniqueAssetsFound"
-

Multiple assets have been found for a single token symbol.

-
-
-
-

NotImplemented

-
NotImplemented: "NotImplemented"
-

Not Implemented yet.

-
-
-
-

PalletNotFound

-
PalletNotFound: "PalletNotFound"
-

The following pallet is not found.

-
-
-
-

RegistryNotFound

-
RegistryNotFound: "RegistryNotFound"
-

Not able to find the pertinent registry to gather certain information. This can refer to xcAssets.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
\ No newline at end of file +

InvalidMultiLocationAsset

InvalidMultiLocationAsset: "InvalidMultiLocationAsset"

The inputted multilocation is incorrect.

+

InvalidPallet

InvalidPallet: "InvalidPallet"

The following pallet does not support the method to be used.

+

InvalidXcmVersion

InvalidXcmVersion: "InvalidXcmVersion"

The xcm version is invalid.

+

MultipleNonUniqueAssetsFound

MultipleNonUniqueAssetsFound: "MultipleNonUniqueAssetsFound"

Multiple assets have been found for a single token symbol.

+

NoFeeAssetLpFound

NoFeeAssetLpFound: "NoFeeAssetLpFound"

The provided paysWithFeeOrigin asset has no liquidity pool.

+

NotImplemented

NotImplemented: "NotImplemented"

Not Implemented yet.

+

PalletNotFound

PalletNotFound: "PalletNotFound"

The following pallet is not found.

+

RegistryNotFound

RegistryNotFound: "RegistryNotFound"

Not able to find the pertinent registry to gather certain information. This can refer to xcAssets.

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/enums/types.Direction.html b/docs/enums/types.Direction.html index f45faf52..29654efe 100644 --- a/docs/enums/types.Direction.html +++ b/docs/enums/types.Direction.html @@ -1,162 +1,20 @@ -Direction | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Enumeration Direction

-
-

Represents all possible tx directions

-
-
-
-
-
- -
-
-

Enumeration Members

-
Local -ParaToPara -ParaToRelay -ParaToSystem -RelayToPara -RelayToSystem -SystemToPara -SystemToRelay -SystemToSystem -
-
-

Enumeration Members

-
-

Local

-
Local: "Local"
-

Local tx

-
-
-
-

ParaToPara

-
ParaToPara: "ParaToPara"
-

Parachain to Parachain.

-
-
-
-

ParaToRelay

-
ParaToRelay: "ParaToRelay"
-

Parachain to Relay chain.

-
-
-
-

ParaToSystem

-
ParaToSystem: "ParaToSystem"
-

Parachain to System parachain.

-
-
-
-

RelayToPara

-
RelayToPara: "RelayToPara"
-

Relay chain to Parachain.

-
-
-
-

RelayToSystem

-
RelayToSystem: "RelayToSystem"
-

Relay to System Parachain.

-
-
-
-

SystemToPara

-
SystemToPara: "SystemToPara"
-

System parachain to Parachain.

-
-
-
-

SystemToRelay

-
SystemToRelay: "SystemToRelay"
-

System parachain to Relay chain.

-
-
-
-

SystemToSystem

-
SystemToSystem: "SystemToSystem"
-

System parachain to System parachain chain.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
\ No newline at end of file +Direction | @substrate/asset-transfer-api - v0.1.4

Enumeration Direction

Represents all possible tx directions

+

Enumeration Members

Local +ParaToPara +ParaToRelay +ParaToSystem +RelayToPara +RelayToSystem +SystemToPara +SystemToRelay +SystemToSystem +

Enumeration Members

Local

Local: "Local"

Local tx

+

ParaToPara

ParaToPara: "ParaToPara"

Parachain to Parachain.

+

ParaToRelay

ParaToRelay: "ParaToRelay"

Parachain to Relay chain.

+

ParaToSystem

ParaToSystem: "ParaToSystem"

Parachain to System parachain.

+

RelayToPara

RelayToPara: "RelayToPara"

Relay chain to Parachain.

+

RelayToSystem

RelayToSystem: "RelayToSystem"

Relay to System Parachain.

+

SystemToPara

SystemToPara: "SystemToPara"

System parachain to Parachain.

+

SystemToRelay

SystemToRelay: "SystemToRelay"

System parachain to Relay chain.

+

SystemToSystem

SystemToSystem: "SystemToSystem"

System parachain to System parachain chain.

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/functions/constructApiPromise.constructApiPromise.html b/docs/functions/constructApiPromise.constructApiPromise.html index 334da111..b6994c48 100644 --- a/docs/functions/constructApiPromise.constructApiPromise.html +++ b/docs/functions/constructApiPromise.constructApiPromise.html @@ -1,69 +1,6 @@ -constructApiPromise | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Function constructApiPromise

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index e05cc27c..8ec4caf1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,18 +1,4 @@ -@substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
-

@substrate/asset-transfer-api - v0.1.4

-



+@substrate/asset-transfer-api - v0.1.4

@substrate/asset-transfer-api - v0.1.4



@substrate/asset-transfer-api

Asset API used for common good parachains

@@ -121,6 +107,7 @@

Asset API used for common good parachains

The api can also send native tokens as well. Similar to the above you would replace the assetIds with ['DOT']. In addition to that, you may provide an empty array to denote you want to send the chain's native token.

The api can also send local transactions for Relay chains. It is the same principal as above, the only difference being that the destChainId would need to be '0'.

For more information, refer to the docs in the repository.

+

Note: For other parachains, local transfers are currently supported via balances and assets pallets. The plan is to extend local transfer support to other pallets like ORML tokens pallet in coming releases.

License

The source code in this repository is distributed under the Apache 2.0 license. See the LICENSE file. This source code comes with absolutely no warranty. Use at your own risk.

Zombienet Testing

Zombienet is used to launch a complete network including a relay chain, and two parachains. It will create HRMP channels betweens the launched parachains allowing the testing enviornment to send XCM messages and transfer assets.

Requirements:

Zombienet Binary: You can download the appropriate binary from the zombienet repository here. Ensure that it is in the root of this directory. Note: For macos users if permission is denied to run the binary you can chmod 755 <file_name> to allow permissions.

@@ -140,56 +127,4 @@

Asset API used for common good parachains

Copy each binary that is necessary into the root <root>/bin folder.

Running Zombienet

From the root directory run ./<zombienet_binary_name> -p native spawn ./zombienet/<network_file>.toml | tee zombienet.log

Create an asset

From the root directory run yarn start:zombienet-post-script. You can run this right after running your zombienet network.

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/constructApiPromise.ApiInfo.html b/docs/interfaces/constructApiPromise.ApiInfo.html index eba7b358..9f05e27d 100644 --- a/docs/interfaces/constructApiPromise.ApiInfo.html +++ b/docs/interfaces/constructApiPromise.ApiInfo.html @@ -1,98 +1,8 @@ -ApiInfo | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Interface ApiInfo

-
-

Return value for constructApiPromise

-
-
-
-

Hierarchy

-
    -
  • ApiInfo
-
-
-
- -
-
-

Properties

-
api +ApiInfo | @substrate/asset-transfer-api - v0.1.4

Interface ApiInfo

Return value for constructApiPromise

+
interface ApiInfo {
    api: ApiPromise;
    safeXcmVersion: number;
    specName: string;
}

Properties

api safeXcmVersion specName -
-
-

Properties

-
-

api

-
api: ApiPromise
-

Polkadot-js ApiPromise

-
-
-
-

safeXcmVersion

-
safeXcmVersion: number
-

SafeXcmVersion for the chain which the api is connected too.

-
-
-
-

specName

-
specName: string
-

SpecName of the chain which the api is connected to.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
\ No newline at end of file +

Properties

api

api: ApiPromise

Polkadot-js ApiPromise

+

safeXcmVersion

safeXcmVersion: number

SafeXcmVersion for the chain which the api is connected too.

+

specName

specName: string

SpecName of the chain which the api is connected to.

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/types.TransferArgsOpts.html b/docs/interfaces/types.TransferArgsOpts.html index 42e082b7..06797db0 100644 --- a/docs/interfaces/types.TransferArgsOpts.html +++ b/docs/interfaces/types.TransferArgsOpts.html @@ -1,44 +1,5 @@ -TransferArgsOpts | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Interface TransferArgsOpts<T>

-
-

The TransferArgsOpts are the options passed into createTransferTransaction.

-
-
-
-

Type Parameters

-
-
-

Hierarchy

-
    -
  • TransferArgsOpts
-
-
-
- -
-
-

Properties

-
format? +TransferArgsOpts | @substrate/asset-transfer-api - v0.1.4

Interface TransferArgsOpts<T>

The TransferArgsOpts are the options passed into createTransferTransaction.

+
interface TransferArgsOpts {
    format?: T;
    isLimited?: boolean;
    keepAlive?: boolean;
    paysWithFeeDest?: string;
    paysWithFeeOrigin?: string;
    sendersAddr?: string;
    transferLiquidToken?: boolean;
    weightLimit?: {
        proofSize?: string;
        refTime?: string;
    };
    xcmVersion?: number;
}

Type Parameters

Properties

format? isLimited? keepAlive? paysWithFeeDest? @@ -47,151 +8,28 @@

Properties

transferLiquidToken? weightLimit? xcmVersion? -
-
-

Properties

-
-

Optional format

-
format?: T
-

Option that specifies the format in which to return a transaction. +

Properties

Optional format

format?: T

Option that specifies the format in which to return a transaction. It can either be a payload, call, or submittable.

Note: A submittable will return a SubmittableExtrinsic polkadot-js type, whereas a payload or call will return a hex.

-
-
-
-

Optional isLimited

-
isLimited?: boolean
-

Boolean to declare if this will be with limited XCM transfers. +

Optional isLimited

isLimited?: boolean

Boolean to declare if this will be with limited XCM transfers. Deafult is unlimited.

-
-
-
-

Optional keepAlive

-
keepAlive?: boolean
-

For creating local asset transfers, this will allow for a transferKeepAlive as oppose +

Optional keepAlive

keepAlive?: boolean

For creating local asset transfers, this will allow for a transferKeepAlive as oppose to a transfer.

-
-
-
-

Optional paysWithFeeDest

-
paysWithFeeDest?: string
-

AssetId to pay fee's on the destination parachain.

-
-
-
-

Optional paysWithFeeOrigin

-
paysWithFeeOrigin?: string
-

AssetId to pay fee's on the current common good parachain. +

Optional paysWithFeeDest

paysWithFeeDest?: string

AssetId to pay fee's on the destination parachain.

+

Optional paysWithFeeOrigin

paysWithFeeOrigin?: string

AssetId to pay fee's on the current common good parachain. Polkadot AssetHub: default DOT Kusama AssetHub: default KSM

-
-
-
-

Optional sendersAddr

-
sendersAddr?: string
-

The SS58 Address the tx will be sent from. This is specifically used for the format payload. +

Optional sendersAddr

sendersAddr?: string

The SS58 Address the tx will be sent from. This is specifically used for the format payload. It is necessary because the payload will need information such as the nonce.

-
-
-
-

Optional transferLiquidToken

-
transferLiquidToken?: boolean
-

Boolean to declare if this will transfer liquidity tokens. +

Optional transferLiquidToken

transferLiquidToken?: boolean

Boolean to declare if this will transfer liquidity tokens. Default is false.

-
-
-
-

Optional weightLimit

-
weightLimit?: {
    proofSize?: string;
    refTime?: string;
}
-

When isLimited is true, the option for applying a weightLimit is possible. +

Optional weightLimit

weightLimit?: {
    proofSize?: string;
    refTime?: string;
}

When isLimited is true, the option for applying a weightLimit is possible. If not inputted it will default to Unlimited.

-
-
-

Type declaration

-
    -
  • -
    Optional proofSize?: string
    -

    Provided when creating limited txs, represents the amount of storage in bytes that can be used +

    Type declaration

    • Optional proofSize?: string

      Provided when creating limited txs, represents the amount of storage in bytes that can be used by the tx

      -
      -
      • -
    • -
      Optional refTime?: string
      -

      Provided when creating limited txs, represents the allowed amount of computation time +

    • Optional refTime?: string

      Provided when creating limited txs, represents the allowed amount of computation time the tx can use

      -
      -
    -
-
-

Optional xcmVersion

-
xcmVersion?: number
-

Set the xcmVersion for message construction. If this is not present a supported version +

Optional xcmVersion

xcmVersion?: number

Set the xcmVersion for message construction. If this is not present a supported version will be queried, and if there is no supported version a safe version will be queried.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/interfaces/types.TxResult.html b/docs/interfaces/types.TxResult.html index 100d1734..d242ff1c 100644 --- a/docs/interfaces/types.TxResult.html +++ b/docs/interfaces/types.TxResult.html @@ -1,152 +1,17 @@ -TxResult | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Interface TxResult<T>

-
-

The TxResult is the result of constructing a transaction. +TxResult | @substrate/asset-transfer-api - v0.1.4

Interface TxResult<T>

The TxResult is the result of constructing a transaction. T extends Format in the context of the options passed in for the Format the user expects.

-
-
-
-

Type Parameters

-
    -
  • -

    T

-
-

Hierarchy

-
    -
  • TxResult
-
-
-
- -
-
-

Properties

-
dest +
interface TxResult {
    dest: string;
    direction: Direction | "local";
    format: Format | "local";
    method: Methods;
    origin: string;
    tx: ConstructedFormat<T>;
    xcmVersion: null | number;
}

Type Parameters

  • T

Properties

dest direction format method origin tx xcmVersion -
-
-

Properties

-
-

dest

-
dest: string
-
-

Description

The destination specName of the transaction

-
-
-

direction

-
direction: Direction | "local"
-
-

Description

The direction of the cross chain transfer.

-
-
-

format

-
format: Format | "local"
-
-

Description

The format type the tx is ouputted in.

-
-
-

method

-
method: Methods
-
-

Description

The method used in the transaction.

-
-
-

origin

-
origin: string
-
-

Description

The origin specName of the transaction

-
-
-

tx

-
tx: ConstructedFormat<T>
-
-

Description

The constructed transaction.

-
-
-

xcmVersion

-
xcmVersion: null | number
-
-

Description

The xcm version that was used to construct the tx.

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
\ No newline at end of file +

Properties

dest

dest: string

Description

The destination specName of the transaction

+

direction

direction: Direction | "local"

Description

The direction of the cross chain transfer.

+

format

format: Format | "local"

Description

The format type the tx is ouputted in.

+

method

method: Methods

Description

The method used in the transaction.

+

origin

origin: string

Description

The origin specName of the transaction

+

tx

tx: ConstructedFormat<T>

Description

The constructed transaction.

+

xcmVersion

xcmVersion: null | number

Description

The xcm version that was used to construct the tx.

+

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/modules/AssetTransferApi.html b/docs/modules/AssetTransferApi.html index 67d8a952..d178e48c 100644 --- a/docs/modules/AssetTransferApi.html +++ b/docs/modules/AssetTransferApi.html @@ -1,51 +1,2 @@ -AssetTransferApi | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Module AssetTransferApi

-
-
-

Index

-
-

Classes

-
AssetTransferApi -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-
-
\ No newline at end of file +AssetTransferApi | @substrate/asset-transfer-api - v0.1.4

Module AssetTransferApi

Index

Classes

AssetTransferApi +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/constructApiPromise.html b/docs/modules/constructApiPromise.html index 50841e4c..717047c6 100644 --- a/docs/modules/constructApiPromise.html +++ b/docs/modules/constructApiPromise.html @@ -1,56 +1,3 @@ -constructApiPromise | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Module constructApiPromise

-
-
-

Index

-
-

Interfaces

-
ApiInfo -
-
-

Functions

-
constructApiPromise -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-
-
\ No newline at end of file +constructApiPromise | @substrate/asset-transfer-api - v0.1.4

Module constructApiPromise

Index

Interfaces

ApiInfo +

Functions

constructApiPromise +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/errors_BaseError.html b/docs/modules/errors_BaseError.html index 1344f231..dec5fc58 100644 --- a/docs/modules/errors_BaseError.html +++ b/docs/modules/errors_BaseError.html @@ -1,51 +1,2 @@ -errors/BaseError | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Module errors/BaseError

-
-
-

Index

-
-

Enumerations

-
BaseErrorsEnum -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-
-
\ No newline at end of file +errors/BaseError | @substrate/asset-transfer-api - v0.1.4

Module errors/BaseError

Index

Enumerations

BaseErrorsEnum +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/types.html b/docs/modules/types.html index 6af844e2..ee84836c 100644 --- a/docs/modules/types.html +++ b/docs/modules/types.html @@ -1,75 +1,11 @@ -types | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Module types

-
-
-

Index

-
-

Enumerations

-
Direction -
-
-

Interfaces

-
TransferArgsOpts +types | @substrate/asset-transfer-api - v0.1.4

Module types

Index

Enumerations

Direction +

Interfaces

TransferArgsOpts TxResult -
-
-

Type Aliases

-
AssetTransferApiOpts -ConstructedFormat -Format -LocalTransferTypes -Methods -RegistryTypes -XcmDirection -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-
-
\ No newline at end of file +

Type Aliases

AssetTransferApiOpts +ConstructedFormat +Format +LocalTransferTypes +Methods +RegistryTypes +XcmDirection +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/types.AssetTransferApiOpts.html b/docs/types/types.AssetTransferApiOpts.html index e3bf376e..43b67fc8 100644 --- a/docs/types/types.AssetTransferApiOpts.html +++ b/docs/types/types.AssetTransferApiOpts.html @@ -1,72 +1,5 @@ -AssetTransferApiOpts | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Type alias AssetTransferApiOpts

-
AssetTransferApiOpts: {
    injectedRegistry?: RequireAtLeastOne<ChainInfoRegistry>;
    registryType?: RegistryTypes;
}
-

Options that are appplied at initialization of the AssetTransferApi.

-
-
-

Type declaration

-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/types.ConstructedFormat.html b/docs/types/types.ConstructedFormat.html index fca43189..a4162635 100644 --- a/docs/types/types.ConstructedFormat.html +++ b/docs/types/types.ConstructedFormat.html @@ -1,63 +1,2 @@ -ConstructedFormat | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Type alias ConstructedFormat<T>

-
ConstructedFormat<T>: T extends "payload"
    ? `0x${string}`
    : T extends "call"
        ? `0x${string}`
        : T extends "submittable"
            ? SubmittableExtrinsic<"promise", ISubmittableResult>
            : never
-

The Format types possible for a constructed transaction.

-
-
-

Type Parameters

-
    -
  • -

    T

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-
-
\ No newline at end of file +ConstructedFormat | @substrate/asset-transfer-api - v0.1.4

Type alias ConstructedFormat<T>

ConstructedFormat<T>: T extends "payload"
    ? `0x${string}`
    : T extends "call"
        ? `0x${string}`
        : T extends "submittable"
            ? SubmittableExtrinsic<"promise", ISubmittableResult>
            : never

The Format types possible for a constructed transaction.

+

Type Parameters

  • T

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/types.Format.html b/docs/types/types.Format.html index a6d235dd..a021d901 100644 --- a/docs/types/types.Format.html +++ b/docs/types/types.Format.html @@ -1,63 +1,7 @@ -Format | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Type alias Format

-
Format: "payload" | "call" | "submittable"
-

AssetTransferApi supports three formats to be returned:

+Format | @substrate/asset-transfer-api - v0.1.4

Type alias Format

Format: "payload" | "call" | "submittable"

AssetTransferApi supports three formats to be returned:

  • payload: This returns a Polkadot-js ExtrinsicPayload as a hex.
  • call: This returns a Polkadot-js Call as a hex.
  • submittable: This returns a Polkadot-js SubmittableExtrinsic.
-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-
-
\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/types.LocalTransferTypes.html b/docs/types/types.LocalTransferTypes.html index 56a404fc..e7785f3c 100644 --- a/docs/types/types.LocalTransferTypes.html +++ b/docs/types/types.LocalTransferTypes.html @@ -1,58 +1,2 @@ -LocalTransferTypes | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Type alias LocalTransferTypes

-
LocalTransferTypes: "assets::transfer" | "assets::transferKeepAlive" | "foreignAssets::transfer" | "foreignAssets::transferKeepAlive" | "balances::transfer" | "balances::transferKeepAlive" | "poolAssets::transfer" | "poolAssets::transferKeepAlive"
-

The types of local transactions the api can construct.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-
-
\ No newline at end of file +LocalTransferTypes | @substrate/asset-transfer-api - v0.1.4

Type alias LocalTransferTypes

LocalTransferTypes: "assets::transfer" | "assets::transferKeepAlive" | "foreignAssets::transfer" | "foreignAssets::transferKeepAlive" | "balances::transfer" | "balances::transferKeepAlive" | "poolAssets::transfer" | "poolAssets::transferKeepAlive"

The types of local transactions the api can construct.

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/types.Methods.html b/docs/types/types.Methods.html index 374ea0c4..a3bae8e8 100644 --- a/docs/types/types.Methods.html +++ b/docs/types/types.Methods.html @@ -1,58 +1,2 @@ -Methods | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Type alias Methods

-
Methods: LocalTransferTypes | "reserveTransferAssets" | "limitedReserveTransferAssets" | "teleportAssets" | "limitedTeleportAssets" | "transferMultiasset" | "transferMultiassets" | "transferMultiassetWithFee"
-

The Methods are the collections of methods the API will use to construct a transaction.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-
-
\ No newline at end of file +Methods | @substrate/asset-transfer-api - v0.1.4

Type alias Methods

Methods: LocalTransferTypes | "reserveTransferAssets" | "limitedReserveTransferAssets" | "teleportAssets" | "limitedTeleportAssets" | "transferMultiasset" | "transferMultiassets" | "transferMultiassetWithFee"

The Methods are the collections of methods the API will use to construct a transaction.

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/types.RegistryTypes.html b/docs/types/types.RegistryTypes.html index 2590c4d7..f54fe7b1 100644 --- a/docs/types/types.RegistryTypes.html +++ b/docs/types/types.RegistryTypes.html @@ -1,60 +1,4 @@ -RegistryTypes | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Type alias RegistryTypes

-
RegistryTypes: "CDN" | "NPM"
-

Types that the registry can be initialized as.

+RegistryTypes | @substrate/asset-transfer-api - v0.1.4

Type alias RegistryTypes

RegistryTypes: "CDN" | "NPM"

Types that the registry can be initialized as.

CDN - The registry will be initialized with the up to date version given the CDN NPM - The registry will be initialized with the NPM version which is updated less frequently.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-
-
\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/types.XcmDirection.html b/docs/types/types.XcmDirection.html index 7c807e5d..d5345f63 100644 --- a/docs/types/types.XcmDirection.html +++ b/docs/types/types.XcmDirection.html @@ -1,58 +1,2 @@ -XcmDirection | @substrate/asset-transfer-api - v0.1.4
-
- -
-
-
-
- -

Type alias XcmDirection

-
XcmDirection: Exclude<Direction, "Local">
-

The direction of the cross chain transfer. This only concerns XCM transactions.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
-
-

Theme

-
-
-
\ No newline at end of file +XcmDirection | @substrate/asset-transfer-api - v0.1.4

Type alias XcmDirection

XcmDirection: Exclude<Direction, "Local">

The direction of the cross chain transfer. This only concerns XCM transactions.

+

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/package.json b/package.json index b16978bb..0f797534 100644 --- a/package.json +++ b/package.json @@ -35,7 +35,7 @@ "devDependencies": { "@substrate/dev": "^0.7.1", "chalk": "4.1.2", - "typedoc": "^0.24.8", + "typedoc": "^0.25.4", "typedoc-plugin-missing-exports": "^1.0.0", "typedoc-theme-hierarchy": "^4.0.0" }, diff --git a/yarn.lock b/yarn.lock index a4838aa3..d893ed1f 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1351,7 +1351,7 @@ __metadata: "@substrate/asset-transfer-api-registry": "npm:^0.2.11" "@substrate/dev": "npm:^0.7.1" chalk: "npm:4.1.2" - typedoc: "npm:^0.24.8" + typedoc: "npm:^0.25.4" typedoc-plugin-missing-exports: "npm:^1.0.0" typedoc-theme-hierarchy: "npm:^4.0.0" languageName: unknown @@ -4180,7 +4180,7 @@ __metadata: languageName: node linkType: hard -"minimatch@npm:^9.0.0, minimatch@npm:^9.0.1": +"minimatch@npm:^9.0.1, minimatch@npm:^9.0.3": version: 9.0.3 resolution: "minimatch@npm:9.0.3" dependencies: @@ -5341,19 +5341,19 @@ __metadata: languageName: node linkType: hard -"typedoc@npm:^0.24.8": - version: 0.24.8 - resolution: "typedoc@npm:0.24.8" +"typedoc@npm:^0.25.4": + version: 0.25.4 + resolution: "typedoc@npm:0.25.4" dependencies: lunr: "npm:^2.3.9" marked: "npm:^4.3.0" - minimatch: "npm:^9.0.0" + minimatch: "npm:^9.0.3" shiki: "npm:^0.14.1" peerDependencies: - typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x + typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x bin: typedoc: bin/typedoc - checksum: 4f2f92ddde3f70a1a9666507f6bdf6620023599bd2c2a3ed3f8f909f9c28d92594c30ee6ee68f5a248ff70e09623acf1323bad633cb713b9f2e36bbd4fccf683 + checksum: 638f63d751ba86f1b0e04a303501b88b6e97ba093f82c3fa72a555c207e16fd316ec76c13f7d628e9ee26296f80fddc45b87d4b13714925c5e726047adb76d22 languageName: node linkType: hard