@paraspell/sdk-pjs 8.4.2 → 8.5.1

package/README.md

@@ -11,7 +11,7 @@
       <img alt="downloads" src="https://img.shields.io/npm/dm/@paraspell/sdk-pjs?style=flat-square" />
     </a>
     <a href="https://github.com/paraspell/xcm-sdk/actions">
-      <img alt="build" src="https://github.com/paraspell/xcm-sdk/actions/workflows/release.yml/badge.svg" />
+      <img alt="build" src="https://github.com/paraspell/xcm-tools/actions/workflows/ci.yml/badge.svg" />
     </a>
     <a href="https://snyk.io/test/github/paraspell/sdk">
       <img alt="snyk" src="https://snyk.io/test/github/paraspell/sdk/badge.svg" />
@@ -19,7 +19,6 @@
   </p>
   <p>Supporting every XCM Active Parachain <a href = "https://paraspell.github.io/docs/supported.html"\>[list]</p>
   <p>SDK documentation <a href = "https://paraspell.github.io/docs/" \>[here]</p>
-   <p>SDK starter template project <a href = "https://github.com/paraspell/xcm-sdk-template" \>[here]</p>
 </div>
 
 <br /><br />
@@ -223,7 +222,7 @@ const result = await Builder(API /*optional*/)
         .dryRun(SENDER_ADDRESS)
 
 //Function pattern
-getDryRun({api /*optional*/,  node, address /*sender address*/, tx /* Extrinsic object */})
+await getDryRun({api /*optional*/,  node, address /*sender address*/, tx /* Extrinsic object */})
 ```
 
 ### Asset claim:
@@ -331,6 +330,9 @@ await getTransferableAmount({address, node, currency /*- {id: currencyID} | {sym
 
 //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!)*/)
 ```
 
 ## 💻 Tests

package/dist/index.cjs

@@ -1395,12 +1395,35 @@ var transferEthToPolkadot = function transferEthToPolkadot(options) {
     api: new PolkadotJsApi()
   }));
 };
