merged main changes

paritytech · Jan 9, 2024 · 05710cb · 05710cb
2 parents 96df8ae + b67ee28
commit 05710cb
Show file tree

Hide file tree

Showing 150 changed files with 4,444 additions and 5,282 deletions.
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -18,10 +18,10 @@ jobs:
       - name: Checkout files
         uses: actions/checkout@v4
 
-      - name: Install Node v16
+      - name: Install Node 18
         uses: actions/setup-node@v4
         with:
-          node-version: '16.13'
+          node-version: '18'
 
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
@@ -49,10 +49,10 @@ jobs:
       - name: Checkout files
         uses: actions/checkout@v4
 
-      - name: Install Node v16
+      - name: Install Node 18
         uses: actions/setup-node@v4
         with:
-          node-version: '16.13'
+          node-version: '18'
 
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
@@ -80,10 +80,10 @@ jobs:
       - name: Checkout files
         uses: actions/checkout@v4
 
-      - name: Install Node v16
+      - name: Install Node v18
         uses: actions/setup-node@v4
         with:
-          node-version: '16.13'
+          node-version: '18'
 
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path

diff --git a/.yarn/releases/yarn-3.6.4.cjs b/.yarn/releases/yarn-3.6.4.cjs
diff --git a/.yarn/releases/yarn-4.0.2.cjs b/.yarn/releases/yarn-4.0.2.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -1,3 +1,7 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-3.6.4.cjs
+yarnPath: .yarn/releases/yarn-4.0.2.cjs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,28 @@
 # Changelog
 
+## [0.1.5](https://github.com/paritytech/asset-transfer-api/compare/v0.1.4..v0.1.5)(2024-01-03)
+
+## Features
+
+- feat: give registry option between CDN and npm package ([#332](https://github.com/paritytech/asset-transfer-api/pull/332))
+- feat: add paysWithFeeOrigin support for MultiLocations ([#333](https://github.com/paritytech/asset-transfer-api/pull/333))
+
+## Fix
+
+- fix(internal): cleanup structure for args passed into calls ([#328](https://github.com/paritytech/asset-transfer-api/pull/328))
+- fix: check fee asset lp exists for paysWithFeeOrigin ([#336](https://github.com/paritytech/asset-transfer-api/pull/336))
+
+## Docs
+
+- docs(readme): Add explanation for local transfers in parachains ([#331](https://github.com/paritytech/asset-transfer-api/pull/331))
+
+## Chore
+
+- chore(deps): bump @babel/traverse from 7.21.4 to 7.23.4 ([#329](https://github.com/paritytech/asset-transfer-api/pull/329))
+- chore(substrate-dev): update @substrate/dev to 0.7.1 ([#334](https://github.com/paritytech/asset-transfer-api/pull/334))
+- chore(yarn): bump yarn to 4.0.2 ([#335](https://github.com/paritytech/asset-transfer-api/pull/335))
+- chore(pjs): update polkadot-js to 10.11.2 ([#339](https://github.com/paritytech/asset-transfer-api/pull/339))
+
 ## [0.1.4](https://github.com/paritytech/asset-transfer-api/compare/v0.1.3..v0.1.4)(2023-11-14)
 
 ## Features

diff --git a/README.md b/README.md
@@ -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
@@ -131,6 +136,13 @@ type AssetTransferApiOpts = {
 	 * NOTE: It supports adding info for `polkadot`, `kusama`, and `westend`.
 	 */
 	injectedRegistry?: RequireAtLeastOne<ChainInfoRegistry>;
+	/**
+	 * RegistryTypes is a string and can either be 'CDN' or 'NPM'.
+	 * 
+	 * 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.
+	 */
+	registryType?: RegistryTypes;
 };
 ```
 

diff --git a/docs/assets/main.js b/docs/assets/main.js
diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git 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,21 +916,25 @@ 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);
 }
 #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 {