@paraspell/sdk-core 8.12.0 → 8.13.0

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
      */
@@ -487,6 +492,15 @@ type TNodeConfig = {
 };
 type TNodeConfigMap = Record<TNodeDotKsmWithRelayChains, TNodeConfig>;
 
+type TDryRunBaseOptions<TRes> = {
+    tx: TRes;
+    origin: TNodeDotKsmWithRelayChains;
+    destination: TNodeDotKsmWithRelayChains;
+    senderAddress: string;
+    address: string;
+    currency: TCurrencyInputWithAmount;
+};
+type TDryRunOptions<TApi, TRes> = WithApi<TDryRunBaseOptions<TRes>, TApi, TRes>;
 type TDryRunCallBaseOptions<TRes> = {
     /**
      * The transaction to dry-run
@@ -518,16 +532,27 @@ type TDryRunXcmBaseOptions = {
     origin: TNodeDotKsmWithRelayChains;
 };
 type TDryRunXcmOptions<TApi, TRes> = WithApi<TDryRunXcmBaseOptions, TApi, TRes>;
-type TDryRunResult = {
+type TDryRunNodeSuccess = {
     success: true;
     fee: bigint;
     weight?: TWeight;
     forwardedXcms: any;
     destParaId?: number;
-} | {
+};
+type TDryRunNodeFailure = {
     success: false;
     failureReason: string;
 };
+type TDryRunNodeResultInternal = TDryRunNodeSuccess | TDryRunNodeFailure;
+type TDryRunNodeResult = (TDryRunNodeSuccess & {
+    currency: string;
+}) | TDryRunNodeFailure;
+type TDryRunResult = {
+    origin: TDryRunNodeResult;
+    destination?: TDryRunNodeResult;
+    assetHub?: TDryRunNodeResult;
+    bridgeHub?: TDryRunNodeResult;
+};
 declare enum XTokensError {
     AssetHasNoReserve = "AssetHasNoReserve",
     NotCrossChainTransfer = "NotCrossChainTransfer",
@@ -669,6 +694,7 @@ type TGetFeeForDestNodeBaseOptions = {
     disableFallback: boolean;
 };
 type TGetFeeForDestNodeOptions<TApi, TRes> = WithApi<TGetFeeForDestNodeBaseOptions, TApi, TRes>;
+type THubKey = 'assetHub' | 'bridgeHub';
 type TFeeType = 'dryRun' | 'paymentInfo';
 type TXcmFeeDetail = {
     fee: bigint;
@@ -723,8 +749,8 @@ interface IPolkadotApi<TApi, TRes> {
     blake2AsHex(data: Uint8Array): string;
     clone(): IPolkadotApi<TApi, TRes>;
     createApiForNode(node: TNodeWithRelayChains): Promise<IPolkadotApi<TApi, TRes>>;
-    getDryRunCall(options: TDryRunCallBaseOptions<TRes>): Promise<TDryRunResult>;
-    getDryRunXcm(options: TDryRunXcmBaseOptions): Promise<TDryRunResult>;
+    getDryRunCall(options: TDryRunCallBaseOptions<TRes>): Promise<TDryRunNodeResultInternal>;
+    getDryRunXcm(options: TDryRunXcmBaseOptions): Promise<TDryRunNodeResultInternal>;
     getBridgeStatus(): Promise<TBridgeStatus>;
     setDisconnectAllowed(allowed: boolean): void;
     getDisconnectAllowed(): boolean;
@@ -846,10 +872,24 @@ declare class GeneralBuilder<TApi, TRes, T extends Partial<TSendBaseOptions> = o
     address(address: TAddress): GeneralBuilder<TApi, TRes, T & {
         address: TAddress;
     }>;
-    address(address: TAddress, senderAddress: string): GeneralBuilder<TApi, TRes, T & {
-        address: TAddress;
+    /**
+     * Sets the sender address.
+     *
+     * @param address - The sender address.
+     * @returns
+     */
+    senderAddress(address: string): GeneralBuilder<TApi, TRes, T & {
         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.
      *
@@ -899,7 +939,7 @@ declare class GeneralBuilder<TApi, TRes, T extends Partial<TSendBaseOptions> = o
      * @returns A Promise that resolves to the transfer extrinsic.
      */
     build(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>): Promise<TRes>;
-    dryRun(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>, senderAddress: string): Promise<TDryRunResult>;
+    dryRun(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TDryRunResult>;
     /**
      * Estimates the XCM fee for the transfer using paymentInfo function.
      *
@@ -1628,6 +1668,10 @@ declare const getTransferInfo: <TApi, TRes>({ origin, destination, accountOrigin
 
 declare const verifyEdOnDestination: <TApi, TRes>(options: TVerifyEdOnDestinationOptions<TApi, TRes>) => Promise<boolean>;
 
+declare const dryRun: <TApi, TRes>(options: TDryRunOptions<TApi, TRes>) => Promise<TDryRunResult>;
+
+declare const dryRunOrigin: <TApi, TRes>(options: TDryRunCallOptions<TApi, TRes>) => Promise<TDryRunNodeResult>;
+
 declare const getParaEthTransferFees: <TApi, TRes>(ahApi: IPolkadotApi<TApi, TRes>) => Promise<[bigint, bigint]>;
 
 declare const transferMoonbeamEvm: <TApi, TRes>({ api, from, to, signer, address, currency }: TEvmBuilderOptions<TApi, TRes>) => Promise<string>;
@@ -1643,8 +1687,6 @@ declare const getXcmFeeEstimate: <TApi, TRes>({ api, tx, origin, destination, ad
 
 declare const getBridgeStatus: <TApi, TRes>(api: IPolkadotApi<TApi, TRes>) => Promise<TBridgeStatus>;
 
-declare const getDryRun: <TApi, TRes>(options: TDryRunCallOptions<TApi, TRes>) => Promise<TDryRunResult>;
-
 declare const send: <TApi, TRes>(options: TSendOptions<TApi, TRes>) => Promise<TRes>;
 
 declare const transferRelayToPara: <TApi, TRes>(options: TRelayToParaOptions<TApi, TRes>) => Promise<TRes>;
@@ -1696,5 +1738,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, 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 };
+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, dryRun, dryRunOrigin, generateAddressMultiLocationV4, getAssetBalance, getAssetBalanceInternal, getBalanceForeign, getBalanceForeignInternal, getBalanceNative, getBalanceNativeInternal, getBridgeStatus, 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, 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, TGetFeeForOriginNodeBaseOptions, TGetFeeForOriginNodeOptions, TGetMaxForeignTransferableAmountOptions, TGetMaxForeignTransferableAmountOptionsBase, TGetMaxNativeTransferableAmountOptions, TGetMaxNativeTransferableAmountOptionsBase, TGetOriginFeeDetailsOptions, TGetOriginFeeDetailsOptionsBase, 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 };