@paraspell/sdk-core 10.0.2 → 10.1.0

package/dist/index.d.ts

@@ -427,7 +427,7 @@ type TVerifyEdOnDestinationOptionsBase<TRes> = {
     /**
      * The destination node.
      */
-    destination: TNodeDotKsmWithRelayChains;
+    destination: TNodeWithRelayChains;
     /**
      * The address of the account.
      */
@@ -531,7 +531,7 @@ type TNodeConfigMap = Record<TNodeDotKsmWithRelayChains, TNodeConfig>;
 type TDryRunBaseOptions<TRes> = {
     tx: TRes;
     origin: TNodeDotKsmWithRelayChains;
-    destination: TNodeDotKsmWithRelayChains;
+    destination: TNodeWithRelayChains;
     senderAddress: string;
     address: string;
     currency: TCurrencyInputWithAmount;
@@ -568,7 +568,7 @@ type TDryRunXcmBaseOptions = {
      * The origin node
      */
     origin: TNodeDotKsmWithRelayChains;
-    asset: TAsset;
+    asset: TAsset | null;
     feeAsset?: TAsset;
     amount: bigint;
     originFee: bigint;
@@ -766,6 +766,11 @@ declare class UnableToComputeError extends Error {
     constructor(message: string);
 }
 
+type TXcmFeeBase = {
+    fee: bigint;
+    balance: bigint;
+    currencySymbol: string;
+};
 type TTransferInfo = {
     chain: {
         origin: TNodeWithRelayChains;
@@ -780,14 +785,21 @@ type TTransferInfo = {
             currencySymbol: string;
             existentialDeposit: bigint;
         };
-        xcmFee: {
+        xcmFee: TXcmFeeBase & {
             sufficient: boolean;
-            fee: bigint;
-            balance: bigint;
             balanceAfter: bigint;
-            currencySymbol: string;
         };
     };
+    assetHub?: {
+        balance: bigint;
+        currencySymbol: string;
+        existentialDeposit: bigint;
+        xcmFee: TXcmFeeBase;
+    };
+    bridgeHub?: {
+        currencySymbol: string;
+        xcmFee: TXcmFeeBase;
+    };
     destination: {
         receivedCurrency: {
             sufficient: boolean | UnableToComputeError;
@@ -797,11 +809,8 @@ type TTransferInfo = {
             currencySymbol: string;
             existentialDeposit: bigint;
         };
-        xcmFee: {
-            fee: bigint;
-            balance: bigint;
+        xcmFee: TXcmFeeBase & {
             balanceAfter: bigint | UnableToComputeError;
-            currencySymbol: string;
         };
     };
 };
@@ -812,8 +821,9 @@ type TOriginFeeDetails = {
 type TGetTransferInfoOptionsBase<TRes> = {
     tx: TRes;
     origin: TNodeDotKsmWithRelayChains;
-    destination: TNodeDotKsmWithRelayChains;
+    destination: TNodeWithRelayChains;
     senderAddress: string;
+    ahAddress?: string;
     address: string;
     currency: WithAmount<TCurrencyCore>;
     feeAsset?: TCurrencyCore;
@@ -832,7 +842,7 @@ type TGetXcmFeeBaseOptions<TRes> = {
     /**
      * The destination node
      */
-    destination: TNodeDotKsmWithRelayChains;
+    destination: TNodeWithRelayChains;
     /**
      * The sender address
      */
@@ -851,7 +861,7 @@ type TGetXcmFeeBuilderOptions = {
 type TGetOriginXcmFeeBaseOptions<TRes> = {
     tx: TRes;
     origin: TNodeDotKsmWithRelayChains;
-    destination: TNodeDotKsmWithRelayChains;
+    destination: TNodeWithRelayChains;
     senderAddress: string;
     currency: TCurrencyInput;
     feeAsset?: TCurrencyInput;
@@ -860,7 +870,7 @@ type TGetOriginXcmFeeBaseOptions<TRes> = {
 type TGetOriginXcmFeeOptions<TApi, TRes> = WithApi<TGetOriginXcmFeeBaseOptions<TRes>, TApi, TRes>;
 type TGetFeeForDestNodeBaseOptions = {
     origin: TNodeDotKsmWithRelayChains;
-    destination: TNodeDotKsmWithRelayChains;
+    destination: TNodeWithRelayChains;
     senderAddress: string;
     address: string;
     currency: TCurrencyInputWithAmount;
@@ -871,8 +881,11 @@ type TGetFeeForDestNodeBaseOptions = {
     disableFallback: boolean;
 };
 type TGetFeeForDestNodeOptions<TApi, TRes> = WithApi<TGetFeeForDestNodeBaseOptions, TApi, TRes>;
+type TGetReverseTxFeeOptions<TApi, TRes> = Omit<TGetFeeForDestNodeOptions<TApi, TRes>, 'destination' | 'disableFallback' | 'forwardedXcms' | 'asset' | 'originFee'> & {
+    destination: TNodeDotKsmWithRelayChains;
+};
 type THubKey = 'assetHub' | 'bridgeHub';
-type TFeeType = 'dryRun' | 'paymentInfo';
+type TFeeType = 'dryRun' | 'paymentInfo' | 'noFeeRequired';
 type TXcmFeeDetail = {
     fee: bigint;
     currency: string;
@@ -912,6 +925,7 @@ interface IPolkadotApi<TApi, TRes> {
     objectToHex(obj: unknown, typeName: string): Promise<string>;
     hexToUint8a(hex: string): Uint8Array;
     stringToUint8a(str: string): Uint8Array;
+    getMethod(tx: TRes): string;
     calculateTransactionFee(tx: TRes, address: string): Promise<bigint>;
     quoteAhPrice(fromMl: TMultiLocation, toMl: TMultiLocation, amountIn: bigint, includeFee?: boolean): Promise<bigint | undefined>;
     getBalanceNative(address: string): Promise<bigint>;
@@ -1784,7 +1798,7 @@ declare const getOriginFeeDetails: <TApi, TRes>(options: TGetOriginFeeDetailsOpt
 declare const getTransferableAmountInternal: <TApi, TRes>({ api, senderAddress, origin: node, destination, currency, tx, feeAsset }: TGetTransferableAmountOptions<TApi, TRes>) => Promise<bigint>;
 declare const getTransferableAmount: <TApi, TRes>(options: TGetTransferableAmountOptions<TApi, TRes>) => Promise<bigint>;
 
-declare const getTransferInfo: <TApi, TRes>({ api, tx, origin, destination, senderAddress, address, currency, feeAsset }: TGetTransferInfoOptions<TApi, TRes>) => Promise<TTransferInfo>;
+declare const getTransferInfo: <TApi, TRes>({ api, tx, origin, destination, senderAddress, ahAddress, address, currency, feeAsset }: TGetTransferInfoOptions<TApi, TRes>) => Promise<TTransferInfo>;
 
 declare const verifyEdOnDestination: <TApi, TRes>(options: TVerifyEdOnDestinationOptions<TApi, TRes>) => Promise<boolean>;
 
@@ -1868,4 +1882,4 @@ declare const validateAddress: (address: TAddress, node: TNodeWithRelayChains, i
 declare const determineRelayChain: (node: TNodeWithRelayChains) => TRelaychain;
 
 export { AssetClaimBuilder, BatchMode, BridgeHaltedError, Builder, DRY_RUN_CLIENT_TIMEOUT_MS, DryRunFailedError, ETHEREUM_JUNCTION, ETH_CHAIN_ID, GeneralBuilder, IncompatibleNodesError, InvalidAddressError, InvalidParameterError, NoXCMSupportImplementedError, NodeNotSupportedError, PolkadotXcmError, ScenarioNotSupportedError, TX_CLIENT_TIMEOUT_MS, TransferToAhNotSupported, UnableToComputeError, Version, XTokensError, blake2b256, blake2b512, claimAssets, computeFeeFromDryRun, computeFeeFromDryRunPjs, convertSs58, createApiInstanceForNode, createBeneficiaryMultiLocation, createVersionedBeneficiary, createX1Payload, deriveAccountId, determineRelayChain, dryRun, dryRunOrigin, encodeSs58, generateAddressMultiLocationV4, getAssetBalance, getAssetBalanceInternal, getBalanceForeign, getBalanceForeignInternal, getBalanceNative, getBalanceNativeInternal, getBridgeStatus, getFees, getNode, getNodeConfig, getNodeProviders, getOriginFeeDetails, getOriginFeeDetailsInternal, getOriginXcmFee, getOriginXcmFeeEstimate, getParaEthTransferFees, getParaId, getTNode, getTransferInfo, getTransferableAmount, getTransferableAmountInternal, getXcmFee, getXcmFeeEstimate, isEthersContract, isEthersSigner, resolveModuleError, resolveParaId, reverseTransformMultiLocation, send, transferMoonbeamEvm, transferMoonbeamToEth, transferRelayToPara, transformMultiLocation, validateAddress, verifyEdOnDestination };
-export type { IPolkadotApi, IPolkadotXCMTransfer, IXTokensTransfer, IXTransferTransfer, OneKey, TAddress, TApiOrUrl, TAssetClaimOptions, TAssetClaimOptionsBase, TBalanceResponse, TBatchOptions, TBifrostToken, TBridgeStatus, TCreateBeneficiaryOptions, TDestWeight, TDestination, TDryRunBaseOptions, TDryRunCallBaseOptions, TDryRunCallOptions, TDryRunNodeFailure, TDryRunNodeResult, TDryRunNodeResultInternal, TDryRunNodeSuccess, TDryRunOptions, TDryRunResult, TDryRunXcmBaseOptions, TDryRunXcmOptions, TEdJsonMap, TEvmBuilderOptions, TEvmBuilderOptionsBase, TEvmNodeFrom, TFeeType, TForeignAssetId, TForeignOrNativeAsset, TForeignOrTokenAsset, TGetAssetBalanceOptions, TGetAssetBalanceOptionsBase, TGetBalanceForeignOptions, TGetBalanceForeignOptionsBase, TGetBalanceNativeOptions, TGetBalanceNativeOptionsBase, TGetFeeForDestNodeBaseOptions, TGetFeeForDestNodeOptions, TGetMaxForeignTransferableAmountOptions, TGetMaxForeignTransferableAmountOptionsBase, TGetMaxNativeTransferableAmountOptions, TGetMaxNativeTransferableAmountOptionsBase, TGetOriginFeeDetailsOptions, TGetOriginFeeDetailsOptionsBase, TGetOriginXcmFeeBaseOptions, TGetOriginXcmFeeEstimateOptions, TGetOriginXcmFeeOptions, TGetTransferInfoOptions, TGetTransferInfoOptionsBase, TGetTransferableAmountOptions, TGetTransferableAmountOptionsBase, TGetXcmFeeBaseOptions, TGetXcmFeeBuilderOptions, TGetXcmFeeEstimateDetail, TGetXcmFeeEstimateOptions, TGetXcmFeeEstimateResult, TGetXcmFeeOptions, TGetXcmFeeResult, THubKey, TMantaAsset, TModuleError, TNativeTokenAsset, TNodeConfig, TNodeConfigMap, TNodleAsset, TOriginFeeDetails, TOtherReserveAsset, TPolkadotXCMTransferOptions, TPolkadotXcmSection, TProviderEntry, TRelayToParaDestination, TRelayToParaOptions, TRelayToParaOverrides, TRelaychain, TReserveAsset, TScenario, TSelfReserveAsset, TSendBaseOptions, TSendBaseOptionsWithSenderAddress, TSendInternalOptions, TSendOptions, TSerializeEthTransferOptions, TSerializedApiCall, TSerializedEthTransfer, TTransferInfo, TTransferLocalOptions, TVerifyEdOnDestinationOptions, TVerifyEdOnDestinationOptionsBase, TVersionClaimAssets, TWeight, TXTokensCurrencySelection, TXTokensSection, TXTokensTransferOptions, TXTransferSection, TXTransferTransferOptions, TXcmAsset, TXcmFeeDetail, TXcmForeignAsset, TXcmPalletSection, TXcmVersioned, TZeitgeistAsset, WithApi, WithRequiredSenderAddress };
+export type { IPolkadotApi, IPolkadotXCMTransfer, IXTokensTransfer, IXTransferTransfer, OneKey, TAddress, TApiOrUrl, TAssetClaimOptions, TAssetClaimOptionsBase, TBalanceResponse, TBatchOptions, TBifrostToken, TBridgeStatus, TCreateBeneficiaryOptions, TDestWeight, TDestination, TDryRunBaseOptions, TDryRunCallBaseOptions, TDryRunCallOptions, TDryRunNodeFailure, TDryRunNodeResult, TDryRunNodeResultInternal, TDryRunNodeSuccess, TDryRunOptions, TDryRunResult, TDryRunXcmBaseOptions, TDryRunXcmOptions, TEdJsonMap, TEvmBuilderOptions, TEvmBuilderOptionsBase, TEvmNodeFrom, TFeeType, TForeignAssetId, TForeignOrNativeAsset, TForeignOrTokenAsset, TGetAssetBalanceOptions, TGetAssetBalanceOptionsBase, TGetBalanceForeignOptions, TGetBalanceForeignOptionsBase, TGetBalanceNativeOptions, TGetBalanceNativeOptionsBase, TGetFeeForDestNodeBaseOptions, TGetFeeForDestNodeOptions, TGetMaxForeignTransferableAmountOptions, TGetMaxForeignTransferableAmountOptionsBase, TGetMaxNativeTransferableAmountOptions, TGetMaxNativeTransferableAmountOptionsBase, TGetOriginFeeDetailsOptions, TGetOriginFeeDetailsOptionsBase, TGetOriginXcmFeeBaseOptions, TGetOriginXcmFeeEstimateOptions, TGetOriginXcmFeeOptions, TGetReverseTxFeeOptions, TGetTransferInfoOptions, TGetTransferInfoOptionsBase, TGetTransferableAmountOptions, TGetTransferableAmountOptionsBase, TGetXcmFeeBaseOptions, TGetXcmFeeBuilderOptions, TGetXcmFeeEstimateDetail, TGetXcmFeeEstimateOptions, TGetXcmFeeEstimateResult, TGetXcmFeeOptions, TGetXcmFeeResult, THubKey, TMantaAsset, TModuleError, TNativeTokenAsset, TNodeConfig, TNodeConfigMap, TNodleAsset, TOriginFeeDetails, TOtherReserveAsset, TPolkadotXCMTransferOptions, TPolkadotXcmSection, TProviderEntry, TRelayToParaDestination, TRelayToParaOptions, TRelayToParaOverrides, TRelaychain, TReserveAsset, TScenario, TSelfReserveAsset, TSendBaseOptions, TSendBaseOptionsWithSenderAddress, TSendInternalOptions, TSendOptions, TSerializeEthTransferOptions, TSerializedApiCall, TSerializedEthTransfer, TTransferInfo, TTransferLocalOptions, TVerifyEdOnDestinationOptions, TVerifyEdOnDestinationOptionsBase, TVersionClaimAssets, TWeight, TXTokensCurrencySelection, TXTokensSection, TXTokensTransferOptions, TXTransferSection, TXTransferTransferOptions, TXcmAsset, TXcmFeeBase, TXcmFeeDetail, TXcmForeignAsset, TXcmPalletSection, TXcmVersioned, TZeitgeistAsset, WithApi, WithRequiredSenderAddress };