@paraspell/sdk-core 11.8.4 → 11.8.6

package/dist/index.d.ts

@@ -150,6 +150,10 @@ type TRelayToParaBaseOptions = {
      * The destination address. A SS58 or H160 format.
      */
     address: TAddress;
+    /**
+     * The sender address. A SS58 or H160 format.
+     */
+    senderAddress?: string;
     /**
      * The optional destination parachain ID
      */
@@ -1434,7 +1438,7 @@ interface IPolkadotApi<TApi, TRes> {
     getEvmStorage(contract: string, slot: string): Promise<string>;
     getBalanceNative(address: string): Promise<bigint>;
     getBalanceNativeAcala(address: string, symbol: string): Promise<bigint>;
-    getBalanceForeignPolkadotXcm(address: string, id?: string): Promise<bigint>;
+    getBalanceForeignPolkadotXcm(chain: TSubstrateChain, address: string, asset: TAssetInfo): Promise<bigint>;
     getMythosForeignBalance(address: string): Promise<bigint>;
     getBalanceForeignAssetsPallet(address: string, location: TLocation): Promise<bigint>;
     getForeignAssetsByIdBalance(address: string, assetId: string): Promise<bigint>;
@@ -1451,6 +1455,10 @@ interface IPolkadotApi<TApi, TRes> {
     setDisconnectAllowed(allowed: boolean): void;
     getDisconnectAllowed(): boolean;
     disconnect(force?: boolean): Promise<void>;
+    /**
+     * Convert a location to a chain account address using the runtime LocationToAccount API, if available.
+     */
+    convertLocationToAccount(location: TLocation): Promise<string | undefined>;
 }
 
 declare const blake2b256: (msg: Uint8Array) => Uint8Array<ArrayBufferLike>;
@@ -1494,7 +1502,7 @@ declare abstract class Parachain<TApi, TRes> {
     throwIfCantReceive(destChain: TChain | undefined): void;
     throwIfTempDisabled(options: TSendInternalOptions<TApi, TRes>, destChain?: TChain): void;
     isSendingTempDisabled(_options: TSendInternalOptions<TApi, TRes>): boolean;
-    isReceivingTempDisabled(_options: TSendInternalOptions<TApi, TRes>): boolean;
+    isReceivingTempDisabled(_scenario: TScenario): boolean;
     canReceiveFrom(_origin: TChain): boolean;
     shouldUseNativeAssetTeleport({ assetInfo: asset, to }: TSendInternalOptions<TApi, TRes>): boolean;
     getRelayToParaOverrides(): TRelayToParaOverrides;
@@ -1688,6 +1696,8 @@ declare class CollectivesWestend<TApi, TRes> extends Collectives<TApi, TRes> {
 declare class ComposableFinance<TApi, TRes> extends Parachain<TApi, TRes> implements IXTokensTransfer {
     constructor();
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
+    isSendingTempDisabled(_options: TSendInternalOptions<TApi, TRes>): boolean;
+    isReceivingTempDisabled(_scenario: TScenario): boolean;
 }
 
 declare class CoretimeKusama<TApi, TRes> extends Parachain<TApi, TRes> implements IPolkadotXCMTransfer {
@@ -1699,6 +1709,7 @@ declare class CoretimeKusama<TApi, TRes> extends Parachain<TApi, TRes> implement
 declare class CoretimePolkadot<TApi, TRes> extends Parachain<TApi, TRes> implements IPolkadotXCMTransfer {
     constructor(chain?: TParachain, info?: string, ecosystem?: TRelaychain, version?: Version);
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
+    canReceiveFrom(origin: TChain): boolean;
     getRelayToParaOverrides(): TRelayToParaOverrides;
 }
 
@@ -1735,6 +1746,8 @@ declare class CrustShadow<TApi, TRes> extends Parachain<TApi, TRes> implements I
 declare class Curio<TApi, TRes> extends Parachain<TApi, TRes> implements IXTokensTransfer {
     constructor();
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
+    isSendingTempDisabled(_options: TSendInternalOptions<TApi, TRes>): boolean;
+    isReceivingTempDisabled(_scenario: TScenario): boolean;
 }
 
 declare class Darwinia<TApi, TRes> extends Parachain<TApi, TRes> implements IPolkadotXCMTransfer {
@@ -1906,12 +1919,16 @@ declare class PeoplePolkadot<TApi, TRes> extends Parachain<TApi, TRes> implement
 
 declare class PAssetHub<TApi, TRes> extends PeoplePolkadot<TApi, TRes> {
     constructor();
+    isSendingTempDisabled(_options: TSendInternalOptions<TApi, TRes>): boolean;
+    isReceivingTempDisabled(_scenario: TScenario): boolean;
 }
 
 declare class Peaq<TApi, TRes> extends Parachain<TApi, TRes> implements IXTokensTransfer {
     constructor();
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
     transferRelayToPara(): Promise<TSerializedApiCall>;
+    isSendingTempDisabled(_options: TSendInternalOptions<TApi, TRes>): boolean;
+    isReceivingTempDisabled(_scenario: TScenario): boolean;
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
@@ -1948,6 +1965,7 @@ declare class Phala<TApi, TRes> extends Parachain<TApi, TRes> implements IXTrans
 declare class Polimec<TApi, TRes> extends Parachain<TApi, TRes> implements IPolkadotXCMTransfer {
     constructor();
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
+    isSendingTempDisabled({ assetInfo }: TSendInternalOptions<TApi, TRes>): boolean;
     transferRelayToPara(options: TRelayToParaOptions<TApi, TRes>): Promise<TSerializedApiCall>;
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
@@ -1967,6 +1985,7 @@ declare class RobonomicsKusama<TApi, TRes> extends Parachain<TApi, TRes> impleme
 declare class RobonomicsPolkadot<TApi, TRes> extends Parachain<TApi, TRes> implements IPolkadotXCMTransfer {
     constructor();
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
+    isReceivingTempDisabled(scenario: TScenario): boolean;
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
@@ -1981,6 +2000,8 @@ declare class Shiden<TApi, TRes> extends Parachain<TApi, TRes> implements IPolka
 declare class Subsocial<TApi, TRes> extends Parachain<TApi, TRes> implements IPolkadotXCMTransfer {
     constructor();
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
+    isSendingTempDisabled(_options: TSendInternalOptions<TApi, TRes>): boolean;
+    isReceivingTempDisabled(_scenario: TScenario): boolean;
 }
 
 declare class Unique<TApi, TRes> extends Parachain<TApi, TRes> implements IXTokensTransfer {
@@ -2000,6 +2021,7 @@ declare class Zeitgeist<TApi, TRes> extends Parachain<TApi, TRes> implements IXT
     constructor(chain?: TParachain, info?: string, ecosystem?: TRelaychain, version?: Version);
     private getCurrencySelection;
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
+    canReceiveFrom(origin: TChain): boolean;
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
@@ -2095,11 +2117,13 @@ type TSetBalanceRes = {
     assetStatusTx?: TSerializedApiCall;
     balanceTx: TSerializedApiCall;
 };
-interface IAssetsPallet {
-    mint<TApi, TRes>(address: string, assetInfo: WithAmount<TAssetInfo>, balance: bigint, chain: TSubstrateChain, api: IPolkadotApi<TApi, TRes>): Promise<TSetBalanceRes>;
+declare abstract class BaseAssetsPallet {
+    protected palletName: TPallet;
+    constructor(palletName: TPallet);
+    abstract mint<TApi, TRes>(address: string, assetInfo: WithAmount<TAssetInfo>, balance: bigint, chain: TSubstrateChain, api: IPolkadotApi<TApi, TRes>): Promise<TSetBalanceRes>;
 }
 
-declare class AssetsPallet implements IAssetsPallet {
+declare class AssetsPallet extends BaseAssetsPallet {
     mint(address: string, asset: WithAmount<TAssetInfo>, _balance: bigint, chain: TSubstrateChain): Promise<TSetBalanceRes>;
 }
 
@@ -2128,7 +2152,6 @@ declare const addEthereumBridgeFees: <TApi, TRes, TResult extends {
     fee?: bigint;
 }>(api: IPolkadotApi<TApi, TRes>, bridgeHubResult: TResult | undefined, destination: TChain, assetHubChain: TSubstrateChain) => Promise<TResult | undefined>;
 
-declare const getCurrencySelection: (asset: TAssetInfo) => TCurrencyCore;
 declare const calcPreviewMintAmount: (balance: bigint, desired: bigint) => bigint | null;
 declare const wrapTxBypass: <TApi, TRes>(dryRunOptions: TDryRunBypassOptions<TApi, TRes>, options?: TBypassOptions) => Promise<TRes>;
 
@@ -2173,7 +2196,14 @@ declare const transferRelayToPara: <TApi, TRes>(options: TRelayToParaOptions<TAp
 /**
  * Creates a type and then call for transferring assets using XCM. Works only for DOT and snowbridge assets so far.
  */
-declare const createTypeAndThenCall: <TApi, TRes>(chain: TSubstrateChain, options: TPolkadotXCMTransferOptions<TApi, TRes>) => Promise<TSerializedApiCall>;
+declare const createTypeAndThenCall: <TApi, TRes>(chain: TSubstrateChain, options: TPolkadotXCMTransferOptions<TApi, TRes>, overrideReserve?: TSubstrateChain) => Promise<TSerializedApiCall>;
+
+/**
+ * Creates a type-and-then call but auto-selects the asset reserve between AssetHub and the Relay chain
+ * by dry-running both variants and preferring the one that succeeds. If both fail, returns the
+ * AssetHub variant. Supports only relaychain assets.
+ */
+declare const createTypeThenAutoReserve: <TApi, TRes>(chain: TSubstrateChain, options: TPolkadotXCMTransferOptions<TApi, TRes>) => Promise<TSerializedApiCall>;
 
 declare const verifyEdOnDestination: <TApi, TRes>(options: TVerifyEdOnDestinationOptions<TApi, TRes>) => Promise<boolean>;
 
@@ -2189,6 +2219,8 @@ declare const assertIsForeign: (asset: TAssetInfo) => asserts asset is TForeignA
 declare const createAsset: (version: Version, amount: bigint, location: TLocation) => TAsset;
 declare const createVersionedAssets: (version: Version, amount: bigint, location: TLocation) => OneKey<Version, TAsset[]>;
 
+declare const getCurrencySelection: (asset: TAssetInfo) => TCurrencyCore;
+
 declare const maybeOverrideAssets: (version: Version, amount: bigint, assets: TAsset[], overriddenCurrency?: TLocation | TAsset[]) => TAsset[];
 declare const maybeOverrideAsset: (version: Version, amount: bigint, asset: TAsset, overriddenCurrency?: TLocation | TAsset[]) => TAsset;
 
@@ -2285,5 +2317,5 @@ declare const handleToAhTeleport: <TApi, TRes>(origin: TParachain, input: TPolka
 
 declare const validateAddress: (address: TAddress, chain: TChain, isDestination?: boolean) => void;
 
-export { AmountTooLowError, AssetClaimBuilder, AssetsPallet, BatchMode, BridgeHaltedError, Builder, ChainNotSupportedError, DRY_RUN_CLIENT_TIMEOUT_MS, DryRunFailedError, ETHEREUM_JUNCTION, ETH_CHAIN_ID, GeneralBuilder, IncompatibleChainsError, InvalidAddressError, InvalidParameterError, MissingChainApiError, NoXCMSupportImplementedError, PolkadotXcmError, ScenarioNotSupportedError, TX_CLIENT_TIMEOUT_MS, TransferToAhNotSupported, UnableToComputeError, XTokensError, abstractDecimals, addEthereumBridgeFees, addXcmVersionHeader, applyDecimalAbstraction, assertAddressIsString, assertHasId, assertHasLocation, assertIsForeign, assertSenderAddress, assertToIsString, blake2b256, blake2b512, calcPreviewMintAmount, claimAssets, computeFeeFromDryRun, computeFeeFromDryRunPjs, computeOverridenAmount, convertSs58, createAsset, createAssetsFilter, createBaseExecuteXcm, createBeneficiaryLocXTokens, createBeneficiaryLocation, createChainClient, createDirectExecuteXcm, createExecuteCall, createExecuteExchangeXcm, createTx, createTypeAndThenCall, createVersionedAssets, createX1Payload, deriveAccountId, dryRun, dryRunInternal, dryRunOrigin, encodeSs58, getAssetBalance, getAssetBalanceInternal, getAssetReserveChain, getBalanceForeign, getBalanceForeignInternal, getBalanceNative, getBalanceNativeInternal, getBridgeStatus, getChain, getChainConfig, getChainLocation, getChainProviders, getChainVersion, getCurrencySelection, getMinTransferableAmount, getMinTransferableAmountInternal, getOriginFeeDetails, getOriginFeeDetailsInternal, getOriginXcmFee, getOriginXcmFeeEstimate, getOriginXcmFeeInternal, getParaEthTransferFees, getParaId, getRelayChainOf, getTChain, getTransferInfo, getTransferableAmount, getTransferableAmountInternal, getXcmFee, getXcmFeeEstimate, getXcmFeeInternal, handleExecuteTransfer, handleSwapExecuteTransfer, handleToAhTeleport, isConfig, localizeLocation, maybeOverrideAsset, maybeOverrideAssets, overrideTxAmount, padFee, padFeeBy, resolveDestChain, resolveModuleError, resolveParaId, reverseTransformLocation, send, sortAssets, transferMoonbeamEvm, transferMoonbeamToEth, transferRelayToPara, traverseXcmHops, validateAddress, verifyEdOnDestination, wrapTxBypass };
+export { AmountTooLowError, AssetClaimBuilder, AssetsPallet, BatchMode, BridgeHaltedError, Builder, ChainNotSupportedError, DRY_RUN_CLIENT_TIMEOUT_MS, DryRunFailedError, ETHEREUM_JUNCTION, ETH_CHAIN_ID, GeneralBuilder, IncompatibleChainsError, InvalidAddressError, InvalidParameterError, MissingChainApiError, NoXCMSupportImplementedError, PolkadotXcmError, ScenarioNotSupportedError, TX_CLIENT_TIMEOUT_MS, TransferToAhNotSupported, UnableToComputeError, XTokensError, abstractDecimals, addEthereumBridgeFees, addXcmVersionHeader, applyDecimalAbstraction, assertAddressIsString, assertHasId, assertHasLocation, assertIsForeign, assertSenderAddress, assertToIsString, blake2b256, blake2b512, calcPreviewMintAmount, claimAssets, computeFeeFromDryRun, computeFeeFromDryRunPjs, computeOverridenAmount, convertSs58, createAsset, createAssetsFilter, createBaseExecuteXcm, createBeneficiaryLocXTokens, createBeneficiaryLocation, createChainClient, createDirectExecuteXcm, createExecuteCall, createExecuteExchangeXcm, createTx, createTypeAndThenCall, createTypeThenAutoReserve, createVersionedAssets, createX1Payload, deriveAccountId, dryRun, dryRunInternal, dryRunOrigin, encodeSs58, getAssetBalance, getAssetBalanceInternal, getAssetReserveChain, getBalanceForeign, getBalanceForeignInternal, getBalanceNative, getBalanceNativeInternal, getBridgeStatus, getChain, getChainConfig, getChainLocation, getChainProviders, getChainVersion, getCurrencySelection, getMinTransferableAmount, getMinTransferableAmountInternal, getOriginFeeDetails, getOriginFeeDetailsInternal, getOriginXcmFee, getOriginXcmFeeEstimate, getOriginXcmFeeInternal, getParaEthTransferFees, getParaId, getRelayChainOf, getTChain, getTransferInfo, getTransferableAmount, getTransferableAmountInternal, getXcmFee, getXcmFeeEstimate, getXcmFeeInternal, handleExecuteTransfer, handleSwapExecuteTransfer, handleToAhTeleport, isConfig, localizeLocation, maybeOverrideAsset, maybeOverrideAssets, overrideTxAmount, padFee, padFeeBy, resolveDestChain, resolveModuleError, resolveParaId, reverseTransformLocation, send, sortAssets, transferMoonbeamEvm, transferMoonbeamToEth, transferRelayToPara, traverseXcmHops, validateAddress, verifyEdOnDestination, wrapTxBypass };
 export type { BuildHopInfoOptions, HopProcessParams, HopTraversalConfig, HopTraversalResult, IPolkadotApi, IPolkadotXCMTransfer, IXTokensTransfer, IXTransferTransfer, OneKey, TAddress, TApiOrUrl, TAssetClaimInternalOptions, TAssetClaimOptions, TAssetClaimOptionsBase, TBatchOptions, TBifrostToken, TBridgeStatus, TBuildDestInfoOptions, TBuilderConfig, TBuilderOptions, TBypassOptions, TChainConfig, TChainConfigMap, TChainWithApi, TConditionalXcmFeeDetail, TConditionalXcmFeeHopInfo, TCreateBaseSwapXcmOptions, TCreateBaseTransferXcmOptions, TCreateBeneficiaryOptions, TCreateBeneficiaryXTokensOptions, TCreateSwapXcmInternalOptions, TCreateSwapXcmOptions, TCreateTransferXcmOptions, TCreateTxsOptions, TDestWeight, TDestXcmFeeDetail, TDestination, TDryRunBaseOptions, TDryRunBypassOptions, TDryRunCallBaseOptions, TDryRunCallOptions, TDryRunChain, TDryRunChainFailure, TDryRunChainResult, TDryRunChainSuccess, TDryRunOptions, TDryRunPreviewOptions, TDryRunResBase, TDryRunResult, TDryRunXcmBaseOptions, TDryRunXcmOptions, TEvmBuilderOptions, TEvmBuilderOptionsBase, TEvmChainFrom, TFeeType, TForeignAssetId, TForeignOrNativeAsset, TForeignOrTokenAsset, TGetAssetBalanceOptions, TGetAssetBalanceOptionsBase, TGetBalanceForeignByAssetOptions, TGetBalanceForeignOptions, TGetBalanceForeignOptionsBase, TGetBalanceNativeOptions, TGetBalanceNativeOptionsBase, TGetFeeForDestChainBaseOptions, TGetFeeForDestChainOptions, TGetMinTransferableAmountOptions, TGetOriginFeeDetailsOptions, TGetOriginFeeDetailsOptionsBase, TGetOriginXcmFeeBaseOptions, TGetOriginXcmFeeEstimateOptions, TGetOriginXcmFeeInternalOptions, TGetOriginXcmFeeOptions, TGetReverseTxFeeOptions, TGetTransferInfoOptions, TGetTransferInfoOptionsBase, TGetTransferableAmountOptions, TGetTransferableAmountOptionsBase, TGetXcmFeeBaseOptions, TGetXcmFeeBuilderOptions, TGetXcmFeeEstimateDetail, TGetXcmFeeEstimateOptions, TGetXcmFeeEstimateResult, TGetXcmFeeInternalOptions, TGetXcmFeeOptions, TGetXcmFeeResult, THopInfo, THopTransferInfo, THubKey, TMantaAsset, TModuleError, TNativeTokenAsset, TNodleAsset, TOriginFeeDetails, TOtherReserveAsset, TPolkadotXCMTransferOptions, TPolkadotXcmMethod, TProviderEntry, TRelayToParaDestination, TRelayToParaOptions, TRelayToParaOverrides, TReserveAsset, TScenario, TSelfReserveAsset, TSendBaseOptions, TSendBaseOptionsWithSenderAddress, TSendInternalOptions, TSendOptions, TSerializeEthTransferOptions, TSerializedApiCall, TSerializedEthTransfer, TSwapConfig, TSwapFeeEstimates, TTransferFeeEstimates, TTransferInfo, TTransferLocalOptions, TTxFactory, TTypeAndThenCallContext, TTypeAndThenFees, TVerifyEdOnDestinationOptions, TVerifyEdOnDestinationOptionsBase, TWeight, TXTokensCurrencySelection, TXTokensMethod, TXTokensTransferOptions, TXTransferMethod, TXTransferTransferOptions, TXcmAsset, TXcmFeeBase, TXcmFeeChain, TXcmFeeDetail, TXcmFeeDetailError, TXcmFeeDetailSuccess, TXcmFeeDetailWithFallback, TXcmFeeHopInfo, TXcmFeeHopResult, TXcmForeignAsset, TXcmPalletMethod, TXcmVersioned, TZeitgeistAsset, WithApi, WithRequiredSenderAddress };