@paraspell/sdk 8.14.0 → 8.15.1

package/README.md

@@ -93,6 +93,7 @@ const builder = Builder(/*node api/ws_url_string/ws_url_array - optional*/)
       .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 | Multilocation object /*If you are sending through xTokens, you need to pass the destination and address multilocation in one object (x2)*/)
       /*.senderAddress(address) - OPTIONAL - used when origin is AssetHub and feeAsset parameter is provided
+        .ahAddress(ahAddress) - OPTIONAL - used when origin is EVM node and XCM goes through AssetHub (Multihop transfer where we are unable to convert Key20 to ID32 address eg. origin: Moonbeam & destination: Ethereum (Multihop goes from Moonbeam > AssetHub > BridgeHub > Ethereum)
         .feeAsset({symbol: 'symbol'} || {id: 'id'} || {multilocation: 'multilocation'}) // Optional parameter used when multiasset is provided or when origin is AssetHub - so user can pay in fees different than DOT
         .xcmVersion(Version.V1/V2/V3/V4)  //Optional parameter for manual override of XCM Version used in call
         .customPallet('Pallet','pallet_function') //Optional parameter for manual override of XCM Pallet and function used in call (If they are named differently on some node but syntax stays the same). Both pallet name and function required. Pallet name must be CamelCase, function name snake_case.*/
@@ -313,38 +314,43 @@ await builder.disconnect()
 ### Asset queries:
 
 ```ts
+import { getFeeAssets, getAssetsObject, getAssetId, getRelayChainSymbol, getNativeAssets, getNativeAssets, getOtherAssets, getAllAssetsSymbols, hasSupportForAsset, getAssetDecimals, getParaId, getTNode, getAssetMultiLocation, NODE_NAMES } from  '@paraspell/sdk'
+
+// Retrieve Fee asset queries (Assets accepted as XCM Fee on specific node)
+getFeeAssets(node: TNode)
+
 // Retrieve assets object from assets.json for particular node including information about native and foreign assets
-paraspell.assets.getAssetsObject(node: TNode)
+getAssetsObject(node: TNode)
 
 // Retrieve foreign assetId for a particular node and asset symbol
-paraspell.assets.getAssetId(node: TNode, symbol: string)
+getAssetId(node: TNode, symbol: string)
 
 // Retrieve the symbol of the relay chain for a particular node. Either "DOT" or "KSM"
-paraspell.assets.getRelayChainSymbol(node: TNode)
+getRelayChainSymbol(node: TNode)
 
 // Retrieve string array of native assets symbols for particular node
-paraspell.assets.getNativeAssets(node: TNode)
+getNativeAssets(node: TNode)
 
 // Retrieve object array of foreign assets for a particular node. Each object has a symbol and assetId property
-paraspell.assets.getOtherAssets(node: TNode)
+getOtherAssets(node: TNode)
 
 // Retrieve string array of all assets symbols. (native and foreign assets are merged into a single array)
-paraspell.assets.getAllAssetsSymbols(node: TNode)
+getAllAssetsSymbols(node: TNode)
 
 // Check if a node supports a particular asset. (Both native and foreign assets are searched). Returns boolean
-paraspell.assets.hasSupportForAsset(node: TNode, symbol: string)
+hasSupportForAsset(node: TNode, symbol: string)
 
 // Get decimals for specific asset
-paraspell.assets.getAssetDecimals(node: TNode, symbol: string)
+getAssetDecimals(node: TNode, symbol: string)
 
 // Get specific node id
-paraspell.assets.getParaId(node: TNode)
+getParaId(node: TNode)
 
 // Get specific TNode from nodeID
-paraspell.assets.getTNode(nodeID: number, ecosystem: 'polkadot' || 'kusama' || 'ethereum') //When Ethereum ecosystem is selected please fill nodeID as 1 to select Ethereum.
+getTNode(nodeID: number, ecosystem: 'polkadot' || 'kusama' || 'ethereum') //When Ethereum ecosystem is selected please fill nodeID as 1 to select Ethereum.
 
 // Import all compatible nodes as constant
-paraspell.NODE_NAMES
+NODE_NAMES
 
 // Get multilocation for asset id or symbol on specific chain
 getAssetMultiLocation(chainFrom, { symbol: symbol } | { id: assetId })
@@ -378,13 +384,7 @@ const ed = getExistentialDeposit(node, currency?)
 
 ### XCM Transfer info
 ```ts
