Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@TarikGul
TarikGul committed Nov 7, 2023
1 parent 285540a commit a7ba1df
Show file tree
Hide file tree
Showing 16 changed files with 61 additions and 61 deletions.
8 changes: 4 additions & 4 deletions docs/classes/AssetTransferApi.AssetTransferApi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">AssetTransferApi</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/AssetTransferApi.ts#L79">AssetTransferApi.ts:79</a></li></ul></aside>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/AssetTransferApi.ts#L79">AssetTransferApi.ts:79</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -88,7 +88,7 @@ <h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/types.T
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.TxResult.html" class="tsd-signature-type tsd-kind-interface">TxResult</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/AssetTransferApi.ts#L126">AssetTransferApi.ts:126</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/AssetTransferApi.ts#L126">AssetTransferApi.ts:126</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="decodeExtrinsic" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>decode<wbr/>Extrinsic</span><a href="#decodeExtrinsic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand Down Expand Up @@ -119,7 +119,7 @@ <h5><span class="tsd-kind-parameter">format</span>: <span class="tsd-signature-t
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/AssetTransferApi.ts#L523">AssetTransferApi.ts:523</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/AssetTransferApi.ts#L523">AssetTransferApi.ts:523</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="fetchFeeInfo" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>fetch<wbr/>Fee<wbr/>Info</span><a href="#fetchFeeInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand Down Expand Up @@ -150,7 +150,7 @@ <h5><span class="tsd-kind-parameter">format</span>: <span class="tsd-signature-t
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">RuntimeDispatchInfo</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">RuntimeDispatchInfoV1</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/AssetTransferApi.ts#L477">AssetTransferApi.ts:477</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/AssetTransferApi.ts#L477">AssetTransferApi.ts:477</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
30 changes: 15 additions & 15 deletions docs/enums/errors_BaseError.BaseErrorsEnum.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h1>Enumeration BaseErrorsEnum</h1></div>
</div>
<div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L6">errors/BaseError.ts:6</a></li></ul></aside>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L6">errors/BaseError.ts:6</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -53,31 +53,31 @@ <h3 class="tsd-anchor-link"><span>Asset<wbr/>Not<wbr/>Found</span><a href="#Asse
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L20">errors/BaseError.ts:20</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L20">errors/BaseError.ts:20</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="DisabledOption" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Disabled<wbr/>Option</span><a href="#DisabledOption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Disabled<wbr/>Option</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;DisabledOption&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>The following option is disabled given the inputs.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L64">errors/BaseError.ts:64</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L64">errors/BaseError.ts:64</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="InternalError" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Internal<wbr/>Error</span><a href="#InternalError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Internal<wbr/>Error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;InternalError&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>An issue has happened internally.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L56">errors/BaseError.ts:56</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L56">errors/BaseError.ts:56</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="InvalidAddress" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Invalid<wbr/>Address</span><a href="#InvalidAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Invalid<wbr/>Address</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;InvalidAddress&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>The inputted address is invalid.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L60">errors/BaseError.ts:60</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L60">errors/BaseError.ts:60</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="InvalidAsset" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Invalid<wbr/>Asset</span><a href="#InvalidAsset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Invalid<wbr/>Asset</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;InvalidAsset&quot;</span></div>
Expand All @@ -86,15 +86,15 @@ <h3 class="tsd-anchor-link"><span>Invalid<wbr/>Asset</span><a href="#InvalidAsse
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L16">errors/BaseError.ts:16</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L16">errors/BaseError.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="InvalidDirection" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Invalid<wbr/>Direction</span><a href="#InvalidDirection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Invalid<wbr/>Direction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;InvalidDirection&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>The direction in which these assets are going to be sent is incorrect.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L32">errors/BaseError.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L32">errors/BaseError.ts:32</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="InvalidInput" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Invalid<wbr/>Input</span><a href="#InvalidInput" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Invalid<wbr/>Input</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;InvalidInput&quot;</span></div>
Expand All @@ -103,63 +103,63 @@ <h3 class="tsd-anchor-link"><span>Invalid<wbr/>Input</span><a href="#InvalidInpu
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L11">errors/BaseError.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L11">errors/BaseError.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="InvalidMultiLocationAsset" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Invalid<wbr/>Multi<wbr/>Location<wbr/>Asset</span><a href="#InvalidMultiLocationAsset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Invalid<wbr/>Multi<wbr/>Location<wbr/>Asset</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;InvalidMultiLocationAsset&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>The inputted multilocation is incorrect.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L36">errors/BaseError.ts:36</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L36">errors/BaseError.ts:36</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="InvalidPallet" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Invalid<wbr/>Pallet</span><a href="#InvalidPallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Invalid<wbr/>Pallet</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;InvalidPallet&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>The following pallet does not support the method to be used.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L24">errors/BaseError.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L24">errors/BaseError.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="InvalidXcmVersion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Invalid<wbr/>Xcm<wbr/>Version</span><a href="#InvalidXcmVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Invalid<wbr/>Xcm<wbr/>Version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;InvalidXcmVersion&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>The xcm version is invalid.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L48">errors/BaseError.ts:48</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L48">errors/BaseError.ts:48</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="MultipleNonUniqueAssetsFound" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Multiple<wbr/>Non<wbr/>Unique<wbr/>Assets<wbr/>Found</span><a href="#MultipleNonUniqueAssetsFound" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Multiple<wbr/>Non<wbr/>Unique<wbr/>Assets<wbr/>Found</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;MultipleNonUniqueAssetsFound&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Multiple assets have been found for a single token symbol.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L40">errors/BaseError.ts:40</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L40">errors/BaseError.ts:40</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="NotImplemented" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Not<wbr/>Implemented</span><a href="#NotImplemented" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Not<wbr/>Implemented</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;NotImplemented&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Not Implemented yet.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L52">errors/BaseError.ts:52</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L52">errors/BaseError.ts:52</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="PalletNotFound" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Pallet<wbr/>Not<wbr/>Found</span><a href="#PalletNotFound" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Pallet<wbr/>Not<wbr/>Found</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;PalletNotFound&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>The following pallet is not found.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L28">errors/BaseError.ts:28</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L28">errors/BaseError.ts:28</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="RegistryNotFound" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Registry<wbr/>Not<wbr/>Found</span><a href="#RegistryNotFound" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Registry<wbr/>Not<wbr/>Found</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;RegistryNotFound&quot;</span></div>
<div class="tsd-comment tsd-typography"><p>Not able to find the pertinent registry to gather certain information. This can refer to xcAssets.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/2cb2d13/src/errors/BaseError.ts#L44">errors/BaseError.ts:44</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/285540a/src/errors/BaseError.ts#L44">errors/BaseError.ts:44</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit a7ba1df

Please sign in to comment.