@paraspell/sdk-core 10.8.3 → 10.9.0

package/dist/index.d.ts

@@ -38,7 +38,7 @@ type TPolkadotXCMTransferOptions<TApi, TRes> = {
 type TXTokensTransferOptions<TApi, TRes> = {
     api: IPolkadotApi<TApi, TRes>;
     asset: WithAmount<TAsset>;
-    destLocation: TMultiLocation;
+    address: TAddress;
     scenario: TScenario;
     origin: TNodePolkadotKusama;
     destination: TDestination;
@@ -52,7 +52,6 @@ type TXTokensTransferOptions<TApi, TRes> = {
 type TXTransferTransferOptions<TApi, TRes> = {
     api: IPolkadotApi<TApi, TRes>;
     asset: WithAmount<TAsset>;
-    scenario: TScenario;
     recipientAddress: TAddress;
     origin: TNodePolkadotKusama;
     paraIdTo?: number;
@@ -200,9 +199,14 @@ type TWeight = {
 };
 type TCreateBeneficiaryOptions<TApi, TRes> = {
     api: IPolkadotApi<TApi, TRes>;
-    scenario: TScenario;
-    pallet: TPallet | null;
-    recipientAddress: TAddress;
+    address: TAddress;
+    version: Version;
+};
+type TCreateBeneficiaryXTokensOptions<TApi, TRes> = {
+    api: IPolkadotApi<TApi, TRes>;
+    origin: TNodeDotKsmWithRelayChains;
+    destination: TDestination;
+    address: TAddress;
     version: Version;
     paraId?: number;
 };
@@ -210,6 +214,42 @@ type TBridgeStatus = 'Normal' | 'Halted';
 type TTransferLocalOptions<TApi, TRes> = Omit<TSendInternalOptions<TApi, TRes>, 'address'> & {
     address: string;
 };
+type TTransferFeeEstimates = {
+    originFee: bigint;
+    reserveFee: bigint;
+};
+type TCreateBaseTransferXcmOptions = {
+    chain: TNodeDotKsmWithRelayChains;
+    destChain: TNodeWithRelayChains;
+    asset: WithAmount<TAsset>;
+    feeAsset?: TAsset;
+    fees: TTransferFeeEstimates;
+    recipientAddress: string;
+    version: Version;
+    paraIdTo?: number;
+};
+type TCreateTransferXcmOptions<TApi, TRes> = WithApi<TCreateBaseTransferXcmOptions, TApi, TRes>;
+type TCreateBaseSwapXcmOptions = {
+    chain?: TNodeDotKsmWithRelayChains;
+    exchangeChain: TNodePolkadotKusama;
+    destChain?: TNodeWithRelayChains;
+    assetFrom: WithAmount<TAsset>;
+    assetTo: WithAmount<TAsset>;
+    senderAddress: string;
+    recipientAddress: string;
+    calculateMinAmountOut: (amountIn: bigint, assetTo?: TAsset) => Promise<bigint>;
+};
+type TCreateSwapXcmOptions<TApi, TRes> = WithApi<TCreateBaseSwapXcmOptions, TApi, TRes>;
+type TSwapFeeEstimates = {
+    originReserveFee: bigint;
+    exchangeFee: bigint;
+    destReserveFee: bigint;
+};
+type TCreateSwapXcmInternalOptions<TApi, TRes> = WithApi<TCreateBaseSwapXcmOptions, TApi, TRes> & {
+    version: Version;
+    fees: TSwapFeeEstimates;
+    paraIdTo?: number;
+};
 
 type TAssetClaimOptionsBase = {
     node: TNodeWithRelayChains;
@@ -503,7 +543,7 @@ type TOtherReserveAsset = {
 type TSelfReserveAsset = 'SelfReserve';
 type TReserveAsset = TOtherReserveAsset | TSelfReserveAsset;
 type TBifrostToken = {
-    Native: string;
+    Native: string | number;
 } | {
     VToken: string;
 } | {
@@ -666,6 +706,8 @@ declare class BridgeHaltedError extends Error {
  * Error thrown when the Dry Run fails.
  */
 declare class DryRunFailedError extends Error {
+    readonly reason: string;
+    readonly dryRunType?: 'origin' | 'destination' | 'assetHub' | 'bridgeHub';
     /**
      * Constructs a new DryRunFailedError.
      *
@@ -1488,6 +1530,12 @@ declare class Interlay<TApi, TRes> extends ParachainNode<TApi, TRes> implements
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
+declare class Jamton<TApi, TRes> extends ParachainNode<TApi, TRes> implements IXTokensTransfer {
+    private static NATIVE_ASSET_IDS;
+    constructor();
+    transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
+}
+
 declare class Karura<TApi, TRes> extends ParachainNode<TApi, TRes> implements IXTokensTransfer {
     constructor();
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
@@ -1656,6 +1704,7 @@ declare const nodes: <TApi, TRes>() => {
     Hydration: Hydration<TApi, TRes>;
     Interlay: Interlay<TApi, TRes>;
     Heima: Heima<TApi, TRes>;
+    Jamton: Jamton<TApi, TRes>;
     Moonbeam: Moonbeam<TApi, TRes>;
     AssetHubKusama: AssetHubKusama<TApi, TRes>;
     CoretimeKusama: CoretimeKusama<TApi, TRes>;
@@ -1768,9 +1817,6 @@ declare const assertHasLocation: (asset: TAsset) => asserts asset is TAssetWithL
 
 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<_paraspell_sdk_common.Version, _paraspell_sdk_common.TMultiLocation>;
-
 declare const computeFeeFromDryRun: (dryRun: any, node: TNodeDotKsmWithRelayChains, executionFee: bigint, isFeeAsset?: boolean) => bigint;
 
 declare const computeFeeFromDryRunPjs: (dryRun: any, node: TNodeDotKsmWithRelayChains, executionFee: bigint) => bigint;
@@ -1785,10 +1831,13 @@ declare const resolveModuleError: (node: TNodeDotKsmWithRelayChains, error: TMod
  */
 declare const getNode: <TApi, TRes, T extends keyof ReturnType<typeof nodes>>(node: T) => ReturnType<typeof nodes<TApi, TRes>>[T];
 
-declare const createBeneficiaryMultiLocation: <TApi, TRes>({ api, scenario, pallet, recipientAddress, version, paraId }: TCreateBeneficiaryOptions<TApi, TRes>) => TMultiLocation;
+declare const createBeneficiaryLocXTokens: <TApi, TRes>({ api, address: recipientAddress, origin, destination, version, paraId }: TCreateBeneficiaryXTokensOptions<TApi, TRes>) => TMultiLocation;
+declare const createBeneficiaryLocation: <TApi, TRes>({ api, address: recipientAddress, version }: TCreateBeneficiaryOptions<TApi, TRes>) => TMultiLocation;
 
 declare const createX1Payload: (version: Version, junction: TJunction) => TJunctions;
 
+declare const getChainLocation: (chain: TNodeWithRelayChains) => TMultiLocation;
+
 /**
  * This function localizes a multiLocation by removing the `Parachain` junction
  * if it exists. The `parents` field is set to `0` either if a `Parachain` was removed
@@ -1802,8 +1851,41 @@ declare const localizeLocation: (node: TNodeWithRelayChains, multiLocation: TMul
 
 declare const reverseTransformMultiLocation: (multiLocation: TMultiLocation) => TMultiLocation;
 
+declare const createMultiAsset: (version: Version, amount: TAmount, multiLocation: TMultiLocation) => TMultiAsset;
+declare const createVersionedMultiAssets: (version: Version, amount: TAmount, multiLocation: TMultiLocation) => OneKey<Version, TMultiAsset[]>;
+
+declare const maybeOverrideMultiAssets: (version: Version, amount: TAmount, multiAssets: TMultiAsset[], overriddenCurrency?: TMultiLocation | TMultiAsset[]) => TMultiAsset[];
+declare const maybeOverrideMultiAsset: (version: Version, amount: TAmount, multiAsset: TMultiAsset, overriddenCurrency?: TMultiLocation | TMultiAsset[]) => TMultiAsset;
+
+declare const sortMultiAssets: (assets: TMultiAsset[]) => TMultiAsset[];
+
 declare const resolveParaId: (paraId: number | undefined, destination: TDestination) => number | undefined;
 
+declare const createAssetsFilter: (asset: TMultiAsset) => {
+    Wild: {
+        AllOf: {
+            id: _paraspell_sdk_common.TMultiLocation;
+            fun: string;
+        };
+    };
+};
+
+declare const createBaseExecuteXcm: (options: TCreateBaseTransferXcmOptions & {
+    suffixXcm?: unknown[];
+}) => unknown[];
+
+declare const createExecuteCall: (chain: TNodeDotKsmWithRelayChains, xcm: TXcmVersioned<any>, maxWeight: TWeight) => TSerializedApiCall;
+
+declare const createExecuteExchangeXcm: <TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>, origin: TNodeDotKsmWithRelayChains, weight: TWeight, originExecutionFee: bigint, destExecutionFee: bigint) => TRes;
+
+declare const createDirectExecuteXcm: <TApi, TRes>(options: TCreateTransferXcmOptions<TApi, TRes>) => OneKey<_paraspell_sdk_common.Version, unknown[]>;
+
+declare const handleExecuteTransfer: <TApi, TRes>(chain: TNodePolkadotKusama, options: TPolkadotXCMTransferOptions<TApi, TRes>) => Promise<TSerializedApiCall>;
+
+declare const handleSwapExecuteTransfer: <TApi, TRes>(options: TCreateSwapXcmOptions<TApi, TRes>) => Promise<TRes>;
+
+declare const handleToAhTeleport: <TApi, TRes>(origin: TNodePolkadotKusama, input: TPolkadotXCMTransferOptions<TApi, TRes>, defaultTx: TRes) => Promise<TRes>;
+
 declare const validateAddress: (address: TAddress, node: TNodeWithRelayChains, isDestination?: boolean) => void;
 
 /**
@@ -1814,5 +1896,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, XTokensError, addXcmVersionHeader, assertAddressIsString, assertHasLocation, assertToIsString, blake2b256, blake2b512, claimAssets, computeFeeFromDryRun, computeFeeFromDryRunPjs, convertSs58, createApiInstanceForNode, createBeneficiary, createBeneficiaryMultiLocation, createVersionedBeneficiary, createX1Payload, deriveAccountId, determineRelayChain, dryRun, dryRunOrigin, encodeSs58, getAssetBalance, getAssetBalanceInternal, getBalanceForeign, getBalanceForeignInternal, getBalanceNative, getBalanceNativeInternal, getBridgeStatus, getNode, getNodeConfig, getNodeProviders, getOriginFeeDetails, getOriginFeeDetailsInternal, getOriginXcmFee, getOriginXcmFeeEstimate, getParaEthTransferFees, getParaId, getTNode, getTransferInfo, getTransferableAmount, getTransferableAmountInternal, getXcmFee, getXcmFeeEstimate, localizeLocation, resolveModuleError, resolveParaId, reverseTransformMultiLocation, send, transferMoonbeamEvm, transferMoonbeamToEth, transferRelayToPara, 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, THopInfo, THopTransferInfo, 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, TWeight, TXTokensCurrencySelection, TXTokensMethod, TXTokensTransferOptions, TXTransferMethod, TXTransferTransferOptions, TXcmAsset, TXcmFeeBase, TXcmFeeChain, TXcmFeeDetail, TXcmFeeHopInfo, TXcmForeignAsset, TXcmPalletMethod, 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, XTokensError, addXcmVersionHeader, assertAddressIsString, assertHasLocation, assertToIsString, blake2b256, blake2b512, claimAssets, computeFeeFromDryRun, computeFeeFromDryRunPjs, convertSs58, createApiInstanceForNode, createAssetsFilter, createBaseExecuteXcm, createBeneficiaryLocXTokens, createBeneficiaryLocation, createDirectExecuteXcm, createExecuteCall, createExecuteExchangeXcm, createMultiAsset, createVersionedMultiAssets, createX1Payload, deriveAccountId, determineRelayChain, dryRun, dryRunOrigin, encodeSs58, getAssetBalance, getAssetBalanceInternal, getBalanceForeign, getBalanceForeignInternal, getBalanceNative, getBalanceNativeInternal, getBridgeStatus, getChainLocation, getNode, getNodeConfig, getNodeProviders, getOriginFeeDetails, getOriginFeeDetailsInternal, getOriginXcmFee, getOriginXcmFeeEstimate, getParaEthTransferFees, getParaId, getTNode, getTransferInfo, getTransferableAmount, getTransferableAmountInternal, getXcmFee, getXcmFeeEstimate, handleExecuteTransfer, handleSwapExecuteTransfer, handleToAhTeleport, localizeLocation, maybeOverrideMultiAsset, maybeOverrideMultiAssets, resolveModuleError, resolveParaId, reverseTransformMultiLocation, send, sortMultiAssets, transferMoonbeamEvm, transferMoonbeamToEth, transferRelayToPara, validateAddress, verifyEdOnDestination };
+export type { IPolkadotApi, IPolkadotXCMTransfer, IXTokensTransfer, IXTransferTransfer, OneKey, TAddress, TApiOrUrl, TAssetClaimOptions, TAssetClaimOptionsBase, TBalanceResponse, TBatchOptions, TBifrostToken, TBridgeStatus, TCreateBaseSwapXcmOptions, TCreateBaseTransferXcmOptions, TCreateBeneficiaryOptions, TCreateBeneficiaryXTokensOptions, TCreateSwapXcmInternalOptions, TCreateSwapXcmOptions, TCreateTransferXcmOptions, 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, THopInfo, THopTransferInfo, 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, TSwapFeeEstimates, TTransferFeeEstimates, TTransferInfo, TTransferLocalOptions, TVerifyEdOnDestinationOptions, TVerifyEdOnDestinationOptionsBase, TWeight, TXTokensCurrencySelection, TXTokensMethod, TXTokensTransferOptions, TXTransferMethod, TXTransferTransferOptions, TXcmAsset, TXcmFeeBase, TXcmFeeChain, TXcmFeeDetail, TXcmFeeHopInfo, TXcmForeignAsset, TXcmPalletMethod, TXcmVersioned, TZeitgeistAsset, WithApi, WithRequiredSenderAddress };