@paraspell/sdk-pjs 12.10.0-rc.2 → 13.0.0

package/README.md

@@ -203,9 +203,9 @@ const builder = Builder(/*client | builder_config |ws_url | [ws_url, ws_url,..]
       .sender(address | PAPI_SIGNER /*Only in PAPI SDK*/ | {address, PJS_SIGNER} /*Only in PJS SDK*/) // - OPTIONAL but strongly recommended as it is automatically ignored when not needed - Used when origin is AssetHub/Hydration with feeAsset or when sending to AssetHub to prevent asset traps by auto-swapping to DOT to have DOT ED.
       .swap({
           currencyTo: {id: currencyID, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | {location: Override('Custom Location'), amount: amount /*Use "ALL" to transfer everything*/}
-          // exchange: ['AssetHubPolkadotDex'], - Optional parameter - 'HydrationDex' | 'AcalaDex' | 'AssetHubPolkadotDex' | ...
+          // exchange: ['AssetHubPolkadot'], - Optional parameter - 'Hydration' | 'Acala' | 'AssetHubPolkadot' | ...
           // slippage: 1, - Optional - 1 by default
-          // evmsender: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+          // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
           // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
           // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
       })
@@ -226,7 +226,15 @@ const result = await Builder(/*chain api/builder_config/ws_url_string/ws_url_arr
         .from(TSubstrateChain)
         .to(TChain)
         .currency({id: currencyID, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | {location: Override('Custom Location'), amount: amount /*Use "ALL" to transfer everything*/} | {[{currencySelection, isFeeAsset?: true /* for example symbol: symbol or id: id, or Location: Location*/, amount: amount /*Use "ALL" to transfer everything*/}]})
-        /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in same fee asset as selected currency.*/
+        /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in same fee asset as selected currency.
+          .swap({
+            currencyTo: CURRENCY_SPEC, //Reffer to currency spec options above
+            // exchange: ['AssetHubPolkadot'], - Optional parameter - 'Hydration' | 'Acala' | 'AssetHubPolkadot' | ...
+            // slippage: 1, - Optional - 1 by default
+            // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+            // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
+            // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
+          })*/
         .recipient(ADDRESS)
         .sender(address | {address, PJS_Signer})
         .dryRun()