+var getParaEthTransferFees = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(api) {
+    var pjsApi;
+    return _regeneratorRuntime().wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          pjsApi = new PolkadotJsApi();
+          pjsApi.setApi(api);
+          _context.next = 4;
+          return pjsApi.init('AssetHubPolkadot');
+        case 4:
+          return _context.abrupt("return", sdkCore.getParaEthTransferFees(pjsApi));
+        case 5:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return function getParaEthTransferFees(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
 
 var transfer = /*#__PURE__*/Object.freeze({
   __proto__: null,
   approveToken: approveToken,
   depositToken: depositToken,
   getDryRun: getDryRun,
+  getParaEthTransferFees: getParaEthTransferFees,
   getTokenBalance: getTokenBalance,
   send: send,
   transferEthToPolkadot: transferEthToPolkadot
@@ -1545,7 +1568,7 @@ var XCDOT = '0xFfFFfFff1FcaCBd218EDc0EbA20Fc2308C778080';
 var transferMoonbeamToEth = /*#__PURE__*/function () {
   var _ref2 = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(_ref) {
     var _signer$account;
-    var api, from, to, signer, address, ahAddress, currency, foundAsset, ethAsset, contract, BRIDGE_LOCATION, ERC20_TOKEN_LOCATION, ERC20_TOKEN_LOCATION_REANCHORED, customXcm, apiPjs, assetHubApi, assetHubApiPjs, xcmHash, sender, _yield$Promise$all, _yield$Promise$all2, parachainId, accountNextId, entropy, messageId, xcmOnDest, customXcmOnDest, transferFee, createTx, tx;
+    var api, from, to, signer, address, ahAddress, currency, foundAsset, ethAsset, contract, BRIDGE_LOCATION, ERC20_TOKEN_LOCATION, ERC20_TOKEN_LOCATION_REANCHORED, customXcm, apiPjs, assetHubApi, assetHubApiPjs, xcmHash, sender, _yield$Promise$all, _yield$Promise$all2, parachainId, accountNextId, entropy, messageId, xcmOnDest, customXcmOnDest, _yield$getParaEthTran, _yield$getParaEthTran2, bridgeFee, executionFee, transferFee, createTx, tx;
     return _regeneratorRuntime().wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
@@ -1748,10 +1771,13 @@ var transferMoonbeamToEth = /*#__PURE__*/function () {
           });
           customXcmOnDest = xcmOnDest.toHex();
           _context.next = 57;
-          return sdkCore.calculateFee(assetHubApi);
+          return sdkCore.getParaEthTransferFees(assetHubApi);
         case 57:
-          transferFee = _context.sent;
-          // Partially inspired by Moonbeam XCM-SDK
+          _yield$getParaEthTran = _context.sent;
+          _yield$getParaEthTran2 = _slicedToArray(_yield$getParaEthTran, 2);
+          bridgeFee = _yield$getParaEthTran2[0];
+          executionFee = _yield$getParaEthTran2[1];
+          transferFee = (bridgeFee + executionFee).toString(); // Partially inspired by Moonbeam XCM-SDK
           // https://github.com/moonbeam-foundation/xcm-sdk/blob/ab835c15bf41612604b1c858d956a9f07705ed65/packages/sdk/src/contract/contracts/Xtokens/Xtokens.ts#L53
           createTx = function createTx(func, args) {
             if (isEthersContract(contract)) {
@@ -1759,7 +1785,7 @@ var transferMoonbeamToEth = /*#__PURE__*/function () {
             }
             return contract.write[func](args);
           }; // Execute the custom XCM message with the precompile
-          _context.next = 61;
+          _context.next = 65;
           return createTx(isEthersSigner(signer) ? 'transferAssetsUsingTypeAndThenAddress((uint8,bytes[]),(address,uint256)[],uint8,uint8,uint8,bytes)' : 'transferAssetsUsingTypeAndThenAddress', [
           // This represents (1,X1(Parachain(1000)))
           [1, ['0x00' + util.numberToHex(sdkCore.getParaId('AssetHubPolkadot'), 32).slice(2)]],
@@ -1771,10 +1797,10 @@ var transferMoonbeamToEth = /*#__PURE__*/function () {
           0,
           // The TransferType corresponding to fee asset
           2, customXcmOnDest]);
-        case 61:
+        case 65:
           tx = _context.sent;
           return _context.abrupt("return", _typeof(tx) === 'object' ? tx.hash : tx);
-        case 63:
+        case 67:
         case "end":
           return _context.stop();
       }
@@ -1964,6 +1990,7 @@ exports.getDryRun = getDryRun;
 exports.getMaxForeignTransferableAmount = getMaxForeignTransferableAmount;
 exports.getMaxNativeTransferableAmount = getMaxNativeTransferableAmount;
 exports.getOriginFeeDetails = getOriginFeeDetails;
+exports.getParaEthTransferFees = getParaEthTransferFees;
 exports.getTokenBalance = getTokenBalance;
 exports.getTransferInfo = getTransferInfo;
 exports.getTransferableAmount = getTransferableAmount;

package/dist/index.d.ts

@@ -43,15 +43,17 @@ declare const transferEthToPolkadot: (options: Omit<TEvmBuilderOptions<TPjsApi,
     response: ethers.TransactionResponse;
     messageReceipt: _snowbridge_api_dist_toPolkadot_v2.MessageReceipt;
 }>;
+declare const getParaEthTransferFees: (api?: TPjsApiOrUrl) => Promise<[bigint, bigint]>;
 
 declare const transfer_approveToken: typeof approveToken;
 declare const transfer_depositToken: typeof depositToken;
 declare const transfer_getDryRun: typeof getDryRun;
+declare const transfer_getParaEthTransferFees: typeof getParaEthTransferFees;
 declare const transfer_getTokenBalance: typeof getTokenBalance;
 declare const transfer_send: typeof send;
 declare const transfer_transferEthToPolkadot: typeof transferEthToPolkadot;
 declare namespace transfer {
-  export { transfer_approveToken as approveToken, transfer_depositToken as depositToken, transfer_getDryRun as getDryRun, transfer_getTokenBalance as getTokenBalance, transfer_send as send, transfer_transferEthToPolkadot as transferEthToPolkadot };
+  export { transfer_approveToken as approveToken, transfer_depositToken as depositToken, transfer_getDryRun as getDryRun, transfer_getParaEthTransferFees as getParaEthTransferFees, transfer_getTokenBalance as getTokenBalance, transfer_send as send, transfer_transferEthToPolkadot as transferEthToPolkadot };
 }
 
 /**
@@ -208,4 +210,4 @@ type IFinalBuilderWithOptions = IFinalBuilderWithOptions$1<TPjsApi, Extrinsic>;
 
 declare const createApiInstanceForNode: (node: TNodeDotKsmWithRelayChains) => Promise<_polkadot_api.ApiPromise>;
 
-export { Builder, EvmBuilder, type Extrinsic, GeneralBuilder, type IFinalBuilderWithOptions, type TPjsApi, type TPjsApiOrUrl, approveToken, assets, claimAssets, createApiInstanceForNode, depositToken, getAssetBalance, getBalanceForeign, getBalanceNative, getDryRun, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getOriginFeeDetails, getTokenBalance, getTransferInfo, getTransferableAmount, send, transferEthToPolkadot, transfer as xcmPallet };
+export { Builder, EvmBuilder, type Extrinsic, GeneralBuilder, type IFinalBuilderWithOptions, type TPjsApi, type TPjsApiOrUrl, approveToken, assets, claimAssets, createApiInstanceForNode, depositToken, getAssetBalance, getBalanceForeign, getBalanceNative, getDryRun, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getOriginFeeDetails, getParaEthTransferFees, getTokenBalance, getTransferInfo, getTransferableAmount, send, transferEthToPolkadot, transfer as xcmPallet };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { getParaId, isForeignAsset, InvalidCurrencyError, getAssetBySymbolOrId, isOverrideMultiLocationSpecifier, BatchMode, createApiInstanceForNode as createApiInstanceForNode$1, getNode, computeFeeFromDryRunPjs, resolveModuleError, getAssetsObject, send as send$1, getDryRun as getDryRun$1, 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, Foreign, ForeignAbstract, Native, Override, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getTNode, hasSupportForAsset, isNodeEvm, calculateFee, ETH_CHAIN_ID, findAssetByMultiLocation, ETHEREUM_JUNCTION, transferMoonbeamEvm, validateAddress, Builder as Builder$1, GeneralBuilder as GeneralBuilder$1 } from '@paraspell/sdk-core';
+import { getParaId, isForeignAsset, InvalidCurrencyError, getAssetBySymbolOrId, isOverrideMultiLocationSpecifier, BatchMode, createApiInstanceForNode as createApiInstanceForNode$1, getNode, computeFeeFromDryRunPjs, resolveModuleError, getAssetsObject, send as send$1, getDryRun as getDryRun$1, getParaEthTransferFees as getParaEthTransferFees$1, 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, Foreign, ForeignAbstract, Native, Override, getAllAssetsSymbols, getAssetDecimals, getAssetId, getAssets, getExistentialDeposit, getNativeAssetSymbol, getNativeAssets, getOtherAssets, getRelayChainSymbol, getSupportedAssets, getTNode, hasSupportForAsset, isNodeEvm, ETH_CHAIN_ID, findAssetByMultiLocation, ETHEREUM_JUNCTION, transferMoonbeamEvm, validateAddress, Builder as Builder$1, GeneralBuilder as GeneralBuilder$1 } from '@paraspell/sdk-core';
 export * from '@paraspell/sdk-core';
 import { Context, toPolkadotV2, assetsV2, environment } from '@snowbridge/api';
 import { WETH9__factory } from '@snowbridge/contract-types';
@@ -1394,12 +1394,35 @@ var transferEthToPolkadot = function transferEthToPolkadot(options) {
     api: new PolkadotJsApi()
   }));
 };
+var getParaEthTransferFees = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(api) {
+    var pjsApi;
+    return _regeneratorRuntime().wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          pjsApi = new PolkadotJsApi();
+          pjsApi.setApi(api);
+          _context.next = 4;
+          return pjsApi.init('AssetHubPolkadot');
+        case 4:
+          return _context.abrupt("return", getParaEthTransferFees$1(pjsApi));
+        case 5:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return function getParaEthTransferFees(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
 
 var transfer = /*#__PURE__*/Object.freeze({
   __proto__: null,
   approveToken: approveToken,
   depositToken: depositToken,
   getDryRun: getDryRun,
+  getParaEthTransferFees: getParaEthTransferFees,
   getTokenBalance: getTokenBalance,
   send: send,
   transferEthToPolkadot: transferEthToPolkadot
@@ -1544,7 +1567,7 @@ var XCDOT = '0xFfFFfFff1FcaCBd218EDc0EbA20Fc2308C778080';
 var transferMoonbeamToEth = /*#__PURE__*/function () {
   var _ref2 = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(_ref) {
     var _signer$account;
-    var api, from, to, signer, address, ahAddress, currency, foundAsset, ethAsset, contract, BRIDGE_LOCATION, ERC20_TOKEN_LOCATION, ERC20_TOKEN_LOCATION_REANCHORED, customXcm, apiPjs, assetHubApi, assetHubApiPjs, xcmHash, sender, _yield$Promise$all, _yield$Promise$all2, parachainId, accountNextId, entropy, messageId, xcmOnDest, customXcmOnDest, transferFee, createTx, tx;
+    var api, from, to, signer, address, ahAddress, currency, foundAsset, ethAsset, contract, BRIDGE_LOCATION, ERC20_TOKEN_LOCATION, ERC20_TOKEN_LOCATION_REANCHORED, customXcm, apiPjs, assetHubApi, assetHubApiPjs, xcmHash, sender, _yield$Promise$all, _yield$Promise$all2, parachainId, accountNextId, entropy, messageId, xcmOnDest, customXcmOnDest, _yield$getParaEthTran, _yield$getParaEthTran2, bridgeFee, executionFee, transferFee, createTx, tx;
     return _regeneratorRuntime().wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
@@ -1747,10 +1770,13 @@ var transferMoonbeamToEth = /*#__PURE__*/function () {
           });
           customXcmOnDest = xcmOnDest.toHex();
           _context.next = 57;
-          return calculateFee(assetHubApi);
+          return getParaEthTransferFees$1(assetHubApi);
         case 57:
-          transferFee = _context.sent;
-          // Partially inspired by Moonbeam XCM-SDK
+          _yield$getParaEthTran = _context.sent;
+          _yield$getParaEthTran2 = _slicedToArray(_yield$getParaEthTran, 2);
+          bridgeFee = _yield$getParaEthTran2[0];
+          executionFee = _yield$getParaEthTran2[1];
+          transferFee = (bridgeFee + executionFee).toString(); // Partially inspired by Moonbeam XCM-SDK
           // https://github.com/moonbeam-foundation/xcm-sdk/blob/ab835c15bf41612604b1c858d956a9f07705ed65/packages/sdk/src/contract/contracts/Xtokens/Xtokens.ts#L53
           createTx = function createTx(func, args) {
             if (isEthersContract(contract)) {
@@ -1758,7 +1784,7 @@ var transferMoonbeamToEth = /*#__PURE__*/function () {
             }
             return contract.write[func](args);
           }; // Execute the custom XCM message with the precompile
-          _context.next = 61;
+          _context.next = 65;
           return createTx(isEthersSigner(signer) ? 'transferAssetsUsingTypeAndThenAddress((uint8,bytes[]),(address,uint256)[],uint8,uint8,uint8,bytes)' : 'transferAssetsUsingTypeAndThenAddress', [
           // This represents (1,X1(Parachain(1000)))
           [1, ['0x00' + numberToHex(getParaId('AssetHubPolkadot'), 32).slice(2)]],
@@ -1770,10 +1796,10 @@ var transferMoonbeamToEth = /*#__PURE__*/function () {
           0,
           // The TransferType corresponding to fee asset
           2, customXcmOnDest]);
-        case 61:
+        case 65:
           tx = _context.sent;
           return _context.abrupt("return", _typeof(tx) === 'object' ? tx.hash : tx);
-        case 63:
+        case 67:
         case "end":
           return _context.stop();
       }
@@ -1948,4 +1974,4 @@ var EvmBuilder = function EvmBuilder(provider) {
   return EvmBuilder$1(pjsApi, provider);
 };
 
-export { Builder, EvmBuilder, GeneralBuilder, approveToken, assets, claimAssets, createApiInstanceForNode, depositToken, getAssetBalance, getBalanceForeign, getBalanceNative, getDryRun, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getOriginFeeDetails, getTokenBalance, getTransferInfo, getTransferableAmount, send, transferEthToPolkadot, transfer as xcmPallet };
+export { Builder, EvmBuilder, GeneralBuilder, approveToken, assets, claimAssets, createApiInstanceForNode, depositToken, getAssetBalance, getBalanceForeign, getBalanceNative, getDryRun, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getOriginFeeDetails, getParaEthTransferFees, getTokenBalance, getTransferInfo, getTransferableAmount, send, transferEthToPolkadot, transfer as xcmPallet };

package/package.json

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