@paraspell/sdk-core 11.8.6 → 11.9.0

package/dist/index.d.ts

@@ -121,7 +121,9 @@ type TSendBaseOptions = {
 /**
  * Options for transferring from a parachain to another parachain or relay chain
  */
-type TSendOptions<TApi, TRes> = WithApi<TSendBaseOptions, TApi, TRes>;
+type TSendOptions<TApi, TRes> = WithApi<TSendBaseOptions, TApi, TRes> & {
+    isAmountAll: boolean;
+};
 type WithRequiredSenderAddress<TBase> = Omit<TBase, 'senderAddress'> & {
     /**
      * The sender address. A SS58 or H160 format.
@@ -136,6 +138,7 @@ type TSendInternalOptions<TApi, TRes> = Omit<TSendBaseOptions, 'from' | 'feeAsse
     feeCurrency?: TCurrencyInput;
     overriddenAsset?: TLocation | TAssetWithFee[];
     version: Version;
+    isAmountAll: boolean;
 };
 type TRelayToParaBaseOptions = {
     /**
@@ -220,6 +223,7 @@ type TCreateBeneficiaryXTokensOptions<TApi, TRes> = {
 type TBridgeStatus = 'Normal' | 'Halted';
 type TTransferLocalOptions<TApi, TRes> = Omit<TSendInternalOptions<TApi, TRes>, 'address'> & {
     address: string;
+    balance: bigint;
 };
 type TTransferFeeEstimates = {
     originFee: bigint;
@@ -326,8 +330,8 @@ declare class AssetClaimBuilder<TApi, TRes, T extends Partial<TAssetClaimOptions
 }
 
 declare class BatchTransactionManager<TApi, TRes> {
-    transactionOptions: TSendOptions<TApi, TRes>[];
-    addTransaction(options: TSendOptions<TApi, TRes>): void;
+    transactionOptions: TBatchedSendOptions<TApi, TRes>[];
+    addTransaction(options: TBatchedSendOptions<TApi, TRes>): void;
     isEmpty(): boolean;
     buildBatch(api: IPolkadotApi<TApi, TRes>, from: TSubstrateChain, options?: TBatchOptions): Promise<TRes>;
 }
@@ -447,7 +451,7 @@ declare class GeneralBuilder<TApi, TRes, T extends Partial<TSendBaseOptions> = o
      * @returns A Extrinsic representing the batched transactions.
      */
     buildBatch(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>, options?: TBatchOptions): Promise<TRes>;
-    protected buildInternal(this: GeneralBuilder<TApi, TRes, TSendBaseOptions>): Promise<TRes>;
+    protected buildInternal<TOptions extends TSendBaseOptions>(this: GeneralBuilder<TApi, TRes, TOptions>): Promise<TBuildInternalRes<TApi, TRes, TOptions>>;
     /**
      * Builds and returns the transfer extrinsic.
      *
@@ -457,7 +461,7 @@ declare class GeneralBuilder<TApi, TRes, T extends Partial<TSendBaseOptions> = o
     private buildCommon;
     private maybePerformXcmFormatCheck;
     dryRun(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>): Promise<TDryRunResult>;
-    dryRunPreview(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>, options?: TDryRunPreviewOptions): Promise<TDryRunResult>;
+    dryRunPreview(this: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>, dryRunOptions?: TDryRunPreviewOptions): Promise<TDryRunResult>;
     private createTxFactory;
     /**
      * Returns the XCM fee for the transfer using dryRun or paymentInfo function.
@@ -897,6 +901,13 @@ type TBuilderConfig<TApi> = {
     xcmFormatCheck?: boolean;
 };
 type TCreateTxsOptions<TApi, TRes> = Pick<TSendOptions<TApi, TRes>, 'api' | 'from' | 'to' | 'currency'>;
+type TBatchedSendOptions<TApi, TRes> = Omit<TSendOptions<TApi, TRes>, 'isAmountAll'> & {
+    buildTx: TTxFactory<TRes>;
+};
+type TBuildInternalRes<TApi, TRes, TOptions extends TSendBaseOptions = TSendBaseOptions> = {
+    tx: TRes;
+    options: TSendOptions<TApi, TRes> & TOptions;
+};
 
 type TProviderEntry = {
     name: string;
@@ -1509,17 +1520,17 @@ declare abstract class Parachain<TApi, TRes> {
     transferRelayToPara(options: TRelayToParaOptions<TApi, TRes>): Promise<TSerializedApiCall>;
     createCurrencySpec(amount: bigint, scenario: TScenario, version: Version, asset?: TAssetInfo, _isOverridenAsset?: boolean): TAsset;
     getNativeAssetSymbol(): string;
-    transferLocal(options: TSendInternalOptions<TApi, TRes>): TRes;
-    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
+    transferLocal(options: TSendInternalOptions<TApi, TRes>): Promise<TRes>;
+    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): Promise<TRes>;
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
     protected transferToEthereum<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>, useOnlyDepositInstruction?: boolean): Promise<TRes>;
 }
 
 declare class Acala<TApi, TRes> extends Parachain<TApi, TRes> implements IXTokensTransfer {
-    constructor();
+    constructor(chain?: TParachain, info?: string, ecosystem?: TRelaychain, version?: Version);
     getCurrencySelection(asset: TAssetInfo): TForeignOrTokenAsset;
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
-    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
+    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): Promise<TRes>;
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
@@ -1590,7 +1601,7 @@ declare class Astar<TApi, TRes> extends Parachain<TApi, TRes> implements IPolkad
 declare class Basilisk<TApi, TRes> extends Parachain<TApi, TRes> implements IXTokensTransfer {
     constructor();
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
-    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
+    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): Promise<TRes>;
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
@@ -1791,7 +1802,7 @@ declare class Hydration<TApi, TRes> extends Parachain<TApi, TRes> implements IXT
     transferMoonbeamWhAsset<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
     canUseXTokens(options: TSendInternalOptions<TApi, TRes>): boolean;
-    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
+    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): Promise<TRes>;
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
@@ -1818,7 +1829,7 @@ declare class Interlay<TApi, TRes> extends Parachain<TApi, TRes> implements IXTo
     constructor();
     getCurrencySelection(asset: TAssetInfo): TForeignOrTokenAsset;
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
-    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
+    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): Promise<TRes>;
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
@@ -1828,11 +1839,8 @@ declare class Jamton<TApi, TRes> extends Parachain<TApi, TRes> implements IXToke
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
 }
 
-declare class Karura<TApi, TRes> extends Parachain<TApi, TRes> implements IXTokensTransfer {
+declare class Karura<TApi, TRes> extends Acala<TApi, TRes> {
     constructor();
-    transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
-    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
-    transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
 declare class KiltSpiritnet<TApi, TRes> extends Parachain<TApi, TRes> implements IPolkadotXCMTransfer {
@@ -1849,7 +1857,7 @@ declare class Kintsugi<TApi, TRes> extends Parachain<TApi, TRes> implements IXTo
     constructor();
     getCurrencySelection(asset: TAssetInfo): TForeignOrTokenAsset;
     transferXTokens<TApi, TRes>(input: TXTokensTransferOptions<TApi, TRes>): TRes;
-    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
+    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): Promise<TRes>;
     transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
@@ -1875,7 +1883,7 @@ declare class Moonbeam<TApi, TRes> extends Parachain<TApi, TRes> implements IPol
     constructor(chain?: TParachain, info?: string, ecosystem?: TRelaychain, version?: Version);
     private getLocation;
     transferPolkadotXCM<TApi, TRes>(input: TPolkadotXCMTransferOptions<TApi, TRes>): Promise<TRes>;
-    transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
+    transferLocalNonNativeAsset(_options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
 declare class Moonriver<TApi, TRes> extends Parachain<TApi, TRes> implements IPolkadotXCMTransfer {
@@ -1895,6 +1903,8 @@ declare class Mythos<TApi, TRes> extends Parachain<TApi, TRes> implements IPolka
 declare class NeuroWeb<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>;
+    transferLocalNativeAsset(options: TTransferLocalOptions<TApi, TRes>): Promise<TRes>;
+    transferLocalNonNativeAsset(options: TTransferLocalOptions<TApi, TRes>): TRes;
 }
 
 declare class NeuroWebPaseo<TApi, TRes> extends NeuroWeb<TApi, TRes> {
@@ -2227,8 +2237,8 @@ declare const maybeOverrideAsset: (version: Version, amount: bigint, asset: TAss
 declare const sortAssets: (assets: TAsset[]) => TAsset[];
 
 declare const computeOverridenAmount: <TApi, TRes>(options: TCreateTxsOptions<TApi, TRes>, increaseAmount: string) => number | bigint;
-declare const overrideTxAmount: <TApi, TRes>(options: TCreateTxsOptions<TApi, TRes>, builder: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>, amount: string) => Promise<TRes>;
-declare const createTx: <TApi, TRes>(options: TCreateTxsOptions<TApi, TRes>, builder: GeneralBuilder<TApi, TRes, TSendBaseOptionsWithSenderAddress>, amount: string | undefined) => Promise<TRes>;
+declare const overrideTxAmount: <TApi, TRes>(options: TCreateTxsOptions<TApi, TRes>, builder: GeneralBuilder<TApi, TRes, TSendBaseOptions>, amount: string) => Promise<TRes>;
+declare const createTx: <TApi, TRes>(options: TCreateTxsOptions<TApi, TRes>, builder: GeneralBuilder<TApi, TRes, TSendBaseOptions>, amount: string | undefined) => Promise<TRes>;
 
 declare const isConfig: <TApi>(value: any) => value is TBuilderConfig<TApi>;
 
@@ -2318,4 +2328,4 @@ 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, 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 };
+export type { BuildHopInfoOptions, HopProcessParams, HopTraversalConfig, HopTraversalResult, IPolkadotApi, IPolkadotXCMTransfer, IXTokensTransfer, IXTransferTransfer, OneKey, TAddress, TApiOrUrl, TAssetClaimInternalOptions, TAssetClaimOptions, TAssetClaimOptionsBase, TBatchOptions, TBatchedSendOptions, TBifrostToken, TBridgeStatus, TBuildDestInfoOptions, TBuildInternalRes, 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 };