@@ -275,23 +283,6 @@ const tx = await builder.buildBatch({
 await builder.disconnect()
 ```
 
-#### Asset claim:
-
-```ts
-//Claim XCM trapped assets from the selected chain
-const builder = Builder(/*chain api/builder_config/ws_url_string/ws_url_array - optional*/)
-      .claimfrom(TSubstrateChain)
-      .currency({id: currencyID, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: currencySymbol, amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Native('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: Foreign('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {symbol: ForeignAbstract('currencySymbol'), amount: amount /*Use "ALL" to transfer everything*/} | {location: AssetLocationString, amount: amount /*Use "ALL" to transfer everything*/ | AssetLocationJson, amount: amount /*Use "ALL" to transfer everything*/} | [{currencySelection /*for example symbol: symbol or id: id, or location: location*/, amount: amount /*Use "ALL" to transfer everything*/}, {currencySelection}, ..]
-)
-      .recipient(address | Location object)
-      /*.xcmVersion(Version.V3) Optional parameter, by default chain specific version. XCM Version ENUM if a different XCM version is needed (Supported V3 & V4 & V5). Requires importing Version enum.*/
-
-const tx = await builder.build()
-
-//Make sure to disconnect the API after it is no longer used (eg, after a transaction)
-await builder.disconnect()
-```
-
 ### Localhost test setup
 
 ```ts
@@ -329,7 +320,15 @@ const fee = await Builder(/*chain api/builder_config/ws_url_string/ws_url_array
           .from(TSubstrateChain)
           .to(TChain)
           .currency(CURRENCY_SPEC)
-          /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in the same fee asset as selected currency.*/
+          /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in the same fee asset as selected currency.
+            .swap({
+                currencyTo: CURRENCY_SPEC, //Reffer to currency spec options above
+                // exchange: ['AssetHubPolkadot'], - Optional parameter - 'Hydration' | 'Acala' | 'AssetHubPolkadot' | ...
+                // slippage: 1, - Optional - 1 by default
+                // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+                // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
+                // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
+            })*/
           .recipient(RECIPIENT_ADDRESS)
           .sender(address | {address, PJS_Signer})
           .getXcmFee(/*{disableFallback: true / false}*/)  //Fallback is optional. When fallback is disabled, you only get notified of a DryRun error, but no Payment info query fallback is performed. Payment info is still performed if Origin or Destination chain do not support DryRun out of the box.
@@ -366,7 +365,15 @@ const transferable = await Builder(/*chain api/builder_config/ws_url_string/ws_u
           .from(TSubstrateChain)
           .to(TChain)
           .currency(CURRENCY_SPEC)
-          /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in the same fee asset as selected currency.*/
+          /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in the same fee asset as selected currency.
+            .swap({
+                currencyTo: CURRENCY_SPEC, //Reffer to currency spec options above
+                // exchange: ['AssetHubPolkadot'], - Optional parameter - 'Hydration' | 'Acala' | 'AssetHubPolkadot' | ...
+                // slippage: 1, - Optional - 1 by default
+                // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+                // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
+                // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
+            })*/
           .recipient(RECIPIENT_ADDRESS)
           .sender(address | {address, PJS_Signer})
           .getTransferableAmount()
@@ -378,7 +385,15 @@ const transferable = await Builder(/*chain api/builder_config/ws_url_string/ws_u
           .from(TSubstrateChain)
           .to(TChain)
           .currency(CURRENCY_SPEC)
-          /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in the same fee asset as selected currency.*/
+          /*.feeAsset(CURRENCY) - Optional parameter when origin === AssetHubPolkadot and TX is supposed to be paid in the same fee asset as selected currency.
+            .swap({
+                currencyTo: CURRENCY_SPEC, //Reffer to currency spec options above
+                // exchange: ['AssetHubPolkadot'], - Optional parameter - 'Hydration' | 'Acala' | 'AssetHubPolkadot' | ...
+                // slippage: 1, - Optional - 1 by default
+                // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+                // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
+                // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
+            })*/
           .recipient(RECIPIENT_ADDRESS)
           .sender(address | {address, PJS_Signer})
           .getMinTransferableAmount()
@@ -408,6 +423,26 @@ const ed = await Builder(/*chain api/builder_config/ws_url_string/ws_url_array -
           .verifyEdOnDestination()
 ```
 
+#### Get best amount out
+
+```ts
+const result = await Builder(/*chain api/builder_config/ws_url_string/ws_url_array - optional*/)
+      .from(TSubstrateChain) //'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/sdk/AssetPallet.html#import-chains-as-types
+      .to(TChain) //'AssetHubPolkadot' | 'Hydration' | 'Moonbeam' | 'Polkadot' |  ... https://paraspell.github.io/docs/sdk/AssetPallet.html#import-chains-as-types
+      .currency(CURRENCY_SPEC) 
+      .recipient(RECIPIENT_ADDRESS)
+      .sender(SENDER_ADDRESS)
+      .swap({
+          currencyTo: CURRENCY_SPEC, 
+          // exchange: ['AssetHubPolkadot'], - Optional parameter - 'Hydration' | 'Acala' | 'AssetHubPolkadot' | ...
+          // slippage: 1, - Optional - 1 by default
+          // evmSenderAddress: '0x000', - Optional parameter when origin CHAIN is EVM based (Required with evmSigner)
+          // evmSigner: Signer, - Optional parameter when origin CHAIN is EVM based (Required with evmInjectorAddress)
+          // onStatusChange: (event) => void - Optional parameter for callback events when sender address is supplied as signer
+      })
+      .getBestAmountOut();
+```
+
 #### Asset balance
 ```ts
 import { getBalance } from "@paraspell/sdk-pjs";
@@ -515,6 +550,52 @@ getOtherAssetsPallets(chain: TChain)
 console.log(SUPPORTED_PALLETS)
 ```
 
+### Import chains as types
+There are 6 options for types you can choose based on your prefference
+
+```ts
+// Import all exchange chains (Swap)
+import type { TExchangeChain } from "@paraspell/sdk-pjs"
+
+// Import all Parachains
+import type { TParachain } from "@paraspell/sdk-pjs"
+
+// Import all Relay chains
+import type { TRelaychain } from "@paraspell/sdk-pjs"
+
+// Import all Substrate chains (Parachains + Relays)
+import type { TSubstrateChain } from "@paraspell/sdk-pjs"
+
+// Import chains outside Polkadot ecosystem (Ethereum)
+import type { TExternalChain } from "@paraspell/sdk-pjs"
+
+// Import all chains implemented in ParaSpell
+import type { TChain } from "@paraspell/sdk-pjs"
+```
+
+### Import chains as constant
+There are 6 options for constants you can choose based on your prefference
+
+```ts
+// Print all exchange chains (Swap)
+console.log(EXCHANGE_CHAINS)
+
+// Print all Parachains
+console.log(PARACHAINS)
+
+// Print all Relay chains
+console.log(RELAYCHAINS)
+
+// Print all Substrate chains (Parachains + Relays)
+console.log(SUBSTRATE_CHAINS)
+
+// Print chains outside Polkadot ecosystem (Ethereum)
+console.log(EXTERNAL_CHAINS)
+
+// Print all chains implemented in ParaSpell
+console.log(CHAINS)
+```
+
 ## 💻 Tests
 - Run compilation using `pnpm compile`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paraspell/sdk-pjs",
-  "version": "12.10.0-rc.2",
+  "version": "13.0.0",
   "description": "Polkadot.js based SDK for ParaSpell XCM/XCMP tool for developers",
   "repository": {
     "type": "git",
@@ -28,8 +28,8 @@
     "@snowbridge/contract-types": "^0.4.4",
     "@snowbridge/registry": "^0.4.4",
     "ethers": "^6.16.0",
-    "viem": "2.47.1",
-    "@paraspell/sdk-core": "12.10.0-rc.2"
+    "viem": "^2.47.6",
+    "@paraspell/sdk-core": "13.0.0"
   },
   "peerDependencies": {
     "@polkadot/api": ">= 16.0 < 17",