Skip to content

Commit

Permalink
Update the readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TarikGul committed Nov 28, 2023
1 parent bf6d01c commit 424d2af
Show file tree
Hide file tree
Showing 20 changed files with 72 additions and 67 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ Note: System refers to System Parachains like Asset Hub.

`yarn add @substrate/asset-transfer-api`

### NodeJS Version

Recommended: v21 or greater
When the API is initalized using the `CDN`, `node:fetch` is being used and is stable in node v21. Therefore it is recommended to use v21 or greater.

### Example Usage

**NOTE:** For more practical usage, and specified examples please look through our `./examples` directory to see more use cases. To
Expand Down Expand Up @@ -141,8 +146,6 @@ type AssetTransferApiOpts = {
};
```

NOTE: When using the CDN which is default, `node:fetch` is being used. It is advised to use NodeJS v21 or greater because `fetch` is stable in those versions.

```typescript
// The TransferArgsOpts are options that give the possibility of adding certain customization to the transaction.

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/AssetTransferApi.AssetTransferApi.html
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/b3d9d1d/src/AssetTransferApi.ts#L81">AssetTransferApi.ts:81</a></li></ul></aside>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/bf6d01c/src/AssetTransferApi.ts#L81">AssetTransferApi.ts:81</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 @@ -89,7 +89,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/b3d9d1d/src/AssetTransferApi.ts#L136">AssetTransferApi.ts:136</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/bf6d01c/src/AssetTransferApi.ts#L136">AssetTransferApi.ts:136</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 @@ -120,7 +120,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/b3d9d1d/src/AssetTransferApi.ts#L456">AssetTransferApi.ts:456</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/bf6d01c/src/AssetTransferApi.ts#L456">AssetTransferApi.ts:456</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 @@ -151,7 +151,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/b3d9d1d/src/AssetTransferApi.ts#L410">AssetTransferApi.ts:410</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/bf6d01c/src/AssetTransferApi.ts#L410">AssetTransferApi.ts:410</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="initializeRegistry" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>initialize<wbr/>Registry</span><a href="#initializeRegistry" 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 All @@ -164,7 +164,7 @@ <h3 class="tsd-anchor-link"><span>initialize<wbr/>Registry</span><a href="#initi
<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">void</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/b3d9d1d/src/AssetTransferApi.ts#L384">AssetTransferApi.ts:384</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/paritytech/asset-transfer-api/blob/bf6d01c/src/AssetTransferApi.ts#L384">AssetTransferApi.ts:384</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit 424d2af

Please sign in to comment.