@paraspell/sdk 8.16.0 → 9.0.0

package/README.md

@@ -185,6 +185,37 @@ await builder.disconnect()
 */
 ```
 
+##### Local transfers
+```ts
+const builder = Builder(/*node api/ws_url_string/ws_url_array - optional*/)
+      .from(NODE)
+      .to(NODE) //Has to be same as origin (from)
+      .currency({id: currencyID, amount: amount} | {symbol: currencySymbol, amount: amount} | {symbol: Native('currencySymbol'), amount: amount} | {symbol: Foreign('currencySymbol'), amount: amount} | {symbol: ForeignAbstract('currencySymbol'), amount: amount} | {multilocation: AssetMultilocationString, amount: amount | AssetMultilocationJson, amount: amount} | {multilocation: Override('Custom Multilocation'), amount: amount} | {multiasset: {currencySelection, isFeeAsset?: true /* for example symbol: symbol or id: id, or multilocation: multilocation*/, amount: amount}})
+      .address(address)
+
+const tx = await builder.build()
+
+//Make sure to disconnect API after it is no longer used (eg. after transaction)
+await builder.disconnect()
+
+/*
+EXAMPLE:
+const builder = Builder()
+  .from('Hydration')
+  .to('Hydration')
+  .currency({
+    symbol: 'DOT',
+    amount: '1000000000'
+  })
+  .address(address)
+
+const tx = await builder.build()
+
+//Disconnect API after TX
+await builder.disconnect()
+*/
+```
+
 ##### Batch calls
 You can batch XCM calls and execute multiple XCM calls within one call. All three scenarios (Para->Para, Para->Relay, Relay->Para) can be used and combined.
 ```js