-import { getTransferInfo, getBalanceForeign, getBalanceNative, getOriginFeeDetails, getMaxNativeTransferableAmount, getMaxForeignTransferableAmount, getTransferableAmount } from "@paraspell/sdk";
-
-//Get balance of foreign currency
-await getBalanceForeign({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 */})
-
-//Get balance of native currency
-await getBalanceNative({address, node, api /* api/ws_url_string optional */})
+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 */})
@@ -392,12 +392,6 @@ await getOriginFeeDetails({from, to, currency /*- {id: currencyID} | {symbol: cu
 //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 */});
 
-//Retrieves maximal transferable balance of chain's native asset (Balance-AssetED) (If a node has more native assets, the asset selection has to be provided. Otherwise the parameter is optional).
-await getMaxNativeTransferableAmount({address, node, currency /*- {symbol: currencySymbol} */})
-
-//Retrives maximal transferable balance of chain's foreign asset (Balance-AssetED)
-await getMaxForeignTransferableAmount({address, node, currency /*- {id: currencyID} | {symbol: currencySymbol} | {symbol: Native('currencySymbol')} | {symbol: Foreign('currencySymbol')} | {symbol: ForeignAbstract('currencySymbol')} | {multilocation: AssetMultilocationString | AssetMultilocationJson}*/});
-
 //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}*/});
 

package/dist/index.cjs

@@ -1783,10 +1783,22 @@ var EvmBuilderCore = /*#__PURE__*/function () {
      */
   }, {
     key: "address",
-    value: function address(_address, ahAddress) {
+    value: function address(_address) {
       return new EvmBuilderCore(_objectSpread2(_objectSpread2({}, this._options), {}, {
-        address: _address,
-        ahAddress: ahAddress
+        address: _address
+      }));
+    }
+    /**
+     * Sets the asset hub address. This is used for transfers that go through the Asset Hub.
+     *
+     * @param address - The address to be used.
+     * @returns An instance of EvmBuilder
+     */
+  }, {
+    key: "ahAddress",
+    value: function ahAddress(address) {
+      return new EvmBuilderCore(_objectSpread2(_objectSpread2({}, this._options), {}, {
+        ahAddress: address
       }));
     }
     /**

package/dist/index.d.ts

@@ -164,9 +164,18 @@ declare class EvmBuilderCore<TApi, TRes, T extends Partial<TEvmBuilderOptions<TA
      * @param address - The Polkadot address to receive the transfer.
      * @returns An instance of EvmBuilder
      */
-    address(address: string, ahAddress?: string): EvmBuilderCore<TApi, TRes, T & {
+    address(address: string): EvmBuilderCore<TApi, TRes, T & {
         address: string;
     }>;
+    /**
+     * Sets the asset hub address. This is used for transfers that go through the Asset Hub.
+     *
+     * @param address - The address to be used.
+     * @returns An instance of EvmBuilder
+     */
+    ahAddress(address: string | undefined): EvmBuilderCore<unknown, unknown, T & {
+        ahAddress: string | undefined;
+    }>;
     /**
      * Specifies the signer for the Ethereum transaction.
      *

package/dist/index.mjs

@@ -1782,10 +1782,22 @@ var EvmBuilderCore = /*#__PURE__*/function () {
      */
   }, {
     key: "address",
-    value: function address(_address, ahAddress) {
+    value: function address(_address) {
       return new EvmBuilderCore(_objectSpread2(_objectSpread2({}, this._options), {}, {
-        address: _address,
-        ahAddress: ahAddress
+        address: _address
+      }));
+    }
+    /**
+     * Sets the asset hub address. This is used for transfers that go through the Asset Hub.
+     *
+     * @param address - The address to be used.
+     * @returns An instance of EvmBuilder
+     */
+  }, {
+    key: "ahAddress",
+    value: function ahAddress(address) {
+      return new EvmBuilderCore(_objectSpread2(_objectSpread2({}, this._options), {}, {
+        ahAddress: address
       }));
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paraspell/sdk",
-  "version": "8.14.0",
+  "version": "8.15.1",
   "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.14.0"
+    "@paraspell/sdk-core": "8.15.1"
   },
   "peerDependencies": {
     "polkadot-api": ">= 1.10.2 < 2"