@paraspell/sdk-core 10.3.1 → 10.4.0

package/dist/index.d.ts

@@ -71,6 +71,7 @@ type TPolkadotXCMTransferOptions<TApi, TRes> = {
     overriddenAsset?: TMultiLocation | TMultiAssetWithFee[];
     scenario: TScenario;
     asset: WithAmount<TAsset>;
+    currency: TCurrencyInputWithAmount;
     feeAsset?: TAsset;
     destination: TDestination;
     paraIdTo?: number;
@@ -188,7 +189,7 @@ type WithRequiredSenderAddress<TBase> = Omit<TBase, 'senderAddress'> & {
     senderAddress: string;
 };
 type TSendBaseOptionsWithSenderAddress = WithRequiredSenderAddress<TSendBaseOptions>;
-type TSendInternalOptions<TApi, TRes> = Omit<TSendBaseOptions, 'from' | 'currency' | 'feeAsset'> & {
+type TSendInternalOptions<TApi, TRes> = Omit<TSendBaseOptions, 'from' | 'feeAsset'> & {
     api: IPolkadotApi<TApi, TRes>;
     asset: WithAmount<TAsset>;
     feeAsset?: TAsset;
@@ -229,7 +230,7 @@ type TRelayToParaBaseOptions = {
     method?: string;
 };
 type TRelayToParaOverrides = {
-    section: TXcmPalletSection;
+    method: TXcmPalletMethod;
     includeFee: boolean;
 };
 /**
@@ -238,17 +239,17 @@ type TRelayToParaOverrides = {
 type TRelayToParaOptions<TApi, TRes> = WithApi<TRelayToParaBaseOptions, TApi, TRes>;
 type TSerializedApiCall = {
     module: TPallet | 'Utility';
-    section: string;
+    method: string;
     parameters: Record<string, unknown>;
 };
 type TDestWeight = {
     ref_time: bigint;
     proof_size: bigint;
 };
-type TXTransferSection = 'transfer';
-type TXTokensSection = 'transfer' | 'transfer_multiasset' | 'transfer_multiassets';
-type TPolkadotXcmSection = 'limited_teleport_assets' | 'limited_reserve_transfer_assets' | 'reserve_transfer_assets' | 'reserve_withdraw_assets' | 'transfer_assets';
-type TXcmPalletSection = 'limited_teleport_assets' | 'reserve_transfer_assets' | 'limited_reserve_transfer_assets';
+type TXTransferMethod = 'transfer';
+type TXTokensMethod = 'transfer' | 'transfer_multiasset' | 'transfer_multiassets';
+type TPolkadotXcmMethod = 'limited_teleport_assets' | 'limited_reserve_transfer_assets' | 'reserve_transfer_assets' | 'reserve_withdraw_assets' | 'transfer_assets';
+type TXcmPalletMethod = 'limited_teleport_assets' | 'reserve_transfer_assets' | 'limited_reserve_transfer_assets';
 type TWeight = {
     refTime: bigint;
     proofSize: bigint;
@@ -289,7 +290,7 @@ type TGetBalanceNativeOptionsBase = {
     /**
      * The node on which to query the balance.
      */
-    node: TNodeDotKsmWithRelayChains;
+    node: TNodeWithRelayChains;
     /**
      * The native currency to query.
      */
@@ -306,7 +307,7 @@ type TGetBalanceForeignOptionsBase = {
     /**
      * The node on which to query the balance.
      */
-    node: TNodePolkadotKusama;
+    node: TNode;
     /**
      * The currency to query.
      */
@@ -324,7 +325,7 @@ type TGetAssetBalanceOptionsBase = {
     /**
      * The node on which to query the balance.
      */
-    node: TNodeDotKsmWithRelayChains;
+    node: TNodeWithRelayChains;
     /**
      * The currency to query.
      */
@@ -586,7 +587,10 @@ type TDryRunNodeResultInternal = TDryRunNodeSuccess | TDryRunNodeFailure;
 type TDryRunNodeResult = (TDryRunNodeSuccess & {
     currency: string;
 }) | TDryRunNodeFailure;
+type TDryRunChain = 'origin' | 'destination' | 'assetHub' | 'bridgeHub';
 type TDryRunResult = {
+    failureReason?: string;
+    failureChain?: TDryRunChain;
     origin: TDryRunNodeResult;
     destination?: TDryRunNodeResult;
     assetHub?: TDryRunNodeResult;
@@ -845,7 +849,7 @@ type TGetXcmFeeBaseOptions<TRes> = {
      */
     senderAddress: string;
     address: string;
-    currency: TCurrencyInputWithAmount;
+    currency: WithAmount<TCurrencyCore>;
     feeAsset?: TCurrencyInput;
     disableFallback: boolean;
 };
@@ -871,7 +875,7 @@ type TGetFeeForDestNodeBaseOptions = {
     destination: TNodeWithRelayChains;
     senderAddress: string;
     address: string;
-    currency: TCurrencyInputWithAmount;
+    currency: WithAmount<TCurrencyCore>;
     forwardedXcms: any;
     asset: TAsset;
     originFee: bigint;
@@ -888,14 +892,21 @@ type TXcmFeeDetail = {
     fee: bigint;
     currency: string;
     feeType: TFeeType;
+    weight?: TWeight;
+    sufficient?: boolean;
     dryRunError?: string;
 } | {
     fee?: bigint;
     currency?: string;
     feeType?: TFeeType;
+    weight?: TWeight;
+    sufficient?: boolean;
     dryRunError: string;
 };
+type TXcmFeeChain = 'origin' | 'destination' | 'assetHub' | 'bridgeHub';
 type TGetXcmFeeResult = {
+    failureReason?: string;
+    failureChain?: TXcmFeeChain;
     origin: TXcmFeeDetail;
     destination: TXcmFeeDetail;
     assetHub?: TXcmFeeDetail;
@@ -904,6 +915,7 @@ type TGetXcmFeeResult = {
 type TGetXcmFeeEstimateDetail = {
     fee: bigint;
     currency: string;
+    sufficient?: boolean;
 };
 type TGetXcmFeeEstimateResult = {
     origin: TGetXcmFeeEstimateDetail;
@@ -1212,13 +1224,11 @@ declare abstract class ParachainNode<TApi, TRes> {
     private readonly _info;
     private readonly _type;
     private readonly _version;
-    protected _assetCheckEnabled: boolean;
     constructor(node: TNodePolkadotKusama, info: string, type: TEcosystemType, version: Version);
     get info(): string;
     get type(): TEcosystemType;
     get node(): TNodePolkadotKusama;
     get version(): Version;
-    get assetCheckEnabled(): boolean;
     protected canUseXTokens({ asset }: TSendInternalOptions<TApi, TRes>): boolean;
     transfer(options: TSendInternalOptions<TApi, TRes>): Promise<TRes>;
     getRelayToParaOverrides(): TRelayToParaOverrides;
@@ -1290,7 +1300,7 @@ declare class AssetHubPolkadot<TApi, TRes> extends ParachainNode<TApi, TRes> imp
     handleMythosTransfer<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): TRes;
     handleBifrostEthTransfer: <TApi_1, TRes_1>(input: TPolkadotXCMTransferOptions<TApi_1, TRes_1>, useDOTAsFeeAsset?: boolean) => TRes_1;
     patchInput<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): TPolkadotXCMTransferOptions<TApi, TRes>;
-    private getSection;
+    private getMethod;
     private handleExecuteTransfer;
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
     getRelayToParaOverrides(): TRelayToParaOverrides;
@@ -1385,14 +1395,12 @@ declare class BifrostPolkadot<TApi, TRes> extends ParachainNode<TApi, TRes> impl
 
 declare class BridgeHubKusama<TApi, TRes> extends ParachainNode<TApi, TRes> implements IPolkadotXCMTransfer {
     constructor();
-    _assetCheckEnabled: boolean;
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
     getRelayToParaOverrides(): TRelayToParaOverrides;
 }
 
 declare class BridgeHubPolkadot<TApi, TRes> extends ParachainNode<TApi, TRes> implements IPolkadotXCMTransfer {
     constructor();
-    _assetCheckEnabled: boolean;
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
     getRelayToParaOverrides(): TRelayToParaOverrides;
 }
@@ -1418,14 +1426,12 @@ declare class ComposableFinance<TApi, TRes> extends ParachainNode<TApi, TRes> im
 
 declare class CoretimeKusama<TApi, TRes> extends ParachainNode<TApi, TRes> implements IPolkadotXCMTransfer {
     constructor();
-    _assetCheckEnabled: boolean;
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
     getRelayToParaOverrides(): TRelayToParaOverrides;
 }
 
 declare class CoretimePolkadot<TApi, TRes> extends ParachainNode<TApi, TRes> implements IPolkadotXCMTransfer {
     constructor();
-    _assetCheckEnabled: boolean;
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
     getRelayToParaOverrides(): TRelayToParaOverrides;
 }
@@ -1566,6 +1572,7 @@ declare class Moonriver<TApi, TRes> extends ParachainNode<TApi, TRes> implements
 
 declare class Mythos<TApi, TRes> extends ParachainNode<TApi, TRes> implements IPolkadotXCMTransfer {
     constructor();
+    private createTx;
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
     transferRelayToPara(): TSerializedApiCall;
 }
@@ -1785,6 +1792,7 @@ declare const transferRelayToPara: <TApi, TRes>(options: TRelayToParaOptions<TAp
 
 declare const createApiInstanceForNode: <TApi, TRes>(api: IPolkadotApi<TApi, TRes>, node: TNodeDotKsmWithRelayChains) => Promise<TApi>;
 
+declare const createBeneficiary: <TApi, TRes>(options: TCreateBeneficiaryOptions<TApi, TRes>) => _paraspell_sdk_common.TMultiLocation;
 declare const createVersionedBeneficiary: <TApi, TRes>(options: TCreateBeneficiaryOptions<TApi, TRes>) => OneKey<Version, _paraspell_sdk_common.TMultiLocation>;
 
 declare const createX1Payload: (version: Version, junction: TJunction) => TJunctions;
@@ -1834,5 +1842,5 @@ 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, replaceBigInt, 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, 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 };
+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, createBeneficiary, 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, replaceBigInt, 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, TDryRunChain, 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, TPolkadotXcmMethod, TProviderEntry, TRelayToParaDestination, TRelayToParaOptions, TRelayToParaOverrides, TRelaychain, TReserveAsset, TScenario, TSelfReserveAsset, TSendBaseOptions, TSendBaseOptionsWithSenderAddress, TSendInternalOptions, TSendOptions, TSerializeEthTransferOptions, TSerializedApiCall, TSerializedEthTransfer, TTransferInfo, TTransferLocalOptions, TVerifyEdOnDestinationOptions, TVerifyEdOnDestinationOptionsBase, TVersionClaimAssets, TWeight, TXTokensCurrencySelection, TXTokensMethod, TXTokensTransferOptions, TXTransferMethod, TXTransferTransferOptions, TXcmAsset, TXcmFeeBase, TXcmFeeChain, TXcmFeeDetail, TXcmForeignAsset, TXcmPalletMethod, TXcmVersioned, TZeitgeistAsset, WithApi, WithRequiredSenderAddress };