@@ -210,6 +241,21 @@ const tx = await builder.buildBatch({
 await builder.disconnect()
 ```
 
+##### Asset claim:
+```ts
+//Claim XCM trapped assets from the selected chain
+const builder = Builder(/*node api/ws_url_string/ws_url_array - optional*/)
+      .claimFrom(NODE)
+      .fungible(MultilocationArray (Only one multilocation allowed) [{Multilocation}])
+      .account(address | Multilocation object)
+      /*.xcmVersion(Version.V3) Optional parameter, by default V3. XCM Version ENUM if a different XCM version is needed (Supported V2 & V3). Requires importing Version enum.*/
+
+const tx = await builder.build()
+
+//Make sure to disconnect API after it is no longer used (eg. after transaction)
+await builder.disconnect()
+```
+
 ### Dry run your XCM Calls:
 ```ts
 //Builder pattern
@@ -264,51 +310,43 @@ const fee = await Builder(/*node api/ws_url_string/ws_url_array - optional*/)
           .getXcmFeeEstimate()
 ```
 
-
-### Asset claim:
+### XCM Transfer info
 ```ts
-//Claim XCM trapped assets from the selected chain
-const builder = Builder(/*node api/ws_url_string/ws_url_array - optional*/)
-      .claimFrom(NODE)
-      .fungible(MultilocationArray (Only one multilocation allowed) [{Multilocation}])
-      .account(address | Multilocation object)
-      /*.xcmVersion(Version.V3) Optional parameter, by default V3. XCM Version ENUM if a different XCM version is needed (Supported V2 & V3). Requires importing Version enum.*/
+import { getAssetBalance, getTransferInfo, getOriginFeeDetails, getTransferableAmount, getParaEthTransferFees, verifyEdOnDestination } from "@paraspell/sdk";
 
-const tx = await builder.build()
+//Get fee information regarding XCM call
+await getOriginFeeDetails({from, to, currency /*- {id: currencyID} | {symbol: currencySymbol} | {symbol: Native('currencySymbol')} | {symbol: Foreign('currencySymbol')} | {symbol: ForeignAbstract('currencySymbol')} | {multilocation: AssetMultilocationString | AssetMultilocationJson}*/, amount, originAddress, destinationAddress, ahAddress /* optional parameter when destination is Ethereum and origin is Parachain other than AssetHub*/, api /* api/ws_url_string optional */, feeMargin /* 10% by default */})
 
-//Make sure to disconnect API after it is no longer used (eg. after transaction)
-await builder.disconnect()
-```
+//Retrieves the asset balance for a given account on a specified node. (You do not need to specify if it is native or foreign).
+await getAssetBalance({address, node, currency /*- {id: currencyID} | {symbol: currencySymbol} | {symbol: Native('currencySymbol')} | {symbol: Foreign('currencySymbol')} | {symbol: ForeignAbstract('currencySymbol')} | {multilocation: AssetMultilocationString | AssetMultilocationJson}*/, api /* api/ws_url_string optional */});
 
-### Local transfers
-```ts
-const builder = Builder(/*node api/ws_url_string/ws_url_array - optional*/)
-      .from(NODE)
-      .to(NODE) //Has to be same as origin (from)
-      .currency({id: currencyID, amount: amount} | {symbol: currencySymbol, amount: amount} | {symbol: Native('currencySymbol'), amount: amount} | {symbol: Foreign('currencySymbol'), amount: amount} | {symbol: ForeignAbstract('currencySymbol'), amount: amount} | {multilocation: AssetMultilocationString, amount: amount | AssetMultilocationJson, amount: amount} | {multilocation: Override('Custom Multilocation'), amount: amount} | {multiasset: {currencySelection, isFeeAsset?: true /* for example symbol: symbol or id: id, or multilocation: multilocation*/, amount: amount}})
-      .address(address)
+//Combines the getMaxNative and getMaxForeign transferable amount functions into one, so you don't have to specify whether you want a native or foreign asset.
+await getTransferableAmount({address, node, currency /*- {id: currencyID} | {symbol: currencySymbol} | {symbol: Native('currencySymbol')} | {symbol: Foreign('currencySymbol')} | {symbol: ForeignAbstract('currencySymbol')} | {multilocation: AssetMultilocationString | AssetMultilocationJson}*/});
 
-const tx = await builder.build()
+//Get all the information about XCM transfer
+await getTransferInfo({from, to, address, destinationAddress, currency /*- {id: currencyID} | {symbol: currencySymbol} | {symbol: Native('currencySymbol')} | {symbol: Foreign('currencySymbol')} | {symbol: ForeignAbstract('currencySymbol')} | {multilocation: AssetMultilocationString | AssetMultilocationJson}*/, amount, api /* api/ws_url_string optional */})
 
-//Make sure to disconnect API after it is no longer used (eg. after transaction)
-await builder.disconnect()
+//Get bridge and execution fee for transfer from Parachain to Ethereum. Returns as an object of 2 values - [bridgeFee, executionFee]
+await getParaEthTransferFees(/*api - optional (Can also be WS port string or array o WS ports. Must be AssetHubPolkadot WS!)*/)
 
-/*
-EXAMPLE:
-const builder = Builder()
-  .from('Hydration')
-  .to('Hydration')
-  .currency({
-    symbol: 'DOT',
-    amount: '1000000000'
-  })
-  .address(address)
+//Verify whether XCM message you wish to send will reach above existential deposit on destination chain.
+await verifyEdOnDestination(node,  currency: {symbol: || id: || multilocation: .. ,amount: 100000n}, address)
+```
 
-const tx = await builder.build()
+### Existential deposit queries
+```ts
+import { getExistentialDeposit } from "@paraspell/sdk";
 
-//Disconnect API after TX
-await builder.disconnect()
-*/
+//Currency is an optional parameter. If you wish to query native asset, currency parameter is not necessary.
+//Currency can be either {symbol: assetSymbol}, {id: assetId}, {multilocation: assetMultilocation}.
+const ed = getExistentialDeposit(node, currency?)
+```
+
+### Convert SS58 address 
+```ts
+import { convertSs58 } from "@paraspell/sdk";
+
+let result = convertSs58(address, node) // returns converted address in string
 ```
 
 ### Asset queries:
@@ -373,45 +411,6 @@ getPalletIndex(node: TNode)
 console.log(SUPPORTED_PALLETS)
 ```
 
-### Existential deposit queries
-```ts
-import { getExistentialDeposit } from "@paraspell/sdk";
-
-//Currency is an optional parameter. If you wish to query native asset, currency parameter is not necessary.
-//Currency can be either {symbol: assetSymbol}, {id: assetId}, {multilocation: assetMultilocation}.
-const ed = getExistentialDeposit(node, currency?)
-```
-
-### Convert SS58 address 
-```ts
-import { convertSs58 } from "@paraspell/sdk";
-
-let result = convertSs58(address, node) // returns converted address in string
-```
-
-### XCM Transfer info
-```ts
-import { getAssetBalance, getTransferInfo, getOriginFeeDetails, getTransferableAmount, getParaEthTransferFees, verifyEdOnDestination } from "@paraspell/sdk";
-
-//Get fee information regarding XCM call
-await getOriginFeeDetails({from, to, currency /*- {id: currencyID} | {symbol: currencySymbol} | {symbol: Native('currencySymbol')} | {symbol: Foreign('currencySymbol')} | {symbol: ForeignAbstract('currencySymbol')} | {multilocation: AssetMultilocationString | AssetMultilocationJson}*/, amount, originAddress, destinationAddress, ahAddress /* optional parameter when destination is Ethereum and origin is Parachain other than AssetHub*/, api /* api/ws_url_string optional */, feeMargin /* 10% by default */})
-
-//Retrieves the asset balance for a given account on a specified node. (You do not need to specify if it is native or foreign).
-await getAssetBalance({address, node, currency /*- {id: currencyID} | {symbol: currencySymbol} | {symbol: Native('currencySymbol')} | {symbol: Foreign('currencySymbol')} | {symbol: ForeignAbstract('currencySymbol')} | {multilocation: AssetMultilocationString | AssetMultilocationJson}*/, api /* api/ws_url_string optional */});
-
-//Combines the getMaxNative and getMaxForeign transferable amount functions into one, so you don't have to specify whether you want a native or foreign asset.
-await getTransferableAmount({address, node, currency /*- {id: currencyID} | {symbol: currencySymbol} | {symbol: Native('currencySymbol')} | {symbol: Foreign('currencySymbol')} | {symbol: ForeignAbstract('currencySymbol')} | {multilocation: AssetMultilocationString | AssetMultilocationJson}*/});
-
-//Get all the information about XCM transfer
-await getTransferInfo({from, to, address, destinationAddress, currency /*- {id: currencyID} | {symbol: currencySymbol} | {symbol: Native('currencySymbol')} | {symbol: Foreign('currencySymbol')} | {symbol: ForeignAbstract('currencySymbol')} | {multilocation: AssetMultilocationString | AssetMultilocationJson}*/, amount, api /* api/ws_url_string optional */})
-
-//Get bridge and execution fee for transfer from Parachain to Ethereum. Returns as an object of 2 values - [bridgeFee, executionFee]
-await getParaEthTransferFees(/*api - optional (Can also be WS port string or array o WS ports. Must be AssetHubPolkadot WS!)*/)
-
-//Verify whether XCM message you wish to send will reach above existential deposit on destination chain.
-await verifyEdOnDestination(node,  currency: {symbol: || id: || multilocation: .. ,amount: 100000n}, address)
-```
-
 ## 💻 Tests
 - Run compilation using `pnpm compile`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paraspell/sdk",
-  "version": "8.16.0",
+  "version": "9.0.0",
   "description": "SDK for ParaSpell XCM/XCMP tool for developers",
   "repository": {
     "type": "git",
@@ -27,7 +27,7 @@
     "ethers": "^6.13.7",
     "quick-lru": "^7.0.1",
     "viem": "^2.28.1",
-    "@paraspell/sdk-core": "8.16.0"
+    "@paraspell/sdk-core": "9.0.0"
   },
   "peerDependencies": {
     "polkadot-api": ">= 1.10.2 < 2"