@paraspell/sdk-core 8.11.1 → 8.12.1

package/dist/index.d.ts

@@ -77,6 +77,7 @@ type TPolkadotXCMTransferOptions<TApi, TRes> = {
     paraIdTo?: number;
     version?: Version;
     senderAddress?: string;
+    ahAddress?: string;
     pallet?: string;
     method?: string;
 };
@@ -141,9 +142,13 @@ type TSendBaseOptions = {
      */
     address: TAddress;
     /**
-     * The optional sender address. A SS58
+     * The optional sender address. A SS58 or H160 format.
      */
     senderAddress?: string;
+    /**
+     * The optional asset hub address. A SS58 format only.
+     */
+    ahAddress?: string;
     /**
      * The destination node or multi-location
      */
@@ -173,6 +178,12 @@ type TSendBaseOptions = {
      */
     method?: string;
 };
+type TSendBaseOptionsWithSenderAddress = Omit<TSendBaseOptions, 'senderAddress'> & {
+    /**
+     * The sender address. A SS58 or H160 format.
+     */
+    senderAddress: string;
+};
 /**
  * Options for transferring from a parachain to another parachain or relay chain
  */
@@ -481,7 +492,7 @@ type TNodeConfig = {
 };
 type TNodeConfigMap = Record<TNodeDotKsmWithRelayChains, TNodeConfig>;
 
-type TDryRunBaseOptions<TRes> = {
+type TDryRunCallBaseOptions<TRes> = {
     /**
      * The transaction to dry-run
      */
@@ -495,11 +506,29 @@ type TDryRunBaseOptions<TRes> = {
      */
     address: string;
 };
-type TDryRunOptions<TApi, TRes> = WithApi<TDryRunBaseOptions<TRes>, TApi, TRes>;
+type TDryRunCallOptions<TApi, TRes> = WithApi<TDryRunCallBaseOptions<TRes>, TApi, TRes>;
+type TDryRunXcmBaseOptions = {
+    originLocation: any;
+    /**
+     * The XCM instructions
+     */
+    xcm: any;
+    /**
+     * The node to dry-run on
+     */
+    node: TNodeDotKsmWithRelayChains;
+    /**
+     * The origin node
+     */
+    origin: TNodeDotKsmWithRelayChains;
+};
+type TDryRunXcmOptions<TApi, TRes> = WithApi<TDryRunXcmBaseOptions, TApi, TRes>;
 type TDryRunResult = {
     success: true;
     fee: bigint;
     weight?: TWeight;
+    forwardedXcms: any;
+    destParaId?: number;
 } | {
     success: false;
     failureReason: string;
@@ -601,6 +630,77 @@ type TGetTransferInfoOptionsBase = {
 };
 type TGetTransferInfoOptions<TApi, TRes> = WithApi<TGetTransferInfoOptionsBase, TApi, TRes>;
 
+type TGetXcmFeeBaseOptions<TRes> = {
+    /**
+     * The transaction to calculate the fee for
+     */
+    tx: TRes;
+    /**
+     * The origin node
+     */
+    origin: TNodeDotKsmWithRelayChains;
+    /**
+     * The destination node
+     */
+    destination: TNodeDotKsmWithRelayChains;
+    /**
+     * The sender address
+     */
+    senderAddress: string;
+    address: string;
+    currency: TCurrencyInputWithAmount;
+    disableFallback: boolean;
+};
+type TGetXcmFeeOptions<TApi, TRes> = WithApi<TGetXcmFeeBaseOptions<TRes>, TApi, TRes>;
+type TGetXcmFeeEstimateOptions<TApi, TRes> = Omit<TGetXcmFeeOptions<TApi, TRes>, 'disableFallback'>;
+type TGetXcmFeeBuilderOptions = {
+    disableFallback: boolean;
+};
+type TGetFeeForOriginNodeBaseOptions<TRes> = {
+    tx: TRes;
+    origin: TNodeDotKsmWithRelayChains;
+    destination: TNodeDotKsmWithRelayChains;
+    senderAddress: string;
+    disableFallback: boolean;
+};
+type TGetFeeForOriginNodeOptions<TApi, TRes> = WithApi<TGetFeeForOriginNodeBaseOptions<TRes>, TApi, TRes>;
+type TGetFeeForDestNodeBaseOptions = {
+    origin: TNodeDotKsmWithRelayChains;
+    destination: TNodeDotKsmWithRelayChains;
+    senderAddress: string;
+    address: string;
+    currency: TCurrencyInputWithAmount;
+    forwardedXcms: any;
+    disableFallback: boolean;
+};
+type TGetFeeForDestNodeOptions<TApi, TRes> = WithApi<TGetFeeForDestNodeBaseOptions, TApi, TRes>;
+type TFeeType = 'dryRun' | 'paymentInfo';
+type TXcmFeeDetail = {
+    fee: bigint;
+    currency: string;
+    feeType: TFeeType;
+    dryRunError?: string;
+} | {
+    fee?: bigint;
+    currency?: string;
+    feeType?: TFeeType;
+    dryRunError: string;
+};
+type TGetXcmFeeResult = {
+    origin: TXcmFeeDetail;
+    destination: TXcmFeeDetail;
+    assetHub?: TXcmFeeDetail;
+    bridgeHub?: TXcmFeeDetail;
+};
+type TGetXcmFeeEstimateDetail = {
+    fee: bigint;
+    currency: string;
+};
+type TGetXcmFeeEstimateResult = {
+    origin: TGetXcmFeeEstimateDetail;
+    destination: TGetXcmFeeEstimateDetail;
+};
+
 interface IPolkadotApi<TApi, TRes> {
     setApi(api?: TApiOrUrl<TApi>): void;
     getApi(): TApi;
@@ -628,7 +728,8 @@ interface IPolkadotApi<TApi, TRes> {
     blake2AsHex(data: Uint8Array): string;
     clone(): IPolkadotApi<TApi, TRes>;
     createApiForNode(node: TNodeWithRelayChains): Promise<IPolkadotApi<TApi, TRes>>;
-    getDryRun(options: TDryRunBaseOptions<TRes>): Promise<TDryRunResult>;
+    getDryRunCall(options: TDryRunCallBaseOptions<TRes>): Promise<TDryRunResult>;
+    getDryRunXcm(options: TDryRunXcmBaseOptions): Promise<TDryRunResult>;
     getBridgeStatus(): Promise<TBridgeStatus>;
     setDisconnectAllowed(allowed: boolean): void;
     getDisconnectAllowed(): boolean;
@@ -747,8 +848,21 @@ declare class GeneralBuilder<TApi, TRes, T extends Partial<TSendBaseOptions> = o
      * @param address - The destination address.
      * @returns An instance of Builder
      */
-    address(address: TAddress, senderAddress?: string): GeneralBuilder<TApi, TRes, T & {
+    address(address: TAddress): GeneralBuilder<TApi, TRes, T & {
+        address: TAddress;
+    }>;
+    address(address: TAddress, senderAddress: string): GeneralBuilder<TApi, TRes, T & {
         address: TAddress;
+        senderAddress: string;
+    }>;
+    /**
+     * Sets the asset hub address. This is used for transfers that go through the Asset Hub and originate from an EVM chain.
+     *
+     * @param address - The address to be used.
+     * @returns An instance of Builder
+     */
+    ahAddress(address: string | undefined): GeneralBuilder<TApi, TRes, T & {
+        ahAddress: string | undefined;
     }>;
     /**
      * Sets the XCM version to be used for the transfer.
@@ -800,6 +914,18 @@ declare class GeneralBuilder<TApi, TRes, T extends Partial<TSendBaseOptions> = o
      */
     build(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>): Promise<TRes>;
     dryRun(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>, senderAddress: string): Promise<TDryRunResult>;
+    /**
+     * Estimates the XCM fee for the transfer using paymentInfo function.
+     *
+     * @returns An origin and destination fee estimate.
+     */
+    getXcmFeeEstimate(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TGetXcmFeeEstimateResult>;
+    /**
+     * Returns the XCM fee for the transfer using dryRun or paymentInfo function.
+     *
+     * @returns An origin and destination fee.
+     */
+    getXcmFee(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>, { disableFallback }?: TGetXcmFeeBuilderOptions): Promise<TGetXcmFeeResult>;
     /**
      * Returns the API instance used by the builder.
      *
@@ -841,7 +967,7 @@ declare abstract class ParachainNode<TApi, TRes> {
     getRelayToParaOverrides(): TRelayToParaOverrides;
     transferRelayToPara(options: TRelayToParaOptions<TApi, TRes>): TSerializedApiCall;
     createCurrencySpec(amount: TAmount, scenario: TScenario, version: Version, _asset?: TAsset, _isOverridenAsset?: boolean): TXcmVersioned<TMultiAsset[]>;
-    createPolkadotXcmHeader(scenario: TScenario, version: Version, destination: TDestination, paraId?: number): TXcmVersioned<TMultiLocation>;
+    createVersionedDestination(scenario: TScenario, version: Version, destination: TDestination, paraId?: number): TXcmVersioned<TMultiLocation>;
     getNativeAssetSymbol(): string;
     transferLocal(options: TSendInternalOptions<TApi, TRes>): TRes;
     transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
@@ -858,6 +984,15 @@ declare class Acala<TApi, TRes> extends ParachainNode<TApi, TRes> implements IXT
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
+declare class Ajuna<TApi, TRes> extends ParachainNode<TApi, TRes> implements IXTokensTransfer, IPolkadotXCMTransfer {
+    constructor();
+    transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
+    transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
+    protected canUseXTokens({ asset, to: destination }: TSendInternalOptions<TApi, TRes>): boolean;
+    transferRelayToPara(): TSerializedApiCall;
+    transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
+}
+
 declare class Altair<TApi, TRes> extends ParachainNode<TApi, TRes> implements IXTokensTransfer {
     constructor();
     private getCurrencySelection;
@@ -904,7 +1039,7 @@ declare class AssetHubPolkadot<TApi, TRes> extends ParachainNode<TApi, TRes> imp
     handleEthBridgeNativeTransfer<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
     handleEthBridgeTransfer<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
     handleMythosTransfer<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): TRes;
-    handleBifrostEthTransfer: <TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi_1, TRes_1>, useDOTAsFeeAsset?: boolean) => TRes_1;
+    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 handleExecuteTransfer;
@@ -1025,11 +1160,6 @@ declare class BridgeHubPolkadot<TApi, TRes> extends ParachainNode<TApi, TRes> im
     getRelayToParaOverrides(): TRelayToParaOverrides;
 }
 
-declare class Calamari<TApi, TRes> extends ParachainNode<TApi, TRes> implements IXTokensTransfer {
-    constructor();
-    transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
-}
-
 declare class Centrifuge<TApi, TRes> extends ParachainNode<TApi, TRes> implements IXTokensTransfer {
     constructor();
     private getCurrencySelection;
@@ -1168,11 +1298,6 @@ declare class Interlay<TApi, TRes> extends ParachainNode<TApi, TRes> implements
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
-declare class InvArchTinker<TApi, TRes> extends ParachainNode<TApi, TRes> implements IXTokensTransfer {
-    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;
@@ -1327,6 +1452,7 @@ declare class Zeitgeist<TApi, TRes> extends ParachainNode<TApi, TRes> implements
 declare const nodes: <TApi, TRes>() => {
     AssetHubPolkadot: AssetHubPolkadot<TApi, TRes>;
     Acala: Acala<TApi, TRes>;
+    Ajuna: Ajuna<TApi, TRes>;
     Astar: Astar<TApi, TRes>;
     Unique: Unique<TApi, TRes>;
     Crust: Crust<TApi, TRes>;
@@ -1349,10 +1475,8 @@ declare const nodes: <TApi, TRes>() => {
     Amplitude: Amplitude<TApi, TRes>;
     Basilisk: Basilisk<TApi, TRes>;
     BifrostKusama: BifrostKusama<TApi, TRes>;
-    Calamari: Calamari<TApi, TRes>;
     CrustShadow: CrustShadow<TApi, TRes>;
     Crab: Crab<TApi, TRes>;
-    InvArchTinker: InvArchTinker<TApi, TRes>;
     Karura: Karura<TApi, TRes>;
     Kintsugi: Kintsugi<TApi, TRes>;
     Moonriver: Moonriver<TApi, TRes>;
@@ -1426,6 +1550,18 @@ declare class InvalidAddressError extends Error {
     constructor(message: string);
 }
 
+/**
+ * Error thrown when the Dry Run fails.
+ */
+declare class InvalidParameterError extends Error {
+    /**
+     * Constructs a new InvalidParameterError.
+     *
+     * @param message - Required error message.
+     */
+    constructor(message: string);
+}
+
 /**
  * Used to inform user, that Parachain they wish to use is not supported yet
  */
@@ -1515,9 +1651,13 @@ declare const transferMoonbeamToEth: <TApi, TRes>({ api, from, to, signer, addre
 declare const isEthersSigner: (signer: Signer | WalletClient) => signer is Signer;
 declare const isEthersContract: (contract: Contract | GetContractReturnType<Abi | readonly unknown[]>) => contract is Contract;
 
+declare const getXcmFee: <TApi, TRes>({ api, tx, origin, destination, senderAddress, address, currency, disableFallback }: TGetXcmFeeOptions<TApi, TRes>) => Promise<TGetXcmFeeResult>;
+
+declare const getXcmFeeEstimate: <TApi, TRes>({ api, tx, origin, destination, address, senderAddress, currency }: TGetXcmFeeEstimateOptions<TApi, TRes>) => Promise<TGetXcmFeeEstimateResult>;
+
 declare const getBridgeStatus: <TApi, TRes>(api: IPolkadotApi<TApi, TRes>) => Promise<TBridgeStatus>;
 
-declare const getDryRun: <TApi, TRes>(options: TDryRunOptions<TApi, TRes>) => Promise<TDryRunResult>;
+declare const getDryRun: <TApi, TRes>(options: TDryRunCallOptions<TApi, TRes>) => Promise<TDryRunResult>;
 
 declare const send: <TApi, TRes>(options: TSendOptions<TApi, TRes>) => Promise<TRes>;
 
@@ -1570,5 +1710,5 @@ declare const validateAddress: (address: TAddress, node: TNodeWithRelayChains, i
  */
 declare const determineRelayChain: (node: TNodeWithRelayChains) => TRelaychain;
 
-export { AssetClaimBuilder, BatchMode, BridgeHaltedError, Builder, DryRunFailedError, ETHEREUM_JUNCTION, ETH_CHAIN_ID, GeneralBuilder, IncompatibleNodesError, InvalidAddressError, NoXCMSupportImplementedError, NodeNotSupportedError, PolkadotXcmError, ScenarioNotSupportedError, Version, XTokensError, claimAssets, computeFeeFromDryRun, computeFeeFromDryRunPjs, createApiInstanceForNode, createBeneficiaryMultiLocation, createVersionedBeneficiary, createX1Payload, determineRelayChain, generateAddressMultiLocationV4, getAssetBalance, getAssetBalanceInternal, getBalanceForeign, getBalanceForeignInternal, getBalanceNative, getBalanceNativeInternal, getBridgeStatus, getDryRun, getFees, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getNode, getNodeConfig, getNodeProviders, getOriginFeeDetails, getOriginFeeDetailsInternal, getParaEthTransferFees, getParaId, getTNode, getTransferInfo, getTransferableAmount, isEthersContract, isEthersSigner, resolveModuleError, resolveParaId, 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, TDryRunOptions, TDryRunResult, TEdJsonMap, TEvmBuilderOptions, TEvmBuilderOptionsBase, TEvmNodeFrom, TForeignAssetId, TForeignOrNativeAsset, TForeignOrTokenAsset, TGetAssetBalanceOptions, TGetAssetBalanceOptionsBase, TGetBalanceForeignOptions, TGetBalanceForeignOptionsBase, TGetBalanceNativeOptions, TGetBalanceNativeOptionsBase, TGetMaxForeignTransferableAmountOptions, TGetMaxForeignTransferableAmountOptionsBase, TGetMaxNativeTransferableAmountOptions, TGetMaxNativeTransferableAmountOptionsBase, TGetOriginFeeDetailsOptions, TGetOriginFeeDetailsOptionsBase, TGetTransferInfoOptions, TGetTransferInfoOptionsBase, TGetTransferableAmountOptions, TGetTransferableAmountOptionsBase, TMantaAsset, TModuleError, TNativeTokenAsset, TNodeConfig, TNodeConfigMap, TNodleAsset, TOriginFeeDetails, TOtherReserveAsset, TPolkadotXCMTransferOptions, TPolkadotXcmSection, TProviderEntry, TRelayToParaDestination, TRelayToParaOptions, TRelayToParaOverrides, TRelaychain, TReserveAsset, TScenario, TSelfReserveAsset, TSendBaseOptions, TSendInternalOptions, TSendOptions, TSerializeEthTransferOptions, TSerializedApiCall, TSerializedEthTransfer, TTransferInfo, TTransferLocalOptions, TVerifyEdOnDestinationOptions, TVerifyEdOnDestinationOptionsBase, TVersionClaimAssets, TWeight, TXTokensCurrencySelection, TXTokensSection, TXTokensTransferOptions, TXTransferSection, TXTransferTransferOptions, TXcmAsset, TXcmForeignAsset, TXcmPalletSection, TXcmVersioned, TZeitgeistAsset, WithApi };
+export { AssetClaimBuilder, BatchMode, BridgeHaltedError, Builder, DryRunFailedError, ETHEREUM_JUNCTION, ETH_CHAIN_ID, GeneralBuilder, IncompatibleNodesError, InvalidAddressError, InvalidParameterError, NoXCMSupportImplementedError, NodeNotSupportedError, PolkadotXcmError, ScenarioNotSupportedError, Version, XTokensError, claimAssets, computeFeeFromDryRun, computeFeeFromDryRunPjs, createApiInstanceForNode, createBeneficiaryMultiLocation, createVersionedBeneficiary, createX1Payload, determineRelayChain, generateAddressMultiLocationV4, getAssetBalance, getAssetBalanceInternal, getBalanceForeign, getBalanceForeignInternal, getBalanceNative, getBalanceNativeInternal, getBridgeStatus, getDryRun, getFees, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getNode, getNodeConfig, getNodeProviders, getOriginFeeDetails, getOriginFeeDetailsInternal, getParaEthTransferFees, getParaId, getTNode, getTransferInfo, getTransferableAmount, getXcmFee, getXcmFeeEstimate, isEthersContract, isEthersSigner, resolveModuleError, resolveParaId, 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, TDryRunCallBaseOptions, TDryRunCallOptions, TDryRunResult, TDryRunXcmBaseOptions, TDryRunXcmOptions, TEdJsonMap, TEvmBuilderOptions, TEvmBuilderOptionsBase, TEvmNodeFrom, TFeeType, TForeignAssetId, TForeignOrNativeAsset, TForeignOrTokenAsset, TGetAssetBalanceOptions, TGetAssetBalanceOptionsBase, TGetBalanceForeignOptions, TGetBalanceForeignOptionsBase, TGetBalanceNativeOptions, TGetBalanceNativeOptionsBase, TGetFeeForDestNodeBaseOptions, TGetFeeForDestNodeOptions, TGetFeeForOriginNodeBaseOptions, TGetFeeForOriginNodeOptions, TGetMaxForeignTransferableAmountOptions, TGetMaxForeignTransferableAmountOptionsBase, TGetMaxNativeTransferableAmountOptions, TGetMaxNativeTransferableAmountOptionsBase, TGetOriginFeeDetailsOptions, TGetOriginFeeDetailsOptionsBase, TGetTransferInfoOptions, TGetTransferInfoOptionsBase, TGetTransferableAmountOptions, TGetTransferableAmountOptionsBase, TGetXcmFeeBaseOptions, TGetXcmFeeBuilderOptions, TGetXcmFeeEstimateDetail, TGetXcmFeeEstimateOptions, TGetXcmFeeEstimateResult, TGetXcmFeeOptions, TGetXcmFeeResult, 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 };