@paraspell/sdk-pjs 8.15.2 → 9.0.0

package/README.md

@@ -181,6 +181,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
@@ -206,6 +237,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
@@ -263,53 +309,44 @@ 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-pjs";
 
-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-pjs";
 
-//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-pjs";
+
+let result = convertSs58(address, node) // returns converted address in string
+```
 
 ### Asset queries:
 
@@ -373,38 +410,6 @@ getPalletIndex(node: TNode)
 console.log(SUPPORTED_PALLETS)
 ```
 
-### Existential deposit queries
-```ts
-import { getExistentialDeposit } from "@paraspell/sdk-pjs";
-
-//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?)
-```
-
-### XCM Transfer info
-```ts
-import { getAssetBalance, getTransferInfo, getOriginFeeDetails, getTransferableAmount, getParaEthTransferFees, verifyEdOnDestination } from "@paraspell/sdk-pjs";
-
-//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/dist/index.cjs

@@ -529,6 +529,11 @@ var PolkadotJsApi = /*#__PURE__*/function () {
       var uint8Array = utilCrypto.decodeAddress(address);
       return util.u8aToHex(uint8Array, -1, isPrefixed);
     }
+  }, {
+    key: "accountToUint8a",
+    value: function accountToUint8a(address) {
+      return utilCrypto.decodeAddress(address);
+    }
   }, {
     key: "callTxMethod",
     value: function callTxMethod(_ref) {
@@ -1257,6 +1262,11 @@ var assets = /*#__PURE__*/Object.freeze({
   verifyEdOnDestination: verifyEdOnDestination
 });
 
+var convertSs58 = function convertSs58(address, node) {
+  var papiApi = new PolkadotJsApi();
+  return sdkCore.convertSs58(papiApi, address, node);
+};
+
 var approveToken = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(signer, amount, symbol) {
     var env, contract, weth9, result, receipt;
@@ -1834,6 +1844,7 @@ exports.EvmBuilder = EvmBuilder;
 exports.approveToken = approveToken;
 exports.assets = assets;
 exports.claimAssets = claimAssets;
+exports.convertSs58 = convertSs58;
 exports.createApiInstanceForNode = createApiInstanceForNode;
 exports.depositToken = depositToken;
 exports.dryRun = dryRun;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _paraspell_sdk_core from '@paraspell/sdk-core';
-import { TApiOrUrl, Foreign, ForeignAbstract, Native, Override, findAsset, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getAssetsObject, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getTNode, hasSupportForAsset, isNodeEvm, TEvmBuilderOptions, TNodeWithRelayChains, TCurrencyInputWithAmount, GeneralBuilder as GeneralBuilder$1, TSendBaseOptions, TNodeDotKsmWithRelayChains } from '@paraspell/sdk-core';
+import { TApiOrUrl, Foreign, ForeignAbstract, Native, Override, findAsset, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getAssetsObject, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getTNode, hasSupportForAsset, isNodeEvm, TNodeDotKsmWithRelayChains, TEvmBuilderOptions, TNodeWithRelayChains, TCurrencyInputWithAmount, GeneralBuilder as GeneralBuilder$1, TSendBaseOptions } from '@paraspell/sdk-core';
 export * from '@paraspell/sdk-core';
 import * as _polkadot_api from '@polkadot/api';
 import { ApiPromise } from '@polkadot/api';
@@ -133,6 +133,8 @@ declare namespace assets {
   };
 }
 
+declare const convertSs58: (address: string, node: TNodeDotKsmWithRelayChains) => string;
+
 /**
  * Builder class for constructing transfers from Ethereum to Polkadot.
  */
@@ -269,5 +271,5 @@ declare namespace transfer {
 
 declare const createApiInstanceForNode: (node: TNodeDotKsmWithRelayChains) => Promise<_polkadot_api.ApiPromise>;
 
-export { Builder, EvmBuilder, approveToken, assets, claimAssets, createApiInstanceForNode, depositToken, dryRun, dryRunOrigin, getAssetBalance, getBalanceForeign, getBalanceNative, getBridgeStatus, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getOriginFeeDetails, getParaEthTransferFees, getTokenBalance, getTransferInfo, getTransferableAmount, send, transferEthToPolkadot, verifyEdOnDestination, transfer as xcmPallet };
+export { Builder, EvmBuilder, approveToken, assets, claimAssets, convertSs58, createApiInstanceForNode, depositToken, dryRun, dryRunOrigin, getAssetBalance, getBalanceForeign, getBalanceNative, getBridgeStatus, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getOriginFeeDetails, getParaEthTransferFees, getTokenBalance, getTransferInfo, getTransferableAmount, send, transferEthToPolkadot, verifyEdOnDestination, transfer as xcmPallet };
 export type { Extrinsic, GeneralBuilder, TPjsApi, TPjsApiOrUrl };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { BatchMode, createApiInstanceForNode as createApiInstanceForNode$1, getNode, isForeignAsset, computeFeeFromDryRunPjs, resolveModuleError, getAssetsObject, NodeNotSupportedError, getBalanceNative as getBalanceNative$1, getBalanceForeign as getBalanceForeign$1, getTransferInfo as getTransferInfo$1, getAssetBalance as getAssetBalance$1, claimAssets as claimAssets$1, getOriginFeeDetails as getOriginFeeDetails$1, getMaxNativeTransferableAmount as getMaxNativeTransferableAmount$1, getMaxForeignTransferableAmount as getMaxForeignTransferableAmount$1, getTransferableAmount as getTransferableAmount$1, verifyEdOnDestination as verifyEdOnDestination$1, Foreign, ForeignAbstract, Native, Override, findAsset, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getTNode, hasSupportForAsset, isNodeEvm, getParaId, ETH_CHAIN_ID, InvalidCurrencyError, isEthersSigner, isOverrideMultiLocationSpecifier, validateAddress, transferMoonbeamToEth, transferMoonbeamEvm, Builder as Builder$1, getParaEthTransferFees as getParaEthTransferFees$1, DRY_RUN_CLIENT_TIMEOUT_MS, getBridgeStatus as getBridgeStatus$1, send as send$1, dryRun as dryRun$1, dryRunOrigin as dryRunOrigin$1 } from '@paraspell/sdk-core';
+import { BatchMode, createApiInstanceForNode as createApiInstanceForNode$1, getNode, isForeignAsset, computeFeeFromDryRunPjs, resolveModuleError, getAssetsObject, NodeNotSupportedError, getBalanceNative as getBalanceNative$1, getBalanceForeign as getBalanceForeign$1, getTransferInfo as getTransferInfo$1, getAssetBalance as getAssetBalance$1, claimAssets as claimAssets$1, getOriginFeeDetails as getOriginFeeDetails$1, getMaxNativeTransferableAmount as getMaxNativeTransferableAmount$1, getMaxForeignTransferableAmount as getMaxForeignTransferableAmount$1, getTransferableAmount as getTransferableAmount$1, verifyEdOnDestination as verifyEdOnDestination$1, Foreign, ForeignAbstract, Native, Override, findAsset, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getTNode, hasSupportForAsset, isNodeEvm, convertSs58 as convertSs58$1, getParaId, ETH_CHAIN_ID, InvalidCurrencyError, isEthersSigner, isOverrideMultiLocationSpecifier, validateAddress, transferMoonbeamToEth, transferMoonbeamEvm, Builder as Builder$1, getParaEthTransferFees as getParaEthTransferFees$1, DRY_RUN_CLIENT_TIMEOUT_MS, getBridgeStatus as getBridgeStatus$1, send as send$1, dryRun as dryRun$1, dryRunOrigin as dryRunOrigin$1 } from '@paraspell/sdk-core';
 export * from '@paraspell/sdk-core';
 import { WsProvider, ApiPromise } from '@polkadot/api';
 import { u32 } from '@polkadot/types';
@@ -528,6 +528,11 @@ var PolkadotJsApi = /*#__PURE__*/function () {
       var uint8Array = decodeAddress(address);
       return u8aToHex(uint8Array, -1, isPrefixed);
     }
+  }, {
+    key: "accountToUint8a",
+    value: function accountToUint8a(address) {
+      return decodeAddress(address);
+    }
   }, {
     key: "callTxMethod",
     value: function callTxMethod(_ref) {
@@ -1256,6 +1261,11 @@ var assets = /*#__PURE__*/Object.freeze({
   verifyEdOnDestination: verifyEdOnDestination
 });
 
+var convertSs58 = function convertSs58(address, node) {
+  var papiApi = new PolkadotJsApi();
+  return convertSs58$1(papiApi, address, node);
+};
+
 var approveToken = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(signer, amount, symbol) {
     var env, contract, weth9, result, receipt;
@@ -1828,4 +1838,4 @@ var transfer = /*#__PURE__*/Object.freeze({
   transferEthToPolkadot: transferEthToPolkadot
 });
 
-export { Builder, EvmBuilder, approveToken, assets, claimAssets, createApiInstanceForNode, depositToken, dryRun, dryRunOrigin, getAssetBalance, getBalanceForeign, getBalanceNative, getBridgeStatus, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getOriginFeeDetails, getParaEthTransferFees, getTokenBalance, getTransferInfo, getTransferableAmount, send, transferEthToPolkadot, verifyEdOnDestination, transfer as xcmPallet };
+export { Builder, EvmBuilder, approveToken, assets, claimAssets, convertSs58, createApiInstanceForNode, depositToken, dryRun, dryRunOrigin, getAssetBalance, getBalanceForeign, getBalanceNative, getBridgeStatus, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getOriginFeeDetails, getParaEthTransferFees, getTokenBalance, getTransferInfo, getTransferableAmount, send, transferEthToPolkadot, verifyEdOnDestination, transfer as xcmPallet };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paraspell/sdk-pjs",
-  "version": "8.15.2",
+  "version": "9.0.0",
   "description": "Polkadot.js based SDK for ParaSpell XCM/XCMP tool for developers",
   "repository": {
     "type": "git",
@@ -27,7 +27,7 @@
     "@snowbridge/contract-types": "0.1.50",
     "ethers": "^6.13.7",
     "viem": "^2.28.1",
-    "@paraspell/sdk-core": "8.15.2"
+    "@paraspell/sdk-core": "9.0.0"
   },
   "peerDependencies": {
     "@polkadot/api": ">= 15.0 < 16",